summaryrefslogtreecommitdiff
AgeCommit message (Collapse)AuthorFilesLines
2023-08-18scripts: kernel-doc: fix macro handling in enumsPavan Kumar Linga1-0/+1
drivers/net/ethernet/intel/idpf/idpf.h uses offsetof to initialize the enum enumerators: enum idpf_cap_field { IDPF_BASE_CAPS = -1, IDPF_CSUM_CAPS = offsetof(struct virtchnl2_get_capabilities, csum_caps), IDPF_SEG_CAPS = offsetof(struct virtchnl2_get_capabilities, seg_caps), IDPF_RSS_CAPS = offsetof(struct virtchnl2_get_capabilities, rss_caps), IDPF_HSPLIT_CAPS = offsetof(struct virtchnl2_get_capabilities, hsplit_caps), IDPF_RSC_CAPS = offsetof(struct virtchnl2_get_capabilities, rsc_caps), IDPF_OTHER_CAPS = offsetof(struct virtchnl2_get_capabilities, other_caps), }; kernel-doc parses the above enumerator with a ',' inside the macro and treats 'csum_caps', 'seg_caps' etc. also as enumerators resulting in the warnings: drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value 'csum_caps' not described in enum 'idpf_cap_field' drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value 'seg_caps' not described in enum 'idpf_cap_field' drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value 'rss_caps' not described in enum 'idpf_cap_field' drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value 'hsplit_caps' not described in enum 'idpf_cap_field' drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value 'rsc_caps' not described in enum 'idpf_cap_field' drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value 'other_caps' not described in enum 'idpf_cap_field' Fix it by removing the macro arguments within the parentheses. Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Pavan Kumar Linga <pavan.kumar.linga@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230815210417.98749-3-pavan.kumar.linga@intel.com
2023-08-18scripts: kernel-doc: parse DEFINE_DMA_UNMAP_[ADDR|LEN]Pavan Kumar Linga1-0/+4
At present, if the macros DEFINE_DMA_UNMAP_ADDR() and DEFINE_DMA_UNMAP_LEN() are used in the structures as shown below, instead of parsing the parameter in the parentheses, kernel-doc parses 'DEFINE_DMA_UNMAP_ADDR(' and 'DEFINE_DMA_UNMAP_LEN(' which results in the following warnings: drivers/net/ethernet/intel/idpf/idpf_txrx.h:201: warning: Function parameter or member 'DEFINE_DMA_UNMAP_ADDR(dma' not described in 'idpf_tx_buf' drivers/net/ethernet/intel/idpf/idpf_txrx.h:201: warning: Function parameter or member 'DEFINE_DMA_UNMAP_LEN(len' not described in 'idpf_tx_buf' struct idpf_tx_buf { DEFINE_DMA_UNMAP_ADDR(dma); DEFINE_DMA_UNMAP_LEN(len); }; Fix the warnings by parsing DEFINE_DMA_UNMAP_ADDR() and DEFINE_DMA_UNMAP_LEN(). Cc: Jonathan Corbet <corbet@lwn.net> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Pavan Kumar Linga <pavan.kumar.linga@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230815210417.98749-2-pavan.kumar.linga@intel.com
2023-08-18Documentation: riscv: Update boot image header since EFI stub is supportedAlexandre Ghiti1-5/+5
The EFI stub is supported on RISC-V so update the documentation that explains how the boot image header was reused to support it. Signed-off-by: Alexandre Ghiti <alexghiti@rivosinc.com> Reviewed-by: Atish Patra <atishp@rivosinc.com> Reviewed-by: Palmer Dabbelt <palmer@rivosinc.com> Acked-by: Palmer Dabbelt <palmer@rivosinc.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230817130734.10387-3-alexghiti@rivosinc.com
2023-08-18Documentation: riscv: Add early boot documentAlexandre Ghiti3-3/+170
This document describes the constraints and requirements of the early boot process in a RISC-V kernel. Signed-off-by: Alexandre Ghiti <alexghiti@rivosinc.com> Reviewed-by: Björn Töpel <bjorn@rivosinc.com> Reviewed-by: Conor Dooley <conor.dooley@microchip.com> Reviewed-by: Sunil V L <sunilvl@ventanamicro.com> Reviewed-by: Andrew Jones <ajones@ventanamicro.com> Reviewed-by: Palmer Dabbelt <palmer@rivosinc.com> Reviewed-by: Atish Patra <atishp@rivosinc.com> Reviewed-by: Song Shuai <songshuaishuai@tinylab.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Palmer Dabbelt <palmer@rivosinc.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230817130734.10387-2-alexghiti@rivosinc.com
2023-08-18Documentation: arm: Add bootargs to the table of added DT parametersAlexandre Ghiti1-1/+3
The bootargs node is also added by the EFI stub in the function update_fdt(), so add it to the table. Signed-off-by: Alexandre Ghiti <alexghiti@rivosinc.com> Reviewed-by: Atish Patra <atishp@rivosinc.com> Reviewed-by: Song Shuai <songshuaishuai@tinylab.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230817130734.10387-1-alexghiti@rivosinc.com
2023-08-18docs: kernel-parameters: Refer to the correct bitmap functionAndy Shevchenko1-1/+1
The parser of the CPU lists is bitmap_parselist() that supports special notations with the plain numbers. bitmap_parse() never supported those and will fail in case one will try it. Fixes: b18def121f07 ("bitmap_parse: Support 'all' semantics") Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230817140432.507889-1-andriy.shevchenko@linux.intel.com
2023-08-18doc: update params of memhp_default_state=Ma Wupeng1-1/+1
Commit 5f47adf762b7 ("mm/memory_hotplug: allow to specify a default online_type") allows to specify a default online_type which make online memory to kernel or movable zone possible but fail to update to doc. Update doc to fit this change. Signed-off-by: Ma Wupeng <mawupeng1@huawei.com> Reviewed-by: David Hildenbrand <david@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230802074312.2111074-1-mawupeng1@huawei.com
2023-08-18docs: Add book to process/kernel-docs.rstCarlos Bilbao1-0/+9
Include to process/kernel-docs.rst a book on Linux system administration published in May, 2023 (with ISBN 978-1098109035). Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230803142417.965313-1-carlos.bilbao@amd.com
2023-08-18docs: sparse: fix invalid link addressesMin-Hua Chen1-2/+2
The http and git links are invalid, replace them with valid links. Signed-off-by: Min-Hua Chen <minhuadotchen@gmail.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230804112320.35592-1-minhuadotchen@gmail.com
2023-08-18docs: vfs: clean up after the iterate() removalJonathan Corbet2-7/+1
Commit 3e3271549670 ("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.net Reviewed-by: Christian Brauner <brauner@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2023-08-18docs: Add a section on surveys to the researcher guidelinesJonathan Corbet1-0/+27
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
2023-08-18docs: move mips under archCosta Shulyupin12-12/+12
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
2023-08-18docs: move loongarch under archCosta Shulyupin14-15/+15
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
2023-08-18docs: mm: Fix number of base pages for 1GB HugeTLBUsama Arif1-1/+2
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
2023-07-31Docs: kernel-parameters: sort the LEGEND listRandy Dunlap1-11/+12
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
2023-07-31docs: cgroup-v1: replace dead CONFIG_MEM_RES_CTRL_SWAP symbolKrzysztof Pawlaczyk1-1/+1
Commit e55b9f96860f ("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 c255a458055e ("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
2023-07-31docs: psi: use correct config nameRamazan Safiullin1-1/+1
Commit 2ce7135adc9a ("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
2023-07-31Docs/process/changes: Replace http:// with https://SeongJae Park1-6/+6
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
2023-07-31Docs/process/changes: Consolidate NFS-utils update linksSeongJae Park1-5/+1
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
2023-07-22docs: Integrate rustdoc generation into htmldocsCarlos Bilbao1-0/+16
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
2023-07-22docs: Move rustdoc output, cross-reference itCarlos Bilbao2-6/+17
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
2023-07-22docs: panic: cleanups for panic paramsRandy Dunlap1-15/+15
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
2023-07-21docs: consolidate networking interfacesCosta Shulyupin1-5/+12
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
2023-07-21Docs: kernel-parameters: sort arm64 entriesRandy Dunlap1-6/+6
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
2023-07-21docs: ABI: fix an RST error in sysfs-bus-nvdimmJonathan Corbet1-1/+3
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>
2023-07-21docs/sp_SP: Add translation of process/contribution-maturity-modelAvadhut Naik2-0/+121
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
2023-07-21docs: maintainer: document expectations of small time maintainersJakub Kicinski2-0/+156
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
2023-07-21afs: Documentation: correct reference to CONFIG_AFS_FSLukas Bulwahn1-1/+1
Commit 0795e7c031c4 ("[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
2023-07-21docs/zh_TW: remove the mailing list entry for zh_TWHu Haowen1-1/+0
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
2023-07-14time: add kernel-doc in time.cRandy Dunlap1-11/+158
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
2023-07-14jiffies: add kernel-doc for all APIsRandy Dunlap1-21/+176
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
2023-07-14docs: time: make separate section for time and timersRandy Dunlap1-9/+18
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
2023-07-14Documentation/highmem: Add information about kmap_local_folio()Fabio M. De Francesco1-12/+15
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
2023-07-14docs/sp_SP: Add translation of process/researcher-guidelinesAvadhut Naik2-0/+151
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
2023-07-14docs: consolidate core subsystemsCosta Shulyupin1-7/+14
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
2023-07-14docs: deprecated.rst: Update an exampleChristophe JAILLET1-1/+1
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
2023-07-14docs: add more driver-model infrastructure interfacesRandy Dunlap1-0/+18
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
2023-07-14Documentation: admin-guide: correct "it's" to possessive "its"Randy Dunlap2-2/+2
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
2023-07-14Documentation: doc-guide: use '%' constant indicator in Return: examplesRandy Dunlap1-5/+5
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
2023-07-14kconfig: docs: mention gconfig at top of kconfig.rstRandy Dunlap1-0/+2
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
2023-07-14docs: scheduler: completion: Fix minor error in pseudo-codeRick Wertenbroek1-1/+1
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
2023-07-14Merge branch 'hu' into docs-mwJonathan Corbet1-100/+56
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.
2023-07-14docs/zh_TW: rewrite index.rstHu Haowen1-100/+56
Update zh_TW's index.rst to the version of commit 0c7b4366f1ab ("docs: Rewrite the front page") with some reference from commit f4bf1cd4ac9c ("docs: move asm-annotations.rst into core-api") and commit eef24f7054a6 ("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
2023-07-14docs/zh_CN: change my own email addressHu Haowen65-82/+82
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
2023-07-14Documentation/features: Refresh support files for 6.5Tiezhu Yang7-8/+8
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
2023-07-14Documentation/features: Check ARCH_WANT_DEFAULT_TOPDOWN_MMAP_LAYOUTTiezhu Yang1-0/+1
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
2023-07-14docs: maintainers: add missing 's' in https for the base lore linkJakub Kicinski1-1/+1
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
2023-07-14docs: Slight maintainer's guide decruftingJonathan Corbet2-24/+15
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>
2023-07-14docs: maintainers: mention tag -s for signed tagsJakub Kicinski1-3/+4
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>
2023-07-14MAINTAINERS: treat Documentation/maintainer as process docsJakub Kicinski1-0/+1
A handful of people got caught out by the recent changes in git which changed the format of Message-ID and broke our recommended applyhook for adding lore links. This was fixed in the docs by commit 2bb19e740e9b ("Documentation: update git configuration for Link: tag") but it seems like few people have noticed. Add maintainer directory to the process entry so that workflows@ gets CCed. Signed-off-by: Jakub Kicinski <kuba@kernel.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20230713230713.1505561-1-kuba@kernel.org>
generated by cgit v1.2.3 (git 2.39.0) at 2024-11-22 07:32:12 +0300