system/NetworkManager
system/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager synced 2024-07-22 02:35:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

CONTRIBUTING: update "Coding Style" section

Browse source
This commit is contained in:
Thomas Haller 2022-01-11 14:39:10 +01:00
parent 5f0ddaa610
commit e0cdbd733b
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
CONTRIBUTING.md
View file

@ -69,8 +69,24 @@ $ git config --add 'blame.ignoreRevsFile' '.git-blame-ignore-revs'
### Style
Since our coding style is entirely automated, the following are just
some details of the style we use:
As we use clang-format, our style is in parts determined by the tool.
Run the tool to format the code. See the earlier point.
The formatting tool cannot cover all questions. The most important rule is
to mimic the existing code and *imitate the surrounding style*.
In general, we require to build without compiler warnings, for the warnings
that we enable. Our language is C11 with some GCC-isms (like typeof(),
expression statements, cleanup attribute). In practice, we support various versions
of GCC and clang. The supported C "dialect", compilers and libc are those that we
can practically build and test in our CI. We don't target a theoretical, pure C11/POSIX
standard or a libc/compiler that we cannot test.
Patches for making NetworkManager more portable are welcome, if there is a
practical use and checked by CI. Glibc and musl libc are supported.
We follow a mixture of [glib's](https://developer.gnome.org/documentation/guidelines/programming/coding-style.html)
and [systemd's](https://github.com/systemd/systemd/blob/main/docs/CODING_STYLE.md) style, which already have extensive
guidelines. Following there are a few noteworthy points.
* Use cleanup functions (`gs_free`, `gs_*`, `nm_auto*`) to let a stack
variable own a resource instead of explicit free. Combine them with
@ -104,15 +120,6 @@ some details of the style we use:
* Always use curly braces for blocks that span multiple lines. For single lines
the braces may be omitted, but are not prohibited.
Additionally, we require to build without compiler warnings for the warnings
that we enable. Also, our language is C11 with some GCC-isms (like typeof(),
expression statements, cleanup attribute). In practice, we support various versions
of GCC and clang. The supported C "dialect", compilers and libc are those that we
can practically build and test in our CI. We don't target a theoretical, pure C11/POSIX
standard or a libc/compiler that we cannot test.
Patches for making NetworkManager more portable are welcome, if there is a
practical use and CI tests. Glibc and musl libc are supported.
### Checkpatch
We have a [checkpatch.pl](contrib/scripts/checkpatch.pl) script, which is