- 28 Aug, 2023 3 commits
-
-
Marcus Folkesson authored
The reference undeniably points to something unrelated nowadays. Remove it. Signed-off-by:
Marcus Folkesson <marcus.folkesson@gmail.com> Suggested-by:
Mark Olsson <mark@markolsson.se> Signed-off-by:
Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230824-pxrc-doc-v1-1-038b75a2ef05@gmail.com
-
Andrei Emeltchenko authored
Make rendered text readable by fixing literal block marker, changing ":" to "::". Signed-off-by:
Andrei Emeltchenko <andrei.emeltchenko@intel.com> Signed-off-by:
-
Marco Pagani authored
Clean typos and remove the reference to the sync_cpu_device_pagetables() callback since all hmm_mirror ops have been removed. Fixes: a22dd506 ("mm/hmm: remove hmm_mirror and related") Signed-off-by:
Marco Pagani <marpagan@redhat.com> Reviewed-by:
Mika Penttilä <mpenttil@redhat.com> Reviewed-by:
Jason Gunthorpe <jgg@nvidia.com> Signed-off-by:
-
- 18 Aug, 2023 17 commits
-
-
Xueshi Hu authored
Minor typo fix in translations. Signed-off-by:
Xueshi Hu <xueshi.hu@smartx.com> Acked-by:
Yanteng Si <siyanteng@loongson.cn> Signed-off-by:
-
Bjorn Helgaas authored
Fix typos in Documentation. Signed-off-by:
Bjorn Helgaas <bhelgaas@google.com> Link: https://lore.kernel.org/r/20230814212822.193684-4-helgaas@kernel.orgSigned-off-by:
-
Bjorn Helgaas authored
Fix typos in Documentation/ABI. The changes are in descriptions or comments where they shouldn't affect use of the ABIs. Signed-off-by:
Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20230814212822.193684-2-helgaas@kernel.orgSigned-off-by:
-
Pavan Kumar Linga authored
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:
-
Pavan Kumar Linga authored
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: -
Alexandre Ghiti authored
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:
-
Alexandre Ghiti authored
This document describes the constraints and requirements of the early boot process in a RISC-V kernel. Signed-off-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:
Song Shuai <songshuaishuai@tinylab.org> Reviewed-by:
-
Alexandre Ghiti authored
The bootargs node is also added by the EFI stub in the function update_fdt(), so add it to the table. Signed-off-by:
-
Andy Shevchenko authored
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: b18def12 ("bitmap_parse: Support 'all' semantics") Signed-off-by:
Andy Shevchenko <andriy.shevchenko@linux.intel.com> Reviewed-by:
-
Ma Wupeng authored
Commit 5f47adf7 ("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:
-
Carlos Bilbao authored
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:
-
Min-Hua Chen authored
The http and git links are invalid, replace them with valid links. Signed-off-by:
Min-Hua Chen <minhuadotchen@gmail.com> Reviewed-by:
-
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 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:
Kees Cook <keescook@chromium.org> Reviewed-by:
Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by:
-
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:
-
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:
Huacai Chen <chenhuacai@loongson.cn> Reviewed-by:
-
Usama Arif authored
1GB HugeTLB page consists of 262144 base pages. Signed-off-by:
Usama Arif <usama.arif@bytedance.com> Reviewed-by:
Mike Rapoport (IBM) <rppt@kernel.org> Acked-by:
Muchun Song <songmuchun@bytedance.com> Signed-off-by:
-
- 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:
-
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:
-
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:
Ramazan Safiullin <ram.safiullin2001@gmail.com> Signed-off-by:
-
SeongJae Park authored
Some links are still using 'http://'. Replace those with 'https://'. Signed-off-by:
SeongJae Park <sj@kernel.org> Reviewed-by:
-
SeongJae Park authored
Two update links for NFS-utils are in two duplicate sessions. Consolidate. Signed-off-by:
-
- 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:
Martin Rodriguez Reboredo <yakoyoku@gmail.com> Signed-off-by:
-
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:
-
Randy Dunlap authored
Move 'panic_print' to its correct place in alphabetical order. Add parameter format for 'pause_on_oops'. Signed-off-by:
-
Costa Shulyupin authored
to make the page more organized as requested Signed-off-by:
-
Randy Dunlap authored
Put the arm64 kernel-parameters entries into alphabetical order. Signed-off-by:
-
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:
-
Avadhut Naik authored
Translate Documentation/process/contribution-maturity-model.rst into Spanish Signed-off-by:
Avadhut Naik <avadhut.naik@amd.com> Reviewed-by:
-
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:
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:
-
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:
-
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:
-
- 14 Jul, 2023 5 commits
-
-
Randy Dunlap authored
Add kernel-doc for all APIs that do not already have it. Signed-off-by:
John Stultz <jstultz@google.com> Signed-off-by:
-
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 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:
-
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:
Fabio M. De Francesco <fmdefrancesco@gmail.com> Signed-off-by:
-
Avadhut Naik authored
Translate Documentation/process/researcher-guidelines.rst into Spanish Signed-off-by:
-
