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

doc: clarify macos packages installation

Browse Source
This commit is contained in:
Tommaso Pecorella
2025-03-15 23:54:24 +01:00
parent a3ec4ecfbe
commit 916eecd59e
1 changed files with 27 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
doc/installation/source/macos.rst
View File

@@ -75,29 +75,40 @@ You will know you are done when you can successfully type `clang++ -v` at the co
Recommended
***********
+-----------------------------+------------------------+-----------------------------------+
| **Feature** | **Homebrew packages** | **MacPorts packages** |
+=============================+========================+===================================+
| Compiler cache optimization | ``ccache`` | ``ccache`` |
+-----------------------------+------------------------+-----------------------------------+
| Code linting | ``clang-format llvm`` | clang-format included with |
| | | ``clang``, need to select |
| | | ``clang-XX llvm-XX`` versions |
+-----------------------------+------------------------+-----------------------------------+
| Debugging | None | ``gdb ddd`` (ddd requires gdb) |
+-----------------------------+------------------------+-----------------------------------+
+-----------------------------+----------------------------+-----------------------------------+
| **Feature** | **Homebrew packages** | **MacPorts packages** |
+=============================+============================+===================================+
| Compiler cache optimization | ``ccache`` | ``ccache`` |
+-----------------------------+----------------------------+-----------------------------------+
| Code linting | clang-format included with | clang-format included with |
| | ``llvm``, need to select | ``clang``, need to select |
| | ``llvm@XX`` version | ``clang-XX llvm-XX`` versions |
+-----------------------------+----------------------------+-----------------------------------+
.. note::
The ``llvm`` Homebrew package provides ``clang-tidy``, but please note that the binary is
placed at ``/opt/homebrew/opt/llvm/bin/clang-tidy`` so you may need to add this path to your
``$PATH`` variable.
macOS development tools are based on clang, so installing llvm and clang using Homebrew or
MacPorts is typically unnecessary. However, ``clang-tidy`` might be missing, and the
``clang-format`` version might be not the expected one. In these cases it is suggested to
install the ``llvm`` package either though Homebrew or MacPorts.
.. note::
Homebrew provides a ``clang-format`` package, but its version might be incompatible with
the one used by |ns3|.
The ``llvm`` Homebrew package provides ``clang-tidy`` and ``clang-format``, but the binary
is placed at ``/opt/homebrew/opt/llvm@XX/bin/clang-tidy`` (where ``XX`` is the installed
version number such as ``18``), so you will need to add this path to your ``$PATH`` variable.
.. note::
Likewise, when using MacPorts, the ``clang-tidy`` and ``clang-format`` binaries will be
placed in ``/opt/local/libexec/llvm-XX/bin`` (where ``XX` is the installed version number
such as ``16``), so you will need to add this to your ``$PATH`` variable.
placed in ``/opt/local/libexec/llvm-XX/bin`` (where ``XX`` is the installed version number
such as ``18``), so you will need to add this to your ``$PATH`` variable.
.. note::
For debugging, ``lldb`` is the default debugger for llvm. Memory checkers such as
Memory Graph exist for macOS, but the ns-3 team doesn't have experience with it as a
substitution for ``valgrind`` (which is reported to not work on M1 Macs).