Without having first read the git-shortlog man-page, the format
of .mailmap may not be immediately obvious. Add comments with pointers
to the man-page, along with other details.
Signed-off-by: Kees Cook <keescook@chromium.org>
Link: https://lore.kernel.org/r/202008080013.58EBD83@keescookSigned-off-by: Jonathan Corbet <corbet@lwn.net>

"The capability fags" should be "The capability flags".

In rst markup, a incorrect markup expression is causing bad rendering in
Sphinx output. Replace the erroneous single quote by a backquote.
Signed-off-by: Remi Andruccioli <remi.andruccioli@gmail.com>
Link: https://lore.kernel.org/r/20200808163123.17643-1-remi.andruccioli@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Documentation/admin-guide/kernel-parameters.rst includes a legend
telling us what configurations or hardware platforms are relevant
for certain boot options.  For X86, it is spelled "X86" and for
x86_64, it is spelled "X86-64", so make corrections for those.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Borislav Petkov <bp@alien8.de>
Cc: x86@kernel.org
Link: https://lore.kernel.org/r/20200810024941.30231-1-rdunlap@infradead.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Support for these was added by the following commits:

  f2c9699f ("riscv: Add STACKPROTECTOR supported")
  3c469798 ("riscv: Enable LOCKDEP_SUPPORT & fixup TRACE_IRQFLAGS_SUPPORT").
  ed48b297 ("riscv: Enable context tracking")
  cbb3d91d ("riscv: Add kmemleak support")
Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Link: https://lore.kernel.org/r/20200810095000.32092-1-tklauser@distanz.chSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Modify coccinelle documentation to further clarify
the usage of the makefile C variable by coccicheck.
Signed-off-by: Sumera Priyadarsini <sylphrenadin@gmail.com>
Acked-by: Julia Lawall <julia.lawall@inria.fr>
Link: https://lore.kernel.org/r/20200811002350.5553-1-sylphrenadin@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Replace :c:func: with func() as the previous usage is deprecated.
Signed-off-by: Puranjay Mohan <puranjay12@gmail.com>
Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Link: https://lore.kernel.org/r/20200810183019.22170-1-puranjay12@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Replace :c:func: with func() as the previous usage is deprecated.
Signed-off-by: Puranjay Mohan <puranjay12@gmail.com>
Link: https://lore.kernel.org/r/20200810183613.25643-1-puranjay12@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Replace :c:func: with func() as the previous usage is deprecated.
Signed-off-by: Puranjay Mohan <puranjay12@gmail.com>
Link: https://lore.kernel.org/r/20200810184828.29297-1-puranjay12@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

emumerated -> enumerated
Signed-off-by: Bryan Brattlof <hello@bryanbrattlof.com>
Link: https://lore.kernel.org/r/87lfili2d8.fsf@bryanbrattlof.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

The kbuild bot recently added the W=1 option, which triggered
documentation cleanups to squelch hundreds of kernel-doc warnings.

To make sure new kernel contributions don't add regressions to
kernel-doc descriptors, this patch suggests an option to treat
warnings as errors in CI/automated tests.

A -Werror command-line option is added to the kernel-doc script. When
this option is set, the script will return the number of warnings
found. The caller can then treat this positive return value as an
error and stop the build.

Using this command line option is however not straightforward when the
kernel-doc script is called from other scripts. To align with typical
kernel compilation or documentation generation, the Werror option is
also set by checking the KCFLAGS environment variable, or if
KDOC_WERROR is defined, as in the following examples:

KCFLAGS="-Wall -Werror" make W=1 sound/
KCFLAGS="-Wall -Werror" make W=1 drivers/soundwire/
KDOC_WERROR=1 make htmldocs

Note that in the last example the documentation build does not stop,
only an additional log is provided.

Credits to Randy Dunlap for suggesting the use of environment variables.
Suggested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Link: https://lore.kernel.org/r/20200728162040.92467-1-pierre-louis.bossart@linux.intel.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Replace RTC_WKLAM_RD with RTC_WKALM_RD.
Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>

Link: https://lore.kernel.org/r/1596104250-32673-1-git-send-email-Julia.Lawall@inria.frSigned-off-by: Jonathan Corbet <corbet@lwn.net>

