Improvements about releng/manual_burn

libisoburn/trunk/releng/README

@@ -79,6 +79,7 @@ There are several options which work with run_all_auto and any single test.
   -k  keep self-generated data.
   -c  cleanup temporary data kept from previous run and exit.
   -f  simulate failure.
+  -h  print this help text
   --  end of general options, begin of test specific options.
 After option "--", there may be given options which are specific to
 particular manually executable test scripts. 
@@ -109,12 +110,15 @@ the user or require sysadmin considerations before they are run:
   If no option --dev is given, then the user gets asked which of the listed
   drives to examine more closely.
 
->>> ./manual_burn -x ../xorriso/xorriso [-- [--dev device_file_to_use]
->>>                                         [--what ...directory...]]
->>> burns the content of the directory given with --what onto re-usable
->>> media: CD-RW, DVD-RW, DVD-RAM, DVD+RW, BD-RE.
->>> Other media types get refused.
->>> Data, which are possibly present on the media, get overwritten.
+./manual_burn -x ../xorriso/xorriso [-- [--dev device_file_to_use]
+                                        [--what ...directory...] [--any_media]]
+  Burns the content of the directory given with --what onto re-usable
+  media: CD-RW, DVD-RW, DVD-RAM, DVD+RW, BD-RE.
+  Other media types get refused, unless option --any_media is given.
+  Data, which are possibly present on the media, get overwritten.
+  The result gets check read and compared with the state of the input
+  directory. MD5 mismatch causes a test failure. Differences to the directory
+  state are reported but still regarded as success.
 
 >>> ./run_all_manual
 
@@ -165,6 +169,8 @@ Predefined are:
   30 = Unexpected state of own directory for self generated files
   29 = Not in ./releng directory or missing essential parts of ./releng
 
+When exiting prematurely, make sure to call function cleanup.
+
 
                  General options, variables, and functions
 
@@ -230,3 +236,6 @@ TODO:
 
 * derive a GNU xorriso test suite from libisoburn test suite
 
+* auto_ tests should know whether they work underneath run_all_auto
+  or whether they run standalone
+