ADDED docs/manual/Makefile Index: docs/manual/Makefile ================================================================== --- /dev/null +++ docs/manual/Makefile @@ -0,0 +1,5 @@ + +megatest_manual.html : megatest_manual.txt getting_started.txt writing_tests.txt reference.txt + asciidoc megatest_manual.txt + dos2unix megatest_manual.html + ADDED docs/manual/getting_started.txt Index: docs/manual/getting_started.txt ================================================================== --- /dev/null +++ docs/manual/getting_started.txt @@ -0,0 +1,79 @@ + +The First Part of the Book +========================== + +[partintro] +.Optional part introduction title +-- +Optional part introduction goes here. +-- + +The First Chapter +----------------- +Chapters can be grouped by preceeding them with a level 0 Book Part +title. + +Book chapters are at level 1 and can contain sub-sections nested up to +three deep. +footnote:[An example footnote.] +indexterm:[Example index entry] + +It's also worth noting that a book part can have it's own preface, +bibliography, glossary and index. Chapters can have their own +bibliography, glossary and index. + +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 <>. + + ADDED docs/manual/megatest_manual.html Index: docs/manual/megatest_manual.html ================================================================== --- /dev/null +++ docs/manual/megatest_manual.html @@ -0,0 +1,1003 @@ + + + + + +The Megatest Users Manual + + + + + +
+
+

Dedication

+
+

Dedicated to my wife, Joanna, who has, for many years now, supported +all my wacky ideas and nutty projects with only the occasional grumble +and roll of the eyes.

+
+

Thanks

+
+

To all the great people from the various places I’ve worked over the +years, thank you. I’ve benefitted from your patience and insight and I +hope that some of what I’ve learned from you has been incorporated +into Megatest.

+

Lastly, my thanks to all the wonderful open source creators. These +truly free projects, from Linux, xemacs, chicken scheme, and fossil to +asciidoc and bash are the philosophical and direct underpinnings of +the Megatest project.

+
+
+
+
+
+

Example Preface

+
+

The optional book preface goes here at section level zero.

+
+

Preface Sub-section

+
+ + + +
+
Note
+		Preface and appendix subsections start out of sequence at level +2 (level 1 is skipped). This only applies to multi-part book +documents.
+
+
+
+
+

The First Part of the Book

+
+
Optional part introduction title
+
+

Optional part introduction goes here.

+
+
+

The First Chapter

+
+

Chapters can be grouped by preceeding them with a level 0 Book Part +title.

+

Book chapters are at level 1 and can contain sub-sections nested up to +three deep. +
[An example footnote.]

+

It’s also worth noting that a book part can have it’s own preface, +bibliography, glossary and index. Chapters can have their own +bibliography, glossary and index.

+

And now for something completely different: monkeys, lions and +tigers (Bengal and Siberian) using the alternative syntax index +entries. + + + +Note that multi-entry terms generate separate index entries.

+

Here are a couple of image examples: an +images/smallnew.png + +example inline image followed by an example block image:

+
+
+Tiger image +
+
Figure 1. Tiger block image
+
+

Followed by an example table:

+
+ + +++ + + + + + + + + + + + + + + + +
Table 1. An example table
Option Description

-a USER GROUP

Add USER to GROUP.

-R GROUP

Disables access to GROUP.

+
+
+
Example 1. An example example
+
+

Lorum ipum…

+
+
+

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. +
[A second example footnote.]

+
+
+
+
+
+
+

The Second Chapter

+
+

An example link to anchor at start of the first sub-section.

+

An example link to a bibliography entry [taoup].

+
+
+

Writing Tests

+
+

The First Chapter of the Second Part

+
+

Chapters grouped into book parts are at level 1 and can contain +sub-sections.

+
+
+

Reference

+
+

The First Chapter of the Second Part

+
+

Chapters grouped into book parts are at level 1 and can contain +sub-sections.

+
+
+
+

The testconfig File

+
+
+
+
# testconfig
+[requirements]
+
+# A normal waiton waits for the prior tests to be COMPLETED
+# and PASS, CHECK or WAIVED
+waiton test1 test2
+
+# A item based waiton will start items in a test when the
+# same-named item is COMPLETED and PASS, CHECK or WAIVED
+# in the prior test
+#
+mode   normal | toplevel
+
+# With a toplevel test you may wish to generate your list
+# of tests to run dynamically
+#
+# waiton #{shell get-valid-tests-to-run.sh}
+
+
+
+
+

