summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
Commit message (Collapse)AuthorAgeFilesLines
* CONTRIBUTING: document style guide about naming in header filesThomas Haller2022-01-201-0/+4
|
* CONTRIBUTING: update "Coding Style" sectionThomas Haller2022-01-111-11/+18
|
* CONTRIBUTING: clarify on the use/lack of curly braces around blocksThomas Haller2022-01-111-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is the style we have ever since. Spell it out. With the difference that now single line statements may have braces. Recently we were already sloppy about allowing curly braces for single line statements. Maybe there was a point in that. Imagine you start with: if (condition) call(some, parameter); Afterwards you change the code so that the line becomes too long and clang-format wraps the line (requiring you to add braces): if (condition) { call(some, call_another_function(hey)); } The problem now is that this diff is larger than it would have been, if you added curly braces from the start. Also, it means you have to go back and forth to add/remove these braces, as clang-format reformats the code. Also, if you have if-else-if blocks, then mixing multi line statements with single line statements is also cumbersome, because when something needs to change, the diff is may be larger (and the change more cumbersome). So it might be convenient to just always add the braces, and the documented style now allows for that.
* CONTRIBUTING: update styleThomas Haller2021-10-061-11/+16
|
* std-aux: add "libnm-std-aux/nm-linux-compat.h" header to avoid build errorsThomas Haller2021-09-081-0/+4
| | | | | | | | | | | | | | | | | | | | We have a copy of a few linux user space headers in `src/linux-headers`. The idea is that we want to use recent kernel API, and not depend on the kernel UAPI headers installed on the build system (and not need to workaround that). However, we may not be able to simply compile them, because they too have dependencies. For example, ../src/linux-headers/ethtool.h:1389:2: error: implicit declaration of function '__KERNEL_DIV_ROUND_UP' [-Werror=implicit-function-declaration] __u32 queue_mask[__KERNEL_DIV_ROUND_UP(MAX_NUM_QUEUE, 32)]; ^ As workaround, don't include headers from "linux-headers" directly, but only include the new "libnm-std-aux/nm-linux-compat.h" adapter header, which tries to solve these incompatibilities. Fixes: 34d48d2596f7 ('platform: clear all BASE types when setting advertised modes for ethernet autoneg')
* CONTRIBUTING: add "Building from Source" sectionThomas Haller2021-08-271-70/+114
| | | | And move sections around.
* CONTRIBUTING: explain order of includes of header filesThomas Haller2021-08-261-0/+29
|
* CONTRIBUTING: explain which version of clang-format to useThomas Haller2021-08-261-10/+39
|
* all: add some README.md files describing the purpose of our sourcesThomas Haller2021-08-191-1/+1
|
* docs: explain GObject properties in CONTRIBUTING.mdThomas Haller2021-06-071-0/+48
|
* update references from "freenode" to "Libera.Chat"Thomas Haller2021-05-251-1/+1
|
* CONTRIBUTING: add section about unit testsThomas Haller2021-05-111-0/+16
|
* CONTRIBUTIING: add chapter describing Cscope and code structureWen Liang2021-03-241-0/+32
| | | | | | Signed-off-by: Wen Liang <liangwen12year@gmail.com> https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/792
* CONTRIBUTING: style fixes and improve textThomas Haller2021-03-161-61/+79
|
* CONTRIBUTING: rename file to have .md extensionThomas Haller2021-03-161-0/+166
We should write our CONTRIBUTING files in markdown syntax, because it's nice to read a plain text and gets nicely rendered. However, if the file doesn't have a ".md" extension, gitlab's web interface shows it as plain text file. Rename the file. This possibly breaks links like [1], but referring to a branch name (and not a commit ID or a tag) is anyway fragile. Hence, I don't try to fix that by adding a symlink or similar, because I think that just makes it more confusing. [1] https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/blob/master/CONTRIBUTING