docs: Explain the desired position of function attributes
authorKees Cook <keescook@chromium.org>
Tue, 5 Oct 2021 15:26:11 +0000 (08:26 -0700)
committerJonathan Corbet <corbet@lwn.net>
Tue, 12 Oct 2021 19:35:02 +0000 (13:35 -0600)
commitd5b421fe0282784a4a8235d549d6ac5d9efff967
treefc9412485891b4ccd938f4763793cb345d2c6d26
parent7275423c177e5dcf53e350ab9db38f99946b8ec5
docs: Explain the desired position of function attributes

While discussing how to format the addition of various function
attributes, some "unwritten rules" of ordering surfaced[1]. Capture as
close as possible to Linus's preferences for future reference.

(Though I note the dissent voiced by Joe Perches, Alexey Dobriyan, and
others that would prefer all attributes live on a separate leading line.)

[1] https://lore.kernel.org/mm-commits/CAHk-=wiOCLRny5aifWNhr621kYrJwhfURsa0vFPeUEm8mF0ufg@mail.gmail.com/

Signed-off-by: Kees Cook <keescook@chromium.org>
Link: https://lore.kernel.org/r/20211005152611.4120605-1-keescook@chromium.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/process/coding-style.rst