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: netdev@vger.kernel.org, workflows@vger.kernel.org,
linux-doc@vger.kernel.org
Subject: [PATCH RFC net] docs: netdev: document guidance on cleanup patches
Date: Fri, 04 Oct 2024 10:49:53 +0100 [thread overview]
Message-ID: <20241004-doc-mc-clean-v1-1-20c28dcb0d52@kernel.org> (raw)
The purpose of this section is to document what is the current practice
regarding clean-up patches which address checkpatch warnings and similar
problems. I feel there is a value in having this documented so others
can easily refer to it.
Clearly this topic is subjective. And to some extent the current
practice discourages a wider range of patches than is described here.
But I feel it is best to start somewhere, with the most well established
part of the current practice.
--
I did think this was already documented. And perhaps it is.
But I was unable to find it after a quick search.
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 c9edf9e7362d..da9980ad0c57 100644
--- a/Documentation/process/maintainer-netdev.rst
+++ b/Documentation/process/maintainer-netdev.rst
@@ -355,6 +355,8 @@ just do it. As a result, a sequence of smaller series gets merged quicker and
with better review coverage. Re-posting large series also increases the mailing
list traffic.
+.. _rcs:
+
Local variable ordering ("reverse xmas tree", "RCS")
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -391,6 +393,15 @@ APIs and helpers, especially scoped iterators. However, direct use of
``__free()`` within networking core and drivers is discouraged.
Similar guidance applies to declaring variables mid-function.
+Clean-Up Patches
+~~~~~~~~~~~~~~~~
+
+Netdev discourages patches which perform simple clean-ups, which are not in
+the context of other work. For example addressing ``checkpatch.pl``
+warnings, or :ref:`local variable ordering<rcs>` issues. This is because it
+is felt that the churn that such changes produce comes at a greater cost
+than the value of such clean-ups.
+
Resending after review
~~~~~~~~~~~~~~~~~~~~~~
next reply other threads:[~2024-10-04 9:50 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-04 9:49 Simon Horman [this message]
2024-10-07 15:24 ` [PATCH RFC net] docs: netdev: document guidance on cleanup patches Jakub Kicinski
2024-10-07 15:55 ` Simon Horman
2024-10-07 16:08 ` Jakub Kicinski
2024-10-07 16:15 ` Simon Horman
2024-10-07 16:54 ` Jakub Kicinski
2024-10-08 12:30 ` 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=20241004-doc-mc-clean-v1-1-20c28dcb0d52@kernel.org \
--to=horms@kernel.org \
--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).