--- a/doc/tutorial/building-topologies.texi Fri Oct 09 20:50:17 2009 -0700
+++ b/doc/tutorial/building-topologies.texi Fri Oct 09 20:50:49 2009 -0700
@@ -43,10 +43,10 @@
this section. The appearance and operation of these helpers should look
quite familiar to you.
-We provide an example script in our @code{examples} directory. This script
+We provide an example script in our @code{examples/tutorial} directory. This script
builds on the @code{first.cc} script and adds a CSMA network to the
point-to-point simulation we've already considered. Go ahead and open
-@code{examples/second.cc} in your favorite editor. You will have already seen
+@code{examples/tutorial/second.cc} in your favorite editor. You will have already seen
enough @command{ns-3} code to understand most of what is going on in this
example, but we will go over the entire script and examine some of the output.
@@ -356,7 +356,7 @@
repository you just type,
@verbatim
- cp examples/second.cc scratch/mysecond.cc
+ cp examples/tutorial/second.cc scratch/mysecond.cc
./waf
@end verbatim
@@ -712,9 +712,9 @@
topology helpers in this section. The appearance and operation of these
helpers should look quite familiar to you.
-We provide an example script in our @code{examples} directory. This script
+We provide an example script in our @code{examples/tutorial} directory. This script
builds on the @code{second.cc} script and adds a Wifi network. Go ahead and
-open @code{examples/third.cc} in your favorite editor. You will have already
+open @code{examples/tutorial/third.cc} in your favorite editor. You will have already
seen enough @command{ns-3} code to understand most of what is going on in
this example, but there are a few new things, so we will go over the entire
script and examine some of the output.
--- a/doc/tutorial/conceptual-overview.texi Fri Oct 09 20:50:17 2009 -0700
+++ b/doc/tutorial/conceptual-overview.texi Fri Oct 09 20:50:49 2009 -0700
@@ -181,7 +181,7 @@
@end verbatim
@cindex first.cc
-Change into the examples directory. You should see a file named
+Change into the @code{examples/tutorial} directory. You should see a file named
@code{first.cc} located there. This is a script that will create a simple
point-to-point link between two nodes and echo a single packet between the
nodes. Let's take a look at that script line by line, so go ahead and open
@@ -277,7 +277,7 @@
@end verbatim
to build the project. So now if you look in the directory
-@code{../build/debug/ns3} you will find the four module include files shown
+@code{../../build/debug/ns3} you will find the four module include files shown
above. You can take a look at the contents of these files and find that they
do include all of the public include files in their respective modules.
@@ -732,12 +732,12 @@
@subsection Building Your Script
We have made it trivial to build your simple scripts. All you have to do is
to drop your script into the scratch directory and it will automatically be
-built if you run Waf. Let's try it. Copy @code{examples/first.cc} into
+built if you run Waf. Let's try it. Copy @code{examples/tutorial/first.cc} into
the @code{scratch} directory after changing back into the top level directory.
@verbatim
cd ..
- cp examples/first.cc scratch/myfirst.cc
+ cp examples/tutorial/first.cc scratch/myfirst.cc
@end verbatim
Now build your first example script using waf:
--- a/doc/tutorial/getting-started.texi Fri Oct 09 20:50:17 2009 -0700
+++ b/doc/tutorial/getting-started.texi Fri Oct 09 20:50:49 2009 -0700
@@ -405,6 +405,7 @@
Python Bindings : enabled
Python API Scanning Support : enabled
Use sudo to set suid bit : not enabled (option --enable-sudo not selected)
+ Build examples and samples : enabled
Static build : not enabled (option --enable-static not selected)
'configure' finished successfully (2.870s)
@end verbatim
@@ -462,51 +463,44 @@
@cindex unit tests
You can run the unit tests of the @command{ns-3} distribution by running the
-``--check'' option,
+``./test.py -c core'' script,
@verbatim
- ./waf --check
+ ./test.py -c core
@end verbatim
-These tests are run in parallel by waf, so the summary, ``Ran n tests'' will
-appear as soon as all of the tasks are launched, but you should eventually
+These tests are run in parallel by waf. You should eventually
see a report saying that,
@verbatim
- C++ UNIT TESTS: all 33 tests passed.
+ 47 of 47 tests passed (47 passed, 0 failed, 0 crashed, 0 valgrind errors)
@end verbatim
This is the important message.
-You will also see output from the test runner and waf task sequence numbers
-the output will actually look something like,
+You will also see output from the test runner and the output will actually look something like,
@verbatim
- Waf: Entering directory `/home/craigdo/repos/ns-3-allinone-3.5-tutorial/ns-3-dev/build'
- [707/709] get-unit-tests-list
- [708/709] run-python-unit-tests
- [709/709] print-introspected-doxygen
- [710/743] run-unit-test(AddressHelper)
- [711/743] run-unit-test(Wifi)
- ...........
- ----------------------------------------------------------------------
- Ran 11 tests in 0.003s
-
- OK
- [712/743] run-unit-test(DcfManager)
- [713/743] run-unit-test(MacRxMiddle)
- [714/743] run-unit-test(Ipv4ListRouting)
+ Waf: Entering directory `/home/craigdo/repos/ns-3-allinone/ns-3-dev/build'
+ Waf: Leaving directory `/home/craigdo/repos/ns-3-allinone/ns-3-dev/build'
+ 'build' finished successfully (1.799s)
+ PASS: TestSuite ns3-wifi-interference
+ PASS: TestSuite histogram
+ PASS: TestSuite sample
+ PASS: TestSuite ipv4-address-helper
+ PASS: TestSuite devices-wifi
+ PASS: TestSuite propagation-loss-model
...
- [739/743] run-unit-test(RandomVariable)
- [740/743] run-unit-test(Object)
- [741/743] run-unit-test(Ptr)
- [742/743] run-unit-test(Callback)
- [743/743] collect-unit-tests-results
- C++ UNIT TESTS: all 33 tests passed.
- Waf: Leaving directory `/home/craigdo/repos/ns-3-allinone-3.5-tutorial/ns-3-dev/build'
- 'build' finished successfully (1.799s)
+ PASS: TestSuite attributes
+ PASS: TestSuite config
+ PASS: TestSuite global-value
+ PASS: TestSuite command-line
+ PASS: TestSuite basic-random-number
+ PASS: TestSuite object
+ PASS: TestSuite random-number-generators
+ 47 of 47 tests passed (47 passed, 0 failed, 0 crashed, 0 valgrind errors)
@end verbatim
This command is typically run by @code{users} to quickly verify that an
@@ -519,7 +513,7 @@
your machine during the @code{./download.py} process above. (Warning: The
@code{ns-3.2} and @code{ns-3.3} releases do not use the @code{ns-3-allinone}
environment and require you to be online when you run regression tests because
-hey dynamically synchronize the reference traces directory with an online
+they dynamically synchronize the reference traces directory with an online
repository immediately prior to the run).
During regression testing Waf will run a number of tests that generate what we
@@ -547,7 +541,7 @@
passing.
@verbatim
- Entering directory `repos/ns-3-allinone/ns-3-dev/build'
+ Entering directory `/home/craigdo/repos/ns-3-allinone/ns-3-dev/build'
[647/669] regression-test (test-csma-bridge)
[648/669] regression-test (test-csma-broadcast)
[649/669] regression-test (test-csma-multicast)
@@ -558,7 +552,7 @@
...
Regression testing summary:
PASS: 22 of 22 tests passed
- Waf: Leaving directory `/home/craigdo/repos/ns-3-allinone-3.5-tutorial/ns-3-dev/build'
+ Waf: Leaving directory `/home/craigdo/repos/ns-3-allinone/ns-3-dev/build'
'build' finished successfully (25.826s)
@end verbatim