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

doc: Update Linux installation documentation

Browse Source
This commit is contained in:
Tom Henderson
2025-09-28 08:35:19 -07:00
parent 6f273a55af
commit 86132ec6c6
1 changed files with 22 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
doc/installation/source/linux.rst
View File

@@ -21,8 +21,10 @@ extensions you need; please review the previous chapter if you need more informa
Requirements
************
The minimum supported version of Ubuntu is Ubuntu 18.04 LTS (as long as a modern compiler
version such as g++ version 9 or later is added).
The minimum supported version of Ubuntu is Ubuntu 22.04 LTS. Older versions may also be
suitable as long as the C++ compiler version is relatively recent. As of the ns-3.46
release, g++ version 11 or later is required (or clang++ version 17 or later).
Older ns-3 releases may work with older versions of g++; check the RELEASE_NOTES.md file.
+--------------------+---------------------------------------------------------------------+
| **ns-3 Version** | **apt Packages** |
@@ -34,10 +36,6 @@ version such as g++ version 9 or later is added).
| 3.29 and earlier | ``g++ python2`` |
+--------------------+---------------------------------------------------------------------+
.. note::
As of July 2023 (ns-3.39 release and later), the minimum g++ version is g++-9.
Older ns-3 releases may work with older versions of g++; check the RELEASE_NOTES.
Recommended
***********
@@ -58,7 +56,18 @@ Recommended
installed using apt.
.. note::
clang-format-14 through clang-format-16 version is required.
Different versions of ns-3 use different versions of clang-format, resulting in
slightly different formatting decisions. The ``check-style-clang-format.py``
file enforces a minimum and maximum major version of clang-format with which the
current codebase is compatible. Since the ns-3.46 release, please consult the
``RELEASE_NOTES.md`` file for the currently supported versions.
For some additional information about installing and using clang-format, please see the
`ns-3 coding style section <https://www.nsnam.org/docs/contributing/html/coding-style.html#clang-format>`_
on clang-format.
.. note::
Different versions of ns-3 use different versions of clang-tidy. Since the ns-3.46
release, see the ``RELEASE_NOTES.md`` file for the currently supported versions.
Optional
********
@@ -104,9 +113,13 @@ Python bindings
===============
Python requires `Cppyy, <https://cppyy.readthedocs.io/en/latest/installation.html>` and specifically,
version 3.1.2 is the latest version known to work with ns-3 at this time.
version 3.5.0 is the latest version known to work with ns-3 at this time.
ns-3.42 and newer::
ns-3.45 and newer::
python3 -m pip install --user cppyy==3.5.0
ns-3.42-3.44::
python3 -m pip install --user cppyy==3.1.2