drop completed items, polish core text

releng/README.core

@@ -1,28 +1,29 @@
 Release Engineering
 ~~~~~~~~~~~~~~~~~~~
 * SOFTWARE TO TEST
- Use latest libraries code base from svn and bzr
+ Use latest libburnia libraries code base from svn and bzr
  (see README for aditional and autodetected library dependencies)
  Alternatively, use latest all-in-one development tarball from:
  http://www.gnu.org/software/xorriso/
 
 * SETUP THE TEST ENVIRONMENT
  + Not all TESTs are scripts (e.g. cppcheck, valgrind)
- + Copy all FILE.conf.template to $HOME/.libburnia-releng/FILE.conf
+ + Copy all SCRIPT.conf.template to $HOME/.libburnia-releng/SCRIPT.conf
  + Read the configuration files and set up accordingly to your needs
 
 * DELIVERING A NEW TEST SCRIPT
- + start a new test script over the top of template_new_releng
+ + Start a new test script over the top of template_new_releng
- + all filenames start with releng_ prefix
+ + All filenames start with releng_ prefix
- + self generated data are to be stored in
+ + Self generated data are to be stored in
    ./releng_generated_data/scriptname/ directory
- + test data generation options -rc [-keep]
+ + Test data generation options -rc [-keep]
- + test data removal options -cleanup
+ + Test data removal options -cleanup
- + well documented configuration file $script.conf.template
+ + Well documented configuration file SCRIPT.conf.template
- + throw FAIL string to stdout if any failure is detected
+ + Throw FAIL string to stdout if any failure is detected
- + exit code 0 on success, non-zero on failure
+ + Return exit code 0 on success, non-zero on failure
- + use different exit codes for any failure (range 1-31)
+ + Use different exit codes for any failure (range 1-31)
 
 * RUNNING TESTS
  + All tests have to be run from the releng/ directory, within
-   libisoburn source tree.
+   libisoburn source tree. Ther is a 'master' script called
+   run_all_releng, which runs all scripts prefixed with releng_*.

releng/TODO

@@ -1,25 +1,14 @@
-* write a 'master' script to run all tests
+
- -> work in progress: run_all_releng
+* write common configuration facility
- + figure out how to store logs and search for interesting
+
+* run_all_releng (master script)
+ + figure out how to efficiently search for interesting
    err/warn keywords spewed up by the script or apps it calls.
- + write common configuration facility
 
 * releng_build_isojigdo:
  + finish boot options
 
-* releng_check_isocontent: compare input data against the ISO image content, might be tricky
+* releng_check_isocontent (WIP) - compare input data against
- -> work in progress
+  the ISO image content, might be tricky
-
-* Give up existing standard option -clean in favor of:
-  + Option -keep which keeps the test data from being removed after
-    the test.
-  + Option -clean_up which removes the test data without doing another test.
-  + Rule: A test must not overwrite existing data on disk.
-          It rather shall refuse and offer option -clean_up to
-          solve the problem (after skilled examination by the user).
-  + Rule: A test shall remove all files which it has created.
-          Only explicit user orders shall allow test files to persist.
-          These orders may be program arguments or configuration variables.
-  -> see releng/test_hardlinks for an implementation example
 
 * Interpreter to read options from config files and sets the variables