update dox for waf --check
authorCraig Dowell <craigdo@ee.washington.edu>
Mon, 15 Jun 2009 15:42:32 -0700
changeset 4534 2680abc768f2
parent 4533 f4d74e20ad78
child 4535 0878cd580565
child 5074 355de6af8ea9
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
--- a/doc/build.txt	Mon Jun 15 15:22:33 2009 -0700
+++ b/doc/build.txt	Mon Jun 15 15:42:32 2009 -0700
@@ -36,7 +36,7 @@
 
 Other waf usages include:
 
- 1. ./waf check
+ 1. ./waf --check
     Runs the unit tests
 
  2. ./waf --doxygen
--- a/doc/main.h	Mon Jun 15 15:22:33 2009 -0700
+++ b/doc/main.h	Mon Jun 15 15:42:32 2009 -0700
@@ -27,8 +27,8 @@
  * ns-3 requires Doxygen version 1.5.4 or greater to fully build all items,
  * although earlier versions of Doxygen will mostly work.
  * 
- * Type "./waf check" followed by "./waf --doxygen" to build the documentation.
- * There is a program that runs during "./waf check" that builds pieces of
+ * Type "./waf --check" followed by "./waf --doxygen" to build the documentation.
+ * There is a program that runs during "./waf --check" that builds pieces of
  * the documentation through introspection.  The doc/ directory contains
  * configuration for Doxygen (doxygen.conf and main.txt).  The Doxygen 
  * build process puts html files into the doc/html/ directory, and latex 
--- a/doc/manual/new-models.texi	Mon Jun 15 15:22:33 2009 -0700
+++ b/doc/manual/new-models.texi	Mon Jun 15 15:42:32 2009 -0700
@@ -205,7 +205,7 @@
 of adding the .cc file to the rest of the source files, and the .h
 file to the list of the header files. 
 
-Now, pop up to the top level directory and type "./waf check".  You
+Now, pop up to the top level directory and type "./waf --check".  You
 shouldn't have broken anything by this operation.
 @subsection include guards
 Next, let's add some 
--- a/doc/release_steps.txt	Mon Jun 15 15:22:33 2009 -0700
+++ b/doc/release_steps.txt	Mon Jun 15 15:42:32 2009 -0700
@@ -6,12 +6,12 @@
    - revise and check in RELEASE_NOTES
    - DO NOT change VERSION at this time
    - confirm that Doxygen builds cleanly and without warnings
-     (./waf check; ./waf --doxygen), and check in any necessary changes 
+     (./waf --check; ./waf --doxygen), and check in any necessary changes 
    - ensure no regressions (./waf --regression)
 3. ./waf configure; ./waf dist
    - this will create an ns-3-dev.tar.bz2 tarball
    - this will also create a ns-3-dev-ref-traces.tar.bz2 tarball
-4. test dev tarball on release platforms (waf check and maybe some other 
+4. test dev tarball on release platforms (waf --check and maybe some other 
    scripts)
 5. once you are happy with the tarball, tag ns-3-dev and ns-3-dev-ref-traces
    - hg tag "ns-3.x"
--- a/doc/tutorial/getting-started.texi	Mon Jun 15 15:22:33 2009 -0700
+++ b/doc/tutorial/getting-started.texi	Mon Jun 15 15:42:32 2009 -0700
@@ -456,10 +456,10 @@
 
 @cindex unit tests
 You can run the unit tests of the @command{ns-3} distribution by running the 
-``check'' command,
+``--check'' option,
 
 @verbatim
-  ./waf check
+  ./waf --check
 @end verbatim
 
 You should see a report from each unit test that executes indicating that the
--- a/doc/tutorial/in-process/introduction.texi	Mon Jun 15 15:22:33 2009 -0700
+++ b/doc/tutorial/in-process/introduction.texi	Mon Jun 15 15:42:32 2009 -0700
@@ -562,7 +562,7 @@
 the ns-3 programs by simply typing,
 
 @verbatim
-  ./waf check
+  ./waf --check
 @end verbatim
 
 You will see many Waf status messages displayed as the system compiles.  The