summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* docs: recommend using Link: whenever using Reported-by:Thorsten Leemhuis2023-02-232-5/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Encourage developers to place Link: tag pointing to the report when they are using Reported-by: tags. Those links are often extremely useful for any code archaeologist that wants to know more about the backstory of a change than the commit message provides. That includes maintainers higher up in the patch-flow hierarchy, which is why Linus asks developers to add such links [1, 2, 3]. To quote [1]: > Again, the commit has a link to the patch *submission*, which is > almost entirely useless. There's no link to the actual problem the > patch fixes. > > [...] > > Put another way: I can see that > > Reported-by: Zhangfei Gao <zhangfei.gao@foxmail.com> > > in the commit, but I don't have a clue what the actual report was, and > there really isn't enough information in the commit itself, except for > a fairly handwavy "Device drivers might, for instance, still need to > flush operations.." > > I don't want to know what device drivers _might_ do. I would want to > have an actual pointer to what they do and where. Another reason why these links are wanted: the ongoing regression tracking efforts can only scale with them, as they allow the regression tracking bot 'regzbot' to automatically connect tracked reports with patches that are posted or committed to fix tracked regressions. Link: https://lore.kernel.org/all/CAHk-=wjMmSZzMJ3Xnskdg4+GGz=5p5p+GSYyFBTh0f-DgvdBWg@mail.gmail.com/ [1] Link: https://lore.kernel.org/all/CAHk-=wgs38ZrfPvy=nOwVkVzjpM3VFU1zobP37Fwd_h9iAD5JQ@mail.gmail.com/ [2] Link: https://lore.kernel.org/all/CAHk-=wjxzafG-=J8oT30s7upn4RhBs6TX-uVFZ5rME+L5_DoJA@mail.gmail.com/ [3] Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Link: https://lore.kernel.org/r/9a07ec640d809723492f8ade4f54705914e80419.1676369564.git.linux@leemhuis.info Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: front page: use recommended heading adornmentsRandy Dunlap2023-02-231-8/+9
| | | | | | | | | | | | | | | | | | | Convert the Documentation front page to use the heading adornments that are documented in doc-guide/sphinx.rst for document title and chapters. I.e., convert most section headings to chapters. This leaves "Indices and tables" as a chapter entry at the same level as the other chapters. The only visual difference from before to after is that the "Indices and tables" heading is smaller and has more vertical whitespace preceding it (although that may depend on the web browser being used). Fixes: 0c7b4366f1ab ("docs: Rewrite the front page") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/20230215005726.27320-1-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/sp_SP: Add process programming-language translationCarlos Bilbao2023-02-232-0/+54
| | | | | | | | Translate Documentation/process/programming-language.rst into Spanish. Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20230207220844.2661295-1-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: locking: refer to the actual existing config namesLukas Bulwahn2023-02-231-2/+2
| | | | | | | | | | | | | | The config is actually called CONFIG_RT_MUTEXES, not CONFIG_RT_MUTEX. The config CONFIG_LOCK_TORTURE_TEST should be connected by underscore, for the sake of consistent referencing to configs in the kernel documentation. Address those issues. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Acked-by: Waiman Long <longman@redhat.com> Link: https://lore.kernel.org/r/20230220165749.12850-1-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/watchdog/hpwdt: Fix FormatJerry Hoemann2023-02-161-3/+3
| | | | | | | | | | Add list format so that compiled documentation looks like it was intended to. Signed-off-by: Jerry Hoemann <jerry.hoemann@hpe.com> Reviewed-by: Guenter Roeck <linux@roeck-us.net> Link: https://lore.kernel.org/r/20230210184247.221134-3-jerry.hoemann@hpe.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/watchdog/hpwdt: Fix ReferenceJerry Hoemann2023-02-161-1/+1
| | | | | | | | | | The IPMI documentation moved to Documentation/driver-api/ipmi.rst. Update reference to reflect new location. Signed-off-by: Jerry Hoemann <jerry.hoemann@hpe.com> Reviewed-by: Guenter Roeck <linux@roeck-us.net> Link: https://lore.kernel.org/r/20230210184247.221134-2-jerry.hoemann@hpe.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: core-api: padata: correct spellingRandy Dunlap2023-02-161-1/+1
| | | | | | | | | | | | | | | | | | | | Correct spelling problems for Documentation/core-api/padata.rst as reported by codespell. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: netdev@vger.kernel.org Cc: Steffen Klassert <steffen.klassert@secunet.com> Cc: Daniel Jordan <daniel.m.jordan@oracle.com> Cc: linux-crypto@vger.kernel.org Cc: Herbert Xu <herbert@gondor.apana.org.au> Cc: "David S. Miller" <davem@davemloft.net> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Jakub Kicinski <kuba@kernel.org> Reviewed-by: Mukesh Ojha <quic_mojha@quicinc.com> Acked-by: Daniel Jordan <daniel.m.jordan@oracle.com> Link: https://lore.kernel.org/r/20230215053744.11716-1-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/mm: Physical Memory: correct spelling in reference to CONFIG_PAGE_EXTENSIONLukas Bulwahn2023-02-161-1/+1
| | | | | | | | | | | | | Commit 5d8c5e430a63 ("docs/mm: Physical Memory: add structure, introduction and nodes description") slips in a minor spelling mistake for the config PAGE_EXTENSION. Correct the config name in the physical-memory documentation. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Acked-by: Mike Rapoport (IBM) <rppt@kernel.org> Link: https://lore.kernel.org/r/20230215100808.9613-1-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Use HTML comments for the kernel-toc SPDX lineJonathan Corbet2023-02-161-1/+1
| | | | | | | | | This line was initially placed in {# jinja2 comments #}, but that led to an "invalid token" complaint from spdxcheck.py. Rather than fix the script for a usage we'll likely never see anywhere else, just switch to an HTML comment, which spdxcheck.py thinks is fine. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Add more information to the HTML sidebarJonathan Corbet2023-02-083-3/+66
| | | | | | | | | | | | | | Add a new sidebar template that creates a more RTD-like "fisheye" view of the current place in the document hierarchy. It is far from ideal, but some readers may find it better for navigating through the documentation as a whole. Add some CSS trickery as well to make the table of contents less intrusive when viewing the pages on a small screen. Reviewed-by: Akira Yokosawa <akiyks@gmail.com> Reviewed-by: David Gow <davidgow@google.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: KVM: Update AMD memory encryption linkWyes Karny2023-02-021-1/+1
| | | | | | | | | | Update AMD memory encryption white-paper document link. Previous link is not available. Update new available link. Signed-off-by: Wyes Karny <wyes.karny@amd.com> Reviewed-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20230125175948.21100-1-wyes.karny@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* printk: Document that CONFIG_BOOT_PRINTK_DELAY required for boot_delay=Bjorn Helgaas2023-02-021-2/+4
| | | | | | | | | | | Document the fact that CONFIG_BOOT_PRINTK_DELAY must be enabled for the "boot_delay" kernel parameter to work. Also mention that "lpj=" may be necessary. Signed-off-by: Bjorn Helgaas <bhelgaas@google.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20230126225420.1320276-1-helgaas@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: userspace-api: correct spellingRandy Dunlap2023-02-0213-14/+14
| | | | | | | | | | | | | | Correct spelling problems for Documentation/userspace-api/ as reported by codespell. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Sean Young <sean@mess.org> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: linux-media@vger.kernel.org Link: https://lore.kernel.org/r/20230129231053.20863-10-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: sparc: correct spellingRandy Dunlap2023-02-022-24/+24
| | | | | | | | | | | | | Correct spelling problems for Documentation/sparc/ as reported by codespell. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: "David S. Miller" <davem@davemloft.net> Cc: sparclinux@vger.kernel.org Link: https://lore.kernel.org/r/20230129231053.20863-9-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: driver-api: correct spellingRandy Dunlap2023-02-0221-24/+24
| | | | | | | | | | | | | | | | | | | | | Correct spelling problems for Documentation/driver-api/ as reported by codespell. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: linux-media@vger.kernel.org Cc: Vishal Verma <vishal.l.verma@intel.com> Cc: Dave Jiang <dave.jiang@intel.com> Cc: nvdimm@lists.linux.dev Cc: Vinod Koul <vkoul@kernel.org> Cc: dmaengine@vger.kernel.org Cc: linux-raid@vger.kernel.org Cc: linux-usb@vger.kernel.org Acked-by: Dan Williams <dan.j.williams@intel.com> Acked-by: Song Liu <song@kernel.org> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Link: https://lore.kernel.org/r/20230129231053.20863-3-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: admin-guide: correct spellingRandy Dunlap2023-02-0225-41/+41
| | | | | | | | | | | | | | | | | | | | Correct spelling problems for Documentation/admin-guide/ as reported by codespell. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Mukesh Ojha <quic_mojha@quicinc.com> Cc: Tejun Heo <tj@kernel.org> Cc: Zefan Li <lizefan.x@bytedance.com> Cc: Johannes Weiner <hannes@cmpxchg.org> Cc: cgroups@vger.kernel.org Cc: Alasdair Kergon <agk@redhat.com> Cc: Mike Snitzer <snitzer@kernel.org> Cc: dm-devel@redhat.com Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: linux-media@vger.kernel.org Cc: linux-mm@kvack.org Link: https://lore.kernel.org/r/20230129231053.20863-2-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: add workload-tracing document to admin-guideShuah Khan2023-02-022-0/+617
| | | | | | | | | | | | | | | | | Add a new section to the admin-guide with information of interest to application developers and system integrators doing analysis of the Linux kernel for safety critical applications. This section will contain documents supporting analysis of kernel interactions with applications, and key kernel subsystems expectations. Add a new workload-tracing document to this new section. Signed-off-by: Shefali Sharma <sshefali021@gmail.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org> Link: https://lore.kernel.org/r/20230131221105.39216-1-skhan@linuxfoundation.org [jc: tweaked the sphinx formatting a bit] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/admin-guide/mm: remove useless markupMike Rapoport (IBM)2023-02-0216-46/+14
| | | | | | | | | | | | | | | It is enough to use a file name to cross-reference another rst document. Jon says: The right things will happen in the HTML output, readers of the plain-text will know immediately where to go, and we don't have to add the label clutter. Drop reference markup and unnecessary labels and use plain file names. Signed-off-by: Mike Rapoport (IBM) <rppt@kernel.org> Link: https://lore.kernel.org/r/20230201094156.991542-4-rppt@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/mm: remove useless markupMike Rapoport (IBM)2023-02-0227-57/+9
| | | | | | | | | | | | | | | It is enough to use a file name to cross-reference another rst document. Jon says: The right things will happen in the HTML output, readers of the plain-text will know immediately where to go, and we don't have to add the label clutter. Drop reference markup and unnecessary labels and use plain file names. Signed-off-by: Mike Rapoport (IBM) <rppt@kernel.org> Link: https://lore.kernel.org/r/20230201094156.991542-3-rppt@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/mm: Physical Memory: remove useless markupMike Rapoport (IBM)2023-02-023-10/+6
| | | | | | | | | | | | | | | | | | | | Jon says: > +See also :ref:`Page Reclaim <page_reclaim>`. Can also just be "See also Documentation/mm/page_reclaim.rst". The right things will happen in the HTML output, readers of the plain-text will know immediately where to go, and we don't have to add the label clutter. Remove reference markup and unnecessary labes and use plain file names. Fixes: 5d8c5e430a63 ("docs/mm: Physical Memory: add structure, introduction and nodes description") Suggested-by: Jonathan Corbet <corbet@lwn.net> Acked-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Mike Rapoport (IBM) <rppt@kernel.org> Link: https://lore.kernel.org/r/20230201094156.991542-2-rppt@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/sp_SP: Add process magic-number translationCarlos Bilbao2023-01-312-0/+91
| | | | | | | | | | | Translate the following document into Spanish: - process/magic-number.rst Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20230125181840.3007341-1-carlos.bilbao@amd.com [jc: escaped '*' to eliminate sphinx warning ] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: ftrace: always use canonical ftrace pathRoss Zwisler2023-01-3122-266/+266
| | | | | | | | | | | | | | | | | | | | | The canonical location for the tracefs filesystem is at /sys/kernel/tracing. But, from Documentation/trace/ftrace.rst: Before 4.1, all ftrace tracing control files were within the debugfs file system, which is typically located at /sys/kernel/debug/tracing. For backward compatibility, when mounting the debugfs file system, the tracefs file system will be automatically mounted at: /sys/kernel/debug/tracing Many parts of Documentation still reference this older debugfs path, so let's update them to avoid confusion. Signed-off-by: Ross Zwisler <zwisler@google.com> Reviewed-by: Steven Rostedt (Google) <rostedt@goodmis.org> Link: https://lore.kernel.org/r/20230125213251.2013791-1-zwisler@google.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Doc/damon: fix the data path errorHui Su2023-01-313-6/+6
| | | | | | | | | | %s/modules/module/ Signed-off-by: Hui Su <suhui_kernel@163.com> Reviewed-by: Alex Shi <alexsshi@kernel.org> Reviewed-by: SeongJae Park <sj@kernel.org> Link: https://lore.kernel.org/r/Y9Tm1FiKBPKA2Tcx@localhost.localdomain Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dma-buf: Add "dma-buf" to title of documentationJonathan Neuschäfer2023-01-311-2/+2
| | | | | | | | | To make it easier to find the dma-buf documentation when looking through tables-of-contents etc., put the name "dma-buf" in the title. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Link: https://lore.kernel.org/r/20230129115917.1229529-1-j.neuschaefer@gmx.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: coccinelle: Escape --options to fix Sphinx outputJonathan Neuschäfer2023-01-311-4/+4
| | | | | | | | | Without such escaping, -- is rendered as – (en dash). Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Acked-by: Julia Lawall <Julia.Lawall@inria.fr> Link: https://lore.kernel.org/r/20230129151408.1525324-1-j.neuschaefer@gmx.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/zh_CN: add damon lru_sort translationZang Leigang2023-01-312-0/+264
| | | | | | | | | | Translate .../admin-guide/mm/damon/lru_sort.rst into Chinese. Signed-off-by: Zang Leigang <zangleigang@hisilicon.com> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/20230130120509.12029-1-zangleigang@hisilicon.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: KVM: fix typos in running-nested-guests.rstWang Yong2023-01-261-1/+1
| | | | | | | | | change "gues" to "guest" and remove redundant ")". Signed-off-by: Wang Yong <yongw.kernel@gmail.com> Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com> Link: https://lore.kernel.org/r/20230110150046.549755-1-yongw.kernel@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/scripts/gdb: add necessary make scripts_gdb stepJakob Koschel2023-01-261-0/+4
| | | | | | | | | | | | | | | | | In order to debug the kernel successfully with gdb you need to run 'make scripts_gdb' nowadays. This was changed with the following commit: Commit 67274c083438340ad16c ("scripts/gdb: delay generation of gdb constants.py") In order to have a complete guide for beginners this remark should be added to the offial documentation. Signed-off-by: Jakob Koschel <jkl820.git@gmail.com> Link: https://lore.kernel.org/r/20230112-documentation-gdb-v2-1-292785c43dc9@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: leds: fix the following docu build warningShuah Khan2023-01-261-0/+1
| | | | | | | | | | | Add leds-qcom-lpg to Documentation/leds/index.rst to fix the following doc build warning. Documentation/leds/leds-qcom-lpg.rst: WARNING: document isn't included in any toctree Signed-off-by: Shuah Khan <skhan@linuxfoundation.org> Link: https://lore.kernel.org/r/20230125154426.12464-1-skhan@linuxfoundation.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/mm: Physical Memory: add structure, introduction and nodes descriptionMike Rapoport (IBM)2023-01-263-0/+351
| | | | | | | | | | | | | | | | Add structure, introduction and Nodes section to Physical Memory chapter. As the new documentation references core-api/dma-api and mm/page_reclaim, add page labels to those documents. Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by: Lorenzo Stoakes <lstoakes@gmail.com> Acked-by: Michal Hocko <mhocko@suse.com> Acked-by: Vlastimil Babka <vbabka@suse.cz> Signed-off-by: Mike Rapoport (IBM) <rppt@kernel.org> Link: https://lore.kernel.org/r/20230125192841.25342-2-rppt@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/mm: Fix typo emluation -> emulationJules Maselbas2023-01-261-1/+1
| | | | | | | | Fix typo emluation -> emulation Signed-off-by: Jules Maselbas <jmaselbas@kalray.eu> Link: https://lore.kernel.org/r/20230126173217.12912-1-jmaselbas@kalray.eu Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Docs/sound/index: Add missing SPDX License IdentifierSeongJae Park2023-01-241-0/+2
| | | | | | | | | Add missing SPDX License Identifier for sound documentation index file. Signed-off-by: SeongJae Park <sj@kernel.org> Acked-by: Takashi Iwai <tiwai@suse.de> Link: https://lore.kernel.org/r/20230122213650.187710-9-sj@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Docs/driver-api/index: Add missing SPDX License IdentifierSeongJae Park2023-01-241-0/+2
| | | | | | | | | Add missing SPDX License Identifier for driver-api documentation index file. Signed-off-by: SeongJae Park <sj@kernel.org> Link: https://lore.kernel.org/r/20230122213650.187710-3-sj@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Docs/subsystem-apis: Remove '[The ]Linux' prefixes from titles of listed ↵SeongJae Park2023-01-2414-42/+42
| | | | | | | | | | | | | | | documents Some documents that listed on subsystem-apis have 'Linux' or 'The Linux' title prefixes. It's duplicated information, and makes finding the document of interest with human eyes not easy. Remove the prefixes from the titles. Signed-off-by: SeongJae Park <sj@kernel.org> Acked-by: Iwona Winiarska <iwona.winiarska@intel.com> Acked-by: Bjorn Helgaas <bhelgaas@google.com> Link: https://lore.kernel.org/r/20230122184834.181977-1-sj@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: accel: Fix debugfs pathJeffrey Hugo2023-01-241-1/+1
| | | | | | | | | | | | | | | The device specific directory in debugfs does not have "accel". For example, the documentation says device 0 should have a debugfs entry as /sys/kernel/debug/accel/accel0/ but in reality the entry is /sys/kernel/debug/accel/0/ Fix the documentation to match the implementation. Fixes: 8c5577a5ccc6 ("doc: add documentation for accel subsystem") Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com> Reviewed-by: Oded Gabbay <ogabbay@kernel.org> Link: https://lore.kernel.org/r/1674145568-31513-1-git-send-email-quic_jhugo@quicinc.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/sp_SP: Add process email-clients translationCarlos Bilbao2023-01-242-0/+375
| | | | | | | | | | Translate the following document into Spanish: - process/email-clients.rst Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20230117144722.31195-1-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: kprobetrace: Split paragraphsYoann Congal2023-01-241-0/+2
| | | | | | | | | | | Add an empty line to force the output to split paragraphs like it is splitin the REST source. Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Steven Rostedt (Google) <rostedt@goodmis.org> Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org> Link: https://lore.kernel.org/r/20230121225304.1711635-4-yoann.congal@smile.fr Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: kprobetrace: Fix code block markupYoann Congal2023-01-241-2/+2
| | | | | | | | | | | This display the following code extract as a code block instead of a normal paragraph. Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Steven Rostedt (Google) <rostedt@goodmis.org> Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org> Link: https://lore.kernel.org/r/20230121225304.1711635-3-yoann.congal@smile.fr Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: kprobetrace: Fix some typosYoann Congal2023-01-241-8/+9
| | | | | | | | | | | | | | | | * Uncapitalise tracepoint * Hyphen in *-based * Plurals * fetch-args -> fetchargs * 2bytes hex -> 2-byte hex * .. -> . * arch -> architecture Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Steven Rostedt (Google) <rostedt@goodmis.org> Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org> Link: https://lore.kernel.org/r/20230121225304.1711635-2-yoann.congal@smile.fr Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* x86/vsyscall: Fix documentation to reflect the default modeSohil Mehta2023-01-191-4/+4
| | | | | | | | | | | | | The default vsyscall mode has been updated from emulate to xonly for a while. Update the kernel-parameters doc to reflect that. Fixes: 625b7b7f79c6 ("x86/vsyscall: Change the default vsyscall mode to xonly") Cc: Andy Lutomirski <luto@kernel.org> Signed-off-by: Sohil Mehta <sohil.mehta@intel.com> Reviewed-by: Tony Luck <tony.luck@intel.com> Reviewed-by: Kees Cook <keescook@chromium.org> Link: https://lore.kernel.org/r/20230111193211.1987047-1-sohil.mehta@intel.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/zh_CN: Add a glossary of Chinese translation termsYanteng Si2023-01-192-0/+45
| | | | | | | | | | | | | As more and more documents are translated and some English words are translated into different Chinese, it seems that we need a glossary of Chinese translation terms. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Reviewed-by: Tang Yizhou <tangyeechou@gmail.com> Acked-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/20230117093416.2262787-1-siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: Avoid duplicate Kconfig inclusionPeter Foley2023-01-191-2/+8
| | | | | | | | | | | Documentation/Kconfig is already included from top-level, avoid including it again from lib/Kconfig.debug. Signed-off-by: Peter Foley <pefoley2@pefoley.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20230114-doc-v2-1-853a8434ac95@pefoley.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'docs-fixes' into docs-mwJonathan Corbet2023-01-132-3/+15
|\ | | | | | | | | Bring the 6.2 fixes into the development branch as well to avoid build problems.
| * docs/conf.py: Use about.html only in sidebar of alabaster themeAkira Yokosawa2023-01-111-1/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | "about.html" is available only for the alabaster theme [1]. Unconditionally putting it to html_sidebars prevents us from using other themes which respect html_sidebars. Remove about.html from the initialization and insert it at the front for the alabaster theme. Link: [1] https://alabaster.readthedocs.io/en/latest/installation.html#sidebars Fixes: d5389d3145ef ("docs: Switch the default HTML theme to alabaster") Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/4b162dbe-2a7f-1710-93e0-754cf8680aae@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Deprecate use of Sphinx < 2.4.xJonathan Corbet2023-01-061-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The Sphinx 2.4 release is three years old, and it is becoming increasingly difficult to even find a system with an sufficiently archaic Python installation that can run versions older than that. I can no longer test changes against anything prior to 2.4.x. Move toward raising our minimum Sphinx requirement to 2.4.x so we can delete some older support code and claim to support a range of versions that we can actually test. In the absence of screams, the actual removal of support can happen later in 2023. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Fix the docs build with Sphinx 6.0Jonathan Corbet2023-01-061-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx 6.0 removed the execfile_() function, which we use as part of the configuration process. They *did* warn us... Just open-code the functionality as is done in Sphinx itself. Tested (using SPHINX_CONF, since this code is only executed with an alternative config file) on various Sphinx versions from 2.5 through 6.0. Reported-by: Martin Liška <mliska@suse.cz> Cc: stable@vger.kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs/sp_SP: Add process kernel-enforcement-statement.rst translationCarlos Bilbao2023-01-132-0/+175
| | | | | | | | | | | | | | | | | | | | Translate the following document into Spanish: - process/kernel-enforcement-statement.rst Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/20230103165608.134190-1-carlos.bilbao@amd.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: deprecated.rst: Add note about DECLARE_FLEX_ARRAY() usageKees Cook2023-01-131-0/+26
| | | | | | | | | | | | | | | | | | | | | | | | There wasn't any mention of when/where DECLARE_FLEX_ARRAY() should be used, so add the rationale and an example to the deprecation docs. Suggested-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr> Cc: "Gustavo A. R. Silva" <gustavoars@kernel.org> Signed-off-by: Kees Cook <keescook@chromium.org> Link: https://lore.kernel.org/r/20230106200600.never.735-kees@kernel.org [jc: minor wording tweaks] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc:it_IT: add translation for botching-up-ioctl.rstFederico Vaga2023-01-132-0/+250
| | | | | | | | | | | | | | | | This patch adds the translation for the botching up ioctl document. Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Link: https://lore.kernel.org/r/20230102183716.9698-1-federico.vaga@vaga.pv.it Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc:it_IT: fix of 2 typosFabio Fantoni2023-01-132-2/+2
| | | | | | | | | | | | | | | | | | Fix of 2 typos spotted reading documentation in italian Signed-off-by: Fabio Fantoni <fantonifabio@tiscali.it> Acked-by: Federico Vaga <federico.vaga@vaga.pv.it> Link: https://lore.kernel.org/r/20230101155548.12350-1-fantonifabio@tiscali.it Signed-off-by: Jonathan Corbet <corbet@lwn.net>
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-18 18:52:41 +0000