Billy Wilson [Thu, 6 Aug 2020 23:17:54 +0000 (17:17 -0600)]
docs: Correct the release date of 5.2 stable
A table lists the 5.2 stable release date as September 15, but it was
released on July 7. This may confuse a reader who is trying to
understand the stable update release cycle.
Kees Cook [Sat, 8 Aug 2020 07:14:36 +0000 (00:14 -0700)]
mailmap: Update comments for with format and more detalis
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.
Randy Dunlap [Mon, 10 Aug 2020 02:49:41 +0000 (19:49 -0700)]
Doc: admin-guide: use correct legends in kernel-parameters.txt
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc: optionally treat warnings as errors
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.
Julia Lawall [Sun, 26 Jul 2020 18:43:40 +0000 (20:43 +0200)]
docs: filesystems: vfs: correct flag name
There is no flag REMAP_CAN_SHORTEN. Commit eca3654e3cc7 ("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.
Julia Lawall [Sun, 26 Jul 2020 19:22:21 +0000 (21:22 +0200)]
docs: filesystems: vfs: correct sync_mode flag names
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.
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.
"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.
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.
Alex Shi [Mon, 13 Jul 2020 11:58:07 +0000 (19:58 +0800)]
doc/zh_CN: add Chinese translation prefer section
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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Alex Shi [Mon, 13 Jul 2020 11:58:06 +0000 (19:58 +0800)]
doc/zh_CN: add clearing-warn-once Chinese version
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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Alex Shi [Mon, 13 Jul 2020 11:58:05 +0000 (19:58 +0800)]
doc/zh_CN: add admin-guide index
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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Commit 95ca6d73a8a97 ("docs: move locking-specific documents to
locking/") accidentally replaced the selftests line for a duplicated
documentation one. Revert this change.
Julia Lawall [Sat, 18 Jul 2020 16:08:38 +0000 (18:08 +0200)]
docs: timers: drop documentation about LB_BIAS
The LB_BIAS feature was removed in commit 1c1b8a7b03ef ("sched/fair:
Replace source_load() & target_load() with weighted_cpuload()"), so drop
the mention that it is disabled in the no_hz case.
Changelog of commit dcda9b04713c ("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.
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
docs: staging/kprobes.rst: Move references to a separate appendix
Kprobes references are currently listed right after kretprobes example,
and appears to be part of the same section. Move this out to a separate
appendix for clarity.
docs: staging/kprobes.rst: Update some of the references
Some of the kprobes references are not valid anymore. Update the URLs to
point to their changed locations, where appropriate. Drop two URLs which
do not exist anymore.
docs: openrisc: Replace HTTP links with HTTPS ones
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
Replace HTTP links with HTTPS ones: 9P FILE SYSTEM
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
Replace HTTP links with HTTPS ones: AFS FILESYSTEM
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
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.
Randy Dunlap [Sat, 4 Jul 2020 03:44:57 +0000 (20:44 -0700)]
Documentation/driver-api: ntb: drop doubled word
Drop the doubled word "with".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Jon Mason <jdmason@kudzu.us> Cc: Dave Jiang <dave.jiang@intel.com> Cc: Allen Hubbe <allenbh@gmail.com> Cc: linux-ntb@googlegroups.com Link: https://lore.kernel.org/r/20200704034502.17199-13-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 7 Jul 2020 18:49:31 +0000 (11:49 -0700)]
Documentation: coda: annotate duplicated words
At first glance it appears that the coda.rst file contains doubled
words "name name" in two places. Turns out it is just confusing
(at least to me), so try to make it clear that the second 'name'
is just the name of a struct field/member.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Jan Harkes <jaharkes@cs.cmu.edu> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Jan Harkes <jaharkes@cs.cmu.edu> Cc: coda@cs.cmu.edu Cc: codalist@coda.cs.cmu.edu Link: https://lore.kernel.org/r/d7c2d274-de28-193f-5a98-9e3e16c6c9d5@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/features: Remove unicore32 from kcov and kmemleak
Commit 3839a7460721 ("Documentation/features: Add kcov") and
commit 4641961cff2f ("Documentation/features: Add kmemleak") were added
shortly after the unicore32 port was removed in commit fb37409a01b0
("arch: remove unicore32 port"). Remove the unicore32 feature lines from
kcov and kmemleak as well.
Randy Dunlap [Tue, 7 Jul 2020 18:04:10 +0000 (11:04 -0700)]
Documentation: s390/vfio-ap: eliminate duplicated word
Drop the doubled word "the".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Pierre Morel <pmorel@linux.ibm.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Tony Krowiak <akrowiak@linux.ibm.com> Cc: Pierre Morel <pmorel@linux.ibm.com> Cc: Halil Pasic <pasic@linux.ibm.com> Cc: linux-s390@vger.kernel.org Link: https://lore.kernel.org/r/20200707180414.10467-17-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 7 Jul 2020 18:04:09 +0000 (11:04 -0700)]
Documentation: powerpc/vas-api: eliminate duplicated word
Drop the doubled word "the".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Michael Ellerman <mpe@ellerman.id.au> Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org> Cc: Paul Mackerras <paulus@samba.org> Cc: linuxppc-dev@lists.ozlabs.org Link: https://lore.kernel.org/r/20200707180414.10467-16-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 7 Jul 2020 18:04:07 +0000 (11:04 -0700)]
Documentation: mips/ingenic-tcu: eliminate duplicated word
Drop the doubled word "to".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Paul Cercueil <paul@crapouillou.net> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Paul Cercueil <paul@crapouillou.net> Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de> Cc: linux-mips@vger.kernel.org Link: https://lore.kernel.org/r/20200707180414.10467-14-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 7 Jul 2020 18:04:06 +0000 (11:04 -0700)]
Documentation: maintainer-entry-profile: eliminate duplicated word
Drop the doubled word "have".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Dan Williams <dan.j.williams@intel.com> Link: https://lore.kernel.org/r/20200707180414.10467-13-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 7 Jul 2020 18:04:05 +0000 (11:04 -0700)]
Documentation: leds/ledtrig-transient: eliminate duplicated word
Drop the doubled word "for".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Jacek Anaszewski <jacek.anaszewski@gmail.com> Acked-by: Pavel Machek <pavel@ucw.cz> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Jacek Anaszewski <jacek.anaszewski@gmail.com> Cc: Pavel Machek <pavel@ucw.cz> Cc: Dan Murphy <dmurphy@ti.com> Cc: linux-leds@vger.kernel.org Link: https://lore.kernel.org/r/20200707180414.10467-12-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 7 Jul 2020 18:04:00 +0000 (11:04 -0700)]
Documentation: gpu/komeda-kms: eliminate duplicated word
Drop the doubled word "and".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: James Qian Wang <james.qian.wang@arm.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: James (Qian) Wang <james.qian.wang@arm.com> Cc: Liviu Dudau <liviu.dudau@arm.com> Cc: Mihail Atanassov <mihail.atanassov@arm.com> Cc: Mali DP Maintainers <malidp@foss.arm.com> Link: https://lore.kernel.org/r/20200707180414.10467-7-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 7 Jul 2020 18:03:58 +0000 (11:03 -0700)]
Documentation: kgdb: eliminate duplicated word
Drop the doubled word "driver".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Douglas Anderson <dianders@chromium.org> Acked-by: Daniel Thompson <daniel.thompson@linaro.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Jason Wessel <jason.wessel@windriver.com> Cc: Daniel Thompson <daniel.thompson@linaro.org> Cc: Douglas Anderson <dianders@chromium.org> Cc: kgdb-bugreport@lists.sourceforge.net Link: https://lore.kernel.org/r/20200707180414.10467-5-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
doc: yama: Swap HTTP for HTTPS and replace dead link
Replace one dead link for the same person's original presentation on the
topic and swap an HTTP URL with HTTPS. While here, linkify the text to
make it more readable when rendered.
Documentation/security-bugs: Explain why plain text is preferred
The security contact list gets regular reports contained in archive
attachments. This tends to add some back-and-forth delay in dealing with
security reports since we have to ask for plain text, etc.
Signed-off-by: Kees Cook <keescook@chromium.org> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Acked-by: Jiri Kosina <jkosina@suse.cz> Acked-by: Gustavo A. R. Silva <gustavoars@kernel.org> Acked-by: Will Deacon <will@kernel.org> Acked-by: Willy Tarreau <w@1wt.eu> Link: https://lore.kernel.org/r/202007091110.205DC6A9@keescook Signed-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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
docs: filesystems: Replace HTTP links with HTTPS ones
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
docs: driver-api: i3c: Replace HTTP links with HTTPS ones
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
kobject: documentation: Replace HTTP links with HTTPS ones
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 neither `\bgnu\.org/license`, nor `\bmozilla\.org/MPL\b`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.
projects / mirror_ubuntu-hirsute-kernel.git / log