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

doc: Update coding style documentation to the new ns-3 style

Browse Source
This commit is contained in:
Eduardo Almeida
2022-09-15 01:33:10 +01:00
parent b284ccb9c8
commit 7279f9c135
2 changed files with 637 additions and 283 deletions
Download Patch File Download Diff File Expand all files Collapse all files

905
doc/contributing/source/coding-style.rst
View File

File diff suppressed because it is too large Load Diff

15
doc/contributing/source/general.rst
View File

@@ -191,15 +191,14 @@ Coding style
We ask that all contributors make their code conform to the
coding standard which is outlined in :ref:`Coding style`.
The project maintains a Python program called ``check-style.py`` found in
the ``utils/`` directory. This is a wrapper around the ``uncrustify``
utility with configuration set to the conventions used by |ns3|, and
can be used to quickly format new source code files proposed for the
mainline.
The project maintains a Python program called ``check-style-clang-format.py`` found in
the ``utils/`` directory. This is a wrapper around the ``clang-format``
utility and can be used to quickly format new source code files proposed for the
mainline. The |ns3| coding style conventions are defined in the corresponding
``.clang-format`` file.
Additionally, the project also maintains a Python program called
``trim_trailing_whitespace.py``, found in the ``utils/`` directory.
This program checks and trims trailing whitespace in text files, in order to
In addition to formatting source code files with ``clang-format``, the Python program
also checks trailing whitespace in text files and converts tabs to spaces, in order to
comply with the |ns3| coding style.
Creating a patch