- Jul 07, 2022
-
-
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 <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>
-
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.net Signed-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:Dipen Patel <dipenp@nvidia.com> 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:
-
- Jun 30, 2022
-
-
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.com Signed-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:
-
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:
-
- Jun 27, 2022
-
-
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.com Signed-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:
Wu XiangCheng <bobwxc@email.cn> Reviewed-by:
Yanteng Si <siyanteng@loongson.cn> Link: https://lore.kernel.org/r/Yp41+eTjoPRa4hrl@bobwxc.mipc Signed-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:
-
Binbin Zhou authored
Synchronous translation from upstream commit 9d19f2b5 ("Documentation: riscv: Add sv48 description to VM layout") Signed-off-by:
Binbin Zhou <zhoubinbin@loongson.cn> Reviewed-by:
-
Binbin Zhou authored
Synchronous translation from the following: [1]: commit 23b1f183("Documentation: riscv: Remove the old documentation") [2]: commit 8933e7f2 ("Documentation: riscv: remove non-existent directory from table of contents") Signed-off-by:
-
Dongliang Mu authored
Fix the invalid url about Semantic Patch Language Signed-off-by:
Dongliang Mu <mudongliangabcd@gmail.com> Link: https://lore.kernel.org/r/20220613071243.12961-1-dzm91@hust.edu.cn Signed-off-by:
-
Chao Liu authored
Since commit c6140415 ("f2fs: introduce FI_COMPRESS_RELEASED instead of using IMMUTABLE bit"), we no longer use the IMMUTABLE bit to prevent writing data for compression. Let's correct the corresponding documentation. BTW, this patch fixes some alignment issues in the compress metadata layout. Signed-off-by:
Chao Liu <liuchao@coolpad.com> Link: https://lore.kernel.org/r/20220613020800.3379482-1-chaoliu719@gmail.com Signed-off-by:
-
Yanteng Si authored
update to commit 481cc973 ("mm,doc: Add new documentation structure") Note: There are some empty files that do not need to be updated for now, they are: bootmem, oom, page_allocation, page_cache, page_reclaim, page_tables, physical_memory process_addrs, shmfs, slab, vmalloc, swap. Signed-off-by:
-
Yanteng Si authored
update to commit d1ed51fc ("docs: vm/page_owner: tweak literal block in STANDARD FORMAT SPECIFIERS") Signed-off-by:
-
Yanteng Si authored
update to commit 110bf7a5 ("Documentation/vm: rework "Temporary Virtual Mappings" section") Signed-off-by:
-
- Jun 24, 2022
-
-
Steven Lung authored
Replace 'absense' with 'absence'. Signed-off-by:
Steven Lung <1030steven@gmail.com> Link: https://lore.kernel.org/r/20220621072910.4704-1-1030steven@gmail.com Signed-off-by:
-
Binbin Zhou authored
Synchronous translation from upstream commit ac23d1a9 ("XArray: Document the locking requirement for the xa_state") Signed-off-by:
-
Binbin Zhou authored
Synchronous translation from upstream commit f9eaaa82 ("workqueue: doc: Call out the non-reentrance conditions") Signed-off-by:
-
Binbin Zhou authored
Synchronous translation from upstream commit 6a7ca80f ("vsprintf: Update %pGp documentation about that it prints hex value") Signed-off-by:
-
Binbin Zhou authored
Synchronous translation from upstream commit 7d9e2661 ("printk: Move the printk() kerneldoc comment to its new home") Signed-off-by:
-
Binbin Zhou authored
Synchronous translation from the following commits(Latest in front): [1]: commit 84dacdbd("mm: document and polish read-ahead code") [2]: commit 2f52578f("mm/util: Add folio_mapping() and folio_file_mapping()") [3]: commit 889a3747("mm/lru: Add folio LRU functions") [4]: commit c24016ac("mm: Add folio reference count functions") Signed-off-by:
-
Binbin Zhou authored
Synchronous translation from upstream commit 640d1930 ("block: Add bio_for_each_folio_all()") Signed-off-by:
-
Binbin Zhou authored
Synchronous translation from the following commits(Latest in front): [1]: commit 0953fb26("irq: remove handle_domain_{irq,nmi}()") [2]: commit 0ddc5e55("Documentation: Fix irq-domain.rst build warning") [3]: commit 991007ba("Documentation: Update irq_domain.rst with new lookup APIs") [4]: commit 405e94e9("irqdomain: Kill irq_domain_add_legacy_isa") Signed-off-by:
-
Binbin Zhou authored
Synchronous translation from upstream commit c9871c80 ("Documentation: core-api/cpuhotplug: Rewrite the API section") Signed-off-by:
-
Binbin Zhou authored
Synchronous translation from upstream commit 08b0b005 ("mm: Add flush_dcache_folio()") Signed-off-by:
-
Tom Schwindl authored
Correct some simple spelling mistakes in consumer.rst, driver.rst and using-gpio.rst. Signed-off-by:
Tom Schwindl <schwindl@posteo.de> Reviewed-by:
Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/YrTdAv3YPlCiDr2u@posteo.de Signed-off-by:
-
Deming Wang authored
Delete duplicate words of "the". Signed-off-by:
Deming Wang <wangdeming@inspur.com> Link: https://lore.kernel.org/r/20220624014605.2007-1-wangdeming@inspur.com Signed-off-by:
-
