[Checkins] SVN: z3c.recipe.usercrontab/trunk/src/z3c/recipe/usercrontab/README.txt reST fixes
Reinout van Rees
reinout at vanrees.org
Mon Jun 15 05:35:22 EDT 2009
Log message for revision 100960:
reST fixes
Changed:
U z3c.recipe.usercrontab/trunk/src/z3c/recipe/usercrontab/README.txt
-=-
Modified: z3c.recipe.usercrontab/trunk/src/z3c/recipe/usercrontab/README.txt
===================================================================
--- z3c.recipe.usercrontab/trunk/src/z3c/recipe/usercrontab/README.txt 2009-06-15 09:32:31 UTC (rev 100959)
+++ z3c.recipe.usercrontab/trunk/src/z3c/recipe/usercrontab/README.txt 2009-06-15 09:35:22 UTC (rev 100960)
@@ -15,19 +15,19 @@
>>> c = UserCrontabManager()
For these tests, we fake a crontab by filling the list of cron entries
-for this object::
+for this object:
>>> c.crontab = [ 'MAILTO=""', '@reboot echo "No-one will see this"']
>>> print c
MAILTO=""
@reboot echo "No-one will see this"
-Now, we're adding a method to it using the official way::
+Now, we're adding a method to it using the official way:
>>> c.add_entry('@reboot echo "example.com gets spammed!"',
... MAILTO="example at example.com")
-The object also has a convenient __repr__, so we can test its output::
+The object also has a convenient __repr__, so we can test its output:
>>> print c
MAILTO=""
@@ -35,7 +35,7 @@
MAILTO=example at example.com
@reboot echo "example.com gets spammed!"
-Adding another entry with yet another MAILTO line is placed at the end::
+Adding another entry with yet another MAILTO line is placed at the end:
>>> c.add_entry('@reboot echo "example.com gets spammed twice!"',
... MAILTO="twice at example.com")
@@ -48,7 +48,7 @@
@reboot echo "example.com gets spammed twice!"
When another entry is made with the same MAILTO, the MAILTO clause is
-not repeated again::
+not repeated again:
>>> c.add_entry('@reboot echo "twice at example.com gets spammed twice!"',
... MAILTO="twice at example.com")
@@ -61,7 +61,7 @@
@reboot echo "twice at example.com gets spammed twice!"
@reboot echo "example.com gets spammed twice!"
-Removing entries also works, and removes superfluous environment variables::
+Removing entries also works, and removes superfluous environment variables:
>>> c.del_entry('@reboot echo "example.com gets spammed!"') == 1
True
@@ -72,7 +72,7 @@
@reboot echo "twice at example.com gets spammed twice!"
@reboot echo "example.com gets spammed twice!"
-Removing entries does not remove too much::
+Removing entries does not remove too much:
>>> c.del_entry('@reboot echo "twice at example.com gets spammed twice!"') == 1
True
@@ -82,7 +82,7 @@
MAILTO=twice at example.com
@reboot echo "example.com gets spammed twice!"
-Removing the last entry also removes the dangling MAILTO line::
+Removing the last entry also removes the dangling MAILTO line:
>>> c.del_entry('@reboot echo "example.com gets spammed twice!"') == 1
True
@@ -91,7 +91,7 @@
@reboot echo "No-one will see this"
Removing the final entry removes the remaining MAILTO line, leaving us
-with an empty list::
+with an empty list:
>>> c.del_entry('@reboot echo "No-one will see this"') == 1
True
@@ -99,14 +99,14 @@
0
Adding an entry without a MAILTO environment line also doesn't put in
-an empty one::
+an empty one:
>>> c.add_entry('@reboot echo "Someone will see this"')
>>> print c
@reboot echo "Someone will see this"
Adding an entry with an empty MAILTO line adds it at the end, so the
-first entry is not disturbed::
+first entry is not disturbed:
>>> c.add_entry('@reboot echo "No-one will see this"', MAILTO="")
>>> print c
@@ -116,7 +116,7 @@
Next, test the read_crontab and write_crontab methods; we'll use
``cat`` and a temporary file to not modifiy the crontab of the user
-running these tests::
+running these tests:
>>> import tempfile
>>> t = tempfile.NamedTemporaryFile('w')
@@ -134,7 +134,7 @@
>>> a == b
False
-Now, delete this entry again and make sure the old crontab is restored::
+Now, delete this entry again and make sure the old crontab is restored:
>>> c.del_entry('# improbable entry') == 1
True
@@ -144,7 +144,7 @@
>>> a == b
True
-Do the buildout shuffle::
+Do the buildout shuffle:
>>> write('buildout.cfg',
... '''
@@ -172,7 +172,7 @@
Installing foo.
<BLANKLINE>
-Check that it really was added to the crontab::
+Check that it really was added to the crontab:
>>> c.read_crontab()
>>> b = repr(c)
@@ -185,7 +185,7 @@
>>> 'WARNING=The entries below were generated by buildout, do not modify' in c.crontab
True
-Uninstall the recipe::
+Uninstall the recipe:
>>> print system(os.path.join('bin', 'buildout')+' buildout:parts=')
Uninstalling foo.
@@ -195,14 +195,14 @@
And check that its entry was removed (i.e., the contents of the
crontab are the same as when this test was started; in any case, the
teardown from the testrunner makes sure the old situation is
-restored)::
+restored):
>>> c.read_crontab()
>>> b = repr(c)
>>> a == b
True
-Now, break it by adding the same crontab entry twice::
+Now, break it by adding the same crontab entry twice:
>>> print system(os.path.join('bin', 'buildout')+' "buildout:parts=foo bar"')
Installing foo.
@@ -225,13 +225,15 @@
RuntimeError: Found more than one matching crontab-entry during uninstall
<BLANKLINE>
-Manually fix it by removing the offending lines::
+Manually fix it by removing the offending lines:
+
>>> c.read_crontab()
>>> c.del_entry("# @reboot\techo nothing happens")
2
>>> c.write_crontab()
-And now we can uninstall again (albeit with some warnings)::
+And now we can uninstall again (albeit with some warnings):
+
>>> print system(os.path.join('bin', 'buildout')+' buildout:parts=') # doctest:
Uninstalling bar.
Running uninstall recipe.
More information about the Checkins
mailing list