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

doc: Simplify check-style-clang-format.py usage commands

Browse Source 
Remove optional flags to avoid errors from users copy-pasting the commands verbatim.
This commit is contained in:
Eduardo Almeida
2023-09-06 23:07:35 +01:00
parent e836db7d96
commit ff954319a0
1 changed files with 4 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -151,17 +151,13 @@ For quick-reference, the most used commands are listed below:
.. sourcecode:: console
# Entire codebase (using paths relative to the ns-3 main directory)
./utils/check-style-clang-format.py [--fix] [--verbose] [--no-formatting] [--no-whitespace] [--no-tabs] .
./utils/check-style-clang-format.py --fix .
# Entire codebase (using absolute paths)
/path/to/utils/check-style-clang-format.py [--fix] [--verbose] [--no-formatting] [--no-whitespace] [--no-tabs] /path/to/ns3
# Specific directory
/path/to/utils/check-style-clang-format.py [--fix] [--verbose] [--no-formatting] [--no-whitespace] [--no-tabs] absolute_or_relative/path/to/directory
# Individual file
/path/to/utils/check-style-clang-format.py [--fix] [--verbose] [--no-formatting] [--no-whitespace] [--no-tabs] absolute_or_relative/path/to/file
/path/to/utils/check-style-clang-format.py --fix /path/to/ns3
# Specific directory or file
/path/to/utils/check-style-clang-format.py --fix absolute_or_relative/path/to/directory_or_file
Clang-tidy
**********