diff --git a/tools/check_format.sh b/tools/check_format.sh index ff86171b66..143a2f6ed5 100755 --- 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 # Author: Pat Pannuto # Author: Brad Campbell