Index: docs/manual/getting_started.txt ================================================================== --- docs/manual/getting_started.txt +++ docs/manual/getting_started.txt @@ -20,62 +20,62 @@ for building Megatest on Linux. footnote:[An example footnote.] indexterm:[Example index entry] - - -And now for something completely different: ((monkeys)), lions and -tigers (Bengal and Siberian) using the alternative syntax index -entries. -(((Big cats,Lions))) -(((Big cats,Tigers,Bengal Tiger))) -(((Big cats,Tigers,Siberian Tiger))) -Note that multi-entry terms generate separate index entries. - -Here are a couple of image examples: an image:images/smallnew.png[] -example inline image followed by an example block image: - -.Tiger block image -image::images/tiger.png[Tiger image] - -Followed by an example table: - -.An example table -[width="60%",options="header"] -|============================================== -| Option | Description -| -a 'USER GROUP' | Add 'USER' to 'GROUP'. -| -R 'GROUP' | Disables access to 'GROUP'. -|============================================== - -.An example example -=============================================== -Lorum ipum... -=============================================== - -[[X1]] -Sub-section with Anchor -~~~~~~~~~~~~~~~~~~~~~~~ -Sub-section at level 2. - -Chapter Sub-section -^^^^^^^^^^^^^^^^^^^ -Sub-section at level 3. - -Chapter Sub-section -+++++++++++++++++++ -Sub-section at level 4. - -This is the maximum sub-section depth supported by the distributed -AsciiDoc configuration. -footnote:[A second example footnote.] - - -The Second Chapter ------------------- -An example link to anchor at start of the <>. -indexterm:[Second example index entry] - -An example link to a bibliography entry <>. - - +// +// +// And now for something completely different: ((monkeys)), lions and +// tigers (Bengal and Siberian) using the alternative syntax index +// entries. +// (((Big cats,Lions))) +// (((Big cats,Tigers,Bengal Tiger))) +// (((Big cats,Tigers,Siberian Tiger))) +// Note that multi-entry terms generate separate index entries. +// +// Here are a couple of image examples: an image:images/smallnew.png[] +// example inline image followed by an example block image: +// +// .Tiger block image +// image::images/tiger.png[Tiger image] +// +// Followed by an example table: +// +// .An example table +// [width="60%",options="header"] +// |============================================== +// | Option | Description +// | -a 'USER GROUP' | Add 'USER' to 'GROUP'. +// | -R 'GROUP' | Disables access to 'GROUP'. +// |============================================== +// +// .An example example +// =============================================== +// Lorum ipum... +// =============================================== +// +// [[X1]] +// Sub-section with Anchor +// ~~~~~~~~~~~~~~~~~~~~~~~ +// Sub-section at level 2. +// +// Chapter Sub-section +// ^^^^^^^^^^^^^^^^^^^ +// Sub-section at level 3. +// +// Chapter Sub-section +// +++++++++++++++++++ +// Sub-section at level 4. +// +// This is the maximum sub-section depth supported by the distributed +// AsciiDoc configuration. +// footnote:[A second example footnote.] +// +// +// The Second Chapter +// ------------------ +// An example link to anchor at start of the <>. +// indexterm:[Second example index entry] +// +// An example link to a bibliography entry <>. +// +// Index: docs/manual/howto.txt ================================================================== --- docs/manual/howto.txt +++ docs/manual/howto.txt @@ -37,32 +37,73 @@ Examining The Environment ~~~~~~~~~~~~~~~~~~~~~~~~~ During Config File Processing ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +It is often helpful to know the content of variables in various +contexts as Megatest does the actions needed to run your tests. A handy technique is to force the startup of an xterm in the context being examined. + +For example, if an item list is not being generated as expected you +can inject the startup of an xterm as if it were an item: + +.Original items table +----------------- +[items] +CELLNAME [system getcellname.sh] +----------------- + +.Items table modified for debug +----------------- +[items] +DEBUG [system xterm] +CELLNAME [system getcellnames.sh] +----------------- + +When this test is run an xterm will pop up. In that xterm the +environment is exactly that in which the script "getcellnames.sh" +would run. You can now debug the script to find out why it isn't +working as expected. Organising Your Tests and Tasks ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The default location "tests" for storing tests can be extended by +adding to your tests-paths section. + ---------------------------- +[misc] +parent #{shell dirname $(readlink -f .)} + [tests-paths] 1 #{get misc parent}/simplerun/tests ---------------------------- +The above example shows how you can use addition sections in your +config file to do complex processing. By putting results of relatively +slow operations into variables the processing of your configs can be +kept fast. + +Alternative Method for Running your Job Script +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.Directly running job in testconfig ------------------- [setup] -------------------- - -The runscript method is a brute force way to run scripts where the -user is responsible for setting STATE and STATUS - -------------------- runscript main.csh ------------------- +The runscript method is essentially a brute force way to run scripts where the +user is responsible for setting STATE and STATUS and managing the details of running a test. + Debugging Server Problems ~~~~~~~~~~~~~~~~~~~~~~~~~ + +Some handy Unix commands to track down issues with servers not +communicating with your test manager processes. Please put in tickets +at https://www.kiatoa.com/fossils/megatest if you have problems with +servers getting stuck. ---------------- sudo lsof -i sudo netstat -lptu sudo netstat -tulpn Index: docs/manual/megatest_manual.html ================================================================== --- docs/manual/megatest_manual.html +++ docs/manual/megatest_manual.html @@ -1,10 +1,10 @@ - + The Megatest Users Manual