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

doc: Update ns-3 version in tutorial examples

Browse Source
This commit is contained in:
Tom Henderson
2021-03-23 21:14:33 -07:00
parent 80e0dd0482
commit 380c8548a0
1 changed files with 43 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
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.32), the following tools
As of the most recent |ns3| release (ns-3.33), the following tools
are needed to get started with |ns3|:
============ ===========================================================
@@ -124,22 +124,22 @@ 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.32.tar.bz2
$ tar xjf ns-allinone-3.32.tar.bz2
$ wget https://www.nsnam.org/release/ns-allinone-3.33.tar.bz2
$ tar xjf ns-allinone-3.33.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.32``, you should see a number of files and directories
``ns-allinone-3.33``, you should see a number of files and directories
.. sourcecode:: text
$ cd ns-allinone-3.32
$ cd ns-allinone-3.33
$ ls
bake constants.py ns-3.32 README
build.py netanim-3.108 pybindgen-0.21.0 util.py
bake constants.py ns-3.33 README
build.py netanim-3.108 pybindgen-0.21.0.post15+nga587377 util.py
You are now ready to build the base |ns3| distribution and may skip ahead
to the section on building |ns3|.
@@ -189,7 +189,7 @@ release number:
.. sourcecode:: bash
$ python3 download.py -n ns-3.32
$ python3 download.py -n ns-3.33
After this step, the additional repositories of |ns3|, bake, pybindgen,
and netanim will be downloaded to the ``ns-3-allinone`` directory.
@@ -258,10 +258,10 @@ distribution of your choice.
There are a few configuration targets available:
1. ``ns-3.32``: the module corresponding to the release; it will download
1. ``ns-3.33``: 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.32``: the module that includes other optional features
3. ``ns-allinone-3.33``: 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
@@ -279,7 +279,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.32``.
this tutorial example with ``ns-3.33``.
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.
@@ -307,7 +307,7 @@ Step into the workspace directory and type the following into your shell:
.. sourcecode:: bash
$ ./bake.py configure -e ns-3.32
$ ./bake.py configure -e ns-3.33
Next, we'll ask bake to check whether we have enough tools to download
various components. Type:
@@ -355,18 +355,26 @@ should yield something like:
>> Searching for system dependency python-dev - OK
>> Searching for system dependency qt - OK
>> Searching for system dependency g++ - OK
>> Downloading pybindgen-0.21.0 (target directory:pybindgen) - OK
>> Searching for system dependency cxxfilt - OK
>> Searching for system dependency setuptools - OK
>> Searching for system dependency gi-cairo - OK
>> Searching for system dependency gir-bindings - OK
>> Searching for system dependency pygobject - OK
>> Searching for system dependency cmake - OK
>> Downloading castxml-0.3.6 (target directory:castxml-0.3.6) - OK
>> Downloading netanim-3.108 - OK
>> Downloading ns-3.32 - OK
>> Downloading pygccxml-2.0.1 - OK
>> Downloading pybindgen-0.21.0.post15+nga587377 (target directory:pybindgen) - OK
>> Downloading ns-3.33 (target directory:ns-3.33) - OK
The above suggests that three sources have been downloaded. Check the
The above suggests that five sources have been downloaded. Check the
``source`` directory now and type ``ls``; one should see:
.. sourcecode:: bash
$ cd source
$ ls
netanim-3.108 ns-3.32 pybindgen
castxml-0.3.6 netanim-3.108 ns-3.33 pybindgen pygccxml-2.0.1 v2.0.1.tar.gz
You are now ready to build the |ns3| distribution.
@@ -397,7 +405,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.32`` under your ``~/workspace`` directory.
``ns-allinone-3.33`` under your ``~/workspace`` directory.
Type the following:
.. sourcecode:: bash
@@ -416,7 +424,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.32/ns-3.32/build'
Waf: Leaving directory '/path/to/workspace/ns-allinone-3.33/ns-3.33/build'
'build' finished successfully (6m25.032s)
Modules built:
@@ -438,7 +446,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.32
Leaving directory ./ns-3.33
Regarding the portion about modules not built::
@@ -465,11 +473,9 @@ and you should see something like:
.. sourcecode:: text
>> Building pybindgen-0.21.0 - OK
>> Building pybindgen-0.21.0.post15+nga587377 - OK
>> Building netanim-3.108 - OK
>> Building ns-3.32 - OK
*Hint: you can also perform both steps, download and build, by calling ``bake.py deploy``.*
>> Building ns-3.33 - OK
There may be failures to build all components, but the build will proceed
anyway if the component is optional. For example, a recent portability issue
@@ -669,7 +675,7 @@ for an already configured project:
.. sourcecode:: bash
$ ./waf --check-profile
Waf: Entering directory \`/path/to/ns-3-allinone/ns-3.32/build\'
Waf: Entering directory \`/path/to/ns-3-allinone/ns-3.33/build\'
Build profile: debug
The build.py script discussed above supports also the ``--enable-examples``
@@ -1203,7 +1209,7 @@ to the output below.
.. sourcecode:: text
ns-3.31+26@g82e7f5d-debug
ns-3.33+249@g80e0dd0-dirty-debug
If ``--check-version`` is run when ``-enable-build-version`` was not configured,
an error message indicating that the option is disabled will be displayed instead.
@@ -1268,20 +1274,20 @@ the core module when the ``--enable-build-version`` option is configured.
.. sourcecode:: text
build-version-example:
Program Version (according to CommandLine): ns-3.31+28@gce1eb40-dirty-debug
Program Version (according to CommandLine): ns-3.33+249@g80e0dd0-dirty-debug
Version fields:
LongVersion: ns-3.32+28@gcefeb91-dirty-debug
ShortVersion: ns-3.32+*
BuildSummary: ns-3.32+*
VersionTag: ns-3.32
LongVersion: ns-3.33+249@g80e0dd0-dirty-debug
ShortVersion: ns-3.33+*
BuildSummary: ns-3.33+*
VersionTag: ns-3.33
Major: 3
Minor: 32
Minor: 33
Patch: 0
ReleaseCandidate:
ClosestAncestorTag: ns-3.32
TagDistance: 28
CommitHash: gce1eb40
ReleaseCandidate:
ClosestAncestorTag: ns-3.33
TagDistance: 249
CommitHash: g80e0dd0
BuildProfile: debug
WorkingTree: dirty
@@ -1292,7 +1298,7 @@ option which will print the full build version and exit.
./waf --run-no-build "command-line-example --version"
Waf: Entering directory `/g/g14/mdb/gitlab/mdb/ns-3-dev/build/debug'
ns-3.31+28@gce1eb40-dirty-debug
ns-3.33+249@g80e0dd0-dirty-debug
If the ``--enable-build-version`` option was not configured, ``--version``
will print out a message similar to ``--check-version`` indicating that the build