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

doc: Update ns-3 version in tutorial and installation references

Browse Source
This commit is contained in:
Tom Henderson
2023-03-13 08:55:01 -07:00
parent 3934e2d306
commit 9e4ee888e1
3 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -70,13 +70,13 @@ 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.37), the following tools
As of the most recent |ns3| release (ns-3.38), the following tools
are needed to get started with |ns3|:
============ ===========================================================
Prerequisite Package/version
============ ===========================================================
C++ compiler ``clang++`` or ``g++`` (g++ version 8 or greater)
C++ compiler ``clang++`` or ``g++`` (g++ version 9 or greater)
Python ``python3`` version >=3.6
CMake ``cmake`` version >=3.10
Build system ``make``, ``ninja``, ``xcodebuild`` (XCode)
@@ -124,21 +124,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.37.tar.bz2
$ tar xjf ns-allinone-3.37.tar.bz2
$ wget https://www.nsnam.org/release/ns-allinone-3.38.tar.bz2
$ tar xjf ns-allinone-3.38.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.37``, you should see a number of files and directories
``ns-allinone-3.38``, you should see a number of files and directories
.. sourcecode:: text
$ cd ns-allinone-3.37
$ cd ns-allinone-3.38
$ ls
bake build.py constants.py netanim-3.108 ns-3.37 README.md util.py
bake build.py constants.py netanim-3.109 ns-3.38 README.md util.py
You are now ready to build the base |ns3| distribution and may skip ahead
to the section on building |ns3|.
@@ -188,7 +188,7 @@ release number:
.. sourcecode:: console
$ python3 download.py -n ns-3.37
$ python3 download.py -n ns-3.38
After this step, the additional repositories of |ns3|, bake, pybindgen,
and netanim will be downloaded to the ``ns-3-allinone`` directory.
@@ -257,9 +257,9 @@ distribution of your choice.
There are a few configuration targets available:
1. ``ns-3.37``: the code corresponding to the release
1. ``ns-3.38``: the code corresponding to the release
2. ``ns-3-dev``: a similar module but using the development code tree
3. ``ns-allinone-3.37``: the module that includes other optional features
3. ``ns-allinone-3.38``: the module that includes other optional features
such as bake build system, netanim animator, and pybindgen
4. ``ns-3-allinone``: similar to the released version of the allinone
module, but for development code.
@@ -276,7 +276,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.37``.
this tutorial example with ``ns-3.38``.
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.
@@ -305,7 +305,7 @@ Step into the workspace directory and type the following into your shell:
.. sourcecode:: console
$ ./bake.py configure -e ns-allinone-3.37
$ ./bake.py configure -e ns-allinone-3.38
Next, we'll ask bake to check whether we have enough tools to download
various components. Type:
@@ -351,11 +351,11 @@ should yield something like:
>> Searching for system dependency qt - OK
>> Searching for system dependency g++ - OK
>> Searching for system dependency cmake - OK
>> Downloading netanim-3.108 - OK
>> Downloading click-ns-3.37 - OK
>> Downloading netanim-3.109 - OK
>> Downloading click-ns-3.38 - OK
>> Downloading BRITE - OK
>> Downloading openflow-dev - OK
>> Downloading ns-3.37 (target directory:ns-3.37) - OK
>> Downloading ns-3.38 (target directory:ns-3.38) - OK
The above suggests that three sources have been downloaded. Check the
``source`` directory now and type ``ls``; one should see:
@@ -364,7 +364,7 @@ The above suggests that three sources have been downloaded. Check the
$ cd source
$ ls
BRITE click-ns-3.37 netanim-3.108 ns-3.37 openflow-dev
BRITE click-ns-3.37 netanim-3.109 ns-3.38 openflow-dev
You are now ready to build the |ns3| distribution.
@@ -394,7 +394,7 @@ native |ns3| build system, CMake, to be introduced later in this tutorial.
If you downloaded
using a tarball you should have a directory called something like
``ns-allinone-3.37`` under your ``~/workspace`` directory.
``ns-allinone-3.38`` under your ``~/workspace`` directory.
Type the following:
.. sourcecode:: console
@@ -426,8 +426,8 @@ and you should see something like:
.. sourcecode:: text
>> Building netanim-3.108 - OK
>> Building ns-3.37 - OK
>> Building netanim-3.109 - OK
>> Building ns-3.38 - OK
There may be failures to build all components, but the build will proceed
anyway if the component is optional.

8
doc/tutorial/source/quick-start.rst
View File

@@ -64,13 +64,13 @@ Downloading the Latest Release
::
$ tar xjf ns-allinone-3.37.tar.bz2
$ tar xjf ns-allinone-3.38.tar.bz2
3) Change into the |ns3| directory directly; e.g.
::
$ cd ns-allinone-3.37/ns-3.37
$ cd ns-allinone-3.38/ns-3.38
The ns-allinone directory has some additional components but we are skipping
over them here; one can work directly from the |ns3| source code directory.
@@ -92,12 +92,12 @@ only to `cd` into ns-3-dev; the `master` branch is checked out by default.
$ cd ns-3-dev
If instead you want to try the most recent release (version 3.37 as of this
If instead you want to try the most recent release (version 3.38 as of this
writing), you can checkout a branch corresponding to that git tag:
::
$ git checkout -b ns-3.37-branch ns-3.37
$ git checkout -b ns-3.38-branch ns-3.38
Building and testing ns-3
*************************