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

check-style: Fix documentation and add usage example for modified files

Browse Source
This commit is contained in:
Eduardo Almeida
2023-10-03 15:27:43 +01:00
parent 7ea7504476
commit 738729e0ab
2 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -114,8 +114,8 @@ check-style-clang-format.py
To facilitate checking and fixing source code files according to the |ns3| coding style,
|ns3| maintains the ``check-style-clang-format.py`` Python script (located in ``utils/``).
This script is a wrapper to clang-format and provides useful options to check and fix
source code files. Additionally, it checks and fixes trailing whitespace and tabs in text
files.
source code files. Additionally, it performs other manual checks and fixes in text files
(described below).
We recommend running this script over your newly introduced C++ files prior to submission
as a Merge Request.
@@ -160,6 +160,9 @@ For quick-reference, the most used commands are listed below:
# Specific directory or file
/path/to/utils/check-style-clang-format.py --fix absolute_or_relative/path/to/directory_or_file
# Modified files
git diff --name-only | xargs ./utils/check-style-clang-format.py --fix
Clang-tidy
**********