- 13 Jul, 2022 5 commits
-
-
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:
Michael Kelley <mikelley@microsoft.com> Link: https://lore.kernel.org/r/1657561704-12631-2-git-send-email-mikelley@microsoft.comSigned-off-by:
Jonathan Corbet <corbet@lwn.net>
-
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:
Wu XiangCheng <bobwxc@email.cn> Link: https://lore.kernel.org/r/20220710133604.31382-1-zhoubinbin@loongson.cnSigned-off-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:Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220713043516.19290-1-lukas.bulwahn@gmail.comSigned-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 4 commits
-
-
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:
-
David Reaver authored
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.comSigned-off-by:
-
Tang Yizhou authored
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.comSigned-off-by:
-
Tang Yizhou authored
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:
-
- 27 Jun, 2022 6 commits
-
-
Akira Yokosawa authored
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 authored
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:
-
Muhammad Usama Anjum authored
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.comSigned-off-by:
-
Wu XiangCheng authored
* update to commit f35cf1a5 ("Documentation: kernel-hacking: minor edits for style") * fix a homophone typo reported by Li Feng Reported-by:
Li Feng <felixlee868@icloud.com> Signed-off-by:
Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/Yp41+eTjoPRa4hrl@bobwxc.mipcSigned-off-by:
-
Yanteng Si authored
Translate .../vm/vmalloced-kernel-stacks.rst into Chinese. Signed-off-by:
-
Yanteng Si authored
Translate .../vm/page_migration.rst into Chinese. Signed-off-by:
-
