From: Drew DeVault <sir@cmpwn.com>
To: linux-doc@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Cc: Drew DeVault <sir@cmpwn.com>
Subject: [PATCH 1/4] submitting-patches.rst: remove heading numbering
Date: Wed, 2 Sep 2020 11:57:56 -0400 [thread overview]
Message-ID: <20200902155759.55895-2-sir@cmpwn.com> (raw)
In-Reply-To: <20200902155759.55895-1-sir@cmpwn.com>
This follows similar changes throughout Documentation; these numbers
tend to get outdated and are not especially useful.
Signed-off-by: Drew DeVault <sir@cmpwn.com>
---
Documentation/process/submitting-patches.rst | 30 ++++++++++----------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 5219bf3cddfc..f205753ae3d8 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -24,7 +24,7 @@ of the mechanical work done for you, though you'll still need to prepare
and document a sensible set of patches. In general, use of ``git`` will make
your life as a kernel developer easier.
-0) Obtain a current source tree
+Obtain a current source tree
-------------------------------
If you do not have a repository with the current kernel source handy, use
@@ -99,7 +99,7 @@ is another popular alternative.
.. _describe_changes:
-2) Describe your changes
+Describe your changes
------------------------
Describe your problem. Whether your patch is a one-line bug fix or
@@ -203,7 +203,7 @@ An example call::
.. _split_changes:
-3) Separate your changes
+Separate your changes
------------------------
Separate each **logical change** into a separate patch.
@@ -236,7 +236,7 @@ then only post say 15 or so at a time and wait for review and integration.
-4) Style-check your changes
+Style-check your changes
---------------------------
Check your patch for basic style violations, details of which can be
@@ -267,7 +267,7 @@ You should be able to justify all violations that remain in your
patch.
-5) Select the recipients for your patch
+Select the recipients for your patch
---------------------------------------
You should always copy the appropriate subsystem maintainer(s) on any patch
@@ -342,7 +342,7 @@ Trivial patches must qualify for one of the following rules:
-6) No MIME, no links, no compression, no attachments. Just plain text
+No MIME, no links, no compression, no attachments. Just plain text
----------------------------------------------------------------------
Linus and other kernel developers need to be able to read and comment
@@ -370,7 +370,7 @@ See :ref:`Documentation/process/email-clients.rst <email_clients>`
for hints about configuring your e-mail client so that it sends your patches
untouched.
-7) E-mail size
+E-mail size
--------------
Large changes are not appropriate for mailing lists, and some
@@ -396,7 +396,7 @@ reviewers sometimes get grumpy. Even in that case, though, respond
politely and address the problems they have pointed out.
-9) Don't get discouraged - or impatient
+Don't get discouraged - or impatient
---------------------------------------
After you have submitted your change, be patient and wait. Reviewers are
@@ -410,7 +410,7 @@ one week before resubmitting or pinging reviewers - possibly longer during
busy times like merge windows.
-10) Include PATCH in the subject
+Include PATCH in the subject
--------------------------------
Due to high e-mail traffic to Linus, and to linux-kernel, it is common
@@ -420,7 +420,7 @@ e-mail discussions.
-11) Sign your work - the Developer's Certificate of Origin
+Sign your work - the Developer's Certificate of Origin
----------------------------------------------------------
To improve tracking of who did what, especially with patches that can
@@ -586,7 +586,7 @@ Example of a patch submitted by a Co-developed-by: author::
Signed-off-by: Submitting Co-Author <sub@coauthor.example.org>
-13) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:
+Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:
--------------------------------------------------------------------------
The Reported-by tag gives credit to people who find bugs and report them and it
@@ -650,7 +650,7 @@ for more details.
.. _the_canonical_patch_format:
-14) The canonical patch format
+The canonical patch format
------------------------------
This section describes how the patch itself should be formatted. Note
@@ -773,7 +773,7 @@ references.
.. _explicit_in_reply_to:
-15) Explicit In-Reply-To headers
+Explicit In-Reply-To headers
--------------------------------
It can be helpful to manually add In-Reply-To: headers to a patch
@@ -787,7 +787,7 @@ helpful, you can use the https://lkml.kernel.org/ redirector (e.g., in
the cover email text) to link to an earlier version of the patch series.
-16) Providing base tree information
+Providing base tree information
-----------------------------------
When other developers receive your patches and start the review process,
@@ -838,7 +838,7 @@ either below the ``---`` line or at the very bottom of all other
content, right before your email signature.
-17) Sending ``git pull`` requests
+Sending ``git pull`` requests
---------------------------------
If you have a series of patches, it may be most convenient to have the
--
2.28.0
next prev parent reply other threads:[~2020-09-02 15:58 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-02 15:57 [PATCH 0/4] Improvements to submitting-patches.rst Drew DeVault
2020-09-02 15:57 ` Drew DeVault [this message]
2020-09-03 15:44 ` [PATCH 1/4] submitting-patches.rst: remove heading numbering Jonathan Corbet
2020-09-03 15:48 ` Drew DeVault
2020-09-03 15:46 ` Jonathan Corbet
2020-09-02 15:57 ` [PATCH 2/4] Documentation/process: expand plain-text advice Drew DeVault
2020-09-02 16:06 ` Randy Dunlap
2020-09-02 16:20 ` Drew DeVault
2020-09-03 15:47 ` Jonathan Corbet
2020-09-02 15:57 ` [PATCH 3/4] Documentation/maintainer: rehome sign-off process Drew DeVault
2020-09-03 15:50 ` Jonathan Corbet
2020-09-02 15:57 ` [PATCH 4/4] submitting-patches.rst: presume git will be used Drew DeVault
2020-09-02 16:11 ` Randy Dunlap
2020-09-02 16:11 ` Drew DeVault
2020-09-03 15:57 ` Jonathan Corbet
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=20200902155759.55895-2-sir@cmpwn.com \
--to=sir@cmpwn.com \
--cc=corbet@lwn.net \
--cc=linux-doc@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).