check-style: Add notes on how to use the script to fix formatting

nsnam · Jul 1, 2024 · 70eda40 · 70eda40
1 parent 1d03ba7
commit 70eda40
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/utils/check-style-clang-format.py b/utils/check-style-clang-format.py
@@ -775,7 +775,14 @@ def check_tabs_line(
 
     if not all_checks_successful:
         if args.verbose:
-            print("")
-            print('NOTE: To fix the files automatically, run this script with the flag "--fix"')
+            print(
+                "",
+                "Notes to fix the above formatting issues:",
+                '  - To fix the formatting of specific files, run this script with the flag "--fix":',
+                "      $ ./utils/check-style-clang-format.py --fix path [path ...]",
+                "  - To fix the formatting of all files modified by this branch, run this script in the following way:",
+                "      $ git diff --name-only master | xargs ./utils/check-style-clang-format.py --fix",
+                sep="\n",
+            )
 
         sys.exit(1)