Skip to content

Commit 91927ab

Browse files
committed
Introduce .git-blame-ignore-revs
The .git-blame-ignore-revs allows easy filtering out large commits from calls to git blame. This can be configured frome the git command line via the following: git config blame.ignoreRevsFile .git-blame-ignore-revs
1 parent 01820d3 commit 91927ab

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

.git-blame-ignore-revs

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Normalize line endings and whitespace
2+
ddd1e30018e74ad293cda0635018d636a6657f57
3+
4+
# Convert tabs to spaces (4)
5+
8c77117c32e49a5070cd85e8920c36723997e465
6+
7+
# Apply uncrustify rules
8+
587a83d647619bb0a508661c7bb4d6df89851582
9+
2c530ba5c352fdf420d1b13709a3970f04e9e6c6
10+
718178c68a1c863dd1a2eac7aea326a789d3bc52
11+
a5dbc2b1de17e5468420d5a928d7392d799780e2

README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,21 @@ See the readme file in the ```./portable``` directory for more information.
7676
- The ```./include``` directory contains the real time kernel header files.
7777

7878
### Code Formatting
79-
FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the [FreeRTOS/FreeRTOS repository](https://github.com/FreeRTOS/FreeRTOS/blob/main/tools/uncrustify.cfg).
79+
FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the [.github/uncrustify.cfg](.github/uncrustify.cfg) file.
80+
81+
### Line Endings
82+
File checked into the FreeRTOS-Kernel repository use unix-style LF line endings for the best compatbility with git.
83+
84+
For optmial compatibility with Microsoft Windows tools, it is best to enable the git autocrlf feature. You can eanble this setting for the current repository using the following command:
85+
```
86+
git config core.autocrlf true
87+
```
88+
89+
### Git History Optimizations
90+
Some commits in this repository perform large refactors which touch many lines and lead to unwanted behavior when using the `git blame` command. You can configure git to ignore the list of large refactor commits in this repository with the followig command:
91+
```
92+
git config blame.ignoreRevsFile .git-blame-ignore-revs
93+
```
8094

8195
### Spelling
8296
*lexicon.txt* contains words that are not traditionally found in an English dictionary. It is used by the spellchecker to verify the various jargon, variable names, and other odd words used in the FreeRTOS code base. If your pull request fails to pass the spelling and you believe this is a mistake, then add the word to *lexicon.txt*.

0 commit comments

Comments
 (0)