My Marvell account has been suspended, map the address to my private mail.
Signed-off-by: Alexander Lobakin <alobakin@pm.me>
Link: https://lore.kernel.org/r/9xzFiqHAFGYuKfUycRaCQSIgsqmeL9E9SA3lSoqOMUPhFVaAgSgvukCUWO7iRbjtiUrFjK46fhu7dJ5TaCv1EjaNFm5yF_H3y5S1s_QALCA=@pm.meSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Add cpu-load Chinese version and link it into admin-guide.
Based on Alex's recent thread:

  https://lkml.kernel.org/r/20200713115807.56362-1-alex.shi@linux.alibaba.comReviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Signed-off-by: Tao Zhou <ouwen210@hotmail.com>
Link: https://lore.kernel.org/r/BL0PR14MB37798BBF2307910DE73EF6D49A770@BL0PR14MB3779.namprd14.prod.outlook.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix typo "tis" -> "this".
Signed-off-by: Yue Hu <huyue2@yulong.com>
Link: https://lore.kernel.org/r/20200725022444.10976-1-zbestahu@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Commit 2165b82f ("docs: Move kprobes.rst from staging/ to trace/")
moved kprobes.rst, but missed to adjust the MAINTAINERS entry.

Hence, ./scripts/get_maintainer.pl --self-test=patterns complains:

  warning: no file matches    F:    Documentation/staging/kprobes.rst

Adjust the entry to the new file location.
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Acked-by: Naveen N. Rao <naveen.n.rao@linux.vnet.ibm.com>
Link: https://lore.kernel.org/r/20200726055843.10783-1-lukas.bulwahn@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Document rfkill allocation.
Signed-off-by: Pavel Machek (CIP) <pavel@denx.de>

Link: https://lore.kernel.org/r/20200726075327.GA25647@duo.ucw.czSigned-off-by: Jonathan Corbet <corbet@lwn.net>

RESOURCE_IO does not exist.  Rename to IORESOURCE_IO.
Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>

Link: https://lore.kernel.org/r/1595778455-12132-1-git-send-email-Julia.Lawall@inria.frSigned-off-by: Jonathan Corbet <corbet@lwn.net>