Appendix A: Example Appendix

+
+

One or more optional appendixes go here at section level zero.

+
+

Appendix Sub-section

+
+ + + +
+
Note
+		Preface and appendix subsections start out of sequence at level +2 (level 1 is skipped). This only applies to multi-part book +documents.
+
+
+
+
+
+

Example Bibliography

+
+

The bibliography list is a style of AsciiDoc bulleted list.

+
    +
  • +

    +[taoup] Eric Steven Raymond. The Art of Unix + Programming. Addison-Wesley. ISBN 0-13-142901-9. +

    +
    • +
  • +

    +[walsh-muellner] Norman Walsh & Leonard Muellner. + DocBook - The Definitive Guide. O’Reilly & Associates. 1999. + ISBN 1-56592-580-7. +

    +
    • +
+
+
+
+

Example Glossary

+
+

Glossaries are optional. Glossaries entries are an example of a style +of AsciiDoc labeled lists.

+
+
+A glossary term +
+
+

+ The corresponding (indented) definition. +

+
+
+A second glossary term +
+
+

+ The corresponding (indented) definition. +

+
+
+
+
+
+

Example Colophon

+
+

Text at the end of a book describing facts about its production.

+
+
+
+

Example Index

+
+
+
+
+
+ + + ADDED docs/manual/megatest_manual.txt Index: docs/manual/megatest_manual.txt ================================================================== --- /dev/null +++ docs/manual/megatest_manual.txt @@ -0,0 +1,97 @@ +The Megatest Users Manual +========================= +Matt Welland +v1.0, April 2012 +:doctype: book + + +[dedication] +Dedication +========== + +Dedicated to my wife, Joanna, who has, for many years now, supported +all my wacky ideas and nutty projects with only the occasional grumble +and roll of the eyes. + +Thanks +------ + +To all the great people from the various places I've worked over the +years, thank you. I've benefitted from your patience and insight and I +hope that some of what I've learned from you has been incorporated +into Megatest. + +Lastly, my thanks to all the wonderful open source creators. These +truly free projects, from Linux, xemacs, chicken scheme, and fossil to +asciidoc and bash are the philosophical and direct underpinnings of +the Megatest project. + +[preface] +Example Preface +================ +The optional book preface goes here at section level zero. + +Preface Sub-section +~~~~~~~~~~~~~~~~~~~ +NOTE: Preface and appendix subsections start out of sequence at level +2 (level 1 is skipped). This only applies to multi-part book +documents. + + +include::getting_started.txt[] +include::writing_tests.txt[] +include::reference.txt[] + +[appendix] +Example Appendix +================ +One or more optional appendixes go here at section level zero. + +Appendix Sub-section +~~~~~~~~~~~~~~~~~~~ +NOTE: Preface and appendix subsections start out of sequence at level +2 (level 1 is skipped). This only applies to multi-part book +documents. + + + +[bibliography] +Example Bibliography +==================== +The bibliography list is a style of AsciiDoc bulleted list. + +[bibliography] +- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix + Programming'. Addison-Wesley. ISBN 0-13-142901-9. +- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner. + 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999. + ISBN 1-56592-580-7. + + +[glossary] +Example Glossary +================ +Glossaries are optional. Glossaries entries are an example of a style +of AsciiDoc labeled lists. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +[colophon] +Example Colophon +================ +Text at the end of a book describing facts about its production. + + +[index] +Example Index +============= +//////////////////////////////////////////////////////////////// +The index is normally left completely empty, it's contents are +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// ADDED docs/manual/reference.txt Index: docs/manual/reference.txt ================================================================== --- /dev/null +++ docs/manual/reference.txt @@ -0,0 +1,34 @@ + +Reference +========= + +The First Chapter of the Second Part +------------------------------------ +Chapters grouped into book parts are at level 1 and can contain +sub-sections. + +The testconfig File +------------------- + +------------------- +# testconfig +[requirements] + +# A normal waiton waits for the prior tests to be COMPLETED +# and PASS, CHECK or WAIVED +waiton test1 test2 + +# A item based waiton will start items in a test when the +# same-named item is COMPLETED and PASS, CHECK or WAIVED +# in the prior test +# +mode normal | toplevel + +# With a toplevel test you may wish to generate your list +# of tests to run dynamically +# +# waiton #{shell get-valid-tests-to-run.sh} +------------------ + +:numbered!: + ADDED docs/manual/thoughts.fig Index: docs/manual/thoughts.fig ================================================================== --- /dev/null +++ docs/manual/thoughts.fig @@ -0,0 +1,49 @@ +#FIG 3.2 +Landscape +Center +Inches +Letter +100.00 +Single +-2 +1200 2 +2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5 + 1800 3000 10800 3000 10800 4800 1800 4800 1800 3000 +2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5 + 14475 975 15975 975 15975 1500 14475 1500 14475 975 +2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2 + 15075 2550 14100 3675 +2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2 + 14175 4275 15150 5475 +4 0 0 50 -1 0 24 0.0000 4 255 990 3150 1800 -runall\001 +4 0 0 50 -1 0 24 0.0000 4 330 4665 2175 5190 (expect:ignore Test: abc FAIL/)\001 +4 0 0 50 -1 0 24 0.0000 4 330 1095 2400 6225 [group]\001 +4 0 0 50 -1 0 24 0.0000 4 330 2415 2625 8085 megatest -runall\001 +4 0 0 50 -1 0 24 0.0000 4 360 1185 5250 8025 $(TAG)\001 +4 0 0 50 -1 0 24 0.0000 4 255 3045 4650 8700 make TARGET=foo\001 +4 0 0 50 -1 0 24 0.0000 4 330 4755 2625 6825 TAG1 envsetup test1 test2 testx\001 +4 0 0 50 -1 0 24 0.0000 4 330 1440 7875 1425 testconfig\001 +4 0 0 50 -1 0 24 0.0000 4 330 2190 7875 1845 [requirements]\001 +4 0 0 50 -1 0 24 0.0000 4 255 2670 3150 2220 -runtests standard\001 +4 0 0 50 -1 0 24 0.0000 4 300 1320 14625 2325 envsetup\001 +4 0 0 50 -1 0 24 0.0000 4 255 705 13650 4125 test1\001 +4 0 0 50 -1 0 24 0.0000 4 255 1410 14550 5850 testsuite2\001 +4 0 0 50 -1 0 24 0.0000 4 255 795 10200 6300 waito\001 +4 0 0 50 -1 0 24 0.0000 4 330 3990 7875 2265 testmode normal | toplevel \001 +4 0 0 50 -1 0 24 0.0000 4 330 2610 7875 2685 waitoncompleted \001 +4 0 0 50 -1 0 24 0.0000 4 360 9255 2175 4350 megatest -list-runs $MT_RUNNAME -target $MT_TARGET\001 +4 0 0 50 -1 0 24 0.0000 4 330 1860 10050 7275 test_toplevel\001 +4 0 0 50 -1 0 24 0.0000 4 330 2190 10050 7695 [requirements]\001 +4 0 0 50 -1 0 24 0.0000 4 330 2580 10050 8115 testmode toplevel\001 +4 0 0 50 -1 0 24 0.0000 4 330 2580 10050 8535 waiton testx testy\001 +4 0 0 50 -1 0 24 0.0000 4 225 810 10050 9375 testx:\001 +4 0 0 50 -1 0 24 0.0000 4 315 1050 10050 9795 [items]\001 +4 0 0 50 -1 0 24 0.0000 4 300 780 10050 11055 testy:\001 +4 0 0 50 -1 0 24 0.0000 4 315 1050 10050 11475 [items]\001 +4 0 0 50 -1 0 24 0.0000 4 330 2190 10800 13170 [requirements]\001 +4 0 0 50 -1 0 24 0.0000 4 300 780 10050 12735 testy:\001 +4 0 0 50 -1 0 24 0.0000 4 330 3330 10800 13590 waitoncompleted testx\001 +4 0 0 50 -1 0 24 0.0000 4 255 2610 10800 14010 waitonitems testx\001 +4 0 0 50 -1 0 24 0.0000 4 255 1605 10050 10215 X A B D E\001 +4 0 0 50 -1 0 24 0.0000 4 255 1245 10050 11895 Y A B C\001 +4 0 0 50 -1 0 24 0.0000 4 330 6660 2100 3450 waiton #{shell get-valid-tests-for-dotproc.sh}\001 ADDED docs/manual/writing_tests.txt Index: docs/manual/writing_tests.txt ================================================================== --- /dev/null +++ docs/manual/writing_tests.txt @@ -0,0 +1,13 @@ + +Writing Tests +============= + +The First Chapter of the Second Part +------------------------------------ +Chapters grouped into book parts are at level 1 and can contain +sub-sections. + + + +:numbered!: +