update dox for waf --check
authorCraig Dowell <craigdo@ee.washington.edu>
Mon Jun 15 15:42:32 2009 -0700 (7 months ago)
changeset 45492680abc768f2
parent 4548 f4d74e20ad78
child 4550 0878cd580565
update dox for waf --check
doc/build.txt
doc/main.h
doc/manual/new-models.texi
doc/release_steps.txt
doc/tutorial/getting-started.texi
doc/tutorial/in-process/introduction.texi
     1.1 --- a/doc/build.txt	Mon Jun 15 15:22:33 2009 -0700
     1.2 +++ b/doc/build.txt	Mon Jun 15 15:42:32 2009 -0700
     1.3 @@ -36,7 +36,7 @@
     1.4  
     1.5  Other waf usages include:
     1.6  
     1.7 - 1. ./waf check
     1.8 + 1. ./waf --check
     1.9      Runs the unit tests
    1.10  
    1.11   2. ./waf --doxygen
     2.1 --- a/doc/main.h	Mon Jun 15 15:22:33 2009 -0700
     2.2 +++ b/doc/main.h	Mon Jun 15 15:42:32 2009 -0700
     2.3 @@ -27,8 +27,8 @@
     2.4   * ns-3 requires Doxygen version 1.5.4 or greater to fully build all items,
     2.5   * although earlier versions of Doxygen will mostly work.
     2.6   * 
     2.7 - * Type "./waf check" followed by "./waf --doxygen" to build the documentation.
     2.8 - * There is a program that runs during "./waf check" that builds pieces of
     2.9 + * Type "./waf --check" followed by "./waf --doxygen" to build the documentation.
    2.10 + * There is a program that runs during "./waf --check" that builds pieces of
    2.11   * the documentation through introspection.  The doc/ directory contains
    2.12   * configuration for Doxygen (doxygen.conf and main.txt).  The Doxygen 
    2.13   * build process puts html files into the doc/html/ directory, and latex 
     3.1 --- a/doc/manual/new-models.texi	Mon Jun 15 15:22:33 2009 -0700
     3.2 +++ b/doc/manual/new-models.texi	Mon Jun 15 15:42:32 2009 -0700
     3.3 @@ -205,7 +205,7 @@
     3.4  of adding the .cc file to the rest of the source files, and the .h
     3.5  file to the list of the header files. 
     3.6  
     3.7 -Now, pop up to the top level directory and type "./waf check".  You
     3.8 +Now, pop up to the top level directory and type "./waf --check".  You
     3.9  shouldn't have broken anything by this operation.
    3.10  @subsection include guards
    3.11  Next, let's add some 
     4.1 --- a/doc/release_steps.txt	Mon Jun 15 15:22:33 2009 -0700
     4.2 +++ b/doc/release_steps.txt	Mon Jun 15 15:42:32 2009 -0700
     4.3 @@ -6,12 +6,12 @@
     4.4     - revise and check in RELEASE_NOTES
     4.5     - DO NOT change VERSION at this time
     4.6     - confirm that Doxygen builds cleanly and without warnings
     4.7 -     (./waf check; ./waf --doxygen), and check in any necessary changes 
     4.8 +     (./waf --check; ./waf --doxygen), and check in any necessary changes 
     4.9     - ensure no regressions (./waf --regression)
    4.10  3. ./waf configure; ./waf dist
    4.11     - this will create an ns-3-dev.tar.bz2 tarball
    4.12     - this will also create a ns-3-dev-ref-traces.tar.bz2 tarball
    4.13 -4. test dev tarball on release platforms (waf check and maybe some other 
    4.14 +4. test dev tarball on release platforms (waf --check and maybe some other 
    4.15     scripts)
    4.16  5. once you are happy with the tarball, tag ns-3-dev and ns-3-dev-ref-traces
    4.17     - hg tag "ns-3.x"
     5.1 --- a/doc/tutorial/getting-started.texi	Mon Jun 15 15:22:33 2009 -0700
     5.2 +++ b/doc/tutorial/getting-started.texi	Mon Jun 15 15:42:32 2009 -0700
     5.3 @@ -456,10 +456,10 @@
     5.4  
     5.5  @cindex unit tests
     5.6  You can run the unit tests of the @command{ns-3} distribution by running the 
     5.7 -``check'' command,
     5.8 +``--check'' option,
     5.9  
    5.10  @verbatim
    5.11 -  ./waf check
    5.12 +  ./waf --check
    5.13  @end verbatim
    5.14  
    5.15  You should see a report from each unit test that executes indicating that the
     6.1 --- a/doc/tutorial/in-process/introduction.texi	Mon Jun 15 15:22:33 2009 -0700
     6.2 +++ b/doc/tutorial/in-process/introduction.texi	Mon Jun 15 15:42:32 2009 -0700
     6.3 @@ -562,7 +562,7 @@
     6.4  the ns-3 programs by simply typing,
     6.5  
     6.6  @verbatim
     6.7 -  ./waf check
     6.8 +  ./waf --check
     6.9  @end verbatim
    6.10  
    6.11  You will see many Waf status messages displayed as the system compiles.  The