Documentation: use a source-read extension for the index link boilerplateThe root document usually has a special :ref:`genindex` link to thegenerated index. This is also the case for Documentation
Documentation: use a source-read extension for the index link boilerplateThe root document usually has a special :ref:`genindex` link to thegenerated index. This is also the case for Documentation/index.rst. Theother index.rst files deeper in the directory hierarchy usually don't.For SPHINXDIRS builds, the root document isn't Documentation/index.rst,but some other index.rst in the hierarchy. Currently they have a".. only::" block to add the index link when doing SPHINXDIRS htmlbuilds.This is obviously very tedious and repetitive. The link is also added toall index.rst files in the hierarchy for SPHINXDIRS builds, not just theroot document.Put the boilerplate in a sphinx-includes/subproject-index.rst file, andinclude it at the end of the root document for subproject builds in anad-hoc source-read extension defined in conf.py.For now, keep having the boilerplate in translations, because thisapproach currently doesn't cover translated index link headers.Cc: Jonathan Corbet <corbet@lwn.net>Cc: Mauro Carvalho Chehab <mchehab@kernel.org>Cc: Randy Dunlap <rdunlap@infradead.org>Signed-off-by: Jani Nikula <jani.nikula@intel.com>Tested-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>[jc: did s/doctree/kern_doc_dir/ ]Signed-off-by: Jonathan Corbet <corbet@lwn.net>Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>
show more ...
docs: keystone: fix typo in knav-qmss documentationSigned-off-by: Akiyoshi Kurita <weibu@redadmin.org>Signed-off-by: Jonathan Corbet <corbet@lwn.net>Message-ID: <20251223112946.2580519-1-weibu@re
docs: keystone: fix typo in knav-qmss documentationSigned-off-by: Akiyoshi Kurita <weibu@redadmin.org>Signed-off-by: Jonathan Corbet <corbet@lwn.net>Message-ID: <20251223112946.2580519-1-weibu@redadmin.org>
Documentation: arm: keystone: update DT binding referenceUpdate the device tree binding reference from .txt to YAML.Binding was converted in commit 20b3c9a403ee ("dt-bindings: arm: Convert ti,keys
Documentation: arm: keystone: update DT binding referenceUpdate the device tree binding reference from .txt to YAML.Binding was converted in commit 20b3c9a403ee ("dt-bindings: arm: Convert ti,keystone to DT schema")and moved to Documentation/devicetree/bindings/arm/ti/ti,keystone.yaml.Signed-off-by: Shubham Sharma <slopixelz@gmail.com>Signed-off-by: Jonathan Corbet <corbet@lwn.net>Message-ID: <20251207195632.68681-1-slopixelz@gmail.com>
docs: arm: stm32: fix typo "busses" -> "buses"Fix the spelling of "busses" to the preferred form "buses" in STM32 ARMarchitecture documentation.Signed-off-by: Akshaykumar Gunari <akshaygunari@gm
docs: arm: stm32: fix typo "busses" -> "buses"Fix the spelling of "busses" to the preferred form "buses" in STM32 ARMarchitecture documentation.Signed-off-by: Akshaykumar Gunari <akshaygunari@gmail.com>Signed-off-by: Jonathan Corbet <corbet@lwn.net>Link: https://lore.kernel.org/r/20250807145119.2214-1-akshaygunari@gmail.com
move asm/unaligned.h to linux/unaligned.hasm/unaligned.h is always an include of asm-generic/unaligned.h;might as well move that thing to linux/unaligned.h and includethat - there's nothing arch-
move asm/unaligned.h to linux/unaligned.hasm/unaligned.h is always an include of asm-generic/unaligned.h;might as well move that thing to linux/unaligned.h and includethat - there's nothing arch-specific in that header.auto-generated by the following:for i in `git grep -l -w asm/unaligned.h`; do sed -i -e "s/asm\/unaligned.h/linux\/unaligned.h/" $idonefor i in `git grep -l -w asm-generic/unaligned.h`; do sed -i -e "s/asm-generic\/unaligned.h/linux\/unaligned.h/" $idonegit mv include/asm-generic/unaligned.h include/linux/unaligned.hgit mv tools/include/asm-generic/unaligned.h tools/include/linux/unaligned.hsed -i -e "/unaligned.h/d" include/asm-generic/Kbuildsed -i -e "s/__ASM_GENERIC/__LINUX/" include/linux/unaligned.h tools/include/linux/unaligned.h
Documentation: Fix spelling mistakesCorrect spelling mistakes in the documentation to improve readability.Signed-off-by: Amit Vadhavana <av2082000@gmail.com>Reviewed-by: Bjorn Helgaas <bhelgaas@
Documentation: Fix spelling mistakesCorrect spelling mistakes in the documentation to improve readability.Signed-off-by: Amit Vadhavana <av2082000@gmail.com>Reviewed-by: Bjorn Helgaas <bhelgaas@google.com>Signed-off-by: Jonathan Corbet <corbet@lwn.net>Link: https://lore.kernel.org/r/20240817072724.6861-1-av2082000@gmail.com
docs: kernel_feat.py: fix potential command injectionThe kernel-feat directive passes its argument straight to the shell.This is unfortunate and unnecessary.Let's always use paths relative to $s
docs: kernel_feat.py: fix potential command injectionThe kernel-feat directive passes its argument straight to the shell.This is unfortunate and unnecessary.Let's always use paths relative to $srctree/Documentation/ and usesubprocess.check_call() instead of subprocess.Popen(shell=True).This also makes the code shorter.This is analogous to commit 3231dd586277 ("docs: kernel_abi.py: fixcommand injection") where we did exactly the same thing forkernel_abi.py, somehow I completely missed this one.Link: https://fosstodon.org/@jani/111676532203641247Reported-by: Jani Nikula <jani.nikula@intel.com>Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>Cc: stable@vger.kernel.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>Link: https://lore.kernel.org/r/20240110174758.3680506-1-vegard.nossum@oracle.com
Documentation: Fix typosFix typos in Documentation.Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>Link: https://lore.kernel.org/r/20230814212822.193684-4-helgaas@kernel.orgSigned-off-by: Jon
Documentation: Fix typosFix typos in Documentation.Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>Link: https://lore.kernel.org/r/20230814212822.193684-4-helgaas@kernel.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation: arm: Add bootargs to the table of added DT parametersThe bootargs node is also added by the EFI stub in the functionupdate_fdt(), so add it to the table.Signed-off-by: Alexandre G
Documentation: arm: Add bootargs to the table of added DT parametersThe bootargs node is also added by the EFI stub in the functionupdate_fdt(), so add it to the table.Signed-off-by: Alexandre Ghiti <alexghiti@rivosinc.com>Reviewed-by: Atish Patra <atishp@rivosinc.com>Reviewed-by: Song Shuai <songshuaishuai@tinylab.org>Signed-off-by: Jonathan Corbet <corbet@lwn.net>Link: https://lore.kernel.org/r/20230817130734.10387-1-alexghiti@rivosinc.com
arm: docs: Move Arm documentation to Documentation/arch/Architecture-specific documentation is being moved into Documentation/arch/as a way of cleaning up the top-level documentation directory and
arm: docs: Move Arm documentation to Documentation/arch/Architecture-specific documentation is being moved into Documentation/arch/as a way of cleaning up the top-level documentation directory and makingthe docs hierarchy more closely match the source hierarchy. MoveDocumentation/arm into arch/ (along with the Chinese equvalenttranslations).Cc: Maxime Coquelin <mcoquelin.stm32@gmail.com>Cc: Chen-Yu Tsai <wens@csie.org>Cc: Jernej Skrabec <jernej.skrabec@gmail.com>Cc: Samuel Holland <samuel@sholland.org>Cc: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>Cc: Alim Akhtar <alim.akhtar@samsung.com>Cc: Alex Shi <alexs@kernel.org>Cc: linux-doc@vger.kernel.orgCc: linux-arm-kernel@lists.infradead.orgCc: linux-arch@vger.kernel.orgAcked-by: Alexandre TORGUE <alexandre.torgue@foss.st.com>Reviewed-by: Yanteng Si <siyanteng@loongson.cn>Signed-off-by: Jonathan Corbet <corbet@lwn.net>