Attachment #466 for bug #593

View | Details | Raw Unified | Return to bug 593
Collapse All | Expand All

(-)a/doc/build.txt (-1 / +1 lines)

Lines 36-42	Link Here

Other waf usages include:

Other waf usages include:

 1. ./waf check

 1. ./waf --check

    Runs the unit tests

    Runs the unit tests

 2. ./waf --doxygen

 2. ./waf --doxygen

(-)a/doc/main.h (-2 / +2 lines)

Lines 27-34	Link Here

 * ns-3 requires Doxygen version 1.5.4 or greater to fully build all items,

 * ns-3 requires Doxygen version 1.5.4 or greater to fully build all items,

 * although earlier versions of Doxygen will mostly work.

 * although earlier versions of Doxygen will mostly work.

 * Type "./waf check" followed by "./waf --doxygen" to build the documentation.

 * Type "./waf --check" followed by "./waf --doxygen" to build the documentation.

 * There is a program that runs during "./waf check" that builds pieces of

 * There is a program that runs during "./waf --check" that builds pieces of

 * the documentation through introspection.  The doc/ directory contains

 * the documentation through introspection.  The doc/ directory contains

 * configuration for Doxygen (doxygen.conf and main.txt).  The Doxygen

 * configuration for Doxygen (doxygen.conf and main.txt).  The Doxygen

 * build process puts html files into the doc/html/ directory, and latex

 * build process puts html files into the doc/html/ directory, and latex

(-)a/doc/manual/new-models.texi (-1 / +1 lines)

Lines 205-211	Link Here

205

of adding the .cc file to the rest of the source files, and the .h

205

of adding the .cc file to the rest of the source files, and the .h

206

file to the list of the header files.

206

file to the list of the header files.

207

208

Now, pop up to the top level directory and type "./waf check".  You

208

Now, pop up to the top level directory and type "./waf --check".  You

209

shouldn't have broken anything by this operation.

209

shouldn't have broken anything by this operation.

210

@subsection include guards

210

@subsection include guards

211

Next, let's add some

211

Next, let's add some




   - 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 
   - 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 
   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 (-1 / +1 lines)

Lines 458-464	Link Here

458

``check'' command,

458

``check'' command,

459

460

@verbatim

460

@verbatim

461

  ./waf check

461

  ./waf --check

462

@end verbatim

462

@end verbatim

463

464

You should see a report from each unit test that executes indicating that the

464

You should see a report from each unit test that executes indicating that the

(-)a/doc/tutorial/in-process/introduction.texi (-1 / +1 lines)

Lines 562-568	Link Here

562

the ns-3 programs by simply typing,

562

the ns-3 programs by simply typing,

563

564

@verbatim

564

@verbatim

565

  ./waf check

565

  ./waf --check

566

@end verbatim

566

@end verbatim

567

568

You will see many Waf status messages displayed as the system compiles.  The

568

You will see many Waf status messages displayed as the system compiles.  The

(-)a/wscript (-1 / +1 lines)

Lines 761-767	Link Here

761

762

def doxygen():

762

def doxygen():

763

    if not os.path.exists('doc/introspected-doxygen.h'):

763

    if not os.path.exists('doc/introspected-doxygen.h'):

764

        Logs.warn("doc/introspected-doxygen.h does not exist; run waf check to generate it.")

764

        Logs.warn("doc/introspected-doxygen.h does not exist; run waf --check to generate it.")

765

766

    ## run doxygen

766

    ## run doxygen

767

    doxygen_config = os.path.join('doc', 'doxygen.conf')

767

    doxygen_config = os.path.join('doc', 'doxygen.conf')

Return to bug 593