- Feb 23, 2023
-
-
Thorsten Leemhuis authored
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>
-
Randy Dunlap authored
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: 0c7b4366 ("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:
-
Carlos Bilbao authored
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:
-
Lukas Bulwahn authored
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:
-
- Feb 17, 2023
-
-
Jerry Hoemann authored
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:
-
Jerry Hoemann authored
The IPMI documentation moved to Documentation/driver-api/ipmi.rst. Update reference to reflect new location. Signed-off-by:
-
Randy Dunlap authored
Correct spelling problems for Documentation/core-api/padata.rst as reported by codespell. Signed-off-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:
-
Lukas Bulwahn authored
Commit 5d8c5e43 ("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:
Mike Rapoport (IBM) <rppt@kernel.org> Link: https://lore.kernel.org/r/20230215100808.9613-1-lukas.bulwahn@gmail.com Signed-off-by:
-
Jonathan Corbet authored
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:
-
- Feb 08, 2023
-
-
Jonathan Corbet authored
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:
-
- Feb 02, 2023
-
-
Wyes Karny authored
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:
-
Bjorn Helgaas authored
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 authored
Correct spelling problems for Documentation/userspace-api/ as reported by codespell. Signed-off-by:
-
Randy Dunlap authored
Correct spelling problems for Documentation/sparc/ as reported by codespell. Signed-off-by:
-
Randy Dunlap authored
Correct spelling problems for Documentation/driver-api/ as reported by codespell. Signed-off-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:
-
Randy Dunlap authored
Correct spelling problems for Documentation/admin-guide/ as reported by codespell. Signed-off-by:
-
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:
-
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) 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) 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:
Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by:
-
- Jan 31, 2023
-
-
Carlos Bilbao authored
Translate the following document into Spanish: - process/magic-number.rst Signed-off-by:
-
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.com Signed-off-by:
-
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.localdomain Signed-off-by:
-
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.net Signed-off-by:
-
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 authored
Without such escaping, -- is rendered as – (en dash). Signed-off-by:
Julia Lawall <Julia.Lawall@inria.fr> Link: https://lore.kernel.org/r/20230129151408.1525324-1-j.neuschaefer@gmx.net Signed-off-by:
-
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.com Signed-off-by:
-
- Jan 26, 2023
-
-
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.com Signed-off-by:
-
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.com Signed-off-by:
-
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:
-
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:
Lorenzo Stoakes <lstoakes@gmail.com> Acked-by:
Michal Hocko <mhocko@suse.com> Acked-by:
Vlastimil Babka <vbabka@suse.cz> Signed-off-by:
-
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.eu Signed-off-by:
-
- Jan 24, 2023
-
-
SeongJae Park authored
Add missing SPDX License Identifier for sound documentation index file. Signed-off-by:
Takashi Iwai <tiwai@suse.de> Link: https://lore.kernel.org/r/20230122213650.187710-9-sj@kernel.org Signed-off-by:
-
SeongJae Park authored
Add missing SPDX License Identifier for driver-api documentation index file. Signed-off-by:
-
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:
Iwona Winiarska <iwona.winiarska@intel.com> Acked-by:
-
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.com Signed-off-by:
-
Carlos Bilbao authored
Translate the following document into Spanish: - process/email-clients.rst Signed-off-by:
-
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:
Masami Hiramatsu (Google) <mhiramat@kernel.org> Link: https://lore.kernel.org/r/20230121225304.1711635-4-yoann.congal@smile.fr Signed-off-by:
-
Yoann Congal authored
This display the following code extract as a code block instead of a normal paragraph. Signed-off-by:
-
Yoann Congal authored
* Uncapitalise tracepoint * Hyphen in *-based * Plurals * fetch-args -> fetchargs * 2bytes hex -> 2-byte hex * .. -> . * arch -> architecture Signed-off-by:
-
