- 02 Feb, 2023 4 commits
-
-
Shuah Khan authored
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>
-
Mike Rapoport (IBM) authored
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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Mike Rapoport (IBM) authored
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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Mike Rapoport (IBM) authored
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: 5d8c5e43 ("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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 31 Jan, 2023 7 commits
-
-
Carlos Bilbao authored
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>
-
Ross Zwisler authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Hui Su authored
%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.localdomainSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jonathan Neuschäfer authored
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.netSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jonathan Neuschäfer authored
Commit 43756e34 ("scripts/kernel-doc: Add support for named variable macro arguments") improved how named variable macro arguments are handled, and changed how they are documented in kerneldoc comments from "@param...", to "@param", deprecating the old syntax. All users of the old syntax have since been converted, so this commit finally removes support for it. The output of "make htmldocs" is the same with and without this commit. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Link: https://lore.kernel.org/r/20230129150435.1510400-1-j.neuschaefer@gmx.netSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jonathan Neuschäfer authored
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.netSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Zang Leigang authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 26 Jan, 2023 5 commits
-
-
Wang Yong authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jakob Koschel authored
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 67274c08 ("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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Shuah Khan authored
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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Mike Rapoport (IBM) authored
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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jules Maselbas authored
Fix typo emluation -> emulation Signed-off-by: Jules Maselbas <jmaselbas@kalray.eu> Link: https://lore.kernel.org/r/20230126173217.12912-1-jmaselbas@kalray.euSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 24 Jan, 2023 8 commits
-
-
SeongJae Park authored
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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
SeongJae Park authored
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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
SeongJae Park authored
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.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Jeffrey Hugo authored
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: 8c5577a5 ("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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Carlos Bilbao authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yoann Congal authored
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.frSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yoann Congal authored
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.frSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yoann Congal authored
* 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.frSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 19 Jan, 2023 3 commits
-
-
Sohil Mehta authored
The default vsyscall mode has been updated from emulate to xonly for a while. Update the kernel-parameters doc to reflect that. Fixes: 625b7b7f ("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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Yanteng Si authored
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.cnSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Peter Foley authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 13 Jan, 2023 9 commits
-
-
Jonathan Corbet authored
Bring the 6.2 fixes into the development branch as well to avoid build problems.
-
Carlos Bilbao authored
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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Kees Cook authored
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>
-
Federico Vaga authored
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.itSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Fabio Fantoni authored
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.itSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Conor Dooley authored
Proton Mail automatically picks up PGP keys for those with kernel.org accounts (and other domains!) which provide WKD for their users & uses them to encrypt emails, including patches. Document the behaviour & Proton Mail's unsuitability for kernel development. Reviewed-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org> Reviewed-by: Mark Brown <broonie@kernel.org> Signed-off-by: Conor Dooley <conor.dooley@microchip.com> Link: https://lore.kernel.org/r/20221231152320.1340874-1-conor@kernel.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Federico Vaga authored
Translation for the following patches commit da4288b9 ("scripts/check-local-export: avoid 'wait $!' for process substitution") commit 5372de4e ("docs/doc-guide: Put meta title for kernel-doc HTML page") commit 4d627ef1 ("docs/doc-guide: Mention make variable SPHINXDIRS") commit 7c43214d ("docs/doc-guide: Add footnote on Inkscape for better images in PDF documents") commit 615041d4 ("docs: kernel-docs: shorten the lengthy doc title") commit cbf4adfd ("Documentation: process: Update email client instructions for Thunderbird") commit e72b3b98 ("maintainer-pgp-guide: minor wording tweaks") commit ea522496 ("Documentation: process: replace outdated LTS table w/ link") commit 93431e06 ("Replace HTTP links with HTTPS ones: documentation") commit e648174b ("Documentation: Fix spelling mistake in hacking.rst") commit 602684ad ("docs: Update version number from 5.x to 6.x in README.rst") commit 48987606 ("docs: add a man-pages link to the front page") commit 0c7b4366 ("docs: Rewrite the front page") Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Link: https://lore.kernel.org/r/20221231130849.4675-1-federico.vaga@vaga.pv.itSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Federico Vaga authored
`usato` becomes `usando` Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Link: https://lore.kernel.org/r/20221230172456.58745-1-federico.vaga@vaga.pv.itSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
Federico Vaga authored
The type contained a typo `uintprt` -> `uintptr` Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Acked-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20221230172328.58612-1-federico.vaga@vaga.pv.itSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 11 Jan, 2023 1 commit
-
-
Akira Yokosawa authored
"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: d5389d31 ("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.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-
- 06 Jan, 2023 2 commits
-
-
Jonathan Corbet authored
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>
-
Jonathan Corbet authored
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>
-
- 02 Jan, 2023 1 commit
-
-
Wang Yong authored
change "64Gb" to "64GB". Signed-off-by: Wang Yong <yongw.kernel@gmail.com> Link: https://lore.kernel.org/r/20221228100141.382325-1-yongw.kernel@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>
-