- Add gettext macros in autoconf/gettext-macros.

[bacula/bacula] / regress / README

diff --git a/regress/README b/regress/README
index fb6547d1561cefcc67a5c44d392a242eada64cbd..96b9ce57e9192c77c8f1b393ebaf3129d7c5887a 100644 (file)
--- a/regress/README
+++ b/regress/README
@@ -1,33 +1,30 @@
-     Bacula Regression
-     Kern Sibbald
-     April 2003
+             Bacula Regression
+               Kern Sibbald
 
-This is Bacula's regression script directory.  At this time
-(May 2003), it is still in development, so all the tests are
-not complete.
+This is Bacula's regression script directory.
 
-To set it up, first edit Makefile and set BACULA-SOURCE to point
-to your source.
+To set it up, create your personal configuration file, by
+copying prototype.conf to xxx.conf or simply editing prototype.conf
+directly.
 
-!!!!!!!!!! IMPORTANT !!!!!!!!
-Second, edit the EMAIL address in the Makefile to be your
-email address and not mine or I will get LOTS of unwanted
-email!
+Then edit your conf file and define appropriate values
+for the variables that are in that file.  If you want to see
+a real example, look at kern.conf, but please don't use my
+email address!
 
-Third, edit the DEPKGS path in the Makefile to point to the
-depkgs directory.
-
-Fourth, make sure that depkgs is pre-built if it isn't 
+Make sure that depkgs is pre-built if it isn't 
 already: (cd your-depkgs; make sqlite).
 
 Then do:
 
+   ./config xxx.conf
    make setup
 
-You run the above one time.  This will copy the Bacula
-source, configure, build it, and configure all the scripts
-and conf files.  If you change your source, you will need
-to redo this command. 
+You run the above one time.  This will build a Makefile from
+Makefile.in and your xxx.conf file, copy the Bacula source,
+configure, build it, and configure all the Bacula scripts
+and conf files.  If you change your source, you will need to
+redo this command.
 
 Then you can run any of the tests in the tests subdirectory.
 Each test whose name ends in -root requires you to be root for
@@ -71,3 +68,31 @@ to do:
 
 this cleans up any files that may be created with root permissions.
 
+If you want to add more tests, do so by putting the shell script 
+in the tests subdirectory. Be careful when adding (or better not)
+new clients, pools, and such to the test-bacula-dir.conf.in file
+as it may invalidate a good number of tests, which respond to
+questions by answering with a number (i.e. the order of the selection
+list is known). It might be better to add your own testb-bacula...
+configuration file.  
+
+To avoid re-doing a make setup if you have made a change to the
+conf files, and you do not need a new copy of the source, you can simply do:
+
+   make sed
+
+Debugging failed tests:
+The simplest thing to do is to edit tests/xxxx where xxxx is the name of
+a or the test that is failing and change all:
+ 
+ @output
+
+to
+  
+ @tee
+
+re-run the test. The output will display on your terminal.  In rare cases,        
+for example to get bacula debug output, you might want to remove the
+"2>&1 >/dev/null" from the end of the bin/bacula call or from the end
+of the diff call, assuming you want to "see" the diff output.
+