tools/check_format.sh: add documentation

Co-authored-by: Brad Campbell <[email protected]>
YoeDistro · Jul 5, 2024 · 5ee94cc · 5ee94cc
1 parent 12ae6a1
commit 5ee94cc
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/tools/check_format.sh b/tools/check_format.sh
@@ -4,6 +4,9 @@
 # SPDX-License-Identifier: Apache-2.0 OR MIT
 # Copyright Tock Contributors 2023.
 #
+# Runs `rustfmt --check` on the workspace and check for tabs in Rust files.
+# Must be run from root Tock directory.
+#
 # Author: Leon Schuermann <[email protected]>
 # Author: Pat Pannuto <[email protected]>
 # Author: Brad Campbell <[email protected]>