From 92c9786127df61d49cbbff7b5d2b231414e373ef Mon Sep 17 00:00:00 2001 From: Thomas Habets Date: Thu, 24 Oct 2019 13:35:13 +0100 Subject: Add notes on coding style --- HACKING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/HACKING.md b/HACKING.md index 055b8dc..14d49e6 100644 --- a/HACKING.md +++ b/HACKING.md @@ -1,5 +1,17 @@ # Hacking on Arping +## Coding style + +* C99 to retain portability for the widest range of platforms +* Approximately [Linux kernel coding style][1], except: + * Line break before function name, in function definitions. + * Curly braces are mandatory. + * Place `*` next to the type, not the name. E.g. `char* p` + +Don't make style-only changes, but fix the style on the line you're touching anyway. + +[1]: https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst + ## Make release 1. Up version in configure.ac. Commit. 2. Run `./extra/mktarball HEAD` -- cgit v1.2.1