There is no flag REMAP_CAN_SHORTEN.  Commit eca3654e ("vfs: enable
remap callers that can handle short operations") that introduces this
text also introduces the flag REMAP_FILE_CAN_SHORTEN.  Change the name
in the documentation accordingly.
Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>
Fixes: eca3654e ("vfs: enable remap callers that can handle short operations")
Link: https://lore.kernel.org/r/1595789020-12941-1-git-send-email-Julia.Lawall@inria.frSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Change the nonexistent flag names WBC_SYNC_ALL and WBC_SYNC_NONE to
WB_SYNC_ALL and WB_SYNC_NONE, respectively, as used in the code with
wbc->sync_mode.
Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>

Link: https://lore.kernel.org/r/1595791341-13209-1-git-send-email-Julia.Lawall@inria.frSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Underscores were being used for emphasis, but these are rendered verbatim
in HTML output. reStructuredText uses asterisks for emphasis. I *think* I
caught all of them.
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Link: https://lore.kernel.org/r/20200727121525.28103-2-vegard.nossum@oracle.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

"xxx``at``" makes the `` appear verbatim in the HTML output. I've opted
for changing this into ``*at()`` to harmonise this with the use of * seen
later in the same document (and add the parentheses to clarify that this
is a system/function call).

``path_``* also makes `` appear in the HTML output, but we can fix it by
moving the * into the ``. Also add the parantheses here.
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Link: https://lore.kernel.org/r/20200727121525.28103-1-vegard.nossum@oracle.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Two cases of "<" somehow turned into "&lt;". I noticed it on
<https://www.kernel.org/doc/html/latest/filesystems/path-lookup.html>.

I've verified that the HTML output is correct with this patch.
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Link: https://lore.kernel.org/r/20200727114527.23944-1-vegard.nossum@oracle.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Rationale:
Reduces attack surface on kernel devs opening the links for MITM
as HTTPS traffic is much harder to manipulate.

Deterministic algorithm:
For each file:
  If not .svg:
    For each line:
      If doesn't contain `\bxmlns\b`:
        For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`:
          If both the HTTP and HTTPS versions
          return 200 OK and serve the same content:
            Replace HTTP with HTTPS.
Signed-off-by: Alexander A. Klimov <grandmaster@al2klimov.de>
Link: https://lore.kernel.org/r/20200714175528.46712-1-grandmaster@al2klimov.deSigned-off-by: Jonathan Corbet <corbet@lwn.net>

To make it a little clearer how to create a fixes tag,
add an example based on the preceeding gitconfig setup.
Signed-off-by: Tom Rix <trix@redhat.com>
Link: https://lore.kernel.org/r/20200710200115.21176-1-trix@redhat.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

The add words is:

Tranlation plan:
Welcome for any part of kernel doc Chinese translation, expecially for
admin-guide part.
Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Link: https://lore.kernel.org/r/20200713115807.56362-3-alex.shi@linux.alibaba.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

and link it into admin-guide.
Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Link: https://lore.kernel.org/r/20200713115807.56362-2-alex.shi@linux.alibaba.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Translate the admin-guide index.rst file into Chinese. and link it into
Chinese top index file.
Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Link: https://lore.kernel.org/r/20200713115807.56362-1-alex.shi@linux.alibaba.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Flag is __maybe_unused, not __maybe_used.

Cc: Federico Vaga <federico.vaga@vaga.pv.it>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: clang-built-linux@googlegroups.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200715122328.3882187-1-lee.jones@linaro.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Commit 95ca6d73 ("docs: move locking-specific documents to
locking/") accidentally replaced the selftests line for a duplicated
documentation one. Revert this change.
Signed-off-by: André Almeida <andrealmeid@collabora.com>
Fixes: 95ca6d73 ("docs: move locking-specific documents to locking/")
Link: https://lore.kernel.org/r/20200715131036.9692-1-andrealmeid@collabora.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

The LB_BIAS feature was removed in commit 1c1b8a7b ("sched/fair:
Replace source_load() & target_load() with weighted_cpuload()"), so drop
the mention that it is disabled in the no_hz case.
Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>

Link: https://lore.kernel.org/r/1595088518-28116-1-git-send-email-Julia.Lawall@inria.frSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix the following warning:

WARNING: Definition list ends without a blank line;
unexpected unindent.

By switching to the literal block syntax.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20200718165107.625847-8-dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix the following sphinx warning:

bpf_devel_QA.rst:444: WARNING: Unknown target name:
"documentation/bpf/btf.rst"

No target was defined for 'btf.rst' in the document. Fix it.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20200718165107.625847-6-dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix the following warning:

WARNING: toctree contains reference to nonexistent document
'process/unaligned-memory-access'

The path to the document was wrong.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20200718165107.625847-5-dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix the following warnings:

tee.rst:65: WARNING: Unexpected indentation.

tee.rst:69: WARNING: Block quote ends without a
blank line; unexpected unindent.

By switching to the 'definition list' syntax.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20200718165107.625847-4-dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix the following warning:

WARNING: toctree contains reference to nonexistent document
'admin-guide/mm/nommu-map'

This was due to a typo.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20200718165107.625847-1-dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix the following warning:

Documentation/admin-guide/pstore-blk.rst:
WARNING: document isn't included in any toctree

By adding 'pstore-blk.rst' to the index
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20200718165107.625847-9-dwlsalmeida@gmail.comAcked-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

Fix the following warning

Documentation/bpf/ringbuf.rst: WARNING: document isn't
included in any toctree

By adding it to the index.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20200718165107.625847-10-dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix the following warning:

Documentation/trace/histogram-design.rst:
WARNING: document isn't included in any toctree

By adding 'histogram-design.rst' to the index.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20200718165107.625847-12-dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix the following sphinx warning:

Documentation/watch_queue.rst:
WARNING: document isn't included in any toctree

By adding watch_queue.rst to the index.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20200718165107.625847-13-dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Changelog of commit dcda9b04 ("mm, tree wide: replace __GFP_REPEAT by
__GFP_RETRY_MAYFAIL with more useful semantic") has very nice description
of GFP flags that affect reclaim behaviour of the page allocator.

It would be pity to keep this description buried in the log so let's expose
it in the Documentation/ as well.

Cc: Michal Hocko <mhocko@suse.com>
Acked-by: Michal Hocko <mhocko@suse.com>
Signed-off-by: Mike Rapoport <rppt@linux.ibm.com>
Link: https://lore.kernel.org/r/20200719153641.231131-1-rppt@kernel.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>