diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 26 |
1 files changed, 17 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fe195b4a..4896fef9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,26 +39,29 @@ The reason is that we might one day use the code under terms of LGPL-2.1-or-late new contributions already must already agree to that. For more details see [RELICENSE.md](RELICENSE.md). +Do not use "Signed-off-by:" lines in commits for NetworkManager. It has no meaning. + Coding Style ------------ ### clang-format -The formatting is automated using clang-format. Run `./contrib/scripts/nm-code-format.sh -i` -([[1]](contrib/scripts/nm-code-format.sh)) to reformat the code or run `clang-format` yourself. - -You may also call `./contrib/scripts/nm-code-format-container.sh` which runs a -Fedora container using podman. +The formatting is automated using [clang-format](https://clang.llvm.org/docs/ClangFormat.html). +Run `./contrib/scripts/nm-code-format.sh -i` ([[1]](contrib/scripts/nm-code-format.sh)) to reformat +the code or run `clang-format` directly. As the generated format depends on the version of clang-format, you need to use the correct clang-format version. That is basically the version that our [gitlab-ci pipeline](https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/pipelines) uses for the "check-tree" test. This is the version from a recent Fedora installation. -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. +You may also run `./contrib/scripts/nm-code-format-container.sh` which uses a +Fedora container with podman and the correct version of clang-format. + +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 @@ -68,6 +71,8 @@ the reformatting commit with git-blame: $ git config --add 'blame.ignoreRevsFile' '.git-blame-ignore-revs' ``` +You may integrate clang-formatter in your editor (for [vim](https://github.com/rhysd/vim-clang-format)). + ### Style As we use clang-format, our style is in parts determined by the tool. @@ -404,7 +409,7 @@ $ git config --add 'notes.displayref' 'refs/notes/bugs' For example, set notes with ``` -$ git notes --ref refs/notes/bugs add -m "(cherry picked from $COMMIT_SHA)" HEAD +$ git notes --ref refs/notes/bugs add -m "(cherry picked from commit $COMMIT_SHA)" HEAD ``` You should see the notes in git-log output as well. @@ -414,3 +419,6 @@ To resync our local notes use: ``` $ git fetch origin refs/notes/bugs:refs/notes/bugs -f ``` +### Testing NetworkManager with nm-in-container script. + +See [the readme](tools/nm-in-container/README.md) for details. |