aboutsummaryrefslogtreecommitdiff
AgeCommit message (Collapse)AuthorFilesLines
2024-01-03Docs: remove mentions of fdformat from util-linuxThomas Weißschuh1-2/+2
Since util-linux commit 13b26e3c36d1 ("fdformat: remove command from default build") the fdformat tool is not built anymore by default. As a result it is not packaged anymore by distributions and therefore not usable by users. Instead mention the "mount" command as more likely to be present alternative. Also drop the reference to fdformat from the list of features of new versions of util-linux. Signed-off-by: Thomas Weißschuh <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2024-01-03Docs/zh_CN: Fix the meaning of DEBUG to pr_debug()JiaLong.Yang1-1/+1
We know the macro DEBUG will make pr_debug() save the formatted string into final binary. But the translation in chinese gives a opposite meaning. Signed-off-by: "JiaLong.Yang" <[email protected]> Reviewed-by: Zenghui Yu <[email protected]> Acked-by: Yanteng Si <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2024-01-03Documentation: move driver-api/dcdbas to userspace-api/Vegard Nossum6-4/+4
This file documents a sysfs interface that is intended for systems management software. It does NOT document any kind of kernel driver API. It is also not meant to be used directly by system administrators or users. Cc: Stuart Hayes <[email protected]> Cc: [email protected] Signed-off-by: Vegard Nossum <[email protected]> Acked-by: Hans de Goede <[email protected]> Reviewed-by: Randy Dunlap <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2024-01-03Documentation: move driver-api/isapnp to userspace-api/Vegard Nossum5-7/+7
driver-api/isapnp documents /proc interfaces for interfacing directly with ISA Plug & Play devices, not any kind of API for kernel developers, and should thus also live under userspace-api/. Also fix a few issues while we're at it. Cc: Jaroslav Kysela <[email protected]> Cc: Mauro Carvalho Chehab <[email protected]> Cc: Alexandre Belloni <[email protected]> Cc: Bartlomiej Zolnierkiewicz <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Reviewed-by: Randy Dunlap <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2024-01-03Documentation/core-api : fix typo in workqueueattreyee-muk1-1/+1
Correct to “boundaries” from “bounaries” Signed-off-by: Attreyee Mukherjee <[email protected]> Acked-by: Tejun Heo <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2024-01-03Documentation/trace: Fixed typos in the ftrace FLAGS sectionMatthew Cassell1-2/+2
Fixed typos in the FTRACE_OPS_FL_RECURSION flag description. Signed-off-by: Matthew Cassell <[email protected]> Reviewed-by: Randy Dunlap <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2024-01-03kernel-doc: handle a void function without producing a warningRandy Dunlap1-0/+1
Currently a void function can produce a warning: main.c:469: warning: contents before sections This one is from arch/x86/kernel/cpu/sgx/main.c (which is not included in any produced kernel documentation output). Handle this by setting $in_doc_sect to 1 whenever any recognized document section name is processed. Fixes: f624adef3d0b ("kernel-doc: limit the "section header:" detection to a select few") Signed-off-by: Randy Dunlap <[email protected]> Cc: Jani Nikula <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2024-01-03scripts/get_abi.pl: ignore some temp filesRandy Dunlap1-0/+1
When there are filenames of the form ".orig" or ".rej" in the Documenatation/ABI/ subdirectories, there can be confusing or erroneous output generated. Example: the file Documenation/ABI/testing/sysfs-bus-papr-pmem.orig causes this warning message: Documentation/ABI/testing/sysfs-bus-papr-pmem:2: WARNING: unknown document: '/powerpc/papr_hcalls' Prevent this by skipping over filenames that may be created by patch/diff tools etc. Signed-off-by: Randy Dunlap <[email protected]> Cc: Greg Kroah-Hartman <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Acked-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2024-01-03docs: kernel_abi.py: fix command injectionVegard Nossum5-50/+14
The kernel-abi directive passes its argument straight to the shell. This is unfortunate and unnecessary. Let's always use paths relative to $srctree/Documentation/ and use subprocess.check_call() instead of subprocess.Popen(shell=True). This also makes the code shorter. Link: https://fosstodon.org/@jani/111676532203641247 Reported-by: Jani Nikula <[email protected]> Cc: [email protected] Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2024-01-03scripts/get_abi: fix source path leakVegard Nossum1-1/+1
The code currently leaks the absolute path of the ABI files into the rendered documentation. There exists code to prevent this, but it is not effective when an absolute path is passed, which it is when $srctree is used. I consider this to be a minimal, stop-gap fix; a better fix would strip off the actual prefix instead of hacking it off with a regex. Link: https://mastodon.social/@vegard/111677490643495163 Cc: Jani Nikula <[email protected]> Cc: [email protected] Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2024-01-03CREDITS, MAINTAINERS, docs/process/howto: Update man-pages' maintainerAlejandro Colomar3-3/+9
Michael retired from maintaining the Linux man-pages project in 2021. See commit 06e72cb19c74d3b1d661609c698ee26d7b6e4d7e ("CONTRIBUTING, README, lsm: Remove mtk as maintainer") in the Linux man-pages repository. Add him to CREDITS. Reported-by: Ahelenia Ziemiańska <[email protected]> Link: <https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/commit/?id=06e72cb19c74d3b1d661609c698ee26d7b6e4d7e> Acked-by: Randy Dunlap <[email protected]> Cc: Michael Kerrisk <[email protected]> Cc: Michael Kerrisk <[email protected]> Cc: Geert Uytterhoeven <[email protected]> Cc: Jonathan Corbet <[email protected]> Signed-off-by: Alejandro Colomar <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-19docs: translations: add translations links when they existVegard Nossum4-1/+170
Add a new Sphinx extension that knows about the translations of kernel documentation and can insert links to the translations at the top of the document. It basically works like this: 1. Register a new node type, LanguagesNode. 2. Register a new transform, TranslationsTransform, that inserts a new LanguageNode at the top of every document. The LanguageNode contains "pending references" to translations of the document. The key here is that these are pending (i.e. unresolved) references that may or may not actually exist. 3. Register a 'doctree-resolved' event that iterates over all the LanguageNode nodes. Any unresolved references are filtered out; the list of resolved references is passed to the 'translations.html' template and rendered as an HTML node (if HTML output is selected). Testing: make htmldocs, make latexdocs with Sphinx v4.3.2 and Firefox. v2: - changed bar into a drop-down menu - fixed language labels - fixed hysteresis reported by Akira Yokosawa Cc: Federico Vaga <[email protected]> Cc: Jani Nikula <[email protected]> Cc: Akira Yokosawa <[email protected]> Cc: Yanteng Si <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-19kernel-doc: Align quick help and the codeAndy Shevchenko1-2/+2
The update to the quick help mentions -Wshort-description, but code never supported for that. Align that with the code by allowing both: -Wshort-description and -Wshort-desc. Fixes: 56b0f453db74 ("kernel-doc: don't let V=1 change outcome") Signed-off-by: Andy Shevchenko <[email protected]> Reviewed-by: Randy Dunlap <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-19MAINTAINERS: add reviewer for Spanish translationsCarlos Bilbao1-0/+1
Add Avadhut Naik as reviewer of the Spanish translations of the documentation. Signed-off-by: Carlos Bilbao <[email protected]> Acked-by: Avadhut Naik <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-18docs: ignore __counted_by attribute in structure definitionsJonathan Corbet1-0/+1
kernel-doc appeared to ignore __counted_by, but appearances can be deceiving; it caused member names to not be recognized, which manifested as a number of spurious "Excess struct member" warnings. Filter that attribute out and reduce the warning onslaught slightly. Signed-off-by: Jonathan Corbet <[email protected]>
2023-12-15scripts: kernel-doc: Clarify missing struct member descriptionKees Cook1-1/+1
The output "or member" should be more specific, instead saying "struct member". Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Kees Cook <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-15docs: conf.py: Ignore __counted_by attributeKees Cook1-0/+1
It seems that Sphinx is confused by the __counted_by attribute on struct members. Add it to the list of known attributes. Reported-by: kernel test robot <[email protected]> Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Cc: Jonathan Corbet <[email protected]> Cc: "Gustavo A. R. Silva" <[email protected]> Cc: [email protected] Cc: [email protected] Signed-off-by: Kees Cook <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-15Documentation, mm/unaccepted: document accept_memory kernel parameterVlastimil Babka1-0/+11
The accept_memory kernel parameter was added in commit dcdfdd40fa82 ("mm: Add support for unaccepted memory") but not listed in the kernel-parameters doc. Add it there. Acked-by: "Kirill A. Shutemov" <[email protected]> Signed-off-by: Vlastimil Babka <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-15scripts/kernel-doc: restore warning for Excess struct/unionRandy Dunlap1-0/+7
The warning for Excess struct or union member description was removed when the $nested parameter of check_sections() was removed. This causes some kernel-doc notation warnings to be missed. Recently the kernel test robot somehow reported an Excess member. The code in kernel-doc has not issued that warning since kernel v4.16, so I don't know how the robot did it. (See the Link for the report.) drivers/net/wireless/intel/iwlwifi/fw/dbg.c:86: warning: Excess struct/union/enum/typedef member 'trans_len' description in 'iwl_fw_dump_ptrs' I patched that warning away even though I could not reproduce the warning from kernel-doc. The warning should be issued for extraneous struct member or union member description, so restore it. Fixes: 1081de2d2f91 ("scripts: kernel-doc: get rid of $nested parameter") Signed-off-by: Randy Dunlap <[email protected]> Link: https://lore.kernel.org/all/[email protected]/ Cc: Mauro Carvalho Chehab <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Reviewed-by: Kees Cook <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-15Documentation: Remove redundant file names from examplesRex Nie1-3/+3
Since most examples use the ddcmd alias, remove the redundant file names Signed-off-by: Rex Nie <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-15docs: Change <h4> style to use smaller font size than <h3>Donald Hunter1-0/+1
The docs currently have <h3> and <h4> set to the same font size which makes headings hard to distinguish. <h1> to <h3> already have entries in sphinx-static/custom.css to shrink their size a bit from the alabaster theme. Add <h4> to custom.css and set it to be smaller than <h3>. Signed-off-by: Donald Hunter <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-15docs/sp_SP: Move howto.rst into /sp_SP/process/Avadhut Naik3-2/+2
Move the howto.rst file in Spanish translation to /sp_SP/process/ to ensure its location is symmetrical to its corresponding version in English. Signed-off-by: Avadhut Naik <[email protected]> Reviewed-by: Carlos Bilbao <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-15docs/sp_SP: Warn of links pointing to documentation in EnglishAvadhut Naik1-0/+3
By default, links in translated Spanish documentation redirect to documents in English, even if their corresponding Spanish version exists. Warn readers about this beforehand through disclaimer.rst. Signed-off-by: Avadhut Naik <[email protected]> Reviewed-by: Carlos Bilbao <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-15docs/sp_SP: Add translation of process/submit-checklistAvadhut Naik2-0/+134
Translate Documentation/process/submit-checklist.rst into Spanish. Signed-off-by: Avadhut Naik <[email protected]> Reviewed-by: Carlos Bilbao <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-15docs/sp_SP: Add translation of process/management-styleAvadhut Naik2-0/+300
Translate Documentation/process/management-style.rst into Spanish. Signed-off-by: Avadhut Naik <[email protected]> Reviewed-by: Carlos Bilbao <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-15docs: Raise the minimum Sphinx requirement to 2.4.4Jonathan Corbet7-29/+7
Commit 31abfdda6527 (docs: Deprecate use of Sphinx < 2.4.x) in 6.2 added a warning that support for older versions of Sphinx would be going away. There have been no complaints, so the time has come. Raise the minimum Sphinx version to 2.4.4 and clean out some compatibility code that we no longer need. Reviewed-by: Mauro Carvalho Chehab <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
2023-12-08Documentation: Destage TEE subsystem documentationSumit Garg14-368/+410
Add a separate documentation directory for TEE subsystem since it is a standalone subsystem which already offers devices consumed by multiple different subsystem drivers. Split overall TEE subsystem documentation modularly where: - The userspace API has been moved to Documentation/userspace-api/tee.rst. - The driver API has been moved to Documentation/driver-api/tee.rst. - The first module covers the overview of TEE subsystem. - The further modules are dedicated to different TEE implementations like: - OP-TEE - AMD-TEE - and so on for future TEE implementation support. Acked-by: Rijo Thomas <[email protected]> Acked-by: Jens Wiklander <[email protected]> Signed-off-by: Sumit Garg <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-08docs: nvmem: remove function parameters (fixes hyperlink generation)Luca Ceresoli1-1/+1
Adding a parameter is not particularly useful here, and it is definitely not done elsewhere. It also prevents the generation of a hyperlink to the kernel-doc documentation. Removing the parameter to enable hyperlinks and make the style coherent. Signed-off-by: Luca Ceresoli <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-08docs: nvmem: generate kernel-doc API documentationLuca Ceresoli1-0/+6
This is useful on its own, and it also enables hyperlink generation for functions mentioned in ReST documentation. Signed-off-by: Luca Ceresoli <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-12-08fs: vboxsf: fix a kernel-doc warningRandy Dunlap1-1/+1
Fix function parameters to prevent kernel-doc warnings. vboxsf_wrappers.c:132: warning: Function parameter or member 'create_parms' not described in 'vboxsf_create' vboxsf_wrappers.c:132: warning: Excess function parameter 'param' description in 'vboxsf_create' Signed-off-by: Randy Dunlap <[email protected]> Cc: Hans de Goede <[email protected]> Cc: Alexander Viro <[email protected]> Cc: Christian Brauner <[email protected]> Reviewed-by: Hans de Goede <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-27docs: submitting-patches: improve the base commit explanationBorislav Petkov (AMD)1-4/+11
After receiving a second patchset this week without knowing which tree it applies on and trying to apply it on the obvious ones and failing, make sure the base tree information which needs to be supplied in the 0th message of the patchset is spelled out more explicitly. Also, make the formulations stronger as this really is a requirement and not only a useful thing anymore. Signed-off-by: "Borislav Petkov (AMD)" <[email protected]> change-id: <unique-series-id> base-commit: <commit-id-or-tag> Reviewed-by: Kees Cook <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-27docs/zh_CN: Update process index to 6.7-rc2Yanteng Si1-8/+44
Update to commit f1477dbfa562 ("docs: add backporting and conflict resolution document") Signed-off-by: Yanteng Si <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/7f79015d251b3ad88d6ea596508e39832623db9d.1700474235.git.siyanteng@loongson.cn
2023-11-27docs/zh_CN: Adjust the number of characters per line in magic-number.rst to ↵Yanteng Si1-30/+39
less than 40 The current lines are too long and unfriendly to developers who use vim to read documents, especially on small monitors, so let's adjust to less than 40 characters. In addition, some translations were modified incidentally. Signed-off-by: Yanteng Si <[email protected]> Reviewed-by: Alex Shi <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/b3c1b55a442280c583518c45495e5540d6797548.1700474235.git.siyanteng@loongson.cn
2023-11-27docs/zh_CN: add process maintainer-pgp-guide tanslationYanteng Si2-0/+790
Translate process/maintainer-pgp-guide.rst into Chinese. Signed-off-by: Yanteng Si <[email protected]> Reviewed-by: Alex Shi <[email protected]> Reviewed-by: Konstantin Ryabitsev <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/7c7f24f653468c9a2c7e3909a7a390ea36eec879.1700474235.git.siyanteng@loongson.cn
2023-11-17Documentation: add tux logoVegard Nossum2-0/+10
We already have the logo, let's use it. Testing: make htmldocs Cc: Miguel Ojeda <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17docs: automarkup: linkify git revsVegard Nossum6-18/+39
There aren't a ton of references to commits in the documentation, but they do exist, and we can use automarkup to linkify them to make them easier to follow. Use something like this to find references to commits: git grep -P 'commit.*[0-9a-f]{8,}' Documentation/ Also fix a few of these to standardize on the exact format that is already used in changelogs. Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17Merge branch 'vegard' into docs-mwJonathan Corbet30-147/+49
Vegard Nossum writes: This patch series replaces some instances of 'class:: toc-title' with toctree's :caption: attribute, see the last patch in the series for some more rationale/explanation.
2023-11-17docs: remove .toc-title classVegard Nossum1-5/+0
The "toc-title" class was introduced in commit ef88f10eb877 ("[media] doc-rst: backward compatibility with older Sphinx versions") as a workaround for Sphinx versions older than 1.4.x. However, these old versions have been deprecated since commit 31abfdda6527 ("docs: Deprecate use of Sphinx < 2.4.x"). Having now changed all the toc-title users to use the :caption: attribute, we can also remove the custom style. Note that the toc-title class is separate from the "kernel-toc" logic that was introduced in commit c404f5d4f099 ("docs: Add more information to the HTML sidebar"). Cc: Mauro Carvalho Chehab <[email protected]> Cc: Jonathan Corbet <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17docs: use toctree :caption: and move introductionVegard Nossum4-26/+22
The canonical way to add a heading to the ToC is to use :caption:. Do that. Let's also move the introduction to the top of the document to be consistent with most other documents. Cc: Jonathan Corbet <[email protected]> Cc: Mauro Carvalho Chehab <[email protected]> Cc: Federico Vaga <[email protected]> Cc: Alex Shi <[email protected]> Cc: Yanteng Si <[email protected]> Cc: Hu Haowen <[email protected]> Cc: [email protected] Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17media: doc: properly format ToC headingsVegard Nossum7-42/+7
"class:: toc-title" was a workaround for older Sphinx versions that are no longer supported. The canonical way to add a heading to the ToC is to use :caption:. Do that. Cc: Mauro Carvalho Chehab <[email protected]> Cc: [email protected] Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17doc: misc-device: properly format ToC headingVegard Nossum1-4/+1
"class:: toc-title" was a workaround for older Sphinx versions that are no longer supported. The canonical way to add a heading to the ToC is to use :caption:. Do that. Cc: Greg Kroah-Hartman <[email protected]> Cc: Julien Panis <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17input: docs: properly format ToC headingsVegard Nossum3-12/+3
"class:: toc-title" was a workaround for older Sphinx versions that are no longer supported. The canonical way to add a heading to the ToC is to use :caption:. Do that. Cc: Dmitry Torokhov <[email protected]> Cc: [email protected] Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17docs: driver-api: properly format ToC headingsVegard Nossum6-26/+6
"class:: toc-title" was a workaround for older Sphinx versions that are no longer supported. The canonical way to add a heading to the ToC is to use :caption:. Do that. Cc: Mauro Carvalho Chehab <[email protected]> Cc: Richard Cochran <[email protected]> Cc: SeongJae Park <[email protected]> Cc: Hans de Goede <[email protected]> Cc: Armin Wolf <[email protected]> Cc: Iwona Winiarska <[email protected]> Cc: Ricardo Cañuelo <[email protected]> Cc: Tomas Winkler <[email protected]> Cc: [email protected] Cc: Yanteng Si <[email protected]> Cc: Alex Shi <[email protected]> Cc: Wu XiangCheng <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17Documentation: dev-tools: properly format ToC headingssVegard Nossum2-8/+2
"class:: toc-title" was a workaround for older Sphinx versions that are no longer supported. The canonical way to add a heading to the ToC is to use :caption:. Do that. Cc: Mauro Carvalho Chehab <[email protected]> Cc: gaochao <[email protected]> Cc: Yanteng Si <[email protected]> Cc: Wu XiangCheng <[email protected]> Cc: Fangrui Song <[email protected]> Cc: Wan Jiabing <[email protected]> Cc: Alex Shi <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17crypto: doc: properly format ToC headingsVegard Nossum2-8/+2
"class:: toc-title" was a workaround for older Sphinx versions that are no longer supported. The canonical way to add a heading to the ToC is to use :caption:. Do that. Cc: Mauro Carvalho Chehab <[email protected]> Cc: Stephan Mueller <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17media: admin-guide: properly format ToC headingVegard Nossum1-9/+1
"class:: toc-title" was a workaround for older Sphinx versions that are no longer supported. The canonical way to add a heading to the ToC is to use :caption:. Do that. Cc: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17doc: userspace-api: properly format ToC headingsVegard Nossum2-8/+2
"class:: toc-title" was a workaround for older Sphinx versions that are no longer supported. The canonical way to add a heading to the ToC is to use :caption:. Do that. Cc: Rui Li <[email protected]> Cc: Yanteng Si <[email protected]> Cc: Wu XiangCheng <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17docs: style toctree captions as headingsVegard Nossum1-0/+3
The rtd theme already styles toctree captions as headings, but the alabaster theme doesn't. Add this in. Cc: Mauro Carvalho Chehab <[email protected]> Cc: Jonathan Corbet <[email protected]> Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2023-11-17Documentation: Fix filename typo in ftrace docYuanhsi Chung1-1/+1
The filename for setting the cpumask should be `tracing_cpumask`, instead of `tracing_cpu_mask`. Signed-off-by: Yuanhsi Chung <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Message-ID: <[email protected]>
2023-11-17docs/zh_TW: replace my email addressHu Haowen61-79/+79
The Gmail address will not be used often from now on, and replace it with the email which is more frequently accessed by myself. Signed-off-by: Hu Haowen <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Message-ID: <[email protected]>
Powered by cgit, Gruvboxed by Blaster4385.