- 31 Mar, 2021 1 commit
-
-
Masahiro Yamada authored
Commit 1a63f9cc ("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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 29 Mar, 2021 1 commit
-
-
Aditya Srivastava authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 26 Mar, 2021 1 commit
-
-
Jonathan Corbet authored
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: 8d295fba ("kernel-doc: better handle '::' sequences") Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 25 Mar, 2021 20 commits
-
-
Mauro Carvalho Chehab authored
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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Thorsten Leemhuis authored
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.infoSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Thorsten Leemhuis authored
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.infoSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Thorsten Leemhuis authored
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.infoSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Thorsten Leemhuis authored
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.infoSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Thorsten Leemhuis authored
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.infoSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Wu XiangCheng authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Wu XiangCheng authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Wu XiangCheng authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Wu XiangCheng authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Wu XiangCheng authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Wu XiangCheng authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Bhaskar Chowdhury authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Dan Carpenter authored
Change the spelling from "consistend" to "consistent". Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com> Link: https://lore.kernel.org/r/YFS5KV7ejNoZmt6H@mwandaSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Bhaskar Chowdhury authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Dwaipayan Ray authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Wu XiangCheng authored
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@mipcSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
SeongJae Park authored
Translate this commit to Korean: cf6d6fc2 ("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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Bryan Brattlof authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Bhaskar Chowdhury authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 15 Mar, 2021 7 commits
-
-
Gao Xiang authored
After commit 8341f2f2 ("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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jonathan Neuschäfer authored
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.netSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jiele zhao authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Geert Uytterhoeven authored
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.beSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Barry Song authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jonathan Corbet authored
Just put in the relevant file names and let automarkup handle the rest. Fixes: 550c8399 ("docs/zh_CN: Add zh_CN/admin-guide/README.rst") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-
Bhaskar Chowdhury authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 09 Mar, 2021 10 commits
-
-
Bhaskar Chowdhury authored
s/varibles/variables/ ...and remove leading spaces from a sentence. Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com> Acked-by: Joe Lawrence <joe.lawrence@redhat.com> Acked-by: Petr Mladek <pmladek@suse.com> Link: https://lore.kernel.org/r/20210305100923.3731-1-unixbhaskar@gmail.com [jc: performed suggested prepositional tweak] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-
Peter Xu authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Mauro Carvalho Chehab authored
Changeset f546ff0c ("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: f546ff0c ("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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Barry Song authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jonathan Neuschäfer authored
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Link: https://lore.kernel.org/r/20210301214722.2310911-1-j.neuschaefer@gmx.netSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yanteng Si authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yanteng Si authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yanteng Si authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yanteng Si authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Randy Dunlap authored
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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-