- 18 Aug, 2023 5 commits
-
-
Jonathan Corbet authored
Commit 3e327154 ("vfs: get rid of old '->iterate' directory operation") removed the iterate() file_operations member, but neglected to clean up the associated documentation. Get rid of the leftovers. Link: https://lore.kernel.org/r/874jl945bv.fsf@meer.lwn.netReviewed-by: Christian Brauner <brauner@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jonathan Corbet authored
It is common for university researchers to want to poll the community with online surveys, but that approach distracts developers while yielding little in the way of useful data. Encourage alternatives instead. Co-developed-by: Dan Williams <dan.j.williams@intel.com> Signed-off-by: Dan Williams <dan.j.williams@intel.com> Reviewed-by: Christian Brauner <brauner@kernel.org> Reviewed-by: Kees Cook <keescook@chromium.org> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/87il9v7u55.fsf@meer.lwn.net
-
Costa Shulyupin authored
and fix all in-tree references. Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Signed-off-by: Costa Shulyupin <costa.shul@redhat.com> Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230725043835.2249678-1-costa.shul@redhat.com
-
Costa Shulyupin authored
and fix all in-tree references. Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Signed-off-by: Costa Shulyupin <costa.shul@redhat.com> Acked-by: Huacai Chen <chenhuacai@loongson.cn> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230717192456.453124-1-costa.shul@redhat.com
-
Usama Arif authored
1GB HugeTLB page consists of 262144 base pages. Signed-off-by: Usama Arif <usama.arif@bytedance.com> Reviewed-by: David Hildenbrand <david@redhat.com> Acked-by: Mike Rapoport (IBM) <rppt@kernel.org> Acked-by: Muchun Song <songmuchun@bytedance.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230207114456.2304801-1-usama.arif@bytedance.com
-
- 31 Jul, 2023 5 commits
-
-
Randy Dunlap authored
Sort the list of kernel build options and hardware support options. Add a comment that the list should be kept sorted instead of having new options inserted willy nilly. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230725174247.32393-1-rdunlap@infradead.org
-
Krzysztof Pawlaczyk authored
Commit e55b9f96 ("mm: memcontrol: drop dead CONFIG_MEMCG_SWAP config symbol") removed MEMCG_SWAP as it was just a shorthand for CONFIG_MEMCG && CONFIG_SWAP. The commit also adjusted the documentation but missed reference to CONFIG_MEM_RES_CTRL_SWAP, which was the previous name of CONFIG_MEMCG_SWAP before renaming in commit c255a458 ("memcg: rename config variables"). Update the reference to the current state. Signed-off-by: Krzysztof Pawlaczyk <krzpaw@gmail.com> Reviewed-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230728105723.251892-1-krzpaw@gmail.com
-
Ramazan Safiullin authored
Commit 2ce7135a ("psi: cgroup support") adds documentation which refers to CONFIG_CGROUP, but the correct name is CONFIG_CGROUPS. Correct the reference to CONFIG_CGROUPS. Co-developed-by: Sabina Trendota <sabinatrendota@gmail.com> Signed-off-by: Sabina Trendota <sabinatrendota@gmail.com> Signed-off-by: Ramazan Safiullin <ram.safiullin2001@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230728115600.231068-1-ram.safiullin2001@gmail.com
-
SeongJae Park authored
Some links are still using 'http://'. Replace those with 'https://'. Signed-off-by: SeongJae Park <sj@kernel.org> Reviewed-by: Kees Cook <keescook@chromium.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230728211616.59550-2-sj@kernel.org
-
SeongJae Park authored
Two update links for NFS-utils are in two duplicate sessions. Consolidate. Signed-off-by: SeongJae Park <sj@kernel.org> Reviewed-by: Kees Cook <keescook@chromium.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230728211616.59550-1-sj@kernel.org
-
- 21 Jul, 2023 10 commits
-
-
Carlos Bilbao authored
Change target `make htmldocs` to combine RST Sphinx and the generation of Rust documentation, when support is available and .config exists. Reviewed-by: Akira Yokosawa <akiyks@gmail.com> Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230718151534.4067460-3-carlos.bilbao@amd.com
-
Carlos Bilbao authored
Generate rustdoc documentation with the rest of subsystem's documentation in Documentation/output. Add a cross reference to the generated rustdoc in Documentation/rust/index.rst if Sphinx target rustdoc is set. Reviewed-by: Akira Yokosawa <akiyks@gmail.com> Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230718151534.4067460-2-carlos.bilbao@amd.com
-
Randy Dunlap authored
Move 'panic_print' to its correct place in alphabetical order. Add parameter format for 'pause_on_oops'. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230715034811.9665-1-rdunlap@infradead.org
-
Costa Shulyupin authored
to make the page more organized as requested Signed-off-by: Costa Shulyupin <costa.shul@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230715165736.74816-1-costa.shul@redhat.com
-
Randy Dunlap authored
Put the arm64 kernel-parameters entries into alphabetical order. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Catalin Marinas <catalin.marinas@arm.com> Cc: Will Deacon <will@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230715235105.17966-1-rdunlap@infradead.org
-
Jonathan Corbet authored
The literal blocks in this file lacked the necessary blank line at the top, causing Sphinx to complain: /Documentation/ABI/testing/sysfs-bus-nvdimm:11: WARNING: Unexpected indentation. Add the lines it's longing for and bring about a bit of warning peace. Reported-by: Hu Haowen <src.res.211@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-
Avadhut Naik authored
Translate Documentation/process/contribution-maturity-model.rst into Spanish Signed-off-by: Avadhut Naik <avadhut.naik@amd.com> Reviewed-by: Carlos Bilbao <carlos.bilbao@amd.com> [ jc: fix added warning for nonexistent ref ] Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230717181602.3468421-1-avadhut.naik@amd.com
-
Jakub Kicinski authored
We appear to have a gap in our process docs. We go into detail on how to contribute code to the kernel, and how to be a subsystem maintainer. I can't find any docs directed towards the thousands of small scale maintainers, like folks maintaining a single driver or a single network protocol. Document our expectations and best practices. I'm hoping this doc will be particularly useful to set expectations with HW vendors. Reviewed-by: Andrew Lunn <andrew@lunn.ch> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org> Reviewed-by: Mark Brown <broonie@kernel.org> Reviewed-by: Leon Romanovsky <leonro@nvidia.com> Signed-off-by: Jakub Kicinski <kuba@kernel.org> Reviewed-by: Simon Horman <simon.horman@corigine.com> Reviewed-by: Martin Habets <habetsm.xilinx@gmail.com> Reviewed-by: Conor Dooley <conor.dooley@microchip.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230719183225.1827100-1-kuba@kernel.org
-
Lukas Bulwahn authored
Commit 0795e7c0 ("[AFS]: Update the AFS fs documentation.") adds a new section listing the build configuration options that need to be enabled for the AFS file system. The documentation refers to CONFIG_AFS, but the option is called CONFIG_AFS_FS, since the beginning of Linux's git history. Refer to the config option with the correct name. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230720094301.9888-1-lukas.bulwahn@gmail.com
-
Hu Haowen authored
Due to some reasons the current mailing list will be revoked and new one will replace it in the future, hence remove the entry from MAINTAINERS ahead of time. Signed-off-by: Hu Haowen <src.res.211@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230720141846.1787-1-src.res.211@gmail.com
-
- 14 Jul, 2023 20 commits
-
-
Randy Dunlap authored
Add kernel-doc for all APIs that do not already have it. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: John Stultz <jstultz@google.com> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Stephen Boyd <sboyd@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Acked-by: John Stultz <jstultz@google.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230704052405.5089-3-rdunlap@infradead.org
-
Randy Dunlap authored
Add kernel-doc notation in <linux/jiffies.h> for interfaces that don't already have it (i.e. most interfaces). Fix some formatting and typos in other comments. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: John Stultz <jstultz@google.com> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Stephen Boyd <sboyd@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Acked-by: John Stultz <jstultz@google.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230704052405.5089-2-rdunlap@infradead.org
-
Randy Dunlap authored
Give time & timer APIs their own section and begin adding entries to that section. Move hrtimers immediately after this new section so that they are all together. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: John Stultz <jstultz@google.com> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Stephen Boyd <sboyd@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230704052405.5089-1-rdunlap@infradead.org
-
Fabio M. De Francesco authored
The differences between kmap_local_page() and kmap_local_folio() consist only in the first taking a pointer to a page and the second taking two arguments, a pointer to a folio and the byte offset within the folio which identifies the page. The two API's can be explained at the same time in the "Temporary Virtual Mappings" section of the Highmem's documentation. Add information about kmap_local_folio() in the same subsection that explains kmap_local_page(). Cc: Andrew Morton <akpm@linux-foundation.org> Reviewed-by: Ira Weiny <ira.weiny@intel.com> Reviewed-by: Mike Rapoport (IBM) <rppt@kernel.org> Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230708121719.8270-1-fmdefrancesco@gmail.com
-
Avadhut Naik authored
Translate Documentation/process/researcher-guidelines.rst into Spanish Signed-off-by: Avadhut Naik <avadhut.naik@amd.com> Reviewed-By: Carlos Bilbao <carlos.bilbao@amd.com> [jc: removed unneeded label at the top] Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230621171457.443362-2-avadhut.naik@amd.com
-
Costa Shulyupin authored
to make the page more organized as requested Signed-off-by: Costa Shulyupin <costa.shul@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230622071004.2934698-1-costa.shul@redhat.com
-
Christophe JAILLET authored
vmalloc() has a 2-factor form. It is vmalloc_array(). So use another function as an example. Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/3484e46180dd2cf05d993ff1a78b481bc2ad1f71.1687723931.git.christophe.jaillet@wanadoo.fr
-
Randy Dunlap authored
Add bus, class, and device data structures and enum constants to the Driver-Model Structures section and add function interfaces to the Device Drivers Base section of the Device drivers infrastructure chapter. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: "Rafael J. Wysocki" <rafael@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230627064523.16618-1-rdunlap@infradead.org
-
Randy Dunlap authored
Correct 2 uses of "it's" to the possessive "its" as needed. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Darrick J. Wong <djwong@kernel.org> Cc: linux-xfs@vger.kernel.org Cc: linux-mm@kvack.org Cc: Jonathan Corbet <corbet@lwn.net> Reviewed-by: Darrick J. Wong <djwong@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230703232024.8069-1-rdunlap@infradead.org
-
Randy Dunlap authored
Use the 'constant' indicator '%' in the examples for the Return: values syntax. This can help encourage people to use it. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Suggested-by: Steven Rostedt <rostedt@goodmis.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Link: https://lore.kernel.org/lkml/20221121154358.36856ca6@gandalf.local.home/Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230703232030.8223-1-rdunlap@infradead.org
-
Randy Dunlap authored
Jesse mentioned that gconfig is missing from the top of the kconfig.rst file, so add it for completeness. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Link: lore.kernel.org/r/CAJFTR8QgYykuEq_AkODEWPUYXncKgRBHOncxT=ypZTQODkyarw@mail.gmail.com Cc: Jesse Taube <mr.bossman075@gmail.com> Cc: Masahiro Yamada <masahiroy@kernel.org> Cc: linux-kbuild@vger.kernel.org Cc: Nathan Chancellor <nathan@kernel.org> Cc: Nick Desaulniers <ndesaulniers@google.com> Cc: Nicolas Schier <nicolas@fjasle.eu> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230704000120.8098-1-rdunlap@infradead.org
-
Rick Wertenbroek authored
Add missing address-of (&) operator in pseudo-code. Signed-off-by: Rick Wertenbroek <rick.wertenbroek@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230706114057.1120335-1-rick.wertenbroek@gmail.com
-
Jonathan Corbet authored
Hu evidently wrote his two patches in separate branches, with the effect that they conflict with each other. I've applied them in the same way to let "git merge" sort it out.
-
Hu Haowen authored
Update zh_TW's index.rst to the version of commit 0c7b4366 ("docs: Rewrite the front page") with some reference from commit f4bf1cd4 ("docs: move asm-annotations.rst into core-api") and commit eef24f70 ("docs/zh_CN: Rewrite the Chinese translation front page"). Signed-off-by: Hu Haowen <src.res.211@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230708054052.45967-1-src.res.211@gmail.com
-
Hu Haowen authored
The previous email address was abandoned due to some reasons by myself, and thus shift the email contents mentioned from the old email address (src.res@email.cn) to the current version (src.res.211@gmail.com). Signed-off-by: Hu Haowen <src.res.211@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230707160119.26873-1-src.res.211@gmail.com
-
Tiezhu Yang authored
Run the refresh script [1] to document the recent feature additions. [1] Documentation/features/scripts/features-refresh.sh Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/1689060720-4628-3-git-send-email-yangtiezhu@loongson.cn
-
Tiezhu Yang authored
ARCH_WANT_DEFAULT_TOPDOWN_MMAP_LAYOUT selects ARCH_HAS_ELF_RANDOMIZE, so add ARCH_WANT_DEFAULT_TOPDOWN_MMAP_LAYOUT as another Kconfig check for ELF-ASLR feature, then the refresh script can be used to handle this case for all archs. Co-developed-by: Xi Ruoyao <xry111@xry111.site> Signed-off-by: Xi Ruoyao <xry111@xry111.site> Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/1689060720-4628-2-git-send-email-yangtiezhu@loongson.cn
-
Jakub Kicinski authored
The example and the git hook use HTTPS but the text for some reason links to the non-SSL version. Signed-off-by: Jakub Kicinski <kuba@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230713230510.1505201-1-kuba@kernel.org
-
Jonathan Corbet authored
Get rid of some markup cruft and unneeded labels in a pair of maintainer's manual documents. No wording changes. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jakub Kicinski authored
The documentation talks about -u and how to configure the default key. It does not mention that once the default key is set one should use the -s flag. Which is likely what most people end up using. Signed-off-by: Jakub Kicinski <kuba@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20230713230606.1505458-1-kuba@kernel.org>
-