- Jan 21, 2022
-
-
Randy Dunlap authored
Adjust the path of the ABI files for firewire.rst to prevent a documentation build error. Prevents this problem: Sphinx parallel build error: docutils.utils.SystemMessage: Documentation/driver-api/firewire.rst:22: (SEVERE/4) Problems with "include" directive path: InputError: [Errno 2] No such file or directory: '../Documentation/driver-api/ABI/stable/firewire-cdev'. Fixes: 2f4830ef ("FireWire: add driver-api Introduction section") Signed-off-by:
Randy Dunlap <rdunlap@infradead.org> Tested-by:
Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/20220119033905.4779-1-rdunlap@infradead.org Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- Jan 18, 2022
-
-
Huichun Feng authored
The sentence looks ambiguous, rephrase it by adding ", there". Signed-off-by:
Huichun Feng <foxhoundsk.tw@gmail.com> Signed-off-by:
Ching-Chun (Jim) Huang <jserv@ccns.ncku.edu.tw> Signed-off-by:
Chun-Hung Tseng <henrybear327@gmail.com> Acked-by:
Steven Rostedt <rostedt@goodmis.org> Link: https://lore.kernel.org/r/20220111052000.2675944-1-foxhoundsk.tw@gmail.com Signed-off-by:
-
Wang Cheng authored
Signed-off-by:
Wang Cheng <wanngchenng@gmail.com> Reviewed-by:
Sumit Garg <sumit.garg@linaro.org> Acked-by:
-
- Jan 08, 2022
-
-
Mauro Carvalho Chehab authored
The name of the package with ctexhook.sty is different on Debian/Ubuntu. Reported-by:
Mauro Carvalho Chehab <mchehab@kernel.org> Tested-by:
-
Jonathan Corbet authored
Our documentation encourages the use of list-table formats, but that advice runs counter to the objective of keeping the plain-text documentation as useful and readable as possible. Turn that advice around the other way so that people don't keep adding these tables. Acked-by:
Christoph Hellwig <hch@lst.de> Acked-by:
-
Thorsten Leemhuis authored
Explain Fixes: and Link: tags in Documentation/process/5.Posting.rst, which are missing in this file for unknown reasons and only described in Documentation/process/submitting-patches.rst. Signed-off-by:
Thorsten Leemhuis <linux@leemhuis.info> CC: Konstantin Ryabitsev <konstantin@linuxfoundation.org> Link: https://lore.kernel.org/r/c4a5f5e25fa84b26fd383bba6eafde4ab57c9de7.1641314856.git.linux@leemhuis.info Signed-off-by:
-
Christian Löhle authored
Using set remotebaud to set the baud rate was deprecated in gdb-7.7 and completely removed from the command parser in gdb-7.8 (released in 2014). Adopt set serial baud instead. Signed-off-by:
Christian Loehle <cloehle@hyperstone.com> Reviewed-by:
Daniel Thompson <daniel.thompson@linaro.org> Link: https://lore.kernel.org/r/4050689967ed46baaa3bfadda53a0e73@hyperstone.com Signed-off-by:
-
James Clark authored
Since commit d18b0178 ("docs: Add automatic cross-reference for documentation pages"), references that were already explicitly defined with "ref:" and referred to other pages with a path have been doubled. This is reported as the following error by Firefox: Start tag "a" seen but an element of the same type was already open. End tag "a" violates nesting rules. As well as the invalid HTML, this also obscures the URI fragment links to subsections because the second link overrides the first. For example on the page admin-guide/hw-vuln/mds.html the last link should be to the "Default Mitigations" subsection using a # URI fragment: admin-guide/hw-vuln/l1tf.html#default-mitigations But it is obsured by a second link to the whole page: admin-guide/hw-vuln/l1tf.html The full HTML with the double <a> tags looks like this: <a class="reference internal" href="l1tf.html#default-mitigations"> <span class="std std-ref"> <a class="reference internal" href="l1tf.html"> <span class="doc">L1TF - L1 Terminal Fault</span> </a> </span> </a> After this commit, there is only a single link: <a class="reference internal" href="l1tf.html#default-mitigations"> <span class="std std-ref">Documentation/admin-guide/hw-vuln//l1tf.rst</span> </a> Now that the second link is removed, the browser correctly jumps to the default-mitigations subsection when clicking the link. The fix is to check that nodes in the document to be modified are not already references. A reference is counted as any text that is a descendant of a reference type node. Only plain text should be converted to new references, otherwise the doubling occurs. Testing ======= * Test that the build stdout is the same (ignoring ordering), and that no new warnings are printed. * Diff all .html files and check that the only modifications occur to the bad double links. * The auto linking of bare references to pages without "ref:" is still working. Fixes: d18b0178 ("docs: Add automatic cross-reference for documentation pages") Reviewed-by:
Nícolas F. R. A. Prado <n@nfraprado.net> Signed-off-by:
James Clark <james.clark@arm.com> Link: https://lore.kernel.org/r/20220105143640.330602-2-james.clark@arm.com Signed-off-by:
-
- Jan 04, 2022
-
-
Lukas Bulwahn authored
The config RANDOMIZE_SLAB does not exist, the authors probably intended to refer to the config RANDOMIZE_BASE, which provides kernel address-space randomization. They probably just confused SLAB with BASE (these two four-letter words coincidentally share three common letters), as they also point out the config SLAB_FREELIST_RANDOM as further randomization within the same sentence. Fix the reference of the config for kernel address-space randomization to the config that provides that. Fixes: 6e885594 ("Documentation: Add section about CPU vulnerabilities for Spectre") Signed-off-by:
Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20211230171940.27558-1-lukas.bulwahn@gmail.com Signed-off-by:
-
Lukas Bulwahn authored
Most readers are probably going to figure out that the config is actually all upper-case letters, as all Kconfig symbols are this way. Properly capitalizing makes the script ./scripts/checkkconfigsymbols.py happy, which otherwise would report this as a reference to a non-existing Kconfig symbol. So, use the right capitalization for the MAGIC_SYSRQ config in the kgdb documentation. Signed-off-by:
-
Shile Zhang authored
Update to the original README.rst and fix some typos. Signed-off-by:
Shile Zhang <shile.zhang@linux.alibaba.com> Reviewed-by:
Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/20211230025702.186158-1-shile.zhang@linux.alibaba.com Signed-off-by:
-
Mauro Carvalho Chehab authored
After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output. Reported-by:
-
- Dec 24, 2021
-
-
Harinder Singh authored
Reword to align with other chapters. Signed-off-by:
Harinder Singh <sharinder@google.com> Reviewed-by:
Brendan Higgins <brendanhiggins@google.com> Link: https://lore.kernel.org/r/20211217044911.798817-8-sharinder@google.com Signed-off-by:
-
Harinder Singh authored
Rewrite page to enhance content consistency. Signed-off-by:
-
Harinder Singh authored
We now have dedicated pages on running tests. Therefore refocus the usage page on writing tests and add content from tips page and information on other architectures. Signed-off-by:
Tim Bird <tim.bird@sony.com> Reviewed-by:
-
Harinder Singh authored
Consolidate documentation running tests into two pages: "run tests with kunit_tool" and "run tests without kunit_tool". Signed-off-by:
-
Harinder Singh authored
Describe the components of KUnit and how the kernel mode parts interact with kunit_tool. Signed-off-by:
Marco Elver <elver@google.com> Signed-off-by:
-
Harinder Singh authored
Clarify the purpose of kunit_tool and fixed consistency issues Signed-off-by:
-
Harinder Singh authored
Add a section on advantages of unit testing, how to write unit tests, KUnit features and Prerequisites. Signed-off-by:
-
Yang Yang authored
Add translation zh_CN/accounting/delay-accounting.rst and links it to zh_CN/accounting/index.rst while clean its todo entry. Signed-off-by:
Yang Yang <yang.yang29@zte.com.cn> Reviewed-by:
Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20211217110949.453361-1-yang.yang29@zte.com.cn Signed-off-by:
-
Randy Dunlap authored
Use "its" for possessive form instead of the contraction "it's". Signed-off-by:
-
Tang Yizhou authored
Translate scheduler/sched-domains.rst into Chinese. Signed-off-by:
Tang Yizhou <tangyizhou@huawei.com> Reviewed-by:
-
Zhiqiang Liu authored
In commit acc6100d ("fs: remove bdev_try_to_free_page callback"), bdev_try_to_free_page has been removed. We should remove its doc. Signed-off-by:
Zhiqiang Liu <liuzhiqiang26@huawei.com> Reviewed-by:
Jens Axboe <axboe@kernel.dk> Reviewed-by:
Jan Kara <jack@suse.cz> Link: https://lore.kernel.org/r/c45e6351-b0f8-3410-787e-02c6aeb3efe6@huawei.com Signed-off-by:
-
- Dec 17, 2021
-
-
Tang Yizhou authored
Translate scheduler/sched-design-CFS.rst into Chinese. Signed-off-by:
-
Tang Yizhou authored
Translate scheduler/sched-capacity.rst into Chinese. Signed-off-by:
-
Yanteng Si authored
Translate .../PCI/sysfs-pci.rst into Chinese. Signed-off-by:
-
Yanteng Si authored
Translate .../PCI/msi-howto.rst into Chinese. Signed-off-by:
-
Mauro Carvalho Chehab authored
Fix: - overriden ->overridden - some whitespace issues introduced at the css/theme Makefile help. Reported-by:
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by:
-
Mauro Carvalho Chehab authored
When make is used with O=<dir>, the location of the css file won't be get right: $ make DOCS_THEME=nature DOCS_CSS=my_css.css O=DOCS SPHINXDIRS=x86 -j9 htmldocs make[1]: Entering directory '/work/lnx/next/next-2021-1210/DOCS' ... cp: cannot stat 'my_css.css': No such file or directory Fix it in a way that both relative and absolute paths will be handled. Reported-by:
-
Anssi Hannula authored
Documentation/vm/overcommit-accounting.rst says that the overcommit amount can be set via vm.overcommit_ratio and vm.overcommit_kbytes. Add a clarification that those only take effect in overcommit handling mode 2 ("Don't overcommit"), i.e. they do not act as an "additional" limit that is always enforced. Signed-off-by:Anssi Hannula <anssi.hannula@iki.fi> Reviewed-by:
David Hildenbrand <david@redhat.com> Link: https://lore.kernel.org/r/20211211194159.3137362-1-anssi.hannula@iki.fi Signed-off-by:
-
Tang Yizhou authored
Translate admin-guide/cputopology.rst into Chinese. Signed-off-by:
-
Miguel Ojeda authored
Apparently, it was decided that trivial@kernel.org is no longer used. Link: https://lore.kernel.org/lkml/fe86efbd-4e03-76c8-55cf-dabd33e85823@infradead.org/ Co-developed-by:
Joe Perches <joe@perches.com> Signed-off-by:
Miguel Ojeda <ojeda@kernel.org> Acked-by:
-
- Dec 11, 2021
-
-
Rae Moar authored
It does not make any significant additions or changes other than those already in use in the kernel: additional features can be added as they become necessary and used. [1]: https://testanything.org/tap-version-13-specification.html Signed-off-by:
Rae Moar <rmoar@google.com> Co-developed-by:
David Gow <davidgow@google.com> Signed-off-by:
Shuah Khan <skhan@linuxfoundation.org> Reviewed-by:
Kees Cook <keescook@chromium.org> Link: https://lore.kernel.org/r/20211207190251.18426-1-davidgow@google.com Signed-off-by:
-
Tang Yizhou authored
These Chinese translations are easier to understand. Also update the first memeber of struct cpufreq_freqs. Signed-off-by:
-
Alexey Brodkin authored
There were some things which made rendered document look not very elegant. That was because: 1. Numbered lists were formatted in more of Markdown way rather than true reStructuredText and so were displayed as a plain text with leading numbers. Well, moreover numbered lists were not needed as in all cases we were just listing a couple of options w/o any intention to follow any particular order, so a simpler unordered list fits better and looks cleaner. 2. URL's of external resources were added as they are (which is OK in a plain text, but make not much sense in a HTML where we may use more human-friendly link names with URL's hidden. 3. Some URL's had trailing slashes which were not really needed Fix all items from above! Signed-off-by:
Alexey Brodkin <abrodkin@synopsys.com> Cc: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Vineet Gupta <vgupta@kernel.org> Link: https://lore.kernel.org/r/20211202215747.19923-1-a...
-
Mauro Carvalho Chehab authored
This is actually an overlay on the top of the RTD theme, which requires to include first the RTD theme. It should be noticed that, when the dark theme is used, the DOCS_CSS files won't be the last CSS themes. So, it won't override the dark.css style by default. So, it is needed to force the them override with "!important". This small script, for instance, produces a nice output with the RTD dark theme: DOCS_THEME=sphinx_rtd_dark_mode cat << EOF > dark_override.css html body { font-family: arial,helvetica,sans-serif; } html[data-theme='dark'] body { color: white !important; } html[data-theme='dark'] .sig-name { color: green !important; } html[data-theme='dark'] .wy-menu-vertical a { color: #ffcc00 !important; } html[data-theme="dark"] h1, html[data-theme="dark"] h2, html[data-theme="dark"] h3 { color: #ffcc00 !important; } html[data-theme="dark"] h4, html[data-theme="dark"] h5, html[data-theme="dark"] h6 { color: #ffcc00 !important; } html[data-theme="dark"] h7, html[data-theme="dark"] h8, html[data-theme="dark"] h9 { color: #ffcc00 !important; } html[data-theme="dark"] .wy-nav-content a, html[data-theme="dark"] .wy-nav-content a:visited { color: #ffcc00 !important; } EOF make DOCS_CSS=dark_override.css DOCS_THEME=sphinx_rtd_dark_mode htmldocs Signed-off-by: -
Mauro Carvalho Chehab authored
When RTD is not installed or when THEME=classic is used, the produced docs contain some weird selections. As this theme has several variables to customize it, set them, in order to produce a nicer output. Signed-off-by:
-
Mauro Carvalho Chehab authored
Specially when the RTD theme is not used, it makes sense to allow specifying extra CSS files via a make variable. Signed-off-by:
-
Mauro Carvalho Chehab authored
Instead of having RTD as an almost mandatory theme, allow the user to select other themes via DOCS_THEME environment var. There's a catch, though: as the current theme override logic is dependent of the RTD theme, we need to move the code which adds the CSS overrides to be inside the RTD theme logic. Signed-off-by:
-
Shuah Khan authored
__ro_after_init is no longer new and under development. Update the document to reflect the correct status. Signed-off-by:
-
