Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
Merge tag 'docs-5.11-2' of git://git.lwn.net/linux
Pull documentation fixes from Jonathan Corbet:
"A small set of late-arriving, small documentation fixes"
* tag 'docs-5.11-2' of git://git.lwn.net/linux:
docs: admin-guide: Fix default value of max_map_count in sysctl/vm.rst
Documentation/submitting-patches: Document the SoB chain
Documentation: process: Correct numbering
docs: submitting-patches: Trivial - fix grammatical error
+1
-1
Documentation/admin-guide/sysctl/vm.rst
+1
-1
Documentation/admin-guide/sysctl/vm.rst
+12
-12
Documentation/process/submit-checklist.rst
+12
-12
Documentation/process/submit-checklist.rst
···
75
13) Has been build- and runtime tested with and without ``CONFIG_SMP`` and
76
``CONFIG_PREEMPT.``
77
78
-
16) All codepaths have been exercised with all lockdep features enabled.
79
80
-
17) All new ``/proc`` entries are documented under ``Documentation/``
81
82
-
18) All new kernel boot parameters are documented in
83
``Documentation/admin-guide/kernel-parameters.rst``.
84
85
-
19) All new module parameters are documented with ``MODULE_PARM_DESC()``
86
87
-
20) All new userspace interfaces are documented in ``Documentation/ABI/``.
88
See ``Documentation/ABI/README`` for more information.
89
Patches that change userspace interfaces should be CCed to
90
linux-api@vger.kernel.org.
91
92
-
21) Check that it all passes ``make headers_check``.
93
94
-
22) Has been checked with injection of at least slab and page-allocation
95
failures. See ``Documentation/fault-injection/``.
96
97
If the new code is substantial, addition of subsystem-specific fault
98
injection might be appropriate.
99
100
-
23) Newly-added code has been compiled with ``gcc -W`` (use
101
``make EXTRA_CFLAGS=-W``). This will generate lots of noise, but is good
102
for finding bugs like "warning: comparison between signed and unsigned".
103
104
-
24) Tested after it has been merged into the -mm patchset to make sure
105
that it still works with all of the other queued patches and various
106
changes in the VM, VFS, and other subsystems.
107
108
-
25) All memory barriers {e.g., ``barrier()``, ``rmb()``, ``wmb()``} need a
109
comment in the source code that explains the logic of what they are doing
110
and why.
111
112
-
26) If any ioctl's are added by the patch, then also update
113
``Documentation/userspace-api/ioctl/ioctl-number.rst``.
114
115
-
27) If your modified source code depends on or uses any of the kernel
116
APIs or features that are related to the following ``Kconfig`` symbols,
117
then test multiple builds with the related ``Kconfig`` symbols disabled
118
and/or ``=m`` (if that option is available) [not all of these at the
···
75
13) Has been build- and runtime tested with and without ``CONFIG_SMP`` and
76
``CONFIG_PREEMPT.``
77
78
+
14) All codepaths have been exercised with all lockdep features enabled.
79
80
+
15) All new ``/proc`` entries are documented under ``Documentation/``
81
82
+
16) All new kernel boot parameters are documented in
83
``Documentation/admin-guide/kernel-parameters.rst``.
84
85
+
17) All new module parameters are documented with ``MODULE_PARM_DESC()``
86
87
+
18) All new userspace interfaces are documented in ``Documentation/ABI/``.
88
See ``Documentation/ABI/README`` for more information.
89
Patches that change userspace interfaces should be CCed to
90
linux-api@vger.kernel.org.
91
92
+
19) Check that it all passes ``make headers_check``.
93
94
+
20) Has been checked with injection of at least slab and page-allocation
95
failures. See ``Documentation/fault-injection/``.
96
97
If the new code is substantial, addition of subsystem-specific fault
98
injection might be appropriate.
99
100
+
21) Newly-added code has been compiled with ``gcc -W`` (use
101
``make EXTRA_CFLAGS=-W``). This will generate lots of noise, but is good
102
for finding bugs like "warning: comparison between signed and unsigned".
103
104
+
22) Tested after it has been merged into the -mm patchset to make sure
105
that it still works with all of the other queued patches and various
106
changes in the VM, VFS, and other subsystems.
107
108
+
23) All memory barriers {e.g., ``barrier()``, ``rmb()``, ``wmb()``} need a
109
comment in the source code that explains the logic of what they are doing
110
and why.
111
112
+
24) If any ioctl's are added by the patch, then also update
113
``Documentation/userspace-api/ioctl/ioctl-number.rst``.
114
115
+
25) If your modified source code depends on or uses any of the kernel
116
APIs or features that are related to the following ``Kconfig`` symbols,
117
then test multiple builds with the related ``Kconfig`` symbols disabled
118
and/or ``=m`` (if that option is available) [not all of these at the
+7
-1
Documentation/process/submitting-patches.rst
+7
-1
Documentation/process/submitting-patches.rst
···
411
now, but you can do this to mark internal company procedures or just
412
point out some special detail about the sign-off.
413
414
415
When to use Acked-by:, Cc:, and Co-developed-by:
416
------------------------------------------------
···
452
have been included in the discussion.
453
454
Co-developed-by: states that the patch was co-created by multiple developers;
455
-
it is a used to give attribution to co-authors (in addition to the author
456
attributed by the From: tag) when several people work on a single patch. Since
457
Co-developed-by: denotes authorship, every Co-developed-by: must be immediately
458
followed by a Signed-off-by: of the associated co-author. Standard sign-off
···
411
now, but you can do this to mark internal company procedures or just
412
point out some special detail about the sign-off.
413
414
+
Any further SoBs (Signed-off-by:'s) following the author's SoB are from
415
+
people handling and transporting the patch, but were not involved in its
416
+
development. SoB chains should reflect the **real** route a patch took
417
+
as it was propagated to the maintainers and ultimately to Linus, with
418
+
the first SoB entry signalling primary authorship of a single author.
419
+
420
421
When to use Acked-by:, Cc:, and Co-developed-by:
422
------------------------------------------------
···
446
have been included in the discussion.
447
448
Co-developed-by: states that the patch was co-created by multiple developers;
449
+
it is used to give attribution to co-authors (in addition to the author
450
attributed by the From: tag) when several people work on a single patch. Since
451
Co-developed-by: denotes authorship, every Co-developed-by: must be immediately
452
followed by a Signed-off-by: of the associated co-author. Standard sign-off