CONTRIBUTING: add --no-backup to uncrustify

RIOT-OS · Oct 20, 2020 · 7e57cf2 · 7e57cf2
1 parent ef92773
commit 7e57cf2
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -105,9 +105,12 @@ It is possible to check if your code follows these conventions:
 * You can [uncrustify] `.c` and `.h` files:
 
   ```console
-  $ uncrustify -c $RIOTBASE/uncrustify-riot.cfg <your file>
+  $ uncrustify -c $RIOTBASE/uncrustify-riot.cfg --no-backup <your file>
   ```
 
+  **Note**: The `--no-backup` flag makes uncrustify *replace* the current file
+   with a formatted version.
+
 * RIOT provides static test tools to verify the quality of changes (cppcheck,
   trailing whitespaces, documentation, etc). These tools are wrapped in a
   single `make` target: `static-test`.