tools/format-cpp: accept optional starting directory

[babeltrace.git] / CONTRIBUTING.adoc

diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc
index 23808c041e61e99dc856f9044a4f2b74fe11a64c..d5241ff4a8d611b924a9713f94116d292059cbc9 100644 (file)
--- a/CONTRIBUTING.adoc
+++ b/CONTRIBUTING.adoc
@@ -1683,11 +1683,17 @@ To automatically format all the project's {cpp} files, run:
 $ ./tools/format-cpp
 ----
 
+Pass a directory path to only format the {cpp} files it contains:
+
+----
+$ ./tools/format-cpp ./src/cli
+----
+
 Use the `FORMATTER` environment variable to override the default
 formatter (`clang-format{nbsp}-i`):
 
 ----
-$ FORMATTER='clang-format-10 -i' ./tools/format-cpp
+$ FORMATTER='my-clang-format-15 -i' ./tools/format-cpp
 ----
 
 ==== Naming