summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Merge tag 'docs-5.17' of git://git.lwn.net/linuxLinus Torvalds2022-01-1159-826/+4221
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Pull documentation updates from Jonathan Corbet: "This isn't a hugely busy cycle for documentation, but a few significant things still showed up: - A documentation section for ARC processors - Reworked and enhanced KUnit documentation - The ability to pick your own theme for HTML builds; if the default "Read the Docs" theme isn't ugly enough for you, you can now pick an uglier one. - More Chinese translation work Plus the usual assortment of fixes and cleanups" * tag 'docs-5.17' of git://git.lwn.net/linux: (53 commits) scripts: sphinx-pre-install: Fix ctex support on Debian docs: discourage use of list tables docs: 5.Posting.rst: describe Fixes: and Link: tags Documentation: kgdb: Replace deprecated remotebaud docs: automarkup.py: Fix invalid HTML link output and broken URI fragments Documentation: refer to config RANDOMIZE_BASE for kernel address-space randomization Documentation: kgdb: properly capitalize the MAGIC_SYSRQ config docs/zh_CN: Update and fix a couple of typos scripts: sphinx-pre-install: add required ctex dependency Documentation: KUnit: Restyled Frequently Asked Questions Documentation: KUnit: Restyle Test Style and Nomenclature page Documentation: KUnit: Rework writing page to focus on writing tests Documentation: kunit: Reorganize documentation related to running tests Documentation: KUnit: Added KUnit Architecture Documentation: KUnit: Rewrite getting started Documentation: KUnit: Rewrite main page docs/zh_CN: Add zh_CN/accounting/delay-accounting.rst Documentation/sphinx: fix typos of "its" docs/zh_CN: Add sched-domains translation doc: fs: remove bdev_try_to_free_page related doc ...
| * scripts: sphinx-pre-install: Fix ctex support on DebianMauro Carvalho Chehab2022-01-071-0/+3
| | | | | | | | | | | | | | | | | | | | | | The name of the package with ctexhook.sty is different on Debian/Ubuntu. Reported-by: Akira Yokosawa <akiyks@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Tested-by: Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/63882425609a2820fac78f5e94620abeb7ed5f6f.1641429634.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: discourage use of list tablesJonathan Corbet2022-01-071-6/+5
| | | | | | | | | | | | | | | | | | | | | | 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: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: 5.Posting.rst: describe Fixes: and Link: tagsThorsten Leemhuis2022-01-071-7/+22
| | | | | | | | | | | | | | | | | | | | | | 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: Jonathan Corbet <corbet@lwn.net>
| * Documentation: kgdb: Replace deprecated remotebaudChristian Löhle2022-01-071-1/+1
| | | | | | | | | | | | | | | | | | | | | | 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: Jonathan Corbet <corbet@lwn.net>
| * docs: automarkup.py: Fix invalid HTML link output and broken URI fragmentsJames Clark2022-01-071-7/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since commit d18b01789ae5 ("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: d18b01789ae5 ("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: Jonathan Corbet <corbet@lwn.net>
| * Documentation: refer to config RANDOMIZE_BASE for kernel address-space ↵Lukas Bulwahn2022-01-031-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | randomization 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: 6e88559470f5 ("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: Jonathan Corbet <corbet@lwn.net>
| * Documentation: kgdb: properly capitalize the MAGIC_SYSRQ configLukas Bulwahn2022-01-031-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20211230172423.30430-1-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN: Update and fix a couple of typosShile Zhang2022-01-031-5/+6
| | | | | | | | | | | | | | | | | | 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: Jonathan Corbet <corbet@lwn.net>
| * scripts: sphinx-pre-install: add required ctex dependencyMauro Carvalho Chehab2022-01-031-0/+1
| | | | | | | | | | | | | | | | | | | | | | After a change meant to fix support for oriental characters (Chinese, Japanese, Korean), ctex stylesheet is now a requirement for PDF output. Reported-by: Christoph Hellwig <hch@lst.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/165aa6167f21e3892a6e308688c93c756e94f4e0.1641243581.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: KUnit: Restyled Frequently Asked QuestionsHarinder Singh2021-12-231-37/+36
| | | | | | | | | | | | | | | | | | 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: Jonathan Corbet <corbet@lwn.net>
| * Documentation: KUnit: Restyle Test Style and Nomenclature pageHarinder Singh2021-12-231-54/+51
| | | | | | | | | | | | | | | | | | Rewrite page to enhance content consistency. Signed-off-by: Harinder Singh <sharinder@google.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Link: https://lore.kernel.org/r/20211217044911.798817-7-sharinder@google.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: KUnit: Rework writing page to focus on writing testsHarinder Singh2021-12-233-327/+255
| | | | | | | | | | | | | | | | | | | | | | | | 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: Harinder Singh <sharinder@google.com> Reviewed-by: Tim Bird <tim.bird@sony.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Link: https://lore.kernel.org/r/20211217044911.798817-6-sharinder@google.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: kunit: Reorganize documentation related to running testsHarinder Singh2021-12-234-1/+311
| | | | | | | | | | | | | | | | | | | | | | Consolidate documentation running tests into two pages: "run tests with kunit_tool" and "run tests without kunit_tool". Signed-off-by: Harinder Singh <sharinder@google.com> Reviewed-by: Tim Bird <tim.bird@sony.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Link: https://lore.kernel.org/r/20211217044911.798817-5-sharinder@google.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: KUnit: Added KUnit ArchitectureHarinder Singh2021-12-234-0/+288
| | | | | | | | | | | | | | | | | | | | | | | | Describe the components of KUnit and how the kernel mode parts interact with kunit_tool. Signed-off-by: Harinder Singh <sharinder@google.com> Co-developed-by: Marco Elver <elver@google.com> Signed-off-by: Marco Elver <elver@google.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Link: https://lore.kernel.org/r/20211217044911.798817-4-sharinder@google.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: KUnit: Rewrite getting startedHarinder Singh2021-12-231-93/+102
| | | | | | | | | | | | | | | | | | Clarify the purpose of kunit_tool and fixed consistency issues Signed-off-by: Harinder Singh <sharinder@google.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Link: https://lore.kernel.org/r/20211217044911.798817-3-sharinder@google.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: KUnit: Rewrite main pageHarinder Singh2021-12-231-78/+88
| | | | | | | | | | | | | | | | | | | | Add a section on advantages of unit testing, how to write unit tests, KUnit features and Prerequisites. Signed-off-by: Harinder Singh <sharinder@google.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Link: https://lore.kernel.org/r/20211217044911.798817-2-sharinder@google.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN: Add zh_CN/accounting/delay-accounting.rstYang Yang2021-12-232-1/+112
| | | | | | | | | | | | | | | | | | | | | | 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: Alex Shi <alexs@kernel.org> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20211217110949.453361-1-yang.yang29@zte.com.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/sphinx: fix typos of "its"Randy Dunlap2021-12-232-2/+2
| | | | | | | | | | | | | | | | | | | | Use "its" for possessive form instead of the contraction "it's". Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Link: https://lore.kernel.org/r/20211222062354.23224-1-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN: Add sched-domains translationTang Yizhou2021-12-232-1/+73
| | | | | | | | | | | | | | | | | | | | Translate scheduler/sched-domains.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> Link: https://lore.kernel.org/r/20211222141131.10134-1-tangyizhou@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc: fs: remove bdev_try_to_free_page related docZhiqiang Liu2021-12-231-5/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | In commit acc6100d3ffa ("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: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN: Add sched-design-CFS Chinese translationTang Yizhou2021-12-172-1/+206
| | | | | | | | | | | | | | | | | | | | Translate scheduler/sched-design-CFS.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> Link: https://lore.kernel.org/r/20211215033726.4538-1-tangyizhou@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN: Add sched-capacity Chinese translationTang Yizhou2021-12-162-1/+391
| | | | | | | | | | | | | | | | | | | | Translate scheduler/sched-capacity.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> Link: https://lore.kernel.org/r/20211213095945.17011-2-tangyizhou@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN: add sysfs-pci trnaslationYanteng Si2021-12-162-1/+127
| | | | | | | | | | | | | | | | | | Translate .../PCI/sysfs-pci.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/0c18e5eadaf47ec2befcf38e515c244cd700e13f.1639224005.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN: add msi-howto translationYanteng Si2021-12-162-2/+235
| | | | | | | | | | | | | | | | | | Translate .../PCI/msi-howto.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/d62846e2e820f600c27dc5e49887b3a2892eec17.1639224005.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: address some text issues with css/theme supportMauro Carvalho Chehab2021-12-162-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | Fix: - overriden ->overridden - some whitespace issues introduced at the css/theme Makefile help. Reported-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/b0b166025019f7cc4f122bd789c79ba28cc2d29d.1639212812.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Makefile: use the right path for DOCS_CSSMauro Carvalho Chehab2021-12-161-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/cea4ff1237ae9a99bc6509ab1bf9c70acd97e265.1639212812.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/vm: clarify overcommit amount sysctl behaviorAnssi Hannula2021-12-161-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Jonathan Corbet <corbet@lwn.net>
| * docs/zh_CN: Add cputopology Chinese translationTang Yizhou2021-12-162-1/+97
| | | | | | | | | | | | | | | | | | Translate admin-guide/cputopology.rst into Chinese. Signed-off-by: Tang Yizhou <tangyizhou@huawei.com> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/20211216023407.10976-1-tangyizhou@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Remove mentions of the Trivial Patch MonkeyMiguel Ojeda2021-12-162-25/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | 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: Joe Perches <joe@perches.com> Signed-off-by: Miguel Ojeda <ojeda@kernel.org> Acked-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20211214191415.GA19070@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: dev-tools: Add KTAP specificationRae Moar2021-12-102-0/+299
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: David Gow <davidgow@google.com> Reviewed-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: Jonathan Corbet <corbet@lwn.net>
| * doc/zh-CN: Update cpu-freq/core.rst to make it more readableTang Yizhou2021-12-101-11/+13
| | | | | | | | | | | | | | | | | | | | | | | | These Chinese translations are easier to understand. Also update the first memeber of struct cpufreq_freqs. Signed-off-by: Tang Yizhou <tangyizhou@huawei.com> Acked-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/20211202130240.27942-1-tangyizhou@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: ARC: Improve readabilityAlexey Brodkin2021-12-101-29/+33
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-abrodkin@synopsys.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: add support for RTD dark modeMauro Carvalho Chehab2021-12-103-15/+53
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/90d316e055ef7f4c9021b9eada8f8d3b2e750a66.1638870323.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: set format for the classic modeMauro Carvalho Chehab2021-12-101-0/+30
| | | | | | | | | | | | | | | | | | | | | | 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/8889380606681a2b7033f73bed9717250302be2a.1638870323.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: allow to pass extra DOCS_CSS themes via makeMauro Carvalho Chehab2021-12-103-1/+17
| | | | | | | | | | | | | | | | | | 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 <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/03d09bf41ad39aa0abfe2ea3c879b09aa3a0948d.1638870323.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: allow selecting a Sphinx themeMauro Carvalho Chehab2021-12-103-22/+41
| | | | | | | | | | | | | | | | | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/bd20adabfd428fd3cd0e69c2cf146aa354932936.1638870323.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: update self-protection __ro_after_init statusShuah Khan2021-12-101-2/+1
| | | | | | | | | | | | | | | | | | __ro_after_init is no longer new and under development. Update the document to reflect the correct status. Signed-off-by: Shuah Khan <skhan@linuxfoundation.org> Link: https://lore.kernel.org/r/20211208164051.8783-1-skhan@linuxfoundation.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * doc/zh_CN: add Chinese document coding style reminderAlex Shi2021-12-101-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The coding style requirement for Chinese document is easy to be overlooked. Add the request as a remdiner. Signed-off-by: Alex Shi <alexs@kernel.org> Cc: Yanteng Si <siyanteng01@gmail.com> Cc: Tang Yizhou <tangyizhou@huawei.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20211209095604.68954-1-alexs@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs/trace: fix a label of boottime-traceYanteng Si2021-12-101-3/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Commit 559789539255 ("Documentation: tracing: Add histogram syntax to boot-time tracing") introduced a warning: linux/Documentation/trace/boottime-trace.rst:136: WARNING: undefined label: histogram (if the link has no caption the label must precede a section header) Replace with: (path) Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org> Acked-by: Masami Hiramatsu <mhiramat@kernel.org> Fixes: 559789539255 ("Documentation: tracing: Add histogram syntax to boot-time tracing") Link: https://lore.kernel.org/r/20211210041536.1446734-1-siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Merge tag 'v5.16-rc4' into docs-nextJonathan Corbet2021-12-10945-7681/+10933
| |\ | | | | | | | | | | | | I have a couple of fixes for warnings introduced after -rc1; catch up to -rc4 so that the fixes have something to fix.
| * | docs/scheduler: fix typo and warning in sched-bwcYanteng Si2021-12-061-3/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | a) since d73df887b6b8 ("sched/fair: Add document for burstable CFS bandwidth") [cpu.cfs_quota_us: the total available run-time within a period (in] shoud be removed, let's delete it. b) Add a period. c) fix a build warning: linux-next/Documentation/scheduler/sched-bwc.rst:243: WARNING: Inline emphasis start-string without end-string. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/163a4dde20b8c4b68d668977a668e281d18fcf92.1638517064.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | docs/zh_CN: add scheduler sched-bwc translationYanteng Si2021-12-062-0/+205
| | | | | | | | | | | | | | | | | | | | | | | | | | | Translate .../scheduler/sched-bwc.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/e5f96f741012af6d4c4a27e7d1aab076ddffd322.1638517064.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | docs/zh_CN: add scheduler sched-arch translationYanteng Si2021-12-062-1/+77
| | | | | | | | | | | | | | | | | | | | | | | | Translate .../scheduler/sched-arch.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/f9e66ba8920bc1bb3f1d67044f64712fa30db7c9.1638517064.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | docs/zh_CN: add completion translationYanteng Si2021-12-062-1/+258
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Translate .../scheduler/completion.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Acked-by: Tang Yizhou <tangyizhou@huawei.com> Link: https://lore.kernel.org/r/47b6fd1f277058dfb8d06dd3d33fedc2ef55fcbb.1638777809.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | docs/zh_CN: add scheduler index translationYanteng Si2021-12-062-1/+43
| | | | | | | | | | | | | | | | | | | | | | | | | | | Translate .../scheduler/index.rst into Chinese. Signed-off-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/e015c61f64fc0d4d3a49f0e85e925f00df433721.1638777809.git.siyanteng@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | doc/zh-CN: Update cpu-freq/cpu-drivers.rst to make it more readableTang Yizhou2021-12-061-69/+70
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are some syntax errors in this document. Also make it more readable. Signed-off-by: Tang Yizhou <tangyizhou@huawei.com> Acked-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20211202050816.12240-1-tangyizhou@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | doc/zh-CN: Update cpufreq-stats.rst to make it more readableTang Yizhou2021-12-061-22/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | These Chinese translations are easier to understand. Also add proofreader. Signed-off-by: Tang Yizhou <tangyizhou@huawei.com> Acked-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20211202142312.20052-1-tangyizhou@huawei.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | docs/zh_CN: Add zh_CN/accounting/taskstats.rstYang Yang2021-11-292-1/+146
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add translation zh_CN/accounting/taskstats.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: Alex Shi <alexs@kernel.org> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20211129065113.306748-1-yang.yang29@zte.com.cn [jc: removed excess RST label] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Doc: networking: Fix the title's Sphinx overline in rds.rstAhmed Zaki2021-11-291-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | A missing "=" caused the title and sections to not show up properly in the htmldocs. Signed-off-by: Ahmed Zaki <anzaki@gmail.com> Link: https://lore.kernel.org/r/20211128171719.3286255-1-anzaki@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-24 09:42:52 +0100