doc/build-waf.txt
changeset 657 be551a3b07c6
parent 635 71b92dfe5f55
child 672 184d5a505279
     1.1 --- a/doc/build-waf.txt	Thu May 17 11:32:22 2007 +0200
     1.2 +++ b/doc/build-waf.txt	Fri May 18 10:27:42 2007 -0700
     1.3 @@ -1,12 +1,17 @@
     1.4 -WAF is an alternative build system, similar to SCons.  NS-3 now is
     1.5 -able to build with WAF, in parallel to SCons.
     1.6 +The main ns-3 build system is SCons.  Read the file build.txt
     1.7 +for SCons instructions.
     1.8  
     1.9 -Note: the WAF build scripts are experimental at this stage.
    1.10 +Waf is an alternative build system, similar to SCons.  ns-3 now is
    1.11 +able to build with Waf, in parallel to SCons.
    1.12  
    1.13 +(http://www.freehackers.org/~tnagy/waf.html)
    1.14  
    1.15 -=== Building with WAF ===
    1.16 +Note: the Waf build scripts are experimental at this stage.
    1.17 +Gustavo Carneiro (gjcarneiro@gmail.com) is the maintainer.
    1.18  
    1.19 -To build NS-3 with waf type the commands:
    1.20 +=== Building with Waf ===
    1.21 +
    1.22 +To build ns-3 with waf type the commands:
    1.23   1. ./waf configure [options]
    1.24   2. ./waf
    1.25  
    1.26 @@ -30,7 +35,7 @@
    1.27      Run code coverage analysis (assuming the project was configured
    1.28  with --enable-gcov)
    1.29  
    1.30 -=== Extending NS-3 ===
    1.31 +=== Extending ns-3 ===
    1.32  
    1.33  To add new modules:
    1.34    1. Create the module directory under src (or src/devices, or whatever);
    1.35 @@ -38,7 +43,7 @@
    1.36    3. Add a 'wscript' describing it;
    1.37    4. Add the module subdirectory name to the all_modules list in src/wscript.
    1.38  
    1.39 -A module's wscript file is basically a regular WAF script.  A NS-3
    1.40 +A module's wscript file is basically a regular Waf script.  A ns-3
    1.41  module is created as a cpp/shlib object, like this:
    1.42  
    1.43  def build(bld):
    1.44 @@ -65,7 +70,7 @@
    1.45  
    1.46  === Note for developers ===
    1.47  
    1.48 -The NS-3 code repository does not contain the waf script.  Instead,
    1.49 +The ns-3 code repository does not contain the waf script.  Instead,
    1.50  developers should check it out from a subversion repository:
    1.51  
    1.52    svn checkout http://waf.googlecode.com/svn/tags/ns3/ waf
    1.53 @@ -77,8 +82,8 @@
    1.54  Then it can be installed system-wide with 'sudo ./waf-light install'.
    1.55  When preparing a distribution, the resulting 'waf' script, which is
    1.56  self contained (no external files needed), can be easily included in
    1.57 -the tarball so that users downloading NS-3 can easily build it without
    1.58 -having WAF installed (although Python >= 2.3 is still needed).
    1.59 +the tarball so that users downloading ns-3 can easily build it without
    1.60 +having Waf installed (although Python >= 2.3 is still needed).
    1.61  
    1.62  The command 'waf dist' can be used to create a distribution tarball.
    1.63  It includes all files in the source directory, except some particular