Skip to content

Commit

Permalink
Merge tag 'docs-5.11-2' of git://git.lwn.net/linux
Browse files Browse the repository at this point in the history
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
  • Loading branch information
torvalds committed Dec 24, 2020
2 parents 555a6e8 + c635b0c commit 71c5f03
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 14 deletions.
2 changes: 1 addition & 1 deletion Documentation/admin-guide/sysctl/vm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ While most applications need less than a thousand maps, certain
programs, particularly malloc debuggers, may consume lots of them,
e.g., up to one or two maps per allocation.

The default value is 65536.
The default value is 65530.


memory_failure_early_kill:
Expand Down
24 changes: 12 additions & 12 deletions Documentation/process/submit-checklist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 7 additions & 1 deletion Documentation/process/submitting-patches.rst
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,12 @@ Some people also put extra tags at the end. They'll just be ignored for
now, but you can do this to mark internal company procedures or just
point out some special detail about the sign-off.

Any further SoBs (Signed-off-by:'s) following the author's SoB are from
people handling and transporting the patch, but were not involved in its
development. SoB chains should reflect the **real** route a patch took
as it was propagated to the maintainers and ultimately to Linus, with
the first SoB entry signalling primary authorship of a single author.


When to use Acked-by:, Cc:, and Co-developed-by:
------------------------------------------------
Expand Down Expand Up @@ -446,7 +452,7 @@ patch. This tag documents that potentially interested parties
have been included in the discussion.

Co-developed-by: states that the patch was co-created by multiple developers;
it is a used to give attribution to co-authors (in addition to the author
it is used to give attribution to co-authors (in addition to the author
attributed by the From: tag) when several people work on a single patch. Since
Co-developed-by: denotes authorship, every Co-developed-by: must be immediately
followed by a Signed-off-by: of the associated co-author. Standard sign-off
Expand Down

0 comments on commit 71c5f03

Please sign in to comment.