F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Freshen the tutorial

Browse Source
This commit is contained in:
Tom Henderson
2011-12-23 12:00:12 -08:00
parent 2cff47cffc
commit b97001e014
4 changed files with 57 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
doc/tutorial/source/getting-started.rst
View File

@@ -53,7 +53,6 @@ that approach, you can get a copy of ``ns-3-allinone`` by typing the
following into your Linux shell (assuming you have installed Mercurial):
::
cd
mkdir repos
cd repos
@@ -69,11 +68,12 @@ following displayed,
adding changesets
adding manifests
adding file changes
added 31 changesets with 45 changes to 7 files
added 47 changesets with 67 changes to 7 files
updating to branch default
7 files updated, 0 files merged, 0 files removed, 0 files unresolved
After the clone command completes, you should have a directory called
``ns-3-allinone`` under your ``~/repos`` directory, the contents of which should
``ns-3-allinone``, the contents of which should
look something like the following:
::
@@ -221,7 +221,7 @@ As mentioned above, one practice is to create a directory called ``repos``
in one's home directory under which one can keep local Mercurial repositories.
One could also keep a ``tarballs`` directory. *Hint: the tutorial
will assume you downloaded into a ``repos`` directory, so remember the
placekeeper.``* If you adopt the ``tarballs`` directory approach, you can
placekeeper.* If you adopt the ``tarballs`` directory approach, you can
get a copy of a release by typing the following into your Linux shell
(substitute the appropriate version numbers, of course):
@@ -230,15 +230,15 @@ get a copy of a release by typing the following into your Linux shell
cd
mkdir tarballs
cd tarballs
wget http://www.nsnam.org/releases/ns-allinone-3.10.tar.bz2
tar xjf ns-allinone-3.10.tar.bz2
wget http://www.nsnam.org/releases/ns-allinone-3.13.tar.bz2
tar xjf ns-allinone-3.13.tar.bz2
If you change into the directory ``ns-allinone-3.10`` you should see a
If you change into the directory ``ns-allinone-3.13`` you should see a
number of files:
::
build.py ns-3.10/ pybindgen-0.15.0/ util.py
build.py ns-3.13/ pybindgen-0.15.0.795/ util.py
constants.py nsc-0.5.2/ README
You are now ready to build the |ns3| distribution.
@@ -256,7 +256,7 @@ Change into the directory you created in the download section above. If you
downloaded using Mercurial you should have a directory called
``ns-3-allinone`` under your ``~/repos`` directory. If you downloaded
using a tarball you should have a directory called something like
``ns-allinone-3.10`` under your ``~/tarballs`` directory. Take a deep
``ns-allinone-3.13`` under your ``~/tarballs`` directory. Take a deep
breath and type the following:
::
@@ -274,7 +274,7 @@ following magic words:
::
Waf: Leaving directory `/home/craigdo/repos/ns-3-allinone/ns-3-dev/build'
Waf: Leaving directory `/home/craigdo/repos/ns-3-allinone/ns-3.13/build'
'build' finished successfully (2m30.586s)
Modules built:
@@ -292,12 +292,12 @@ following magic words:
topology-read uan virtual-net-device
visualizer wifi wimax
Once the project has built you can say goodbye to your old friends, the
Once the project has built, you can stop working with the
``ns-3-allinone`` scripts. You got what you needed from them and will now
interact directly with Waf and we do it in the ``ns-3-dev`` directory,
interact directly with Waf and we do it in the |ns3| directory,
not in the ``ns-3-allinone`` directory. Go ahead and change into the
``ns-3-dev`` directory (or the directory for the appropriate release you
downloaded.
|ns3| directory (or the directory for the appropriate release or
development snapshot that you downloaded; e.g.
::
@@ -399,7 +399,7 @@ Now go ahead and switch back to the debug build that includes the examples and t
./waf -d debug --enable-examples --enable-tests configure
The build system is now configured and you can build the debug versions of
the |ns3| programs by simply typing,
the |ns3| programs by simply typing
::
@@ -443,7 +443,7 @@ see a report saying that,
::
47 of 47 tests passed (47 passed, 0 failed, 0 crashed, 0 valgrind errors)
92 of 92 tests passed (92 passed, 0 failed, 0 crashed, 0 valgrind errors)
This is the important message.
@@ -486,9 +486,9 @@ You will also see output from the test runner and the output will actually look
PASS: TestSuite basic-random-number
PASS: TestSuite object
PASS: TestSuite random-number-generators
95 of 95 tests passed (95 passed, 0 failed, 0 crashed, 0 valgrind errors)
92 of 92 tests passed (92 passed, 0 failed, 0 crashed, 0 valgrind errors)
This command is typically run by ``users`` to quickly verify that an
This command is typically run by users to quickly verify that an
|ns3| distribution has built correctly.
Running a Script