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

documentation: Update tutorial to ns-3.32

Browse Source
This commit is contained in:
Tom Henderson
2020-10-04 08:00:41 -07:00
parent 87b8455364
commit ad08b56bb1
1 changed files with 22 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -68,7 +68,7 @@ You may want to take this opportunity to explore the |ns3| wiki
a bit, or the main web site at https://www.nsnam.org, since there is a
wealth of information there.
As of the most recent |ns3| release (ns-3.31), the following tools
As of the most recent |ns3| release (ns-3.32), the following tools
are needed to get started with |ns3|:
============ ===========================================================
@@ -112,21 +112,21 @@ get a copy of a release by typing the following into your Linux shell
$ cd
$ mkdir workspace
$ cd workspace
$ wget https://www.nsnam.org/release/ns-allinone-3.31.tar.bz2
$ tar xjf ns-allinone-3.31.tar.bz2
$ wget https://www.nsnam.org/release/ns-allinone-3.32.tar.bz2
$ tar xjf ns-allinone-3.32.tar.bz2
Notice the use above of the ``wget`` utility, which is a command-line
tool to fetch objects from the web; if you do not have this installed,
you can use a browser for this step.
Following these steps, if you change into the directory
``ns-allinone-3.31``, you should see a number of files and directories
``ns-allinone-3.32``, you should see a number of files and directories
.. sourcecode:: text
$ cd ns-allinone-3.31
$ cd ns-allinone-3.32
$ ls
bake constants.py ns-3.31 README
bake constants.py ns-3.32 README
build.py netanim-3.108 pybindgen-0.21.0 util.py
You are now ready to build the base |ns3| distribution and may skip ahead
@@ -177,7 +177,7 @@ release number:
.. sourcecode:: bash
$ python3 download.py -n ns-3.31
$ python3 download.py -n ns-3.32
After this step, the additional repositories of |ns3|, bake, pybindgen,
and netanim will be downloaded to the ``ns-3-allinone`` directory.
@@ -246,10 +246,10 @@ distribution of your choice.
There are a few configuration targets available:
1. ``ns-3.31``: the module corresponding to the release; it will download
1. ``ns-3.32``: the module corresponding to the release; it will download
components similar to the release tarball.
2. ``ns-3-dev``: a similar module but using the development code tree
3. ``ns-allinone-3.31``: the module that includes other optional features
3. ``ns-allinone-3.32``: the module that includes other optional features
such as Click routing, Openflow for |ns3|, and the Network Simulation
Cradle
4. ``ns-3-allinone``: similar to the released version of the allinone
@@ -267,7 +267,7 @@ code either by inspection of the repository list or by going to the
`"ns-3 Releases"
<https://www.nsnam.org/releases>`_
web page and clicking on the latest release link. We'll proceed in
this tutorial example with ``ns-3.31``.
this tutorial example with ``ns-3.32``.
We are now going to use the bake tool to pull down the various pieces of
|ns3| you will be using. First, we'll say a word about running bake.
@@ -295,7 +295,7 @@ Step into the workspace directory and type the following into your shell:
.. sourcecode:: bash
$ ./bake.py configure -e ns-3.31
$ ./bake.py configure -e ns-3.32
Next, we'll ask bake to check whether we have enough tools to download
various components. Type:
@@ -345,7 +345,7 @@ should yield something like:
>> Searching for system dependency g++ - OK
>> Downloading pybindgen-0.21.0 (target directory:pybindgen) - OK
>> Downloading netanim-3.108 - OK
>> Downloading ns-3.31 - OK
>> Downloading ns-3.32 - OK
The above suggests that three sources have been downloaded. Check the
``source`` directory now and type ``ls``; one should see:
@@ -354,7 +354,7 @@ The above suggests that three sources have been downloaded. Check the
$ cd source
$ ls
netanim-3.108 ns-3.31 pybindgen
netanim-3.108 ns-3.32 pybindgen
You are now ready to build the |ns3| distribution.
@@ -385,7 +385,7 @@ native |ns3| build system, Waf, to be introduced later in this tutorial.
If you downloaded
using a tarball you should have a directory called something like
``ns-allinone-3.31`` under your ``~/workspace`` directory.
``ns-allinone-3.32`` under your ``~/workspace`` directory.
Type the following:
.. sourcecode:: bash
@@ -404,7 +404,7 @@ script builds the various pieces you downloaded. First, the script will
attempt to build the netanim animator, then the pybindgen bindings generator,
and finally |ns3|. Eventually you should see the following::
Waf: Leaving directory '/path/to/workspace/ns-allinone-3.31/ns-3.31/build'
Waf: Leaving directory '/path/to/workspace/ns-allinone-3.32/ns-3.32/build'
'build' finished successfully (6m25.032s)
Modules built:
@@ -426,7 +426,7 @@ and finally |ns3|. Eventually you should see the following::
Modules not built (see ns-3 tutorial for explanation):
brite click openflow
Leaving directory ./ns-3.31
Leaving directory ./ns-3.32
Regarding the portion about modules not built::
@@ -455,7 +455,7 @@ and you should see something like:
>> Building pybindgen-0.21.0 - OK
>> Building netanim-3.108 - OK
>> Building ns-3.31 - OK
>> Building ns-3.32 - OK
*Hint: you can also perform both steps, download and build, by calling ``bake.py deploy``.*
@@ -657,7 +657,7 @@ for an already configured project:
.. sourcecode:: bash
$ ./waf --check-profile
Waf: Entering directory \`/path/to/ns-3-allinone/ns-3.31/build\'
Waf: Entering directory \`/path/to/ns-3-allinone/ns-3.32/build\'
Build profile: debug
The build.py script discussed above supports also the ``--enable-examples``
@@ -772,7 +772,10 @@ The build profile controls the use of logging, assertions, and compiler optimiza
| | | | ``-march=native`` |
+----------+---------------------------------+-------------------------------+---------------------------------+
As you can see, logging and assertions are only available in debug builds.
As you can see, logging and assertions are only configured
by default in debug builds, although they can be selectively enabled
in other build profiles by using the ``--enable-logs`` and
``--enable-asserts`` flags during Waf configuration time.
Recommended practice is to develop your scenario in debug mode, then
conduct repetitive runs (for statistics or changing parameters) in
optimized build profile.