--- a/BUILD Thu Sep 07 12:35:06 2006 +0200
+++ b/BUILD Fri Sep 08 09:16:52 2006 +0200
@@ -9,55 +9,48 @@
in the directory 'build-dir/dbg-shared/bin' and
'build-dir/dbg-shared/lib'.
+All builds are built with debugging symbols. Debugging
+builds enable asserts while optimized builds disable them.
+
1) Options
----------
-- verbose: if you have install scons 0.91.96, the default
- build output is terse. To get a more verbose output, you
- need to set the 'verbose' variable to 'y'.
-
-Example:
-scons verbose=y
+- verbose: if you have installed scons 0.91.96 or higher,
+ the default build output is terse. To get a more verbose
+ output, you need to set the 'verbose' variable to 'y'.
+Example: scons verbose=y
2) Targets
----------
- doc: build the doxygen documentation.
-Example:
-scons doc
+Example: scons doc
- dbg-shared: a debug build using shared libraries.
The files are built in 'build-dir/dbg-shared/'.
-Example:
-scons dbg-shared
+Example: scons dbg-shared
- dbg-static: a debug build using static libraries
The files are built in 'build-dir/dbg-static/'.
-Example:
-scons dbg-static
+Example: scons dbg-static
- opt-shared: an optimized build using shared libraries.
The files are built in 'build-dir/opt-shared/'.
-Example:
-scons opt-shared
+Example: scons opt-shared
- opt-static: an optimized build using static libraries.
The files are built in 'build-dir/opt-static/'.
-Example:
-scons opt-static
+Example: scons opt-static
- dbg: an alias for dbg-shared
-Example:
-scons dbg
+Example: scons dbg
- opt: an alias for opt-shared
-Example:
-scons opt
+Example: scons opt
- all: alias for dbg-shared, dbg-static, opt-shared
and opt-static
-Example:
-scons all
+Example: scons all
- dist: generate a release tarball and zipfile from the
source tree. The tarball and zipfile name are generated
@@ -67,13 +60,11 @@
ns3 = Ns3 ()
ns3.name = 'foo'
ns3.version = '0.0.10'
-Example command:
-scons dist
-Example output:
+Example command: scons dist
+Example output files:
foo-0.0.10.tar.gz
foo-0.0.10.zip
- distcheck: generate a release tarball and zipfile and
attempt to run the 'all' target for the release tarball.
-Example:
-scons distcheck
+Example: scons distcheck