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

documentation: Update tutorial references to 3.31 release

Browse Source
This commit is contained in:
Tom Henderson
2020-06-18 20:47:13 -07:00
parent 4d411daa1f
commit 270b2cfe3e
1 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -68,14 +68,14 @@ 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.30), the following tools
As of the most recent |ns3| release (ns-3.31), the following tools
are needed to get started with |ns3|:
============ ===========================================================
Prerequisite Package/version
============ ===========================================================
C++ compiler ``clang++`` or ``g++`` (g++ version 4.9 or greater)
Python ``python2`` version >= 2.7.10 and ``python3`` version >=3.4
Python ``python3`` version >=3.5
Git any recent version (to access |ns3| from `GitLab.com <https://gitlab.com/nsnam/ns-3-dev/>`_)
tar any recent version (to unpack an `ns-3 release <https://www.nsnam.org/releases/>`_)
bunzip2 any recent version (to uncompress an |ns3| release)
@@ -112,22 +112,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.30.tar.bz2
$ tar xjf ns-allinone-3.30.tar.bz2
$ wget https://www.nsnam.org/release/ns-allinone-3.31.tar.bz2
$ tar xjf ns-allinone-3.31.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.30``, you should see a number of files and directories
``ns-allinone-3.31``, you should see a number of files and directories
.. sourcecode:: text
$ cd ns-allinone-3.30
$ cd ns-allinone-3.31
$ ls
bake constants.py ns-3.30 README
build.py netanim-3.108 pybindgen-0.20.0 util.py
bake constants.py ns-3.31 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
to the section on building |ns3|.
@@ -170,14 +170,14 @@ either download the most recent development snapshot of |ns3|:
.. sourcecode:: bash
$ python download.py
$ python3 download.py
or to specify a release of |ns3|, using the ``-n`` flag to specify a
release number:
.. sourcecode:: bash
$ python download.py -n ns-3.30
$ python3 download.py -n ns-3.31
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.30``: the module corresponding to the release; it will download
1. ``ns-3.31``: 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.30``: the module that includes other optional features
3. ``ns-allinone-3.31``: 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.30``.
this tutorial example with ``ns-3.31``.
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.30
$ ./bake.py configure -e ns-3.31
Next, we'll ask bake to check whether we have enough tools to download
various components. Type:
@@ -343,9 +343,9 @@ 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.20.0 (target directory:pybindgen) - OK
>> Downloading pybindgen-0.21.0 (target directory:pybindgen) - OK
>> Downloading netanim-3.108 - OK
>> Downloading ns-3.30 - OK
>> Downloading ns-3.31 - 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.30 pybindgen
netanim-3.108 ns-3.31 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.30`` under your ``~/workspace`` directory.
``ns-allinone-3.31`` 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.30/ns-3.30/build'
Waf: Leaving directory '/path/to/workspace/ns-allinone-3.31/ns-3.31/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.30
Leaving directory ./ns-3.31
Regarding the portion about modules not built::
@@ -453,9 +453,9 @@ and you should see something like:
.. sourcecode:: text
>> Building pybindgen-0.20.0 - OK
>> Building pybindgen-0.21.0 - OK
>> Building netanim-3.108 - OK
>> Building ns-3.30 - OK
>> Building ns-3.31 - OK
*Hint: you can also perform both steps, download and build, by calling ``bake.py deploy``.*
@@ -541,8 +541,8 @@ output that looks similar to the following::
Checking for compilation flag -fvisibility=hidden support : ok
Checking for compilation flag -Wno-array-bounds support : ok
Checking for pybindgen location : ../pybindgen (guessed)
Checking for python module 'pybindgen' : 0.20.0
Checking for pybindgen version : 0.20.0
Checking for python module 'pybindgen' : 0.21.0
Checking for pybindgen version : 0.21.0
Checking for code snippet : yes
Checking for types uint64_t and unsigned long equivalence : no
Checking for code snippet : no
@@ -657,7 +657,7 @@ for an already configured project:
.. sourcecode:: bash
$ ./waf --check-profile
Waf: Entering directory \`/path/to/ns-3-allinone/ns-3.30/build\'
Waf: Entering directory \`/path/to/ns-3-allinone/ns-3.31/build\'
Build profile: debug
The build.py script discussed above supports also the ``--enable-examples``