From ad9f9b0931b14d686faa2a22f37973b35482a7db Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Fri, 22 Aug 2025 07:40:27 +0900 Subject: [PATCH] doc: Remove references to build.py --- doc/manual/source/enable-tests.rst | 31 +----------------- doc/tutorial/source/getting-started.rst | 42 ++++++++++--------------- 2 files changed, 17 insertions(+), 56 deletions(-) diff --git a/doc/manual/source/enable-tests.rst b/doc/manual/source/enable-tests.rst index 5dbb4a063..58187fff7 100644 --- a/doc/manual/source/enable-tests.rst +++ b/doc/manual/source/enable-tests.rst @@ -12,40 +12,11 @@ This chapter discusses how to build |ns3| with or without its examples and tests How to enable/disable examples and tests in |ns3| ************************************************* -There are 3 ways to enable/disable examples and tests in |ns3|: +There are 2 ways to enable/disable examples and tests in |ns3|: -#. Using build.py when |ns3| is built for the first time #. Using ns3 once |ns3| has been built #. Using the |ns3| configuration file once |ns3| has been built -Enable/disable examples and tests using build.py -++++++++++++++++++++++++++++++++++++++++++++++++ - -You can use build.py to enable/disable examples and tests when |ns3| is built for the first time. - -By default, examples and tests are not built in |ns3|. - -From the ns-3-allinone directory, you can build |ns3| without any -examples or tests simply by doing: :: - - $ ./build.py - -Running test.py in the top level |ns3| directory now will cause no examples or tests to be run: - -.. sourcecode:: text - - 0 of 0 tests passed (0 passed, 0 skipped, 0 failed, 0 crashed, 0 valgrind errors) - -If you would like build |ns3| with examples and tests, then do the following from the ns-3-allinone directory: :: - - $ ./build.py --enable-examples --enable-tests - -Running test.py in the top level |ns3| directory will cause all of the examples and tests to be run: - -.. sourcecode:: text - - 170 of 170 tests passed (170 passed, 0 skipped, 0 failed, 0 crashed, 0 valgrind errors) - Enable/disable examples and tests using ns3 +++++++++++++++++++++++++++++++++++++++++++ diff --git a/doc/tutorial/source/getting-started.rst b/doc/tutorial/source/getting-started.rst index 5cad8524d..18d1589b0 100644 --- a/doc/tutorial/source/getting-started.rst +++ b/doc/tutorial/source/getting-started.rst @@ -105,6 +105,20 @@ files are bundled together and the archive is usually compressed. The process for downloading |ns3| via tarball is simple; you just have to pick a release, download it and uncompress it. +We recommend downloading the most recent release (highest release +number). Prior to the ns-3.45 release, we offered one downloadable +source code archive, called ``ns-allinone-3.nn.tar.bz2`` (where ``nn`` +stands for the release number), which contained the network animator +NetAnim, the bake build tool and the ns-3 release. Starting with +ns-3.45, we offer two release archives: + +#. ``ns-3.45.tar.bz2``: Contains only ns-3 +#. ``ns-allinone-3.45.tar.bz2``: Contains ns-3 plus some compatible extension modules available in the `ns-3 App Store `_ + +We will focus on the first option above. The instructions for the second +one are basically the same, except that you will need to change into +the ``ns-3.nn`` directory after unpacking it. + Let's assume that you, as a user, wish to build |ns3| in a local directory called ``workspace``. If you adopt the ``workspace`` directory approach, you can @@ -116,8 +130,8 @@ 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.45.tar.bz2 - $ tar xjf ns-allinone-3.45.tar.bz2 + $ wget https://www.nsnam.org/release/ns-3.45.tar.bz2 + $ tar xjf ns-3.45.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, @@ -401,30 +415,6 @@ for an already configured project: $ ./ns3 show profile Build profile: debug -The build.py script discussed above supports also the ``--enable-examples`` -and ``enable-tests`` arguments and passes them through to the ns-3 -configuration, but in general, does not directly support -other ns3 options; for example, this will not work: - -.. sourcecode:: console - - $ ./build.py --enable-asserts - -will result in: - -.. sourcecode:: console - - build.py: error: no such option: --enable-asserts - -However, the special operator ``--`` can be used to pass additional -configure options through to ns3, so instead of the above, the following will work: - -.. sourcecode:: console - - $ ./build.py -- --enable-asserts - -as it generates the underlying command ``./ns3 configure --enable-asserts``. - Here are a few more introductory tips about CMake. Handling build errors