Jonathan Corbet
212209cff8
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: 8d295fbad6 ("kernel-doc: better handle '::' sequences")
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-26 13:16:35 -06:00
Mauro Carvalho Chehab
8d295fbad6
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 >
2021-03-25 12:50:27 -06:00
Thorsten Leemhuis
4b9d49d1ec
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 >
2021-03-25 12:16:46 -06:00
Thorsten Leemhuis
9bc4430db5
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 >
2021-03-25 12:16:46 -06:00
Thorsten Leemhuis
4f08d7ab90
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 >
2021-03-25 12:16:46 -06:00
Thorsten Leemhuis
2dfa9eb0ff
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 >
2021-03-25 12:16:46 -06:00
Thorsten Leemhuis
613f969117
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 >
2021-03-25 12:16:46 -06:00
Wu XiangCheng
33282cc7cf
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 >
2021-03-25 11:53:39 -06:00
Wu XiangCheng
e54882ff38
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 >
2021-03-25 11:53:38 -06:00
Wu XiangCheng
2d15357100
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 >
2021-03-25 11:53:38 -06:00
Wu XiangCheng
b1b381e2c0
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 >
2021-03-25 11:53:38 -06:00
Wu XiangCheng
84dc0c20e8
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 >
2021-03-25 11:53:38 -06:00
Wu XiangCheng
d5d444d0ea
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 >
2021-03-25 11:53:38 -06:00
Bhaskar Chowdhury
1ccc4a39cc
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 >
2021-03-25 11:51:23 -06:00
Dan Carpenter
ee4b4c9f94
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 >
2021-03-25 11:49:40 -06:00
Bhaskar Chowdhury
1e528e9ea2
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 >
2021-03-25 11:48:31 -06:00
Dwaipayan Ray
3337c3a152
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 >
2021-03-25 11:47:42 -06:00
Wu XiangCheng
3501c960df
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 >
2021-03-25 11:45:54 -06:00
SeongJae Park
c3fa459b69
docs/kokr: make sections on bug reporting match practice
...
Translate this commit to Korean:
cf6d6fc279 ("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 >
2021-03-25 11:44:22 -06:00
Bryan Brattlof
2379d15a7c
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 >
2021-03-25 11:41:37 -06:00
Bhaskar Chowdhury
399bfc8b29
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 >
2021-03-25 11:38:51 -06:00
Gao Xiang
a8f2a68e42
Documentation: sysrq: update description about sysrq crash
...
After commit 8341f2f222 ("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 >
2021-03-15 14:23:21 -06:00
Jonathan Neuschäfer
3eca1cfbc1
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 >
2021-03-15 13:35:35 -06:00
Jiele zhao
0860b72d53
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 >
2021-03-15 13:32:32 -06:00
Geert Uytterhoeven
e3c2b1edd5
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 >
2021-03-15 13:26:21 -06:00