- 14 Jul, 2022 6 commits
-
-
Lukas Bulwahn authored
Commit 31b24bee ("docs: add a warning to submitting-drivers.rst") in October 2016 already warns "This (...) should maybe just be deleted, but I'm not quite ready to do that yet". Maybe, six years ago, we were not ready but let us remove old content for the better now and structure and maintain less content in the kernel documentation with a better result. Drop this already outdated document and adjust all textual references. Here is an argument why deleting the content will not remove any useful information to the existing kernel documentation, individually broken down for each section. Section "Allocating Device Numbers" refers to https://www.lanana.org/, and then refers to Documentation/admin-guide/devices.rst. However, the devices.rst clearly states: "The version of this document at lanana.org is no longer maintained." Everything needed for submitting drivers is already stated in devices.rst and the reference to https://www.lanana.org/ is outdated, and should be just deleted. Section "Who To Submit Drivers To" is all about Linux 2.0 - 2.6, before the new release version scheme; the mentioned developers are still around, but actually not the first developers to contact anymore. Section "What Criteria Determine Acceptance" has a few bullet points: Licensing and Copyright is well-covered in process/kernel-license.rst. Interfaces, Code, Portability, Clarity state some obvious things about ensuring kernel code quality. Control suggests to add a MAINTAINERS entry, which is already mentioned in 6.Followthrough.rst: "... added yourself to the MAINTAINERS file..." PM support states a bit about implementing and testing power management of a driver, it remains an open question where to place that in the process documents. Driver developers interested in power management will find the corresponding part on power management in the kernel documentation anyway. In section "What Criteria Do Not Determine Acceptance", the points Vendor and Author states something basic consequence of the kernel being an open-source community software development. Probably no need to mention it nowadays. Section "Resources" lists resources that are also mentioned elsewhere more central. - Linux kernel tree and mailing list is mentioned in many places. - https://lwn.net/Kernel/LDD3/ is mentioned in Documentation/process/kernel-docs.rst. - https://lwn.net/ is mentioned in: - Documentation/process/8.Conclusion.rst - Documentation/process/kernel-docs.rst - https://kernelnewbies.org/ is mentioned in: - Documentation/process/8.Conclusion.rst - Documentation/process/kernel-docs.rst - http://www.linux-usb.org/ is mentioned in Documentation/driver-api/usb/usb.rst - https://landley.net/kdocs/ols/2002/ols2002-pages-545-555.pdf is mentioned in Documentation/process/kernel-docs.rst - https://kernelnewbies.org/KernelJanitors is mentioned in Documentation/process/howto.rst - https://git-scm.com/ is mentioned in - Documentation/process/2.Process.rst - Documentation/process/7.AdvancedTopics.rst - Documentation/process/howto.rst Signed-off-by:
Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220704122537.3407-7-lukas.bulwahn@gmail.comSigned-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Lukas Bulwahn authored
The statement that the Latex version of Linux Device List is unmaintained, must go back to some historic time where there were actually two separate document sources, one in a txt format and another in a tex format (maybe even just on lanana.org). Nowadays, html and tex are generated from the ReST document file and the statement might be confused, believing the actual generated LaTeX document from the maintained ReST document could be an unmaintained one. Remove this statement on the LaTeX version and only keep pointing out that the version on lanana.org is no longer maintained. Signed-off-by:
-
Lukas Bulwahn authored
One section in submitting-drivers.rst was just a collection of references to other external documentation. All except the one added in this commit is already mentioned in kernel-docs or other places in the kernel documentation. Add Arjan van de Ven's article on How to NOT write kernel driver to this index of further kernel documentation. Signed-off-by:
-
Lukas Bulwahn authored
Remove and rephrase statements that only make sense if a single author exclusively would maintain this document, but we would really want to consider this being a page maintained by the kernel community, as it is placed in the kernel repository, and let us hope that more contributors suggest some more documents. Further, do some minor word-smithing. Signed-off-by:
-
Lukas Bulwahn authored
The original title comes from copying the content from a web page that covered various mixed computer-science material. Within the kernel documentation and its current structure, the title can be shortened. Other titles considered, but not selected were: - Index of More Kernel Documentation - Further Kernel Documentation - References to Further Kernel Documentation Shorten the title. Signed-off-by:
-
Lukas Bulwahn authored
The documents on each section of this document are ordered by its published date, from the newest to the oldest. In the kernel-docs.rst, the references on each section of this document are intended to be ordered by its published date, from the newest to the oldest. The Linux Kernel Module Programming Guide was published in 2021; so, it is placed at the top as the most recent publication after the rolling-version "Linux Kernel Mailing List Glossary" reference. Fixes: 630c8fa0 ("Documentation: Update details of The Linux Kernel Module Programming Guide") Signed-off-by:
-
- 13 Jul, 2022 8 commits
-
-
Wu XiangCheng authored
Last English version used: commit d2b40ba2 ("docs: *-regressions.rst: explain how quickly issues should be handled") Signed-off-by:
Wu XiangCheng <bobwxc@email.cn> Reviewed-by: Yanteng Si<siyanteng@loongson.cn> Link: https://lore.kernel.org/r/YsbuDGIpUjOzfAAh@bobwxc.mipcSigned-off-by:
-
Michael Kelley authored
Add documentation topic for clocks and timers when running as a guest on Hyper-V. Signed-off-by:
Michael Kelley <mikelley@microsoft.com> Link: https://lore.kernel.org/r/1657561704-12631-4-git-send-email-mikelley@microsoft.comSigned-off-by:
-
Michael Kelley authored
Add documentation topic for using VMbus when running as a guest on Hyper-V. Signed-off-by:
-
Michael Kelley authored
Add an initial documentation topic for Linux enlightenments to run as a guest on Microsoft's Hyper-V hypervisor, linked under the "virt" documentation area. Update the virt doc index.rst and the MAINTAINERS file. Signed-off-by:
-
Yixuan Cao authored
I noticed that there are some Chinese words that can be more accurate. So I fix them as follows. 首先，英文原文中的"release" 在这个语境下 是物理页面“释放”的意思，而不是“发布”。 其次，标准表的第一列和第二列， 表达的是“长短键”的意思，第一列是“短键”， 而第二列是“长键”。这样翻译或会更清晰一些。 Signed-off-by:
Yixuan Cao <caoyixuan2019@email.szu.edu.cn> Acked-by: Yanteng Si<siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20220708172351.20928-1-caoyixuan2019@email.szu.edu.cnSigned-off-by:
-
Binbin Zhou authored
Translate core-api/watch_queue.rst into Chinese. Last English version used: commit f5461124 ("Documentation: move watch_queue to core-api"). Signed-off-by:
Binbin Zhou <zhoubinbin@loongson.cn> Reviewed-by:
-
Dov Murik authored
The siphash documentation misspelled "offsetendof" instead of "offsetofend". Fixes: 2c956a60 ("siphash: add cryptographically secure PRF") Signed-off-by:
Dov Murik <dovmurik@linux.ibm.com> Acked-by:
Jason A. Donenfeld <Jason@zx2c4.com> Link: https://lore.kernel.org/r/20220712104455.1408150-1-dovmurik@linux.ibm.comSigned-off-by:
-
Lukas Bulwahn authored
After sending a patch to linux-doc-tw-discuss@lists.sourceforge.net, I got the typical response for a moderated list: Your mail to 'linux-doc-tw-discuss' with the subject .... Is being held until the list moderator can review it for approval. The reason it is being held: Post by non-member to a members-only list Mark this mailing list moderated in MAINTAINERS. Signed-off-by:
-
- 07 Jul, 2022 25 commits
-
-
Mauro Carvalho Chehab authored
Changeset fd27de58b0ad ("dt-bindings: display: tegra: Convert to json-schema") renamed: Documentation/devicetree/bindings/display/tegra/nvidia,tegra20-host1x.txt to: Documentation/devicetree/bindings/display/tegra/nvidia,tegra20-host1x.yaml. Update its cross-reference accordingly. Fixes: fd27de58b0ad ("dt-bindings: display: tegra: Convert to json-schema") Signed-off-by:Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/e0adee01fe8064f981eb854e04fb64c4a0408b66.1656234456.git.mchehab@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
Changeset 441613662db7 ("dt-bindings: mfd: Convert da9063 to yaml") renamed: Documentation/devicetree/bindings/mfd/da9063.txt to: Documentation/devicetree/bindings/mfd/dlg,da9063.yaml. Update its cross-reference accordingly. Fixes: 441613662db7 ("dt-bindings: mfd: Convert da9063 to yaml") Signed-off-by:Rob Herring <robh@kernel.org> Acked-by:
Conor Dooley <conor.dooley@microchip.com> Link: https://lore.kernel.org/r/da459164d166d994b06f9ce8bf3a2108ccd0abd5.1656234456.git.mchehab@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
The binding directory for hte was renamed. Update references accordingly. Fixes: af583852 ("dt-bindings: Renamed hte directory to timestamp") Signed-off-by:
Dipen Patel <dipenp@nvidia.com> Link: https://lore.kernel.org/r/2e2c86485cb0642455cee01796f9a74de21403e6.1656234456.git.mchehab@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
Since IDE support was deleted by Christoph Hellwig <hch@lst.de>, Jun 16 2021, drop the left-over from README file, updating the documentation to point to ata/pata_falcon.c. Fixes: 44b1fbc0 ("m68k/q40: Replace q40ide driver with pata_falcon and falconide") Fixes: b7fb14d3 ("ide: remove the legacy ide driver") Signed-off-by:
Geert Uytterhoeven <geert@linux-m68k.org> Acked-by:
-
Mauro Carvalho Chehab authored
Changeset a8e35fec ("objtool: Update documentation") renamed: tools/objtool/Documentation/stack-validation.txt to: tools/objtool/Documentation/objtool.txt. Update the cross-references accordingly. Fixes: a8e35fec ("objtool: Update documentation") Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset daec8d40 ("Documentation: KVM: add separate directories for architecture-specific documentation") renamed: Documentation/virt/kvm/s390-diag.rst to: Documentation/virt/kvm/s390/s390-diag.rst. Update its cross-reference accordingly. Fixes: daec8d40 ("Documentation: KVM: add separate directories for architecture-specific documentation") Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset daec8d40 ("Documentation: KVM: add separate directories for architecture-specific documentation") renamed: Documentation/virt/kvm/msr.rst to: Documentation/virt/kvm/x86/msr.rst. Update its cross-reference accordingly. Fixes: daec8d40 ("Documentation: KVM: add separate directories for architecture-specific documentation") Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset daec8d40 ("Documentation: KVM: add separate directories for architecture-specific documentation") renamed: Documentation/virt/kvm/amd-memory-encryption.rst to: Documentation/virt/kvm/x86/amd-memory-encryption.rst. Update the cross-references accordingly. Fixes: daec8d40 ("Documentation: KVM: add separate directories for architecture-specific documentation") Signed-off-by:
-
Mauro Carvalho Chehab authored
Changesets: daec8d40 ("Documentation: KVM: add separate directories for architecture-specific documentation") and: daec8d40 ("Documentation: KVM: add separate directories for architecture-specific documentation") renamed: Documentation/virt/kvm/s390-pv.rst to: Documentation/virt/kvm/s390/s390-pv.rst. Update its cross-reference accordingly. Fixes: daec8d40 ("Documentation: KVM: add separate directories for architecture-specific documentation") Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset f5461124 ("Documentation: move watch_queue to core-api") renamed: Documentation/watch_queue.rst to: Documentation/core-api/watch_queue.rst. Update the cross-references accordingly. Fixes: f5461124 ("Documentation: move watch_queue to core-api") Reviewed-by:
Randy Dunlap <rdunlap@infradead.org> Signed-off-by:
-
Mauro Carvalho Chehab authored
typo: zs_malloc.rst -> zsmalloc.rst Fixes: 6dbc3a5b ("docs/zh_CN: add vm zsmalloc translation") Signed-off-by:
-
Mauro Carvalho Chehab authored
typo: _free_page_reporting.rst -> free_page_reporting.rst Fixes: 9859b277 ("docs/zh_CN: add vm frontswap translation") Fixes: adeacecb ("docs/zh_CN: add free_page_reporting translation") Signed-off-by:
-
Mauro Carvalho Chehab authored
The location of the rust doc is wrong (probably a typo). Fix it. Fixes: 3a591515 ("docs/zh_CN: Add translation zh_CN/doc-guide/kernel-doc.rst") Signed-off-by:
-
Mauro Carvalho Chehab authored
The devicetree directory was using wrong case: Devicetree/ -> devicetree/ Fixes: a17b0169 ("docs/zh_CN: add devicetree index translation") Fixes: c5648129 ("docs/zh_CN: add devicetree usage-model translation") Fixes: 09d4466d ("docs/zh_CN: add devicetree of_unittest translation") Signed-off-by:
-
Mauro Carvalho Chehab authored
typo: page_frag.rst -> page_frags.rst Fixes: f51debc2 ("docs/zh_CN: add vm page_frags translation") Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset efc930fa ("docs: filesystems: caching/netfs-api.txt: convert it to ReST") renamed: Documentation/filesystems/caching/netfs-api.txt to: Documentation/filesystems/caching/netfs-api.rst. Update its cross-reference accordingly. Fixes: efc930fa ("docs: filesystems: caching/netfs-api.txt: convert it to ReST") Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset 8df01363 ("docs: netdev: move the netdev-FAQ to the process pages") renamed: Documentation/networking/netdev-FAQ.rst to: Documentation/process/maintainer-netdev.rst. Update its cross-reference accordingly. Fixes: 8df01363 ("docs: netdev: move the netdev-FAQ to the process pages") Acked-by:
Jakub Kicinski <kuba@kernel.org> Signed-off-by:
-
Jonathan Corbet authored
The automarkup code tries to look up symbols once as a function, and once as a macro. The Sphinx C domain code, though, totally ignores that distinction and will return the same results either way. So just look things up once and be done with it; the resulting output does not change, but htmldocs build time drops by about 5%. Tested-by:
Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/20220630163630.714673-3-corbet@lwn.netSigned-off-by:
-
Jonathan Corbet authored
The automarkup code tries to create a lot of cross-references that don't exist. Cross-reference lookups are expensive, especially in later versions of Sphinx, so there is value in avoiding unnecessary ones. Remember attempts that failed and do not retry them. This improves the htmldocs build time by 5-10% depending on the phase of the moon and other factors. Tested-by:
-
Mauro Carvalho Chehab authored
All extern functions of drivers/gpio/gpiolib.c are already inside the Kernel documentation, as driver-api/gpio/index.rst already includes it. Placing a kernel-doc here will only cause mess, as the same symbol will be placed on two parts of the document, causing breakages in cross-references. So, instead, add a cross-reference there. This solves those Sphinx 3.1+ warnings: .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464. .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493. .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464. .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464. .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464. .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493. .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493. .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493. Signed-off-by: -
Mauro Carvalho Chehab authored
Newer versions of Sphinx have a known bug: https://github.com/sphinx-doc/sphinx/pull/8313 Those currently produces 11 false-positive warnings On Sphinx version 3.1+. While Sphinx fix is not applied, let's warn adventurers that would be using Sphinx installed via distro packages. Signed-off-by:
-
Mauro Carvalho Chehab authored
As it is not a consensus about installing sphinx using venv, and modern distributions are now shipping with Sphinx versions above the minimal requirements to build the docs, provide both venv and package install commands by default. Signed-off-by:
-
Mauro Carvalho Chehab authored
Better to add the PDF note late for venv recommendation. Signed-off-by:
-
Mauro Carvalho Chehab authored
After distro upgrades, the directory names for python may change. On such case, the previously-created venv will be broken, and sphinx-build won't run. Add a logic to report it. Signed-off-by:
-
Mauro Carvalho Chehab authored
The logic which checks if the venv version is good enough but was not activated is broken: it is checking against the wrong val, making it to recommend to re-create a venv every time. Fix it. Signed-off-by:
-
- 30 Jun, 2022 1 commit
-
-
Akira Yokosawa authored
SPHINXDIRS is useful when you want to test build only those documents affected by your changes. Mention it in the "Sphinx Build" section. Signed-off-by:
-
