summaryrefslogtreecommitdiff
AgeCommit message (Collapse)AuthorFilesLines
2021-04-15docs/zh_CN: two minor fixes in zh_CN/doc-guide/Wu XiangCheng2-3/+2
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-15Documentation: dev-tools: Add Testing OverviewDavid Gow2-0/+121
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-15docs/zh_CN: add translations in zh_CN/dev-tools/gcovBernard Zhao3-0/+300
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-14docs: reporting-issues: make people CC the regressions listThorsten Leemhuis1-20/+35
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-14MAINTAINERS: add regressions mailing listThorsten Leemhuis1-0/+5
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-14doc:it_IT: align Italian documentationFederico Vaga10-72/+154
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>
2021-04-14docs/zh_CN: sync reporting-issues.rstWu XiangCheng1-362/+428
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>
2021-04-14docs/zh_CN: Link zh_CN/doc-guide to zh_CN/index.rstWu XiangCheng1-0/+1
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-14docs/zh_CN: Add translation zh_CN/doc-guide/index.rstWu XiangCheng1-0/+27
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-14docs/zh_CN: Add translation zh_CN/doc-guide/maintainer-profile.rstWu XiangCheng1-0/+43
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-14docs/zh_CN: Add translation zh_CN/doc-guide/contributing.rstWu XiangCheng1-0/+238
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-14docs/zh_CN: Add translation zh_CN/doc-guide/parse-headers.rstWu XiangCheng1-0/+187
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-14docs/zh_CN: Add translation zh_CN/doc-guide/kernel-doc.rstWu XiangCheng1-0/+500
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-14docs/zh_CN: Add translation zh_CN/doc-guide/sphinx.rstWu XiangCheng1-0/+415
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-14Documentation/submitting-patches: Document RESEND tag on patchesBorislav Petkov1-0/+10
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-08doc/zh_CN: Clean zh_CN translation maintainerWu XiangCheng1-2/+0
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>
2021-04-08tools: Fix a typo in kernel-chktaintMasanari Iida1-1/+1
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-08docs/zh_CN: add riscv to zh_CN indexYanteng Si1-0/+1
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-08docs/zh_CN: add iio to zh_CN indexYanteng Si1-0/+1
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-08docs/zh_CN: add mips to zh_CN indexYanteng Si1-0/+1
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-08docs/zh_CN: add cpu-freq to zh_CN indexYanteng Si1-0/+1
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-08docs/zh_CN: add cpu-freq index.rst translationYanteng Si1-0/+45
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-08docs/zh_CN: add cpu-freq cpufreq-stats.rst translationYanteng Si1-0/+130
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-08docs/zh_CN: add cpu-freq cpu-drivers.rst translationYanteng Si1-0/+259
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-08docs/zh_CN: add cpu-freq core.rst translationYanteng Si1-0/+105
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-08docs: Minor spelling fix in spi documentationStéphane Blondon1-1/+1
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-08docs/gcov: Convert two tags to ref in dev-tools/gov.rstWu XiangCheng1-2/+6
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-03-31docs: reporting-issues: Remove reference to oldnoconfigIsmael Luceno1-2/+1
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>
2021-03-31doc: admin-guide: remove explanation of "watchdog/%u"Wang Qing1-20/+0
"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-31Documentation: filesystems api-summary: add namespace.cRandy Dunlap1-0/+3
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-31fs/namespace: correct/improve kernel-doc notationRandy Dunlap1-6/+8
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-31scripts: get_abi: ignore code blocks for cross-referencesMauro Carvalho Chehab1-0/+19
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-31scripts: get_abi.pl: parse description line per lineMauro Carvalho Chehab1-21/+28
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-31scripts: get_abi.pl: extend xref match to other typesMauro Carvalho Chehab1-1/+1
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-31get_abi.pl: fix xref boundariesMauro Carvalho Chehab1-4/+9
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>
2021-03-31get_abi.pl: seek for all occurrences for Documentation/ABIMauro Carvalho Chehab1-1/+1
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>
2021-03-31scripts: get_abi.pl: better handle escape chars on what:Mauro Carvalho Chehab1-2/+3
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>
2021-03-31Docs/zh_CN: update Alex Shi new email addressAlex Shi2-2/+2
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>
2021-03-31mailmap: update email address for Alex ShiAlex Shi1-2/+3
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>
2021-03-31docs: powerpc: Fix misspellings and grammar errorsHe Ying9-11/+11
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>
2021-03-31Documentation: Add leading slash to some pathsMark O'Donovan4-18/+18
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>
2021-03-31docs: reporting-issues: reduce quoting and assorted fixesThorsten Leemhuis1-34/+45
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>
2021-03-31docs: reporting-issues.rst: reshuffle and improve TLDRThorsten Leemhuis1-40/+35
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>
2021-03-31MAINTAINERS: add entry for Documentation/admin-guide/reporting-issues.rstThorsten Leemhuis1-0/+6
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>
2021-03-31docs: make reporting-issues.rst official and delete reporting-bugs.rstThorsten Leemhuis3-242/+10
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>
2021-03-31docs: Remove make headers_check from checklist in translationsMasahiro Yamada3-21/+15
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>
2021-03-30scripts: kernel-doc: add warning for comment not following kernel-doc syntaxAditya Srivastava1-4/+13
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>
2021-03-26docs: kernel-doc: properly recognize parameter lines with colonsJonathan Corbet1-1/+7
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>
2021-03-25kernel-doc: better handle '::' sequencesMauro Carvalho Chehab1-1/+1
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>
2021-03-25docs: reporting-issues.rst: improved process esp. for stable regressionsThorsten Leemhuis1-267/+168
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>
generated by cgit v1.2.3 (git 2.39.0) at 2024-12-25 02:53:20 +0300