diff mbox series

Documentation: process: Correct numbering

Message ID 1608061835-5118-1-git-send-email-milan.lakhani@codethink.co.uk (mailing list archive)
State New, archived
Headers show
Series Documentation: process: Correct numbering | expand

Commit Message

Milan Lakhani Dec. 15, 2020, 7:50 p.m. UTC
Renumber the steps in submit-checklist.rst as some numbers were skipped.

Signed-off-by: Milan Lakhani <milan.lakhani@codethink.co.uk>
---
 Documentation/process/submit-checklist.rst | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

Comments

Sudip Mukherjee Dec. 15, 2020, 8:16 p.m. UTC | #1
Hi Milan,

On Tue, Dec 15, 2020 at 07:50:35PM +0000, Milan Lakhani wrote:
> Renumber the steps in submit-checklist.rst as some numbers were skipped.
> 
> Signed-off-by: Milan Lakhani <milan.lakhani@codethink.co.uk>

Maybe you can also add:
Fixes: 72deb455b5ec ("block: remove CONFIG_LBDAF")

But I am confused about why you have added Greg and staging list instead
of 'linux-doc@vger.kernel.org'.

--
Regards
Sudip


-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#222): https://lists.elisa.tech/g/linux-safety/message/222
Mute This Topic: https://lists.elisa.tech/mt/78984776/5278000
Group Owner: linux-safety+owner@lists.elisa.tech
Unsubscribe: https://lists.elisa.tech/g/linux-safety/unsub [linux-safety@archiver.kernel.org]
-=-=-=-=-=-=-=-=-=-=-=-
Milan Lakhani Dec. 15, 2020, 8:32 p.m. UTC | #2
Hi Sudip,

On 15/12/2020 20:16, Sudip Mukherjee wrote:
> Hi Milan,
>
> On Tue, Dec 15, 2020 at 07:50:35PM +0000, Milan Lakhani wrote:
>> Renumber the steps in submit-checklist.rst as some numbers were skipped.
>>
>> Signed-off-by: Milan Lakhani <milan.lakhani@codethink.co.uk>
> Maybe you can also add:
> Fixes: 72deb455b5ec ("block: remove CONFIG_LBDAF")
Will add this :)
>
> But I am confused about why you have added Greg and staging list instead
> of 'linux-doc@vger.kernel.org'.

I was a bit unsure since the whole repository is called staging so I was 
thinking these different folders may use the same lists and didn't pay 
attention that the staging list had the word 'drivers', I'm clear on the 
different lists now though. I'll change the drivers list for the one you 
mention there.

Thanks,
Milan

>
> --
> Regards
> Sudip
>
>
> 
>
>
>


-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#223): https://lists.elisa.tech/g/linux-safety/message/223
Mute This Topic: https://lists.elisa.tech/mt/78984776/5278000
Group Owner: linux-safety+owner@lists.elisa.tech
Unsubscribe: https://lists.elisa.tech/g/linux-safety/unsub [linux-safety@archiver.kernel.org]
-=-=-=-=-=-=-=-=-=-=-=-
Milan Lakhani Dec. 16, 2020, 4:16 p.m. UTC | #3
Hi,

I made the below changes and sent the documentation patch version 2,

In case there are any other new contributors wondering the best place to 
send their kernel patches, I now send mine to:

