summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
2022-06-01docs: add SVG version of the Linux logoMiguel Ojeda2-0/+2048
In the Rust for Linux patch series, Jonathan Corbet requested [1] that we avoid binary assets (such as the logo), possibly by recreating them in SVG format. However, it turns out there is no SVG version of the Linux logo in the kernel tree yet, only a GIF one from the pre-v2.0.0 days. This patch fixes that by adding a SVG version of the Linux logo, which we could then use in the Rust for Linux documentation and other similar places. This is a vector re-illustration by Garrett LeSage of the original logo by Larry Ewing, plus cleanups by IFo Hancroft. The file was imported as-is from: https://github.com/garrett/Tux/blob/ecd40de64250ea2b24c849e901c3297ad01e54f6/tux.svg The stated license in the repository is: > Public domain http://creativecommons.org/publicdomain/zero/1.0/ > > ...but, if anyone asks: > > Tux was originally made by Larry Ewing in the Gimp, re-illustrated > in vector by Garrett LeSage, using Inkscape and refined and > cleaned up by IFo Hancroft. Here, the acknowledgement requirement has been made mandatory to match the wording of the existing GIF logo in `COPYING-logo`. Both Garrett LeSage and IFo Hancroft gave their permission [2,3] to use their re-illustration with the license as given in the `COPYING-logo` file. Link: https://lore.kernel.org/lkml/87fspk1xoc.fsf@meer.lwn.net/ [1] Link: https://lore.kernel.org/lkml/YgFsD7zBZyVqyF+F@battlestation/ [2] Link: https://lore.kernel.org/lkml/CAFfNkxV=DmRJL1Oqm3w9YzBYcNLSAG3Ss8pih9ZVwh_E-Fbw+Q@mail.gmail.com/ [3] Signed-off-by: Miguel Ojeda <ojeda@kernel.org> Link: https://lore.kernel.org/r/20220528153132.8636-2-ojeda@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-06-01docs: move Linux logo into a new `images` folderMiguel Ojeda3-1/+1
Having assets in the top-level `Documentation` directory can make it harder to find the documents one needs, especially if we want to add more of them later on. Instead, create a new `images` folder inside it that is used to hold assets such as logos. In addition, update the reference in `scripts/spdxcheck-test.sh`. Link: https://lore.kernel.org/lkml/8735hicoy7.fsf@meer.lwn.net/ Suggested-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Miguel Ojeda <ojeda@kernel.org> Link: https://lore.kernel.org/r/20220528153132.8636-1-ojeda@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-06-01docs: blockdev: change title to match section contentJoel Colledge1-3/+3
This index.rst was added in commit 39443104c7d3 docs: blockdev: convert to ReST It appears that the title from the RapidIO index page was copied. This title does not match the content of this directory. Change it to match. Signed-off-by: Joel Colledge <joel.colledge@linbit.com> Link: https://lore.kernel.org/r/20220530142849.717-1-joel.colledge@linbit.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-06-01docs/conf.py: Cope with removal of language=None in Sphinx 5.0.0Akira Yokosawa1-1/+1
One of the changes in Sphinx 5.0.0 [1] says [sic]: 5.0.0 final - #10474: language does not accept None as it value. The default value of language becomes to 'en' now. [1]: https://www.sphinx-doc.org/en/master/changes.html#release-5-0-0-released-may-30-2022 It results in a new warning from Sphinx 5.0.0 [sic]: WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English). Silence the warning by using 'en'. It works with all the Sphinx versions required for building kernel documentation (1.7.9 or later). Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/bd0c2ddc-2401-03cb-4526-79ca664e1cbe@gmail.com Cc: stable@vger.kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-17docs: pdfdocs: Add space for chapter counts >= 100 in TOCAkira Yokosawa1-7/+7
It turns out that networking.pdf has exceeded 100 chapters and titles of chapters >= 100 collide with their counts in its table of contents (TOC). Increase relevant params by 0.6em in the preamble to avoid such ugly collisions. While at it, fix a typo in comment (subsection). Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/bdb60ba3-7813-47d0-74f9-7c31dd912d95@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-17docs/zh_CN: Add dev-tools/gdb-kernel-debugging.rst Chinese translationgaochao2-1/+168
Translate dev-tools/gdb-kernel-debugging.rst into Chinese. Signed-off-by: gaochao <gaochao49@huawei.com> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/20220514100046.1683-1-gaochao49@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-17input: Docs: correct ntrig.rst typoRandy Dunlap1-1/+1
Fix a typo in ntrig.rst (found with 'codespell'). 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> Link: https://lore.kernel.org/r/20220516002047.11395-1-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-17input: Docs: correct atarikbd.rst typosRandy Dunlap1-2/+2
Fix 2 "MOSE" typos in atarikbd.rst (found with 'codespell'). a. s/MOSE/MODE/ b. s/MOSE/MOUSE/ 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> Link: https://lore.kernel.org/r/20220516002055.12000-1-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-17MAINTAINERS: Become the docs/zh_CN maintainerYanteng Si1-0/+1
It's time to become a maintainer of Chinese documentation, and Yanteng's plan is to help everyone with the utmost enthusiasm and patience. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/b0c1324d1d63846d700ab354446a6deaf30754c0.1652712771.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-12docs/zh_CN: fix devicetree usage-model translationHuilong Deng1-4/+4
machine_desc is a item in devicetree, shouldn't be half translated. Let's keep a whole word untranslated. Signed-off-by: Huilong Deng <denghuilong@cdjrlc.com> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/20220510020135.55452-1-denghuilong@cdjrlc.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-09mm,doc: Add new documentation structureMatthew Wilcox (Oracle)13-7/+93
Closely following the outline of Mel Gorman's book "Understanding the Linux Virtual Memory Manager", add a new outline. Preserve the current contents of the mm underneath the new outline so we can transition those documents to a more sensible place later. Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> Reviewed-by: John Hubbard <jhubbard@nvidia.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Johannes Weiner <hannes@cmpxchg.org> Link: https://lore.kernel.org/r/20220507134947.444287-1-willy@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-09Documentation: drop more IDE boot options and ide-cd.rstRandy Dunlap3-559/+0
Drop ide-* command line options. Drop cdrom/ide-cd.rst documentation. Fixes: 898ee22c32be ("Drop Documentation/ide/") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jens Axboe <axboe@kernel.dk> Cc: Christoph Hellwig <hch@lst.de> Acked-by: Damien Le Moal <damien.lemoal@opensource.wdc.com> Acked-by: Phillip Potter <phil@philpotter.co.uk> Link: https://lore.kernel.org/r/20220424033701.7988-1-rdunlap@infradead.org [jc: also deleted reference from cdrom/index.rst] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-09Documentation/process: use scripts/get_maintainer.pl on patchesKrzysztof Kozlowski3-9/+12
Explain that, when collecting list of people to Cc the patch, scripts/get_maintainer.pl should be used on patches, not on the directories. The behavior is quite different, because with "-f" on a directory, the maintainers of individual files will not be shown. Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Link: https://lore.kernel.org/r/20220427185645.677039-1-krzysztof.kozlowski@linaro.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-09MAINTAINERS: Add entry for DOCUMENTATION/JAPANESEAkira Yokosawa1-0/+6
Due to the lack of an entry for the Japanese translation of documentation, Kosuke Fujimoto needed to ask the status of its maintenance [1]. Add an entry for DOCUMENTATION/JAPANESE as a sub-subsystem under the DOCUMENTATION subsystem to make it easier for another prospective contributor to know there is someone who takes care of Japanese translation. As a first step, install myself as a designated reviewer. Hopefully, other interested members get accustomed to the kernel-dev workflow and would get ready to be (co-)maintainers/reviewers shortly. [1]: https://lore.kernel.org/r/172fa015-26df-c978-853d-3aba67c581cc@gmail.com/ Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Tsugikazu Shibata <shibata@linuxfoundation.org> Cc: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Link: https://lore.kernel.org/r/7689b502-8c34-85b1-54e0-7a3b5e3c2bd1@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-09docs/trans/ja_JP/howto: Don't mention specific kernel versionsKosuke Fujimoto1-23/+21
This change is based on commit d2b008f134b7 ("Documentation/process/howto: Update for 4.x -> 5.x versioning"). Replace "4.x kernel version" with generic term such as "mainline tree" Reviewed-by: Akira Yokosawa <akiyks@gmail.com> --- V2: Reformatted commit log message (Yokosawa-san) V3: Updated some expressions (Shibata-san) - added "version number" in mainline tree section - updated from "stable kernel" to "stable tree" V4: Added reviewed by tag and removed extra characters (Yokosawa-san) 　V5: Removed an extra character (Shibata-san) Signed-off-by: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Acked-by: Tsugikazu Shibata <shibata@linuxfoundation.org> Link: https://lore.kernel.org/r/20220501102256.6379-1-fujimotokosuke0@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-09docs/ja_JP/SubmittingPatches: Request summaries for commit referencesAkira Yokosawa1-0/+11
Reflect changes made in commit 0af5270324cc ("Documentation/SubmittingPatches: Request summaries for commit references"). Note: Translated paragraph uses a slightly different structure and omit a redundant phrase so that they are easier to follow. Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Tsugikazu Shibata <shibata@linuxfoundation.org> Cc: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Acked-by: Tsugikazu Shibata <shibata@linuxfoundation.org> Reviewed-by: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Link: https://lore.kernel.org/r/20220503104820.49269-1-akiyks@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-09docs/ja_JP/SubmittingPatches: Add Suggested-by as a standard signatureAkira Yokosawa1-1/+8
Reflect changes made in commit 8543ae1296f6 ("checkpatch: add Suggested-by as a standard signature"). Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Tsugikazu Shibata <shibata@linuxfoundation.org> Cc: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Acked-by: Tsugikazu Shibata <shibata@linuxfoundation.org> Reviewed-by: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Link: https://lore.kernel.org/r/20220503104757.49208-1-akiyks@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-09docs/ja_JP/SubmittingPatches: Randy has movedAkira Yokosawa1-3/+1
Reflect changes made in commit 755727b7fb1e ("Randy has moved"). Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Tsugikazu Shibata <shibata@linuxfoundation.org> Cc: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Acked-by: Tsugikazu Shibata <shibata@linuxfoundation.org> Reviewed-by: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Link: https://lore.kernel.org/r/20220503104729.49140-1-akiyks@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-09docs/ja_JP/SubmittingPatches: Suggest the use of scripts/get_maintainer.plAkira Yokosawa1-1/+2
Reflect changes made in commit e52d2e1f25f0 ("Documentation/SubmittingPatches: suggested the use of scripts/get_maintainer.pl"). Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Tsugikazu Shibata <shibata@linuxfoundation.org> Cc: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Acked-by: Tsugikazu Shibata <shibata@linuxfoundation.org> Reviewed-by: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Link: https://lore.kernel.org/r/20220503104650.49068-1-akiyks@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-09docs/ja_JP/SubmittingPatches: Update GregKH linksAkira Yokosawa1-4/+5
Reflect changes made in commit f5039935ac68 ("Documentation: update GregKH links"). Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Tsugikazu Shibata <shibata@linuxfoundation.org> Cc: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Acked-by: Tsugikazu Shibata <shibata@linuxfoundation.org> Reviewed-by: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Link: https://lore.kernel.org/r/20220503104613.49001-1-akiyks@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-01Documentation/sysctl: document max_rcu_stall_to_panicJoel Savitz1-0/+7
commit dfe564045c65 ("rcu: Panic after fixed number of stalls") introduced a new systctl but no accompanying documentation. Add a simple entry to the documentation. Signed-off-by: Joel Savitz <jsavitz@redhat.com> Acked-by: Paul E. McKenney <paulmck@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-28Documentation: add missing angle bracket in cgroup-v2 docJoel Savitz1-1/+1
Trivial addition of missing closing angle backet. Signed-off-by: Joel Savitz <jsavitz@redhat.com> Link: https://lore.kernel.org/r/20220422164526.3464306-1-jsavitz@redhat.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-28Documentation: dev-tools: use literal block instead of code-blockFrank Rowand1-10/+8
KTAP Specification: Change code-block directives to straightforward literal blocks since the blocks do not contain code. Suggested-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Frank Rowand <frank.rowand@sony.com> Reviewed-by: David Gow <davidgow@google.com> Link: https://lore.kernel.org/r/20220316202622.324866-3-frowand.list@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-28docs/zh_CN: add vm numa translationYanteng Si2-1/+102
Translate .../vm/numa.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/65e5a38c3112fb1f9e126f1807fda2724ebf3312.1650794774.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-28docs/zh_CN: add vm hmm translationYanteng Si2-1/+362
Translate .../vm/hmm.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/6248f340dd43097d6517239e1f038165b9fef7cd.1650794774.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-28docs/ja_JP/index: update section title in JapaneseKosuke Fujimoto1-1/+1
Update section title "Japanese Translation" in Japanese. This change is to keep consistency with other translations. Signed-off-by: Kosuke Fujimoto <fujimotokosuke0@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Tsugikazu Shibata <shibata@linuxfoundation.org> Cc: Akira Yokosawa <akiyks@gmail.com> Cc: linux-doc@vger.kernel.org Reviewed-by: Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/20220425124853.8347-1-fujimotokosuke0@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-28Documentation: devres: fix typo in interface listJohan Hovold1-1/+1
Fix the misspelled devm_get_clk_from_child() helper name in the devres interface list. Signed-off-by: Johan Hovold <johan+linaro@kernel.org> Link: https://lore.kernel.org/r/20220427073142.16700-1-johan+linaro@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-28docs: submitting-patches: Fix crossref to 'The canonical patch format'Akira Yokosawa1-1/+1
The reference to `explicit_in_reply_to` is pointless as when the reference was added in the form of "#15" [1], Section 15) was "The canonical patch format". The reference of "#15" had not been properly updated in a couple of reorganizations during the plain-text SubmittingPatches era. Fix it by using `the_canonical_patch_format`. [1]: 2ae19acaa50a ("Documentation: Add "how to write a good patch summary" to SubmittingPatches") Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Fixes: 5903019b2a5e ("Documentation/SubmittingPatches: convert it to ReST markup") Fixes: 9b2c76777acc ("Documentation/SubmittingPatches: enrich the Sphinx output") Cc: Jonathan Corbet <corbet@lwn.net> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: stable@vger.kernel.org # v4.9+ Link: https://lore.kernel.org/r/64e105a5-50be-23f2-6cae-903a2ea98e18@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-28Documentation: x86: rework IOMMU documentationAlex Deucher3-116/+152
Add preliminary documentation for AMD IOMMU and combine with the existing Intel IOMMU documentation and clean up and modernize some of the existing documentation to align with the current state of the kernel. Signed-off-by: Alex Deucher <alexander.deucher@amd.com> Acked-by: Joerg Roedel <jroedel@suse.de> Link: https://lore.kernel.org/r/20220422192656.624920-1-alexander.deucher@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-22Documentation: move watch_queue to core-apiRandy Dunlap3-1/+1
Move watch_queue documentation to the core-api index and subdirectory. Fixes: c73be61cede5 ("pipe: Add general notification queue support") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: David Howells <dhowells@redhat.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-22Docs: Replace version by 'current' in changes.rstBruno Moreira-Guedes1-1/+1
The file 'Documentation/process/changes.rst' states the listed requirements are for the 4.x kernel version. However, there are requirements updated for the 5.x version, as there might be in other future versions. This patch updates it to 'latest' so the document won't be outdated in the future. Signed-off-by: Bruno Moreira-Guedes <codeagain@codeagain.dev> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-22Docs: Add cpio requirement to changes.rstBruno Moreira-Guedes1-0/+6
The install target requires cpio to run the `kernel/gen_kheaders.sh` script, but it's missing in the requirements list at 'Documentation/process/changes.rst'. This patch adds it to the list. Signed-off-by: Bruno Moreira-Guedes <codeagain@codeagain.dev> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-22Documentation: kunit: change complete_and_exit to kthread_complete_and_exitAndreas-Christian Hagau1-1/+1
Commit cead18552660 ("exit: Rename complete_and_exit to kthread_complete_and_exit") renamed complete_and_exit to kthread_complete_and_exit. Signed-off-by: Andreas-Christian Hagau <ach@hagau.se> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-20rtla: Documentation: fix email addressesRandy Dunlap1-1/+2
Correct lkml@vger to linux-kernel@vger. Add linux-trace-devel since that is what is in the MAINTAINERS file. Fixes: d40d48e1f1f2 ("rtla: Add Documentation") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Daniel Bristot de Oliveira <bristot@kernel.org> Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-20Drop Documentation/ide/Randy Dunlap9-978/+0
Drop all Documentation/ide/ since IDE support was deleted by Christoph Hellwig <hch@lst.de>, Jun 16 2021. Fixes: b7fb14d3ac63 ("ide: remove the legacy ide driver") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Jens Axboe <axboe@kernel.dk> Acked-by: Damien Le Moal <damien.lemoal@opensource.wdc.com> Reviewed-by: Christoph Hellwig <hch@lst.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16docs/scheduler: fix unit errorJui-Tse Huang1-2/+2
The unit mentioned in the documentation of scheduler statistics is outdated which may mislead the readers. The unit of statistics that is reported by /proc/schedstat is modified to nanosecond, and the unit of statistics that is reported by /proc/PID/schedstat is provided as well to make the context consistent. The rq_cpu_time and the rq_sched_info.run_delay of a run queue, and the sched_info.run_delay of a task are all updated based on the clock of the run queue, while the se.sum_exec_runtime of a task is updated based on the clock_task of the run queue of the task. Both the clock and clock_task are relied on the return value of the function sched_clock() which is in the unit of nanosecond. Signed-off-by: Jui-Tse Huang <juitse.huang@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16docs/admin: alphabetize parts of kernel-parameters.txt (part 2)Randy Dunlap1-83/+83
Alphabetize several of the kernel boot parameters in kernel-parameters.txt. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16Docs/admin: alphabetize some kernel-parameters (part 1)Randy Dunlap2-63/+61
Move some out-of-place kernel parameters into their correct locations. Move one out-of-order keyword/legend in kernel-parameters.rst. Add some missing keyword legends in kernel-parameters.rst: HIBERNATION HYPER_V and drop some obsolete/removed keyword legends: EIDE IOSCHED OSS TS XT Correct the location of the setup.h file. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: "Rafael J. Wysocki" <rafael@kernel.org> Cc: Pavel Machek <pavel@ucw.cz> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16Docs: admin/kernel-parameters: edit a few boot optionsRandy Dunlap1-11/+36
Clean up some of admin-guide/kernel-parameters.txt: a. "smt" should be "smt=" (S390) b. (dropped) c. Sparc supports the vdso= boot option d. make the tp_printk options (2) formatting similar to other options by adding spacing e. add "trace_clock=" with a reference to Documentation/trace/ftrace.rst f. use [IA-64] as documented instead of [ia64] g. fix formatting and text for test_suspend= h. fix formatting for swapaccount= i. fix formatting and grammar for video.brightness_switch_enabled= Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Heiko Carstens <hca@linux.ibm.com> Cc: Vasily Gorbik <gor@linux.ibm.com> Cc: Alexander Gordeev <agordeev@linux.ibm.com> Cc: Christian Borntraeger <borntraeger@linux.ibm.com> Cc: Sven Schnelle <svens@linux.ibm.com> Cc: linux-s390@vger.kernel.org Cc: Steven Rostedt <rostedt@goodmis.org> Cc: Ingo Molnar <mingo@redhat.com> Cc: "David S. Miller" <davem@davemloft.net> Cc: sparclinux@vger.kernel.org Cc: Michael Ellerman <mpe@ellerman.id.au> Cc: linux-ia64@vger.kernel.org Cc: "Rafael J. Wysocki" <rafael@kernel.org> Cc: Pavel Machek <pavel@ucw.cz> Cc: Len Brown <lenb@kernel.org> Cc: linux-pm@vger.kernel.org Cc: linux-acpi@vger.kernel.org Cc: Johannes Weiner <hannes@cmpxchg.org> Cc: Andrew Morton <akpm@linux-foundation.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16x86/efi: Remove references of EFI earlyprintk from documentationAkihiko Odaki1-2/+2
x86 EFI earlyprink was removed with commit 69c1f396f25b ("efi/x86: Convert x86 EFI earlyprintk into generic earlycon implementation"). Signed-off-by: Akihiko Odaki <akihiko.odaki@gmail.com> Reviewed-by: Ard Biesheuvel <ardb@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16docs: fault-injection: fix defaultsDylan Yudaken1-7/+7
ignore-gfp-wait and ignore-gfp-highmem defaults are actually true (Y) in both failslab and fail_page_alloc, not false as the docs suggest. See page_alloc.c:3762 and failslab.c:13 At the same time use 'Y' instead of '1' in the example scripts just for consistency. (though 1 would work) Signed-off-by: Dylan Yudaken <dylany@fb.com> Reviewed-by: Akinobu Mita <akinobu.mita@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16Documentation: arch_pgtable_helpers: demote pgtable list headingsBagas Sanjaya1-5/+5
All page title headings in arch_pgtable_helpers.txt except "Architecture Page Table Helpers" should have been subheadings instead. Demote them to chapter headings. Cc: Andrew Morton <akpm@linux-foundation.org> Cc: Anshuman Khandual <anshuman.khandual@arm.com> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16docs/zh_CN: Fix typo in process/howto.rstZhou Yuheng1-1/+1
Correct the url of linux-next Signed-off-by: Zhou Yuheng <woshoxxx@gmail.com> Reviewed-by: Alex Shi <alexs@kernel.org> Acked-by: Tang Yizhou <tangyizhou@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16docs/zh_CN: add vm hugetlbfs_reserv translationYanteng Si2-0/+437
Translate .../vm/hugetlbfs_reserv.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16docs/scheduler: Change unit of cpu_time and rq_time to nanosecondsChunguang Xu1-2/+2
In the current implementation, cpu_time and rq_time should be in nanoseconds, so this document needs to be modified. Signed-off-by: Chunguang Xu <brookxu@tencent.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16docs/zh_CN: Add spinlocks Chinese translationTang Yizhou1-0/+149
Translate locking/spinlocks.rst into Chinese. Signed-off-by: Tang Yizhou <tangyizhou@huawei.com> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-16docs/zh_CN: Add locking/index Chinese translationTang Yizhou2-1/+43
Translate locking/index.rst into Chinese. Signed-off-by: Tang Yizhou <tangyizhou@huawei.com> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-05docs/zh_CN: Add schedutil Chinese translationTang Yizhou2-0/+166
Translate scheduler/schedutil.rst into Chinese. Signed-off-by: Tang Yizhou <tangyizhou@huawei.com> Reviewed-by: Alex Shi <alexs@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-05docs/zh_CN: Add sched-debug Chinese translationTang Yizhou2-0/+52
Translate scheduler/sched-debug.rst into Chinese. Signed-off-by: Tang Yizhou <tangyizhou@huawei.com> Reviewed-by: Alex Shi <alexs@kernel.org> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-04-05Documentation: x86: Fix obsolete name of page fault handlerChin En Lin1-10/+13
Since commit 91eeafea1e4b ("x86/entry: Switch page fault exception to IDTENTRY_RAW"), the function name of the page fault handler is out of date. And because of commit aa37c51b9421 ("x86/mm: Break out user address space handling"), the description of search_exception_table is not correct anymore. It may mislead the user who wants to use the documentation to figure out the page fault handler. Also, fix typo and add the parentheses after function and macro name. Signed-off-by: Chin En Lin <shiyn.lin@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
generated by cgit v1.2.3 (git 2.39.1) at 2024-10-03 01:23:32 +0000