Verified Commit 1cda7922 authored by Thomas Haller's avatar Thomas Haller
Browse files

format: add ".git-blame-ignore-revs" and hint how to ignore the commit during git-blame

parent 39026b64
Pipeline #219637 passed with stages
in 36 minutes and 20 seconds
# The commits that did automated reformatting. You can ignore them
# during git-blame with `--ignore-rev` or `--ignore-revs-file`.
#
# $ git config --add 'blame.ignoreRevsFile' '.git-blame-ignore-revs'
#
328fb90f3e0d4e35975aff63944ac0412d7893a5
740b092fda3d5f45102422f22884c88ea6c42858
......@@ -14,13 +14,21 @@ You are welcome to not bother and open a merge request with
wrong formatting, but note that we then will automatically adjust
your contribution before merging.
The automatic reformatting was done by commit 328fb90f3e0d4e35975aff63944ac0412d7893a5.
Use `--ignore-rev` option or `--ignore-revs-file .git-blame-ignore-revs` to ignore
the reformatting commit with git-blame:
```
$ git config --add 'blame.ignoreRevsFile' '.git-blame-ignore-revs'
```
Since our coding style is entirely automated, the following are just
some details of the style we use:
* Indent with 4 spaces. (_no_ tabs).
* Have no space between the function name and the opening '('.
- GOOD: `g_strdup(x)`
- GOOD: `g_strdup(x)`
- BAD: `g_strdup (x)`
* C-style comments
......@@ -28,8 +36,8 @@ some details of the style we use:
- BAD: `f(x); // comment`
* Keep assignments in the variable declaration area pretty short.
- GOOD: `MyObject *object;`
- BAD: `MyObject *object = complex_and_long_init_function(arg1, arg2, arg3);`
- GOOD: `MyObject *object;`
- BAD: `MyObject *object = complex_and_long_init_function(arg1, arg2, arg3);`
* 80-cols is a guideline, don't make the code uncomfortable in order to fit in
less than 80 cols.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment