aboutsummaryrefslogtreecommitdiffstats
path: root/tools/perf/scripts/python/export-to-postgresql.py (unfollow)
AgeCommit message (Collapse)AuthorFilesLines
2022-07-14docs: zh_CN: align to submitting-drivers removalLukas Bulwahn5-166/+2
Adjust the Chinese translation to the removal of submitting-drivers in the English kernel documentation. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/20220704122537.3407-11-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-14docs: ko_KR: howto: remove reference to removed submitting-driversLukas Bulwahn1-1/+1
The document submitting-drivers.rst was deleted. This removes the corresponding reference in the Korean translation of the howto. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220704122537.3407-10-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-14docs: ja_JP: howto: remove reference to removed submitting-driversLukas Bulwahn1-2/+2
The document submitting-drivers.rst was deleted. This removes the corresponding reference in the Japanese translation of the howto, with some assistance from Akira Yokasawa. Link: https://lore.kernel.org/linux-doc/a2be48e5-e559-17d7-5ae7-d1205a737ea4@gmail.com/ Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Reviewed-by: Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/20220704122537.3407-9-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-14docs: it_IT: align to submitting-drivers removalLukas Bulwahn7-31/+8
Adjust the Italian translation to the removal of submitting-drivers in the English kernel documentation, with some assistance from Frederico Vaga. Link: https://lore.kernel.org/linux-doc/20220628091647.xf5cygybqemwprgb@numero86.vaga.pv.it/ Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220704122537.3407-8-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-14docs: process: remove outdated submitting-drivers.rstLukas Bulwahn8-214/+13
Commit 31b24bee3357 ("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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-14docs: admin: devices: drop confusing outdated statement on LatexLukas Bulwahn1-4/+3
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 <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220704122537.3407-6-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-14docs: kernel-docs: add a reference mentioned in submitting-drivers.rstLukas Bulwahn1-0/+14
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 <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220704122537.3407-5-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-14docs: kernel-docs: reflect that it is community-maintainedLukas Bulwahn1-13/+9
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 <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220704122537.3407-4-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-14docs: kernel-docs: shorten the lengthy doc titleLukas Bulwahn1-2/+2
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 <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220704122537.3407-3-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-14docs: kernel-docs: order reference from newest to oldestLukas Bulwahn1-12/+12
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: 630c8fa02f9a ("Documentation: Update details of The Linux Kernel Module Programming Guide") Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220704122537.3407-2-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-13docs/zh_CN: Add a new translation of reporting-regressions.rstWu XiangCheng2-1/+371
Last English version used: commit d2b40ba2cce2 ("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.mipc Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-13Documentation: hyperv: Add overview of clocks and timersMichael Kelley2-0/+74
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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-13Documentation: hyperv: Add overview of VMbusMichael Kelley2-0/+304
Add documentation topic for using VMbus when running as a guest on Hyper-V. Signed-off-by: Michael Kelley <mikelley@microsoft.com> Link: https://lore.kernel.org/r/1657561704-12631-3-git-send-email-mikelley@microsoft.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-13Documentation: hyperv: Add overview of Hyper-V enlightenmentsMichael Kelley4-0/+219
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: Michael Kelley <mikelley@microsoft.com> Link: https://lore.kernel.org/r/1657561704-12631-2-git-send-email-mikelley@microsoft.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-13Documentation/translations/zh_CN/mm/page_owner.rst: adjust some wordsYixuan Cao1-4/+4
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.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-13docs/zh_CN: core-api: Add watch_queue Chinese translationBinbin Zhou2-0/+314
Translate core-api/watch_queue.rst into Chinese. Last English version used: commit f5461124d59b ("Documentation: move watch_queue to core-api"). Signed-off-by: Binbin Zhou <zhoubinbin@loongson.cn> Reviewed-by: Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/20220710133604.31382-1-zhoubinbin@loongson.cn Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-13Documentation: siphash: Fix typo in the name of offsetofend macroDov Murik1-1/+1
The siphash documentation misspelled "offsetendof" instead of "offsetofend". Fixes: 2c956a60778cbb ("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.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-13MAINTAINERS: mark linux-doc-tw-discuss mailing list moderatedLukas Bulwahn1-1/+1
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: Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220713043516.19290-1-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07MAINTAINERS: update nvidia,tegra20-host1x.yaml referenceMauro Carvalho Chehab1-2/+2
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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07dt-bindings: mfd: update dlg,da9063.yaml referenceMauro Carvalho Chehab1-1/+1
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: Mauro Carvalho Chehab <mchehab@kernel.org> Acked-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.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07tegra194-hte.rst: fix reference to its bindingMauro Carvalho Chehab1-1/+1
The binding directory for hte was renamed. Update references accordingly. Fixes: af583852d2ef ("dt-bindings: Renamed hte directory to timestamp") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Reviewed-by: Dipen Patel <dipenp@nvidia.com> Link: https://lore.kernel.org/r/2e2c86485cb0642455cee01796f9a74de21403e6.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07arch: m68k: q40: README: drop references to IDE driverMauro Carvalho Chehab1-3/+2
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: 44b1fbc0f5f3 ("m68k/q40: Replace q40ide driver with pata_falcon and falconide") Fixes: b7fb14d3ac63 ("ide: remove the legacy ide driver") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Reviewed-by: Geert Uytterhoeven <geert@linux-m68k.org> Acked-by: Geert Uytterhoeven <geert@linux-m68k.org> Link: https://lore.kernel.org/r/d6e3482ed622b6953db69cddb70f20c55c96e4da.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07objtool: update objtool.txt referencesMauro Carvalho Chehab5-5/+5
Changeset a8e35fece49b ("objtool: Update documentation") renamed: tools/objtool/Documentation/stack-validation.txt to: tools/objtool/Documentation/objtool.txt. Update the cross-references accordingly. Fixes: a8e35fece49b ("objtool: Update documentation") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/ec285ece6348a5be191aebe45f78d06b3319056b.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07Documentation: KVM: update s390-diag.rst referenceMauro Carvalho Chehab1-1/+1
Changeset daec8d408308 ("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: daec8d408308 ("Documentation: KVM: add separate directories for architecture-specific documentation") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/85b81e4678bbe23d0e9692616798762a6465f0a3.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07Documentation: KVM: update msr.rst referenceMauro Carvalho Chehab1-1/+1
Changeset daec8d408308 ("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: daec8d408308 ("Documentation: KVM: add separate directories for architecture-specific documentation") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/5652b7f5caff3b817a660b75f1f319a2f8962380.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07Documentation: KVM: update amd-memory-encryption.rst referencesMauro Carvalho Chehab3-3/+3
Changeset daec8d408308 ("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: daec8d408308 ("Documentation: KVM: add separate directories for architecture-specific documentation") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/fd80db889e34aae87a4ca88cad94f650723668f4.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07Documentation: KVM: update s390-pv.rst referenceMauro Carvalho Chehab1-1/+1
Changesets: daec8d408308 ("Documentation: KVM: add separate directories for architecture-specific documentation") and: daec8d408308 ("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: daec8d408308 ("Documentation: KVM: add separate directories for architecture-specific documentation") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/e2676f087d287db0bc31ae7c05c80ce5adf93333.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07Documentation: update watch_queue.rst referencesMauro Carvalho Chehab4-4/+4
Changeset f5461124d59b ("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: f5461124d59b ("Documentation: move watch_queue to core-api") Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/1c220de9c58f35e815a3df9458ac2bea323c8bfb.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07docs: zh_CN/vm/zsmalloc.rst: fix a typoMauro Carvalho Chehab1-1/+1
typo: zs_malloc.rst -> zsmalloc.rst Fixes: 6dbc3a5bdb46 ("docs/zh_CN: add vm zsmalloc translation") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Acked-by: Yanteng Si<siyanteng@loongson.cn> Link: https://lore.kernel.org/r/25a9fff20d39a6638b8a7c0fefa0767e77d96dec.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07docs: zh_CN/vm: fix a typo for page reporting ReST fileMauro Carvalho Chehab2-2/+2
typo: _free_page_reporting.rst -> free_page_reporting.rst Fixes: 9859b277bffe ("docs/zh_CN: add vm frontswap translation") Fixes: adeacecbd36c ("docs/zh_CN: add free_page_reporting translation") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Acked-by: Yanteng Si<siyanteng@loongson.cn> Link: https://lore.kernel.org/r/c7db8f975f461eaebd7ea7489ff9666d89e121c6.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07docs: zh_CN: fix a broken referenceMauro Carvalho Chehab1-1/+1
The location of the rust doc is wrong (probably a typo). Fix it. Fixes: 3a5915156429 ("docs/zh_CN: Add translation zh_CN/doc-guide/kernel-doc.rst") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/94fe771609d32583fee41f47fe29433cbce5b04e.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07docs: zh_CN/devicetree: fix typosMauro Carvalho Chehab3-3/+3
The devicetree directory was using wrong case: Devicetree/ -> devicetree/ Fixes: a17b0169f29b ("docs/zh_CN: add devicetree index translation") Fixes: c56481299df3 ("docs/zh_CN: add devicetree usage-model translation") Fixes: 09d4466d3f3c ("docs/zh_CN: add devicetree of_unittest translation") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Acked-by: Yanteng Si<siyanteng@loongson.cn> Link: https://lore.kernel.org/r/b4ca010ef223ab9cb76e8caa0a3cde734e0b6b2f.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07docs: zh_CN: page_frags.rst: fix a broken referenceMauro Carvalho Chehab1-1/+1
typo: page_frag.rst -> page_frags.rst Fixes: f51debc256f8 ("docs/zh_CN: add vm page_frags translation") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Acked-by: Yanteng Si<siyanteng@loongson.cn> Link: https://lore.kernel.org/r/a12e18044ddb2ca16a1fed10823d59558d6de405.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07docs: filesystems: update netfs-api.rst referenceMauro Carvalho Chehab1-1/+1
Changeset efc930fa1d84 ("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: efc930fa1d84 ("docs: filesystems: caching/netfs-api.txt: convert it to ReST") Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/5f867f01d42c3e65e111167739ed1a41a26623f9.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07docs: netdev: update maintainer-netdev.rst referenceMauro Carvalho Chehab1-1/+1
Changeset 8df0136376dc ("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: 8df0136376dc ("docs: netdev: move the netdev-FAQ to the process pages") Acked-by: Jakub Kicinski <kuba@kernel.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/aed0482b3d931bfcfe84f38197526edcbb8fd830.1656234456.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07docs: automarkup: do not look up symbols twiceJonathan Corbet1-31/+26
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.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07docs: automarkup: track failed cross-reference attemptsJonathan Corbet1-0/+13
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: Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/20220630163630.714673-2-corbet@lwn.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07docs: tegra194-hte.rst: don't include gpiolib.c twiceMauro Carvalho Chehab1-2/+1
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 <mchehab@kernel.org> Link: https://lore.kernel.org/r/de81b472f552bd651f140f0aa779a29652fffa62.1656759989.git.mchehab@kernel.org Acked-by: Dipen Patel <dipenp@nvidia.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0Mauro Carvalho Chehab1-0/+4
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 <mchehab@kernel.org> Link: https://lore.kernel.org/r/085e0ada65c11da9303d07e70c510dc45f21315b.1656756450.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07scripts: sphinx-pre-install: provide both venv and package installsMauro Carvalho Chehab1-13/+42
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 <mchehab@kernel.org> Link: https://lore.kernel.org/r/7c99d985df204c73e3daafd5fd2f30a31269405d.1656756450.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07scripts: sphinx-pre-install: check for PDF min version later onMauro Carvalho Chehab1-5/+10
Better to add the PDF note late for venv recommendation. Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/8e117aabe6dfa1b1ec92dccd20e801393c977667.1656756450.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07scripts: sphinx-pre-install: report broken venvMauro Carvalho Chehab1-0/+6
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 <mchehab@kernel.org> Link: https://lore.kernel.org/r/f117f03555b0636d2be0b68f3a23b1d3f03ccf1d.1656756450.git.mchehab@kernel.org [jc: fixed typo in warning message] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-07-07scripts: sphinx-pre-install: fix venv version check logicMauro Carvalho Chehab1-3/+7
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: Mauro Carvalho Chehab <mchehab@kernel.org> Link: https://lore.kernel.org/r/afe01b7863fd655986d84ace8948f3d7aede796d.1656756450.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-06-30docs/doc-guide: Mention make variable SPHINXDIRSAkira Yokosawa1-0/+7
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: Akira Yokosawa <akiyks@gmail.com> Cc: Maciej W. Rozycki <macro@orcam.me.uk> Link: https://lore.kernel.org/r/50d6f0bc-030d-9529-0665-e2b3e7c792d8@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-06-30scripts: get_feat.pl: use /usr/bin/env to find perlDavid Reaver1-1/+1
I tried running `make pdfdocs` on NixOS, but it failed because get_feat.pl uses a shebang line with /usr/bin/perl, and that file path doesn't exist on NixOS. Using the more portable /usr/bin/env perl fixes the problem. Signed-off-by: David Reaver <me@davidreaver.com> Link: https://lore.kernel.org/r/20220625211548.1200198-1-me@davidreaver.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-06-30docs/zh_CN: Add mutex-design Chinese translationTang Yizhou2-1/+146
Translate locking/mutex-design.rst into Chinese. Signed-off-by: Tang Yizhou <yizhou.tang@shopee.com> Reviewed-by: Alex Shi <alexs@kernel.org> Reviewed-by: Yanteng Si<siyanteng@loongson.cn> Link: https://lore.kernel.org/r/20220629013240.65386-3-yizhou.tang@shopee.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-06-30docs/zh_CN: Show the Chinese translation of spinlocksTang Yizhou1-1/+2
Last time I forgot to edit locking/index.rst so the Chinese translation of spinlocks hasn't been shown on web yet. Signed-off-by: Tang Yizhou <yizhou.tang@shopee.com> Reviewed-by: Yanteng Si<siyanteng@loongson.cn> Reviewed-by: Alex Shi <alexs@kernel.org> Link: https://lore.kernel.org/r/20220629013240.65386-2-yizhou.tang@shopee.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-06-27docs/doc-guide: Put meta title for kernel-doc HTML pageAkira Yokosawa1-0/+2
kernel-doc.rst has two 1st level section titles of "Writing kernel-doc comments" and "Including kernel-doc comments". Therefore, rather than using the first one, put a meta title of "Kernel-doc comments" for the title of the resulting HTML page by using the "title" directive. Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/15636c13-7fa2-f973-6d3d-361222b839ef@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-06-27docs/doc-guide: Add footnote on Inkscape for better images in PDF documentsAkira Yokosawa1-1/+6
With kernel releases v5.18 and later, if you have Inkscape, images embedded in PDF documents are of vector graphics, not the raster images as are the case with pre-v5.18 releases. Even with pre-5.18 releases, having Inkscape would improve images converted from some of SVG files which are not fully covered by the limited capability of rsvg-convert(1) [1]. Add a footnote mentioning the expected improvements of such images. Link: https://gitlab.gnome.org/GNOME/librsvg#non-goals-of-librsvg [1] Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/81cddbde-bc28-bec1-fca4-3c8fe2df502f@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-06-27docs/kselftest: add more guidelines for adding new testsMuhammad Usama Anjum1-1/+26
Improve and add instructions to add new tests. Add build commands to test before sending the new test patch. Signed-off-by: Muhammad Usama Anjum <usama.anjum@collabora.com> Reviewed-by: Shuah Khan <skhan@linuxfoundation.org> Link: https://lore.kernel.org/r/20220521073651.4191910-1-usama.anjum@collabora.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Copyright © 1996 – 2023 Jason A. Donenfeld. All Rights Reverse Engineered.