From ff954319a009b8f5ec6b95e23fe7ca4bb0e16426 Mon Sep 17 00:00:00 2001 From: Eduardo Almeida Date: Wed, 6 Sep 2023 23:07:35 +0100 Subject: [PATCH] doc: Simplify check-style-clang-format.py usage commands Remove optional flags to avoid errors from users copy-pasting the commands verbatim. --- doc/contributing/source/coding-style.rst | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/doc/contributing/source/coding-style.rst b/doc/contributing/source/coding-style.rst index b2a80f2b1..e1cf0c0a0 100644 --- a/doc/contributing/source/coding-style.rst +++ b/doc/contributing/source/coding-style.rst @@ -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 **********