Commit Graph

996300 Commits

Author SHA1 Message Date
eef8abdaed Documentation: input: joydev file corrections
Fix typos, grammar, punctuation in
Documentation/input/joydev/*.rst files.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Link: https://lore.kernel.org/r/20210429063137.20232-1-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-05-03 16:51:10 -06:00
6a79162fe5 docs: Fix typo in Documentation/x86/x86_64/5level-paging.rst
fix two typos in the documentation
(Documentation/x86/x86_64/5level-paging.rst), changing 'paing' for 'paging'
and using the right verbal form for plural on 'some vendors offer'.

Signed-off-by: Carlos Bilbao <bilbao@vt.edu>
Link: https://lore.kernel.org/r/2599991.mvXUDI8C0e@iron-maiden
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-04-27 13:03:30 -06:00
80342d484a kernel-doc: Add support for __deprecated
The current linux-next tree has a new error:

./Documentation/gpu/drm-mm:445: ./drivers/gpu/drm/drm_prime.c:994: WARNING: Error in declarator or parameters
Invalid C declaration: Expecting "(" in parameters. [error at 17]
  int __deprecated drm_prime_sg_to_page_array (struct sg_table *sgt, struct page **pages, int max_entries)
  -----------------^

While we might consider that documenting a deprecated interface is not
necessarily best practice, removing the error is easy.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>

Link: https://lore.kernel.org/r/20210427114828.GY235567@casper.infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-04-27 09:59:04 -06:00
441ca977a8 docs/zh_CN: add openrisc translation to zh_CN index
This patch add zh_CN/openrisc 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/162fb50638028c9b0a92a0ce5c53e691be0cfec2.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-04-20 16:08:15 -06:00
acc6a91a29 docs/zh_CN: add openrisc index.rst translation
This patch translates Documentation/openrisc/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/f3878525e0d5f94a9c541f5ec8fd31b44a6dc5cd.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-04-20 16:08:15 -06:00
30d0f7d7aa docs/zh_CN: add openrisc todo.rst translation
This patch translates Documentation/openrisc/todo.rst into Chinese.

Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Wu XiangCheng <bobwxc@email.cn>
Link: https://lore.kernel.org/r/daf5b352ba62a4737148d524bcae0e64756ed6da.1618568135.git.siyanteng@loongson.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-04-20 16:08:15 -06:00
3f59307f99 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>
2021-04-20 16:08:14 -06:00
aa93de2030 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>
2021-04-20 16:08:14 -06:00
6c5c146cd9 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>
2021-04-20 16:08:14 -06:00
b9b4c38315 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>
2021-04-20 16:08:14 -06:00
83d07650f5 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>
2021-04-20 16:08:14 -06:00
3e77439e69 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>
2021-04-20 16:08:14 -06:00
e8ebbdff7b 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>
2021-04-20 16:08:14 -06:00
b77e0ce62d 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>
2021-04-20 16:08:13 -06:00
e9dfeed251 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>
2021-04-15 16:01:50 -06:00
f9bbc12ccb 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>
2021-04-15 15:26:06 -06:00
9a18473cef 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>
2021-04-15 14:54:29 -06:00
c797997a24 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>
2021-04-15 14:53:02 -06:00
e5143657d9 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>
2021-04-15 14:50:59 -06:00
6161a4b18a 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>
2021-04-13 15:13:27 -06:00
ad4db83425 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>
2021-04-13 15:13:27 -06:00
511aaf2b32 doc:it_IT: align Italian documentation
Translation for the following patches

commit 7dfbea4c46 ("scripts: remove namespace.pl")
commit 1a63f9cce7 ("docs: Remove make headers_check from checklist")
commit 1e013ff7cb ("docs: Document cross-referencing using relative path")
commit 0be1511f51 ("Documentation: doc-guide: fixes to sphinx.rst")
commit 9113584012 ("kernel-doc: Fix example in Nested structs/unions")
commit 875f82cb37 ("Documentation/submitting-patches: Extend commit message layout description")
commit 78f101a1b2 ("Documentation/submitting-patches: Add blurb about backtraces in commit messages")
commit f0ea149eee ("docs: submitting-patches: Emphasise the requirement to Cc: stable when using Fixes: tag")
commit 05a5f51ca5 ("Documentation: Replace lkml.org links with lore")
commit 9bf19b78a2 ("Documentation/submitting-patches: Document the SoB chain")
commit b7592e5b82 ("docs: Remove the Microsoft rhetoric")
commit 26606ce072 ("coding-style.rst: Avoid comma statements")
commit dd58e64974 ("docs: Make syscalls' helpers naming consistent")
commit 460cd17e9f ("net: switch to the kernel.org patchwork instance")
commit 163ba35ff3 ("doc: use KCFLAGS instead of EXTRA_CFLAGS to pass flags from command line")
commit 0ef597c3ac ("docs: remove mention of ENABLE_MUST_CHECK")
commit f8408264c7 ("drivers: Remove CONFIG_OPROFILE support")
commit 0653c358d2 ("scsi: Drop gdth driver")
commit f8ae7bbec7 ("net: x25_asy: Delete the x25_asy driver")
commit cf6d6fc279 ("docs: process/howto.rst: make sections on bug reporting match practice")
commit da514157c4 ("docs: make reporting-bugs.rst obsolete")
commit 4f8af077a0 ("docs: Fix reST markup when linking to sections")
commit 3a4928cf5e ("Documentation: kernel-hacking: change 'current()' to 'current'")
commit c170f2eb96 ("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>
2021-04-13 15:08:55 -06:00
7eb33bdece docs/zh_CN: sync reporting-issues.rst
Sync zh translation reporting-issues.rst to
commit 58c539453b ("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>
2021-04-13 15:07:30 -06:00
e18f54f9bf 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>
2021-04-13 15:06:01 -06:00
febe6c2f85 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>
2021-04-13 15:06:01 -06:00
28418abdee 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>
2021-04-13 15:06:01 -06:00
0374bbba2d 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>
2021-04-13 15:06:01 -06:00
7e402ef571 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>
2021-04-13 15:06:00 -06:00
3a59151564 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>
2021-04-13 15:06:00 -06:00
bb17248373 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>
2021-04-13 15:06:00 -06:00
6349469a4f 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>
2021-04-13 15:00:37 -06:00
dfc7927d4e 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 a9e73211fb ("Fix a mistake sentence in the file 'Documentation/zh_CN/magic-number.txt'")
* last Reviewed-by at 2016-02-16
commit 45c73ea7a7 ("Documentation: Chinese translation of arm64/silicon-errata.txt")
* last Signed-off-by at 2019-03-13 (pick by Alex Shi)
commit 95dcdb6e12 ("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>
2021-04-08 11:45:12 -06:00
84de8154c5 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>
2021-04-08 11:41:22 -06:00
269dd42f47 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>
2021-04-08 11:39:34 -06:00
2061761e4b 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>
2021-04-08 11:39:34 -06:00
057e7eff6b 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>
2021-04-08 11:39:34 -06:00
b8dc02995a 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>
2021-04-08 11:39:33 -06:00
4d6687730d 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>
2021-04-08 11:39:33 -06:00
ffd1f19d08 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>
2021-04-08 11:39:33 -06:00
8b6d5ae8a9 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>
2021-04-08 11:39:33 -06:00
dde201b901 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>
2021-04-08 11:39:33 -06:00
d1ad0a7361 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>
2021-04-08 11:36:25 -06:00
1446e32235 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>
2021-04-08 11:19:43 -06:00
0e5e0a5553 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: 04c459d204 ("kconfig: remove oldnoconfig target")
Ref: 312ee68752 ("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>
2021-03-31 14:33:45 -06:00
c5c1c700e2 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>
2021-03-31 14:32:02 -06:00
8be594b22a 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>
2021-03-31 14:23:33 -06:00
1f287bc4e2 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>
2021-03-31 14:22:55 -06:00
2ae7bb570e 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>
2021-03-31 13:53:16 -06:00
c27c2e3441 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>
2021-03-31 13:53:16 -06:00
87ec9ea1fc 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>
2021-03-31 13:53:16 -06:00