kernel@vger.kernel.org (Kernel mailing list)
linux-safety@lists.elisa.tech (ELISA safety list)
The maintainers (obtained by running 'git show HEAD | perl 
scripts/get_maintainer.pl --separator , --nokeywords --nogit 
--nogit-fallback --norolestats --nol' if the HEAD commit is the patch)

For driver patches I'll also include devel@driverdev.osuosl.org and Greg 
gregkh@linuxfoundation.org, while for a documentation patch I'll include 
the linux-doc@vger.kernel.org list.

Milan

On 15/12/2020 20:32, Milan Lakhani wrote:
> Hi Sudip,
>
> On 15/12/2020 20:16, Sudip Mukherjee wrote:
>> Hi Milan,
>>
>> On Tue, Dec 15, 2020 at 07:50:35PM +0000, Milan Lakhani wrote:
>>> Renumber the steps in submit-checklist.rst as some numbers were 
>>> skipped.
>>>
>>> Signed-off-by: Milan Lakhani <milan.lakhani@codethink.co.uk>
>> Maybe you can also add:
>> Fixes: 72deb455b5ec ("block: remove CONFIG_LBDAF")
> Will add this :)
>>
>> But I am confused about why you have added Greg and staging list instead
>> of 'linux-doc@vger.kernel.org'.
>
> I was a bit unsure since the whole repository is called staging so I 
> was thinking these different folders may use the same lists and didn't 
> pay attention that the staging list had the word 'drivers', I'm clear 
> on the different lists now though. I'll change the drivers list for 
> the one you mention there.
>
> Thanks,
> Milan
>
>>
>> -- 
>> Regards
>> Sudip
>>
>>
>> 
>>
>>
>>


-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#225): https://lists.elisa.tech/g/linux-safety/message/225
Mute This Topic: https://lists.elisa.tech/mt/79004338/5278000
Group Owner: linux-safety+owner@lists.elisa.tech
Unsubscribe: https://lists.elisa.tech/g/linux-safety/unsub [linux-safety@archiver.kernel.org]
-=-=-=-=-=-=-=-=-=-=-=-
Lukas Bulwahn Dec. 16, 2020, 4:23 p.m. UTC | #4
On Wed, Dec 16, 2020 at 5:16 PM Milan Lakhani <milan.lakhani@codethink.co.uk>
wrote:

> Hi,
>
> I made the below changes and sent the documentation patch version 2,
>
> In case there are any other new contributors wondering the best place to
> send their kernel patches, I now send mine to:
>
> kernel@vger.kernel.org (Kernel mailing list)
> linux-safety@lists.elisa.tech (ELISA safety list)
> The maintainers (obtained by running 'git show HEAD | perl
> scripts/get_maintainer.pl --separator , --nokeywords --nogit
> --nogit-fallback --norolestats --nol' if the HEAD commit is the patch)
>
> For driver patches I'll also include devel@driverdev.osuosl.org and Greg
> gregkh@linuxfoundation.org, while for a documentation patch I'll include
> the linux-doc@vger.kernel.org list.
>
>
Patches to documentation should also be sent to Jonathan Corbet and they
should apply on top of his doc-next branch.

Here are some hints from Jonathan on the submission of patches to him:

https://www.kernel.org/doc/html/latest/doc-guide/maintainer-profile.html

Also make sure that document generation has no warnings.

Lukas


> Milan
>
> On 15/12/2020 20:32, Milan Lakhani wrote:
> > Hi Sudip,
> >
> > On 15/12/2020 20:16, Sudip Mukherjee wrote:
> >> Hi Milan,
> >>
> >> On Tue, Dec 15, 2020 at 07:50:35PM +0000, Milan Lakhani wrote:
> >>> Renumber the steps in submit-checklist.rst as some numbers were
> >>> skipped.
> >>>
> >>> Signed-off-by: Milan Lakhani <milan.lakhani@codethink.co.uk>
> >> Maybe you can also add:
> >> Fixes: 72deb455b5ec ("block: remove CONFIG_LBDAF")
> > Will add this :)
> >>
> >> But I am confused about why you have added Greg and staging list instead
> >> of 'linux-doc@vger.kernel.org'.
> >
> > I was a bit unsure since the whole repository is called staging so I
> > was thinking these different folders may use the same lists and didn't
> > pay attention that the staging list had the word 'drivers', I'm clear
> > on the different lists now though. I'll change the drivers list for
> > the one you mention there.
> >
> > Thanks,
> > Milan
> >
> >>
> >> --
> >> Regards
> >> Sudip
> >>
> >>
> >>
> >>
> >>
> >>
>
>
> 
>
>
>


