Yanteng Si [Fri, 16 Apr 2021 10:32:31 +0000 (18:32 +0800)]
docs/zh_CN: add openrisc openrisc_port.rst translation
This patch tranlates Documentation/openrisc/openrisc_port.rst into Chinese
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/e116b3020dfd181c15a59ecf41673cd4dbeea3b2.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Fri, 16 Apr 2021 10:32:30 +0000 (18:32 +0800)]
docs/zh_CN: add core api translation to zh_CN index
This patch add zh_CN/core-api to zh_CN/index.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/f23ea90fe88a6ac34d29c6642abe9aceba7ccafb.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Fri, 16 Apr 2021 10:32:29 +0000 (18:32 +0800)]
docs/zh_CN: add core-api index.rst translation
This patch translates Documentation/core-api/index.rst into Chinese.
add Documentation/translations/zh_CN/core-api/irq/* to zh_CN/core-api/index.rst.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/d246fcd092111338d64f6b678dda2cd67fcb3f4a.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Fri, 16 Apr 2021 10:32:28 +0000 (18:32 +0800)]
docs/zh_CN: add core-api irq index.rst translation
This patch translates Documentation/core-api/irq/index.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/f6f2edfa645badfdd29122bee3ff0c9577197691.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Fri, 16 Apr 2021 10:32:27 +0000 (18:32 +0800)]
docs/zh_CN: add core-api irq irqflags-tracing.rst translation
This patch translates Documentation/core-api/irq/irqflags-tracing.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/deb4b3649d7001f7505672cf45813f0064c9a8d0.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Fri, 16 Apr 2021 10:32:26 +0000 (18:32 +0800)]
docs/zh_CN: add core-api irq irq-domain.rst translation
This patch translates Documentation/core-api/irq/irq-domain.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/86e44d36315228408c8bd97360041a9f59a85462.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Fri, 16 Apr 2021 10:32:25 +0000 (18:32 +0800)]
docs/zh_CN: add core-api irq irq-affinity.rst translation
This patch translates Documentation/core-api/irq/irq-affinity.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/d235db96434baf472441877fc8ffca0f6f70a9f5.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Fri, 16 Apr 2021 10:32:24 +0000 (18:32 +0800)]
docs/zh_CN: add core-api irq concepts.rst translation
This patch translates Documentation/core-api/irq/concepts.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/22babdd7e3fa5121360eff875d005ba5f4647e21.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Jonathan Corbet [Thu, 15 Apr 2021 22:01:50 +0000 (16:01 -0600)]
docs: sphinx-pre-install: don't barf on beta Sphinx releases
sphinx-pre-install is picky when it comes to parsing sphinx versions; it
failed when run with sphinx 4.0.0b1. Tweak the regex to tolerate a
trailing "bN" on the version number.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Aditya Srivastava [Wed, 14 Apr 2021 19:25:29 +0000 (00:55 +0530)]
scripts: kernel-doc: improve parsing for kernel-doc comments syntax
Currently kernel-doc does not identify some cases of probable kernel
doc comments, for e.g. pointer used as declaration type for identifier,
space separated identifier, etc.
Some example of these cases in files can be:
i)" * journal_t * jbd2_journal_init_dev() - creates and initialises a journal structure"
in fs/jbd2/journal.c
ii) "* dget, dget_dlock - get a reference to a dentry" in
include/linux/dcache.h
iii) " * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t"
in include/linux/seqlock.h
Also improve identification for non-kerneldoc comments. For e.g.,
i) " * The following functions allow us to read data using a swap map"
in kernel/power/swap.c does follow the kernel-doc like syntax, but the
content inside does not adheres to the expected format.
Improve parsing by adding support for these probable attempts to write
kernel-doc comment.
Suggested-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/lkml/87mtujktl2.fsf@meer.lwn.net
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Link: https://lore.kernel.org/r/20210414192529.9080-1-yashsri421@gmail.com
[ jc: fixed some line-length issues ]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Wed, 14 Apr 2021 03:34:37 +0000 (11:34 +0800)]
docs/zh_CN: two minor fixes in zh_CN/doc-guide/
zh_CN/doc-guide/kernel-doc.rst
replace a ref tag to solve docs-next warning
zh_CN/doc-guide/parse-headers.rst
fix an unperfect word
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/20210414033435.GA27907@bobwxc.top
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
David Gow [Thu, 15 Apr 2021 05:40:36 +0000 (22:40 -0700)]
Documentation: dev-tools: Add Testing Overview
The kernel now has a number of testing and debugging tools, and we've
seen a bit of confusion about what the differences between them are.
Add a basic documentation outlining the testing tools, when to use each,
and how they interact.
This is a pretty quick overview rather than the idealised "kernel
testing guide" that'd probably be optimal, but given the number of times
questions like "When do you use KUnit and when do you use Kselftest?"
are being asked, it seemed worth at least having something. Hopefully
this can form the basis for more detailed documentation later.
Signed-off-by: David Gow <davidgow@google.com>
Reviewed-by: Marco Elver <elver@google.com>
Reviewed-by: Daniel Latypov <dlatypov@google.com>
Link: https://lore.kernel.org/r/20210415054036.581117-1-davidgow@google.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Bernard Zhao [Thu, 15 Apr 2021 05:43:06 +0000 (13:43 +0800)]
docs/zh_CN: add translations in zh_CN/dev-tools/gcov
Add new zh translations
* zh_CN/dev-tools/gcov.rst
* zh_CN/dev-tools/index.rst
and link them to zh_CN/index.rst
Signed-off-by: Bernard Zhao <bernard@vivo.com>
Reviewed-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Reviewed-by: Fangrui Song <maskray@google.com>
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/20210415054304.GA26689@bobwxc.top
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Fri, 9 Apr 2021 11:47:24 +0000 (13:47 +0200)]
docs: reporting-issues: make people CC the regressions list
Make people CC the recently created mailing list dedicated to Linux
kernel regressions when reporting one. Some paragraphs had to be
reshuffled and slightly rewritten during the process, as the text
otherwise would have gotten unnecessarily hard to follow.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/ac28089d710d5d41f295221bc726555ba32f4984.1617967127.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Fri, 9 Apr 2021 11:47:23 +0000 (13:47 +0200)]
MAINTAINERS: add regressions mailing list
Add the newly created regression mailing list finally created after it
already had been agreed on during the maintainers summit 2017 (see
https://lwn.net/Articles/738216/ ). The topic was recently discussed
again, where an idea to create a broader list for all issues was
discussed, but Linus preferred a more targeted list:
https://lkml.kernel.org/r/CAHk-=wgiYqqLzsb9-UpfH+=ktk7ra-2fOsdc_ZJ7WF47wS73CA@mail.gmail.com/
Hence, the creation for that list was asked for and granted:
https://bugzilla.kernel.org/show_bug.cgi?id=212557
In the end it became regressions@lists.linux.dev instead of
linux-regressions@lists.linux.dev as 'Linux' would have been redundant
in the latter case.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/ecf1f0125399c5242ff213b827eacc6f93af3172.1617967127.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Federico Vaga [Fri, 9 Apr 2021 22:41:04 +0000 (00:41 +0200)]
doc:it_IT: align Italian documentation
Translation for the following patches
commit
7dfbea4c468c ("scripts: remove namespace.pl")
commit
1a63f9cce7b7 ("docs: Remove make headers_check from checklist")
commit
1e013ff7cb54 ("docs: Document cross-referencing using relative path")
commit
0be1511f516e ("Documentation: doc-guide: fixes to sphinx.rst")
commit
911358401284 ("kernel-doc: Fix example in Nested structs/unions")
commit
875f82cb374b ("Documentation/submitting-patches: Extend commit message layout description")
commit
78f101a1b258 ("Documentation/submitting-patches: Add blurb about backtraces in commit messages")
commit
f0ea149eee6b ("docs: submitting-patches: Emphasise the requirement to Cc: stable when using Fixes: tag")
commit
05a5f51ca566 ("Documentation: Replace lkml.org links with lore")
commit
9bf19b78a203 ("Documentation/submitting-patches: Document the SoB chain")
commit
b7592e5b82db ("docs: Remove the Microsoft rhetoric")
commit
26606ce072d4 ("coding-style.rst: Avoid comma statements")
commit
dd58e649742a ("docs: Make syscalls' helpers naming consistent")
commit
460cd17e9f7d ("net: switch to the kernel.org patchwork instance")
commit
163ba35ff371 ("doc: use KCFLAGS instead of EXTRA_CFLAGS to pass flags from command line")
commit
0ef597c3ac49 ("docs: remove mention of ENABLE_MUST_CHECK")
commit
f8408264c77a ("drivers: Remove CONFIG_OPROFILE support")
commit
0653c358d2dc ("scsi: Drop gdth driver")
commit
f8ae7bbec726 ("net: x25_asy: Delete the x25_asy driver")
commit
cf6d6fc27936 ("docs: process/howto.rst: make sections on bug reporting match practice")
commit
da514157c4f0 ("docs: make reporting-bugs.rst obsolete")
commit
4f8af077a02e ("docs: Fix reST markup when linking to sections")
commit
3a4928cf5e3c ("Documentation: kernel-hacking: change 'current()' to 'current'")
commit
c170f2eb9648 ("docs: Document cross-referencing between documentation pages")
Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Link: https://lore.kernel.org/r/20210409224104.30471-1-federico.vaga@vaga.pv.it
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Tue, 13 Apr 2021 07:29:36 +0000 (15:29 +0800)]
docs/zh_CN: sync reporting-issues.rst
Sync zh translation reporting-issues.rst to
commit
58c539453b71 ("docs: reporting-issues: reduce quoting and assorted
fixes")
Drop reporting-bug.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/20210413072934.GA2674@bobwxc.top
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Tue, 13 Apr 2021 07:13:39 +0000 (15:13 +0800)]
docs/zh_CN: Link zh_CN/doc-guide to zh_CN/index.rst
Add zh_CN/doc-guide entry in zh_CN/index.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/8738b39c1b54e15477a937c861f114165a8c0648.1618295149.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Tue, 13 Apr 2021 07:13:26 +0000 (15:13 +0800)]
docs/zh_CN: Add translation zh_CN/doc-guide/index.rst
Add new translation
Documentation/translations/zh_CN/doc-guide/index.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/4a01400c3d65b2f7eb1c1bebd3a0e102ed29208f.1618295149.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Tue, 13 Apr 2021 07:13:13 +0000 (15:13 +0800)]
docs/zh_CN: Add translation zh_CN/doc-guide/maintainer-profile.rst
Add new translation
Documentation/translations/zh_CN/doc-guide/maintainer-profile.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/0ea1acfd30e8a0f2676981100e27513178cde06b.1618295149.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Tue, 13 Apr 2021 07:12:58 +0000 (15:12 +0800)]
docs/zh_CN: Add translation zh_CN/doc-guide/contributing.rst
Add new translation
Documentation/translations/zh_CN/doc-guide/contributing.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/3c48979277abe63d1d157c7eb9187d32380db42a.1618295149.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Tue, 13 Apr 2021 07:12:21 +0000 (15:12 +0800)]
docs/zh_CN: Add translation zh_CN/doc-guide/parse-headers.rst
Add new translation
Documentation/translations/zh_CN/doc-guide/parse-headers.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/81d98cf80325ff3b1c4145965bc7d05ddb2b3c49.1618295149.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Tue, 13 Apr 2021 07:12:07 +0000 (15:12 +0800)]
docs/zh_CN: Add translation zh_CN/doc-guide/kernel-doc.rst
Add new translation
Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/783d134b1dd18f580f2c0511c2330382a86e79b5.1618295149.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Tue, 13 Apr 2021 07:11:16 +0000 (15:11 +0800)]
docs/zh_CN: Add translation zh_CN/doc-guide/sphinx.rst
Add new translation
Documentation/translations/zh_CN/doc-guide/sphinx.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/7c8c2eeb6c0b73410fbdb66cf702dc0e58b02a3e.1618295149.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Borislav Petkov [Tue, 13 Apr 2021 11:38:34 +0000 (13:38 +0200)]
Documentation/submitting-patches: Document RESEND tag on patches
Explain when a submitter should tag a patch or a patch series with the
"RESEND" tag.
This has been partially carved out from a tip subsystem handbook
patchset by Thomas Gleixner:
https://lkml.kernel.org/r/
20181107171010.
421878737@linutronix.de
and incorporates follow-on comments.
Signed-off-by: Borislav Petkov <bp@suse.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Mon, 29 Mar 2021 15:15:53 +0000 (23:15 +0800)]
doc/zh_CN: Clean zh_CN translation maintainer
Remove Harry Wei and <xiyoulinuxkernelgroup@googlegroups.com> from
MAINTAINERS Chinese Translation.
According to git logs, Harry Wei (aka WeiWei Jia)
* last submitted at 2012-05-07
commit
a9e73211fb0f ("Fix a mistake sentence in the file 'Documentation/zh_CN/magic-number.txt'")
* last Reviewed-by at 2016-02-16
commit
45c73ea7a785 ("Documentation: Chinese translation of arm64/silicon-errata.txt")
* last Signed-off-by at 2019-03-13 (pick by Alex Shi)
commit
95dcdb6e125f ("docs/zh_CN: rename magic-numbers as rst doc")
According to mail list archives, Harry Wei
* last replied at 2016-02-15
<https://lore.kernel.org/lkml/CAD+1EGPFdoD7HHZYfEWVvmesXXG27n=6KmEZ8=B6nrvb+oaLZA@mail.gmail.com/>
* last appeared at 2018-05-12
<https://lore.kernel.org/lkml/CA+scX6kYH8Y9_f1PLcMHG-MD9bhXgd4gGpkJanjzvwwj9L=aOQ@mail.gmail.com/>
He/She did not maintain zh_CN translations for a long time.
<xiyoulinuxkernelgroup@googlegroups.com> is a maillist for Linux group of
Xi'an University of Posts and Telecommunications, not special for zh_CN
translation work.
Anyway, many thanks him/her and Xiyou for their contributions to the early
Chinese translation work!
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/20210329151551.GA10901@mipc
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Masanari Iida [Fri, 2 Apr 2021 07:05:14 +0000 (16:05 +0900)]
tools: Fix a typo in kernel-chktaint
This patch fixes a spelling typo in kernel-chktaint
Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20210402070514.336376-1-standby24x7@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Tue, 6 Apr 2021 07:02:39 +0000 (15:02 +0800)]
docs/zh_CN: add riscv to zh_CN index
All the files in the riscv directory have been translated into
Chinese and it is time to add them to the zh_CN index.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/20210406070239.19910-9-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Tue, 6 Apr 2021 07:02:38 +0000 (15:02 +0800)]
docs/zh_CN: add iio to zh_CN index
All the files in the iio directory have been translated into
Chinese and it is time to add them to the zh_CN index.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/20210406070239.19910-8-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Tue, 6 Apr 2021 07:02:37 +0000 (15:02 +0800)]
docs/zh_CN: add mips to zh_CN index
All the files in the mips directory have been translated into
Chinese and it is time to add them to the zh_CN index.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/20210406070239.19910-7-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Tue, 6 Apr 2021 07:02:36 +0000 (15:02 +0800)]
docs/zh_CN: add cpu-freq to zh_CN index
All the files in the cpu-freq directory have been translated into
Chinese and it is time to add them to the zh_CN index.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/20210406070239.19910-6-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Tue, 6 Apr 2021 07:02:35 +0000 (15:02 +0800)]
docs/zh_CN: add cpu-freq index.rst translation
This patch translates Documention/cpu-freq/index.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/20210406070239.19910-5-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Tue, 6 Apr 2021 07:02:34 +0000 (15:02 +0800)]
docs/zh_CN: add cpu-freq cpufreq-stats.rst translation
This patch translates Documention/cpu-freq/cpufreq-stats.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/20210406070239.19910-4-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Tue, 6 Apr 2021 07:02:33 +0000 (15:02 +0800)]
docs/zh_CN: add cpu-freq cpu-drivers.rst translation
This patch translates Documention/cpu-freq/cpu-drivers.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/20210406070239.19910-3-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Tue, 6 Apr 2021 07:02:32 +0000 (15:02 +0800)]
docs/zh_CN: add cpu-freq core.rst translation
This patch translates Documention/cpu-freq/core.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Link: https://lore.kernel.org/r/20210406070239.19910-2-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Stéphane Blondon [Tue, 6 Apr 2021 12:31:50 +0000 (14:31 +0200)]
docs: Minor spelling fix in spi documentation
Signed-off-by: Stéphane Blondon <stephane.blondon@gmail.com>
Link: https://lore.kernel.org/r/CAOy+up7EdTf4ouh5onVy_ZzXFWGBEP+P6CPqY-=E+1UFwCeq8w@mail.gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Sat, 3 Apr 2021 11:37:54 +0000 (19:37 +0800)]
docs/gcov: Convert two tags to ref in dev-tools/gov.rst
Htmldocs does not display the chapter number, convert the two manual
chapter number tags to ref tags.
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Acked-by: Peter Oberparleiter <oberpar@linux.ibm.com>
Link: https://lore.kernel.org/r/20210403113752.GA32236@mipc
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Ismael Luceno [Wed, 31 Mar 2021 16:35:41 +0000 (18:35 +0200)]
docs: reporting-issues: Remove reference to oldnoconfig
Replace it with olddefconfig. oldnoconfig didn't do what the document
suggests (it aliased to olddefconfig), and isn't available since 4.19.
Ref:
04c459d20448 ("kconfig: remove oldnoconfig target")
Ref:
312ee68752fa ("kconfig: announce removal of oldnoconfig if used")
Signed-off-by: Ismael Luceno <ismael@iodev.co.uk>
Link: https://lore.kernel.org/r/20210331163541.28356-1-ismael@iodev.co.uk
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wang Qing [Mon, 15 Mar 2021 09:49:03 +0000 (17:49 +0800)]
doc: admin-guide: remove explanation of "watchdog/%u"
"watchdog/%u" threads has be replaced by cpu_stop_work,
which will mislead the reader.
Signed-off-by: Wang Qing <wangqing@vivo.com>
Link: https://lore.kernel.org/r/1615801744-31548-1-git-send-email-wangqing@vivo.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Thu, 18 Mar 2021 02:52:26 +0000 (19:52 -0700)]
Documentation: filesystems api-summary: add namespace.c
Add fs/namespace.c to the filesystems api-summary docbook.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210318025227.4162-2-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Thu, 18 Mar 2021 02:52:25 +0000 (19:52 -0700)]
fs/namespace: correct/improve kernel-doc notation
Fix kernel-doc warnings in fs/namespace.c:
./fs/namespace.c:1379: warning: Function parameter or member 'm' not described in 'may_umount_tree'
./fs/namespace.c:1379: warning: Excess function parameter 'mnt' description in 'may_umount_tree'
./fs/namespace.c:1950: warning: Function parameter or member 'path' not described in 'clone_private_mount'
Also convert path_is_mountpoint() comments to kernel-doc.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Allegedly-acked-by: Al Viro <viro@zeniv.linux.org.uk>
Link: https://lore.kernel.org/r/20210318025227.4162-1-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mauro Carvalho Chehab [Thu, 25 Mar 2021 10:38:27 +0000 (11:38 +0100)]
scripts: get_abi: ignore code blocks for cross-references
The script should not generate cross-references inside
literal blocks.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/a590f994f8a5742db333bde69e88241a080e4fe0.1616668017.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mauro Carvalho Chehab [Thu, 25 Mar 2021 10:38:26 +0000 (11:38 +0100)]
scripts: get_abi.pl: parse description line per line
Change the description parsing logic in rst mode in order
to parse it line per line.
The end result is the same, but doing line per line allows
to add some code to escape literal blocks when seeking for
cross-references.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/d33cfa2e59ecf8f28d4ed7de7402468cf2168921.1616668017.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mauro Carvalho Chehab [Thu, 25 Mar 2021 10:38:25 +0000 (11:38 +0100)]
scripts: get_abi.pl: extend xref match to other types
Currently, there are "What:" symbols for more than just
/sys.
Extend the regex to also cover configfs, /proc /dev and /kvd
symbols.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/a1c7e2b2c37ed6e111dfc8641deb37ed96375a63.1616668017.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mauro Carvalho Chehab [Thu, 25 Mar 2021 10:38:24 +0000 (11:38 +0100)]
get_abi.pl: fix xref boundaries
There are some issues with the regex that seeks for What:
cross references: basically, it is mis-identifying the start
and the end boundaries of the regex, which causes :ref: to
be inseerted for the wrong symbols at the wrong places.
Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/79a14d2518499b76931b5f29c50979987108152d.1616668017.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mauro Carvalho Chehab [Thu, 25 Mar 2021 10:38:23 +0000 (11:38 +0100)]
get_abi.pl: seek for all occurrences for Documentation/ABI
Instead of retrieving just one match at most, ensure that the entire
description will be parsed.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/17019b73e106d1b1b353b8880ed189bad3604c13.1616668017.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mauro Carvalho Chehab [Thu, 25 Mar 2021 10:38:22 +0000 (11:38 +0100)]
scripts: get_abi.pl: better handle escape chars on what:
The parser for the symbols defined on What: doesn't cover all
chars that need to be scaped, like '{' and '}'. Change the logic
to be more generic, and ensure that the same regex will be used
on both What: and when parsing the cross-references.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/29cb56def89b508fe605bcd2ba74a4376cc08e35.1616668017.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Alex Shi [Fri, 26 Mar 2021 08:49:31 +0000 (16:49 +0800)]
Docs/zh_CN: update Alex Shi new email address
I am leaving Alibaba, udpate the old email address to new one.
Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Alex Shi <alexs@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Link: https://lore.kernel.org/r/1616748571-52058-2-git-send-email-alex.shi@linux.alibaba.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Alex Shi [Fri, 26 Mar 2021 08:49:30 +0000 (16:49 +0800)]
mailmap: update email address for Alex Shi
Add my kernel.org address for old email address.
Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Kees Cook <keescook@chromium.org>
Cc: Leon Romanovsky <leon@kernel.org>
Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
Cc: Alexander Lobakin <alobakin@pm.me>
Cc: linux-kernel@vger.kernel.org
Link: https://lore.kernel.org/r/1616748571-52058-1-git-send-email-alex.shi@linux.alibaba.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
He Ying [Fri, 26 Mar 2021 10:08:53 +0000 (06:08 -0400)]
docs: powerpc: Fix misspellings and grammar errors
Reported-by: Hulk Robot <hulkci@huawei.com>
Signed-off-by: He Ying <heying24@huawei.com>
Acked-by: Michael Ellerman <mpe@ellerman.id.au>
Link: https://lore.kernel.org/r/20210326100853.173586-1-heying24@huawei.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mark O'Donovan [Sun, 28 Mar 2021 15:28:37 +0000 (16:28 +0100)]
Documentation: Add leading slash to some paths
Change multiple sys/xyz to /sys/xyz
Signed-off-by: Mark O'Donovan <shiftee@posteo.net>
Link: https://lore.kernel.org/r/20210328152837.73347-1-shiftee@posteo.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Tue, 30 Mar 2021 14:13:07 +0000 (16:13 +0200)]
docs: reporting-issues: reduce quoting and assorted fixes
A pile of small fixes:
- don't quote terms like vanilla, mainline, and stable, unless in they
occur in places where readers new to the kernel might see them for the
first time
- make people rule out that vendor patches are interfering if they face
a regression in a stable or longterm kernel they saw in a vendor
kernel for the first time
- s/bugs/issues/ in a selected spots
- exchange two headlines that got mixed up somehow
- add a few links to some of the steps in the guide
- Greg mentioned sending reports to the stable mailing list is
sufficient, so remove the "CC stable maintainers" bits
- fix a few typos and mistakes in the text, with a few very small
improvements along the way
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/07bca15d8465b8e234537feb8841dd2ff20243bc.1617113469.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Tue, 30 Mar 2021 14:13:06 +0000 (16:13 +0200)]
docs: reporting-issues.rst: reshuffle and improve TLDR
Make the TLDR a bit shorter while improving it at the same time by going
straight to the aspects readers are more interested it. The change makes
the process especially more straight-forward for people that hit a
regression in a stable or longterm kernel. Due to the changes the TLDR
now also matches the step by step guide better.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/762ccd7735315d2fdaa79612fccc1f474881118b.1617113469.git.linux@leemhuis.info
[ jc: fixed transposed _` as noted by Thorsten ]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Tue, 30 Mar 2021 14:13:05 +0000 (16:13 +0200)]
MAINTAINERS: add entry for Documentation/admin-guide/reporting-issues.rst
Thorsten will keep an eye on the new document about reporting issues
(aka bugs).
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/c8d55ec74d104b90fdb9c155bca3b407e8480fb3.1617113469.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Tue, 30 Mar 2021 14:13:04 +0000 (16:13 +0200)]
docs: make reporting-issues.rst official and delete reporting-bugs.rst
Remove the WIP and two FIXME notes in the text to make it official, as
it's now considered fully ready for consumption. To make sure this
step is okay for people the intent of this change and the latest version
of the text were posted to ksummit-discuss; nobody complained, thus
lets move ahead.
Add a footer to point out people can contact Thorsten directly in case
they find something to improve in the text.
Dear reporting-bugs.rst, I'm sorry to tell you, but that makes you fully
obsolete and we thus have to let you go now. Thank you very much for
your service, you in one form or another have been around for a long
time. I'm sure over the years you got read a lot and helped quite a few
people. But it's time to retire now. Rest in peace.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
CC: Harry Wei <harryxiyou@gmail.com>
CC: Alex Shi <alex.shi@linux.alibaba.com>
CC: Federico Vaga <federico.vaga@vaga.pv.it>
CC: Greg KH <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/49c674c2d304d87e6259063580fda05267e8c348.1617113469.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Masahiro Yamada [Tue, 2 Mar 2021 14:18:22 +0000 (23:18 +0900)]
docs: Remove make headers_check from checklist in translations
Commit
1a63f9cce7b7 ("docs: Remove make headers_check from checklist")
fixed only the English version.
Let's fix the translated variants too.
Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
Link: https://lore.kernel.org/r/20210302141822.504773-1-masahiroy@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Aditya Srivastava [Mon, 29 Mar 2021 09:29:45 +0000 (14:59 +0530)]
scripts: kernel-doc: add warning for comment not following kernel-doc syntax
Currently, kernel-doc start parsing the comment as a kernel-doc comment if
it starts with '/**', but does not take into account if the content inside
the comment too, adheres with the expected format.
This results in unexpected and unclear warnings for the user.
E.g., running scripts/kernel-doc -none mm/memcontrol.c emits:
"mm/memcontrol.c:961: warning: expecting prototype for do not fallback to current(). Prototype was for get_mem_cgroup_from_current() instead"
Here kernel-doc parses the corresponding comment as a kernel-doc comment
and expects prototype for it in the next lines, and as a result causing
this warning.
Provide a clearer warning message to the users regarding the same, if the
content inside the comment does not follow the kernel-doc expected format.
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Link: https://lore.kernel.org/r/20210329092945.13152-1-yashsri421@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Jonathan Corbet [Fri, 26 Mar 2021 19:16:35 +0000 (13:16 -0600)]
docs: kernel-doc: properly recognize parameter lines with colons
The previous attempt to properly handle literal blocks broke parsing of
parameter lines containing colons; fix it by tweaking the regex to
specifically exclude the "::" pattern while accepting lines containing
colons in general. Add a little documentation to the regex while in the
neighborhood.
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Fixes:
8d295fbad687 ("kernel-doc: better handle '::' sequences")
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mauro Carvalho Chehab [Thu, 25 Mar 2021 18:14:25 +0000 (19:14 +0100)]
kernel-doc: better handle '::' sequences
Right now, if one of the following headers end with a '::', the
kernel-doc script will do the wrong thing:
description|context|returns?|notes?|examples?
The real issue is with examples, as people could try to write
something like:
example::
/* Some C code */
and this won't be properly evaluated. So, improve the regex
to not catch '\w+::' regex for the above identifiers.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/2cf44cf1fa42588632735d4fbc8e84304bdc235f.1616696051.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Fri, 19 Mar 2021 19:27:49 +0000 (20:27 +0100)]
docs: reporting-issues.rst: improved process esp. for stable regressions
Provide a shorter and easier process for users that deal with
regressions in stable and longterm kernels, as those should be reported
quickly.
To realize this in the least-confusing way and without having steps
multiple times in different places, split the 'search for existing
reports' into two. That has the additinal benefit that users will search
for them quickly when going through the step by step guide and thus will
save them trouble if the find reports.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
CC: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/d934c15e536bceeff5c40a126930ddf803548e08.1616181657.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Fri, 19 Mar 2021 19:27:48 +0000 (20:27 +0100)]
docs: reporting-issues.rst: duplicate sections for reviewing purposes
This duplicates two section to make the diff in the next patch a bit
easier to gasp for humans.
Straight copy, no content changes.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/ef85edc8466f035eb243dd6629429ad4fd0565d8.1616181657.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Fri, 19 Mar 2021 19:27:47 +0000 (20:27 +0100)]
docs: reporting-issues.rst: reorder some steps
Reorder some steps where the order in which the readers perform them is
not crucial. This is a preparation for a later change that would make
the text much more complex otherwise.
Content just moved, not changed at all in the process.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/8dfc58efde25a05ccf9bf85929826c4b1b9e09c5.1616181657.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Fri, 19 Mar 2021 19:27:46 +0000 (20:27 +0100)]
docs: reporting-issues.rst: tone down 'test vanilla mainline' a little
Tell users that reporting bugs with vendor kernels which are only
slightly patched can be okay in some situations, but point out there's a
risk in doing so.
Adjust some related sections to make them compatible and a bit clearer.
At the same time make them less daunting: we want users to report bugs,
even if they can't test vanilla mainline kernel.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
CC: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/652ee20eb36228f5d7ca842299faa4cb472feedb.1616181657.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thorsten Leemhuis [Fri, 19 Mar 2021 19:27:45 +0000 (20:27 +0100)]
docs: reporting-issues.rst: fix small typos and style issues
Fix a typo and change "head over" to "scroll down", as suggested by Jon
when reviewing another patch that used the phrase the same way.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/fb845d2f1db6138337203bbfac419c04b5f28053.1616181657.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Thu, 18 Mar 2021 07:20:48 +0000 (15:20 +0800)]
docs/zh_CN: Add zh_CN/admin-guide/init.rst
Add translation zh_CN/admin-guide/init.rst, and link it to
zh_CN/admin-guide/index.rst while clean its todo entry.
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/cd2fd8d0ea2ad50afc6bd2abe15eba73b6c7940c.1616050069.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Thu, 18 Mar 2021 07:20:29 +0000 (15:20 +0800)]
docs/zh_CN: Add zh_CN/admin-guide/tainted-kernels.rst
Add translation zh_CN/admin-guide/tainted-kernels.rst, and link it to
zh_CN/admin-guide/index.rst while clean its todo entry.
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/189f2403ad168dafb4d5e50847c235064a2acaad.1616050069.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Thu, 18 Mar 2021 07:20:11 +0000 (15:20 +0800)]
docs/zh_CN: Add zh_CN/admin-guide/security-bugs.rst
Add translation zh_CN/admin-guide/security-bugs.rst, and link it to
zh_CN/admin-guide/index.rst while clean its todo entry.
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/f4210d304fa3f0b2a6e9eb798f63bf2e267231a0.1616050069.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Thu, 18 Mar 2021 07:19:58 +0000 (15:19 +0800)]
docs/zh_CN: Add zh_CN/admin-guide/bug-hunting.rst
Add translation zh_CN/admin-guide/bug-hunting.rst, and link it to
zh_CN/admin-guide/index.rst while clean its todo entry.
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/dad9f26205e9cae7254ed21c796688851ca5ebfd.1616050069.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Thu, 18 Mar 2021 07:19:39 +0000 (15:19 +0800)]
docs/zh_CN: Add zh_CN/admin-guide/bug-bisect.rst
Add translation zh_CN/admin-guide/bug-bisect.rst, and link it to
zh_CN/admin-guide/index.rst while clean its todo entry.
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/b9106f76fdc8e20ce4fcd43aec499f00df411610.1616050069.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Thu, 18 Mar 2021 07:19:17 +0000 (15:19 +0800)]
docs/zh_CN: Add zh_CN/admin-guide/reporting-issues
Add translation zh_CN/admin-guide/reporting-issues.rst, and link it to
zh_CN/admin-guide/index.rst.
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/13d126d5a210988728c76398436c62f1fb25fb0c.1616050069.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Bhaskar Chowdhury [Fri, 19 Mar 2021 01:58:48 +0000 (07:28 +0530)]
docs: filesystems: Fix a mundane typo
s/provisoned/provisioned/
Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: OGAWA Hirofumi <hirofumi@mail.parknet.co.jp>
Link: https://lore.kernel.org/r/20210319015848.19515-1-unixbhaskar@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Dan Carpenter [Fri, 19 Mar 2021 14:46:01 +0000 (17:46 +0300)]
Documentation: megaraid: fix spelling "consistend" => "consistent"
Change the spelling from "consistend" to "consistent".
Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
Link: https://lore.kernel.org/r/YFS5KV7ejNoZmt6H@mwanda
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Bhaskar Chowdhury [Mon, 22 Mar 2021 06:22:37 +0000 (11:52 +0530)]
docs: powerpc: Fix a typo
s/struture/structure/
Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20210322062237.2971314-1-unixbhaskar@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Dwaipayan Ray [Mon, 22 Mar 2021 08:21:39 +0000 (13:51 +0530)]
docs: document all error message types in checkpatch
All the error message types now have a verbose description.
Also there are two new groups of message types:
- Macros, Attributes and Symbols
- Functions and Variables
Rearrange the message types to fit these new groups as needed.
Signed-off-by: Dwaipayan Ray <dwaipayanray1@gmail.com>
Reviewed-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Link: https://lore.kernel.org/r/20210322082139.33822-1-dwaipayanray1@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Wu XiangCheng [Tue, 23 Mar 2021 09:16:52 +0000 (17:16 +0800)]
docs/zh_CN: Add translations in zh_CN/kernel-hacking/
Add new translations
* Documentation/translations/zh_CN/kernel-hacking/index.rst
* Documentation/translations/zh_CN/kernel-hacking/hacking.rst
And link them to zh_CN/index.rst.
Signed-off-by: Wu XiangCheng <bobwxc@email.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/20210323091651.GA23904@mipc
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
SeongJae Park [Mon, 8 Mar 2021 07:57:01 +0000 (08:57 +0100)]
docs/kokr: make sections on bug reporting match practice
Translate this commit to Korean:
cf6d6fc27936 ("docs: process/howto.rst: make sections on bug reporting match practice")
Signed-off-by: SeongJae Park <sjpark@amazon.de>
Link: https://lore.kernel.org/r/20210308075701.23411-1-sj38.park@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Bryan Brattlof [Tue, 23 Mar 2021 14:55:59 +0000 (14:55 +0000)]
Documentation: gpio: chip should be plural
Signed-off-by: Bryan Brattlof <hello@bryanbrattlof.com>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Link: https://lore.kernel.org/r/20210323145509.139393-1-hello@bryanbrattlof.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Bhaskar Chowdhury [Wed, 24 Mar 2021 08:00:46 +0000 (13:30 +0530)]
docs: rbtree.rst: Fix a typo
s/maintanence/maintenance/
Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20210324080046.20709-1-unixbhaskar@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Gao Xiang [Tue, 9 Mar 2021 19:15:50 +0000 (03:15 +0800)]
Documentation: sysrq: update description about sysrq crash
After commit
8341f2f222d7 ("sysrq: Use panic() to force a crash"),
a crash was not generated by dereferencing a NULL pointer anymore.
Let's update documentation as well to make it less misleading.
Signed-off-by: Gao Xiang <hsiangkao@redhat.com>
Cc: Matthias Kaehlcke <mka@chromium.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Zefan Li <lizefan.x@bytedance.com>
Link: https://lore.kernel.org/r/20210309191550.3955601-1-hsiangkao@redhat.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Jonathan Neuschäfer [Fri, 12 Mar 2021 15:28:03 +0000 (16:28 +0100)]
docs: Group arch-specific documentation under "CPU Architectures"
To declutter the top-level table of contents (the side bar), this
patch reduces the architecture-specfic documentation to one top-level
item, "CPU Architectures".
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Link: https://lore.kernel.org/r/20210312152804.2110703-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Jiele zhao [Mon, 8 Mar 2021 02:03:58 +0000 (02:03 +0000)]
security/loadpin: Update the changing interface in the source code.
Loadpin cmdline interface "enabled" has been renamed to "enforce"
for a long time, but the User Description Document was not updated.
(Meaning unchanged)
And kernel_read_file* were moved from linux/fs.h to its own
linux/kernel_read_file.h include file. So update that change here.
Signed-off-by: Jiele zhao <unclexiaole@gmail.com>
Link: https://lore.kernel.org/r/20210308020358.102836-1-unclexiaole@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Geert Uytterhoeven [Tue, 9 Mar 2021 13:06:50 +0000 (14:06 +0100)]
docs: dt: submitting-patches: Fix grammar in subsystem section
Reword the subsystem bindings section to make sense, from a grammatical
point of view.
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20210309130650.2318419-1-geert+renesas@glider.be
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Barry Song [Tue, 23 Feb 2021 00:32:30 +0000 (13:32 +1300)]
Documentation/features: mark BATCHED_UNMAP_TLB_FLUSH doesn't apply to ARM64
BATCHED_UNMAP_TLB_FLUSH is used on x86 to do batched tlb shootdown by
sending one IPI to TLB flush all entries after unmapping pages rather
than sending an IPI to flush each individual entry.
On arm64, tlb shootdown is done by hardware. Flush instructions are
innershareable. The local flushes are limited to the boot (1 per CPU)
and when a task is getting a new ASID.
So marking this feature as "TODO" is not proper. ".." isn't good as
well. So this patch adds a "N/A" for this kind of features which are
not needed on some architectures.
Signed-off-by: Barry Song <song.bao.hua@hisilicon.com>
Acked-by: Will Deacon <will@kernel.org>
Cc: Mel Gorman <mgorman@suse.de>
Cc: Andy Lutomirski <luto@kernel.org>
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
Link: https://lore.kernel.org/r/20210223003230.11976-1-song.bao.hua@hisilicon.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Jonathan Corbet [Mon, 15 Mar 2021 19:10:53 +0000 (13:10 -0600)]
docs/zh_cn: Fix a couple of reference warnings
Just put in the relevant file names and let automarkup handle the rest.
Fixes:
550c8399d017 ("docs/zh_CN: Add zh_CN/admin-guide/README.rst")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Bhaskar Chowdhury [Sat, 13 Mar 2021 06:10:29 +0000 (11:40 +0530)]
docs: admin-guide: cgroup-v1: Fix typos in the file memory.rst
s/overcommited/overcommitted/
s/Overcommiting/Overcommitting/
Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20210313061029.28024-1-unixbhaskar@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Bhaskar Chowdhury [Fri, 5 Mar 2021 10:09:23 +0000 (15:39 +0530)]
docs: livepatch: Fix a typo and remove the unnecessary gaps in a sentence
s/varibles/variables/
...and remove leading spaces from a sentence.
Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
Acked-by: Joe Lawrence <joe.lawrence@redhat.com>
Acked-by: Petr Mladek <pmladek@suse.com>
Link: https://lore.kernel.org/r/20210305100923.3731-1-unixbhaskar@gmail.com
[jc: performed suggested prepositional tweak]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Peter Xu [Tue, 2 Mar 2021 00:06:46 +0000 (19:06 -0500)]
docs: filesystem: Update smaps vm flag list to latest
We've missed a few documentation when adding new VM_* flags. Add the missing
pieces so they'll be in sync now.
Signed-off-by: Peter Xu <peterx@redhat.com>
Link: https://lore.kernel.org/r/20210302000646.432358-1-peterx@redhat.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mauro Carvalho Chehab [Wed, 3 Mar 2021 15:58:00 +0000 (16:58 +0100)]
docs: conf.py: adjust the LaTeX document output
Changeset
f546ff0c0c07 ("Move our minimum Sphinx version to 1.7")
cleaned up some compatibility issues with previous Sphinx
versions, but it also dropped the PDF margin sets.
Without that, the media documentation won't build fine, as
the margins are too wide to display texts with monospaced
fonts.
While here, align the "latex_elements = {" values, and add
a few other sphinxsetup configs in order to allow Sphinx to
wrap long lines on literal blocks.
Fixes:
f546ff0c0c07 ("Move our minimum Sphinx version to 1.7")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Documentation/conf.py | 31 +++++++++++++++++++------------
1 file changed, 19 insertions(+), 12 deletions(-)
Link: https://lore.kernel.org/r/911fbac185dd09c7df715cf4153361b81f04b7ad.1614787053.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Barry Song [Tue, 2 Mar 2021 08:41:59 +0000 (21:41 +1300)]
Documentation/admin-guide: kernel-parameters: correct the architectures for numa_balancing
X86 isn't the only architecture supporting NUMA_BALANCING. ARM64, PPC,
S390 and RISCV also support it:
arch$ git grep NUMA_BALANCING
arm64/Kconfig: select ARCH_SUPPORTS_NUMA_BALANCING
arm64/configs/defconfig:CONFIG_NUMA_BALANCING=y
arm64/include/asm/pgtable.h:#ifdef CONFIG_NUMA_BALANCING
powerpc/configs/powernv_defconfig:CONFIG_NUMA_BALANCING=y
powerpc/configs/ppc64_defconfig:CONFIG_NUMA_BALANCING=y
powerpc/configs/pseries_defconfig:CONFIG_NUMA_BALANCING=y
powerpc/include/asm/book3s/64/pgtable.h:#ifdef CONFIG_NUMA_BALANCING
powerpc/include/asm/book3s/64/pgtable.h:#ifdef CONFIG_NUMA_BALANCING
powerpc/include/asm/book3s/64/pgtable.h:#endif /* CONFIG_NUMA_BALANCING */
powerpc/include/asm/book3s/64/pgtable.h:#ifdef CONFIG_NUMA_BALANCING
powerpc/include/asm/book3s/64/pgtable.h:#endif /* CONFIG_NUMA_BALANCING */
powerpc/include/asm/nohash/pgtable.h:#ifdef CONFIG_NUMA_BALANCING
powerpc/include/asm/nohash/pgtable.h:#endif /* CONFIG_NUMA_BALANCING */
powerpc/platforms/Kconfig.cputype: select ARCH_SUPPORTS_NUMA_BALANCING
riscv/Kconfig: select ARCH_SUPPORTS_NUMA_BALANCING
riscv/include/asm/pgtable.h:#ifdef CONFIG_NUMA_BALANCING
s390/Kconfig: select ARCH_SUPPORTS_NUMA_BALANCING
s390/configs/debug_defconfig:CONFIG_NUMA_BALANCING=y
s390/configs/defconfig:CONFIG_NUMA_BALANCING=y
s390/include/asm/pgtable.h:#ifdef CONFIG_NUMA_BALANCING
x86/Kconfig: select ARCH_SUPPORTS_NUMA_BALANCING if X86_64
x86/include/asm/pgtable.h:#ifdef CONFIG_NUMA_BALANCING
x86/include/asm/pgtable.h:#endif /* CONFIG_NUMA_BALANCING */
On the other hand, setup_numabalancing() is implemented in mm/mempolicy.c
which doesn't depend on architectures.
Signed-off-by: Barry Song <song.bao.hua@hisilicon.com>
Reviewed-by: Palmer Dabbelt <palmerdabbelt@google.com>
Acked-by: Palmer Dabbelt <palmerdabbelt@google.com>
Cc: Mel Gorman <mgorman@suse.de>
Cc: Paul Walmsley <paul.walmsley@sifive.com>
Cc: Palmer Dabbelt <palmer@dabbelt.com>
Cc: Albert Ou <aou@eecs.berkeley.edu>
Cc: "Paul E. McKenney" <paulmck@kernel.org>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Viresh Kumar <viresh.kumar@linaro.org>
Cc: Mike Kravetz <mike.kravetz@oracle.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: https://lore.kernel.org/r/20210302084159.33688-1-song.bao.hua@hisilicon.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Jonathan Neuschäfer [Mon, 1 Mar 2021 21:47:21 +0000 (22:47 +0100)]
docs: kvm: Fix a typo ("althought")
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Link: https://lore.kernel.org/r/20210301214722.2310911-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Sun, 28 Feb 2021 19:10:54 +0000 (03:10 +0800)]
docs/zh_CN: add riscv index.rst translation
This patch translates Documentation/riscv/index.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/20210228191054.6048-5-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Sun, 28 Feb 2021 19:10:53 +0000 (03:10 +0800)]
docs/zh_CN: add riscv pmu.rst translation
This patch translates Documentation/riscv/pmu.rst into Chinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/20210228191054.6048-4-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Sun, 28 Feb 2021 19:10:52 +0000 (03:10 +0800)]
docs/zh_CN: add riscv patch-acceptance.rst translation
This patch translates Documentation/riscv/patch-acceptance.rst into Chineae.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/20210228191054.6048-3-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Yanteng Si [Sun, 28 Feb 2021 19:10:51 +0000 (03:10 +0800)]
docs/zh_CN:add riscv boot-image-header.rst translation
This patch translates Documentation/riscv/boot-image-header.rst intoChinese.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com>
Link: https://lore.kernel.org/r/20210228191054.6048-2-siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 2 Mar 2021 22:35:23 +0000 (14:35 -0800)]
input: Documentation: corrections for uinput.rst
Fix a typo (supportinf -> supporting).
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210302223523.20130-9-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 2 Mar 2021 22:35:22 +0000 (14:35 -0800)]
input: Documentation: corrections for input-programming.rst
Drop a repeated word.
Fix punctuation of "eg." to "e.g."
Fix punctuation of "ie" to "i.e."
Add hyphentation to non-zero.
Capitalize PM (for Power Management).
Capitalize ID (for Identifier).
Change "," in a run-on sentence to ";".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210302223523.20130-8-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 2 Mar 2021 22:35:21 +0000 (14:35 -0800)]
input: Documentation: corrections for notifier.rst
Add 'ledstate' to the keyboard_notifier_param struct info and tell
which header file contains that struct.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210302223523.20130-7-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 2 Mar 2021 22:35:20 +0000 (14:35 -0800)]
input: Documentation: corrections for multi-touch-protocol.rst
Correct hyphenation, spelling, and capitalization.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Henrik Rydberg <rydberg@bitmath.org>
Link: https://lore.kernel.org/r/20210302223523.20130-6-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 2 Mar 2021 22:35:19 +0000 (14:35 -0800)]
input: Documentation: corrections for gameport-programming.rst
Use "E.g." instead of "Eg.".
Use correct index for buttons[] array.
Update all of struct gameport's descriptions.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20210302223523.20130-5-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Randy Dunlap [Tue, 2 Mar 2021 22:35:18 +0000 (14:35 -0800)]
input: Documentation: update related file names in ff.rst
Change other related documentation file names from .txt to .rst
and be more explicit about their paths/locations.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: linux-input@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Johann Deneux <johann.deneux@gmail.com>
Cc: Anssi Hannula <anssi.hannula@gmail.com>
Link: https://lore.kernel.org/r/20210302223523.20130-4-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>