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
Barry Song
6bfef171d0
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 >
2021-03-15 13:17:40 -06:00
Jonathan Corbet
d0c4c07e7b
docs/zh_cn: Fix a couple of reference warnings
...
Just put in the relevant file names and let automarkup handle the rest.
Fixes: 550c8399d0 ("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 >
2021-03-15 13:10:53 -06:00
Bhaskar Chowdhury
fdebeae0d7
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 >
2021-03-15 13:03:25 -06:00
Bhaskar Chowdhury
a5907065ac
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 >
2021-03-08 17:25:16 -07:00
Peter Xu
1f7faca2f9
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 >
2021-03-08 17:20:53 -07:00
Mauro Carvalho Chehab
3b4c963243
docs: conf.py: adjust the LaTeX document output
...
Changeset f546ff0c0c ("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: f546ff0c0c ("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 >
2021-03-08 17:20:03 -07:00
Barry Song
00b072c011
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 >
2021-03-08 17:19:05 -07:00
Jonathan Neuschäfer
c44456f296
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 >
2021-03-08 17:17:48 -07:00
Yanteng Si
5af38859ef
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 >
2021-03-08 17:16:59 -07:00
Yanteng Si
b52e2a6e66
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 >
2021-03-08 17:16:59 -07:00
Yanteng Si
cb07e0977a
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 >
2021-03-08 17:16:59 -07:00
Yanteng Si
d619afd344
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 >
2021-03-08 17:16:59 -07:00
Randy Dunlap
8bd490e4fc
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 >
2021-03-08 17:15:37 -07:00
Randy Dunlap
5c1841152b
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 >
2021-03-08 17:15:36 -07:00
Randy Dunlap
365c6a3e0f
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 >
2021-03-08 17:15:36 -07:00
Randy Dunlap
338b660bff
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 >
2021-03-08 17:15:36 -07:00
Randy Dunlap
ebe14885ab
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 >
2021-03-08 17:15:36 -07:00
Randy Dunlap
a9600c9858
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 >
2021-03-08 17:15:36 -07:00
Randy Dunlap
61be51c1a6
input: Documentation: corrections for event-codes.rst
...
Fix hyphenation, typos, capitalization, and a referenced file name
(.txt -> .rst).
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-3-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:15:36 -07:00
Randy Dunlap
d1c34bb205
input: Documentation: corrections for input.rst
...
Fix grammar, punctuation, and spelling.
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-2-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:15:36 -07:00
Mauro Carvalho Chehab
0b54c2e34b
scripts/kernel-doc: ignore identifier on anonymous enums
...
When anonymous enums are used, the identifier is empty.
While, IMO, it should be avoided the usage of such enums,
adding support for it is not hard.
So, postpone the check for empty identifiers to happen
only at the dump phase.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/055ad57879f1b9381b90879e00f72fde1c3a5647.1614760910.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:10:24 -07:00
Martin Kepplinger
e85d92b3bc
Documentation: dynamic-debug-howto: fix example
...
dynamic debug is "expecting pairs of match-spec <value>" so the example
for all files of which the paths include "usb" there is "file" missing.
Signed-off-by: Martin Kepplinger <martin.kepplinger@puri.sm >
Link: https://lore.kernel.org/r/20210303091646.773111-1-martin.kepplinger@puri.sm
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:09:26 -07:00
Geert Uytterhoeven
459d7ed812
docs: driver-model: device: Add ATTRIBUTE_GROUPS() example
...
Add a paragraph about the ATTRIBUTE_GROUPS() helper macro, and use it in
the example. Retain the old description, as it is still useful in case
of multiple groups. Change the names of the group(s) structures, to
match the ATTRIBUTE_GROUPS() macro.
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be >
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Link: https://lore.kernel.org/r/20210303133845.3939403-3-geert+renesas@glider.be
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:06:56 -07:00
Geert Uytterhoeven
d944f0b115
docs: driver-model: device: Add DEVICE_ATTR_{RO,RW} examples
...
bus.rst, driver.rst, and hwmon-kernel-api.rst refer to the
DEVICE_ATTR_* macros for devices, but device.rst does not mention them.
Add a paragraph about these helper macros, and use them in the examples.
Retain the old description, as it is still useful for less common values
of mode. Change the names of the example "show" and "store" methods, to
match the expectations of the DEVICE_ATTR_* macros.
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be >
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Link: https://lore.kernel.org/r/20210303133845.3939403-2-geert+renesas@glider.be
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:06:56 -07:00
Wu XiangCheng
0e2c578cba
docs/zh_CN: Add zh_CN/admin-guide/unicode.rst
...
Add translation zh_CN/admin-guide/unicode.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/20210304080148.GA16612@mipc
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:02:38 -07:00
Wu XiangCheng
550c8399d0
docs/zh_CN: Add zh_CN/admin-guide/README.rst
...
Add translation zh_CN/admin-guide/README.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/20210304080131.GA16539@mipc
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 17:01:21 -07:00
hjh
4eba99315c
PATCH Documentation translations:translate sound/hd-audio/controls to chinese
...
Signed-off-by: hjh <huangjianghui@uniontech.com >
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com >
Link: https://lore.kernel.org/r/20210304094556.5858-1-huangjianghui@uniontech.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 16:54:05 -07:00
Aditya Srivastava
084aa00162
scripts: kernel-doc: fix attribute capture in function parsing
...
Currently, kernel-doc warns for function prototype parsing on the
presence of attributes "__attribute_const__" and "__flatten" in the
definition.
There are 166 occurrences in ~70 files in the kernel tree for
"__attribute_const__" and 5 occurrences in 4 files for "__flatten".
Out of 166, there are 3 occurrences in three different files with
"__attribute_const__" and a preceding kernel-doc; and, 1 occurrence in
./mm/percpu.c for "__flatten" with a preceding kernel-doc. All other
occurrences have no preceding kernel-doc.
Add support for "__attribute_const__" and "__flatten" attributes.
A quick evaluation by running 'kernel-doc -none' on kernel-tree reveals
that no additional warning or error has been added or removed by the fix.
Suggested-by: Lukas Bulwahn <lukas.bulwahn@gmail.com >
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com >
Link: https://lore.kernel.org/r/20210306113510.31023-1-yashsri421@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 16:04:20 -07:00
Wu XiangCheng
6dbc975f48
docs/zh_CN: Improve zh_CN/process/8.Conclusion.rst
...
Improve language and grammar of zh_CN/process/8.Conclusion.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn >
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com >
Link: https://lore.kernel.org/r/8311d04c5528442ecae241062fbb1a7eded0b4f6.1614920267.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 16:01:21 -07:00
Wu XiangCheng
dc4bdca8c3
docs/zh_CN: Improve zh_CN/process/7.AdvancedTopics
...
Improve language and grammar of zh_CN/process/7.AdvancedTopics.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn >
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com >
Link: https://lore.kernel.org/r/e1579cfc77eb0cc31fb7402e8742dbc364b9086e.1614920267.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 16:01:21 -07:00
Wu XiangCheng
1ba336902c
docs/zh_CN: Improve zh_CN/process/6.Followthrough
...
Improve language and grammar of zh_CN/process/6.Followthrough.rst
Signed-off-by: Wu XiangCheng <bobwxc@email.cn >
Reviewed-by: Alex Shi <alex.shi@linux.alibaba.com >
Link: https://lore.kernel.org/r/2024bbd647208fcb1c8b3db036e6f492bbdb2464.1614920267.git.bobwxc@email.cn
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-03-08 16:01:21 -07:00