-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#226): https://lists.elisa.tech/g/linux-safety/message/226
Mute This Topic: https://lists.elisa.tech/mt/79004338/5278000
Group Owner: linux-safety+owner@lists.elisa.tech
Unsubscribe: https://lists.elisa.tech/g/linux-safety/unsub [linux-safety@archiver.kernel.org]
-=-=-=-=-=-=-=-=-=-=-=-
Sudip Mukherjee Dec. 16, 2020, 4:30 p.m. UTC | #5
Hi Milan,

On 16/12/2020 16:16, Milan Lakhani wrote:
> Hi,
> 
> I made the below changes and sent the documentation patch version 2,
> 

<snip>

> 
> For driver patches I'll also include devel@driverdev.osuosl.org and Greg
> gregkh@linuxfoundation.org, while for a documentation patch I'll include
> the linux-doc@vger.kernel.org list.

Not for all the drivers. Like any patch to drivers in
'drivers/watchdog/' does not need GregKH or devel@driverdev.osuosl.org.
diff mbox series

Patch

diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst
index 1879f88..230ee42 100644
--- a/Documentation/process/submit-checklist.rst
+++ b/Documentation/process/submit-checklist.rst
@@ -75,44 +75,44 @@  and elsewhere regarding submitting Linux kernel patches.
 13) Has been build- and runtime tested with and without ``CONFIG_SMP`` and
     ``CONFIG_PREEMPT.``
 
-16) All codepaths have been exercised with all lockdep features enabled.
+14) All codepaths have been exercised with all lockdep features enabled.
 
-17) All new ``/proc`` entries are documented under ``Documentation/``
+15) All new ``/proc`` entries are documented under ``Documentation/``
 
-18) All new kernel boot parameters are documented in
+16) All new kernel boot parameters are documented in
     ``Documentation/admin-guide/kernel-parameters.rst``.
 
-19) All new module parameters are documented with ``MODULE_PARM_DESC()``
+17) All new module parameters are documented with ``MODULE_PARM_DESC()``
 
-20) All new userspace interfaces are documented in ``Documentation/ABI/``.
+18) All new userspace interfaces are documented in ``Documentation/ABI/``.
     See ``Documentation/ABI/README`` for more information.
     Patches that change userspace interfaces should be CCed to
     linux-api@vger.kernel.org.
 
-21) Check that it all passes ``make headers_check``.
+19) Check that it all passes ``make headers_check``.
 
-22) Has been checked with injection of at least slab and page-allocation
+20) Has been checked with injection of at least slab and page-allocation
     failures.  See ``Documentation/fault-injection/``.
 
     If the new code is substantial, addition of subsystem-specific fault
     injection might be appropriate.
 
-23) Newly-added code has been compiled with ``gcc -W`` (use
+21) Newly-added code has been compiled with ``gcc -W`` (use
     ``make EXTRA_CFLAGS=-W``).  This will generate lots of noise, but is good
     for finding bugs like "warning: comparison between signed and unsigned".
 
-24) Tested after it has been merged into the -mm patchset to make sure
+22) Tested after it has been merged into the -mm patchset to make sure
     that it still works with all of the other queued patches and various
     changes in the VM, VFS, and other subsystems.
 
-25) All memory barriers {e.g., ``barrier()``, ``rmb()``, ``wmb()``} need a
+23) All memory barriers {e.g., ``barrier()``, ``rmb()``, ``wmb()``} need a
     comment in the source code that explains the logic of what they are doing
     and why.
 
-26) If any ioctl's are added by the patch, then also update
+24) If any ioctl's are added by the patch, then also update
     ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
 
-27) If your modified source code depends on or uses any of the kernel
+25) If your modified source code depends on or uses any of the kernel
     APIs or features that are related to the following ``Kconfig`` symbols,
     then test multiple builds with the related ``Kconfig`` symbols disabled
     and/or ``=m`` (if that option is available) [not all of these at the