From: Simon Horman <horms@kernel.org>
To: "David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>,
Paolo Abeni <pabeni@redhat.com>,
Jonathan Corbet <corbet@lwn.net>
Cc: Alexandre Ferrieux <alexandre.ferrieux@gmail.com>,
netdev@vger.kernel.org, workflows@vger.kernel.org,
linux-doc@vger.kernel.org
Subject: [PATCH net] docs: netdev: Document guidance on inline functions
Date: Mon, 03 Feb 2025 13:59:44 +0000 [thread overview]
Message-ID: <20250203-inline-funk-v1-1-2f48418e5874@kernel.org> (raw)
Document preference for non inline functions in .c files.
This has been the preference for as long as I can recall
and I was recently surprised to discover that it is undocumented.
Reported-by: Alexandre Ferrieux <alexandre.ferrieux@gmail.com>
Closes: https://lore.kernel.org/all/9662e6fe-cc91-4258-aba1-ab5b016a041a@orange.com/
Signed-off-by: Simon Horman <horms@kernel.org>
---
Documentation/process/maintainer-netdev.rst | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/Documentation/process/maintainer-netdev.rst b/Documentation/process/maintainer-netdev.rst
index e497729525d5..1fbb8178b8cd 100644
--- a/Documentation/process/maintainer-netdev.rst
+++ b/Documentation/process/maintainer-netdev.rst
@@ -408,6 +408,17 @@ at a greater cost than the value of such clean-ups.
Conversely, spelling and grammar fixes are not discouraged.
+Inline functions
+----------------
+
+The use of static inline functions in .c file is strongly discouraged
+unless there is a demonstrable reason for them, usually performance
+related. Rather, it is preferred to omit the inline keyword and allow the
+compiler to inline them as it sees fit.
+
+This is a stricter requirement than that of the general Linux Kernel
+:ref:`Coding Style<codingstyle>`
+
Resending after review
~~~~~~~~~~~~~~~~~~~~~~
next reply other threads:[~2025-02-03 13:59 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-03 13:59 Simon Horman [this message]
2025-02-03 15:00 ` [PATCH net] docs: netdev: Document guidance on inline functions Jonathan Corbet
2025-02-03 19:50 ` Mauro Carvalho Chehab
2025-02-03 19:53 ` Mauro Carvalho Chehab
2025-02-04 11:55 ` Simon Horman
2025-02-04 11:54 ` Simon Horman
2025-02-04 13:25 ` Andrew Lunn
2025-02-04 20:07 ` Simon Horman
2025-02-04 22:46 ` David Laight
2025-02-03 15:10 ` Andrew Lunn
2025-02-04 9:35 ` Simon Horman
2025-02-03 18:51 ` Randy Dunlap
2025-02-04 11:56 ` Simon Horman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250203-inline-funk-v1-1-2f48418e5874@kernel.org \
--to=horms@kernel.org \
--cc=alexandre.ferrieux@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=workflows@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).