Remove tab characters & protect against accidentally introducing them #2414
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bradjc
reviewed
Feb 8, 2021
| @@ -377,9 +377,9 @@ impl Driver for L3gd20Spi<'_> { | |||
| ) -> ReturnCode { | |||
| match subscribe_num { | |||
| 0 /* set the one shot callback */ => { | |||
There was a problem hiding this comment.
Just FYI this is a known rustfmt issue: rust-lang/rustfmt#4119
phil-levis
previously approved these changes
Feb 8, 2021
Some tab characters will not be replaced by spaces through rustfmt. To avoid these making it into the repository, add an additional check for tab characters. If available, the fast "git grep" will be used, otherwise it will fall back to the system grep. This has been tested with GNU grep.
It appears that rustfmt does not always remove tab characters, in particular as part of macro invocations. This removes (accidentally) inserted tab characters for a consistent code style.
dd922cf to
0c96b02
Compare
ppannuto
approved these changes
Feb 10, 2021
bradjc
approved these changes
Feb 10, 2021
|
bors r+ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Overview
This pull request removes tab characters from Tock's Rust codebase, most of which have been accidentally introduced by me. Whoops, sorry!
While I don't want to "police" anyone's code style, Tock's codebase uses almost exclusively spaces.
rustfmtseems to replace tabs by spaces pretty consistently, but it appears to have a hard time in macro invocations and some other places. Given that there is no defined standard width for representing tabs in Tock's Rust files, and we're interleaving tabs with spaces, this makes for a very inconsistent indentation depending on the editor's configuration.Furthermore, this adds a check for tab characters in the codebase to the
run_cargo_fmt.shscript. It usesgit grepif available, and falls back to the system'sgrepotherwise. It has been tested with GNUgrepand might require small modifications for BSDgrep. The check's overhead isn't noticeable (compared to thecargo fmtinvocations), even on some low-end systems of mine.Output prior to removing the tab characters from the codebase:
Testing Strategy
This pull request was tested by running the script against the codebase with tab characters, and against the properly formatted one. It requires testing on a machine with BSD grep (such as macOS).
TODO or Help Wanted
I'd appreciate someone with access to a machine having BSD
grepto test the fallback to the system's installedgrep.Documentation Updated
/docs, or no updates are required.Formatting
make prepush.