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: initramfs: file data alignment via name paddingThe existing cpio extraction logic reads (maximum PATH_MAX) name_lenbytes from the archive into the collected name buffer and ensures thatthe
docs: initramfs: file data alignment via name paddingThe existing cpio extraction logic reads (maximum PATH_MAX) name_lenbytes from the archive into the collected name buffer and ensures thatthe trailing byte is a null-terminator. This allows the actual file nameto be shorter than name_len, with the name string simply zero-terminatedprior to the last byte.Initramfs generators, such as dracut-cpio[1], can take advantage of namezero-padding to align file data segments within the archive tofilesystem block boundaries. Block boundary alignment may allow thecopy_file_range syscall to reflink archive source and destinationextents.Link: https://github.com/dracutdevs/dracut/commit/300e4b116c624bca1b9e7251708b1ae656fe9157 [1]Signed-off-by: David Disseldorp <ddiss@suse.de>Reviewed-by: Nicolas Schier <nsc@kernel.org>Link: https://lore.kernel.org/r/20250819032607.28727-7-ddiss@suse.deSigned-off-by: Nathan Chancellor <nathan@kernel.org>
docs: initramfs: update compression and mtime descriptionsUpdate the document to reflect that initramfs didn't replace initrdfollowing kernel 2.5.x.The initramfs buffer format now supports many c
docs: initramfs: update compression and mtime descriptionsUpdate the document to reflect that initramfs didn't replace initrdfollowing kernel 2.5.x.The initramfs buffer format now supports many compression types inaddition to gzip, so include them in the grammar section.c_mtime use is dependent on CONFIG_INITRAMFS_PRESERVE_MTIME.Signed-off-by: David Disseldorp <ddiss@suse.de>Link: https://lore.kernel.org/r/20250402033949.852-2-ddiss@suse.deReviewed-by: Randy Dunlap <rdunlap@infradead.org>Signed-off-by: Christian Brauner <brauner@kernel.org>
Documentation: Fix intiramfs script nameDocumentation was not changed when renaming the script in commit80e715a06c2d ("initramfs: rename gen_initramfs_list.sh togen_initramfs.sh"). Fixing this.
Documentation: Fix intiramfs script nameDocumentation was not changed when renaming the script in commit80e715a06c2d ("initramfs: rename gen_initramfs_list.sh togen_initramfs.sh"). Fixing this.Basically does: $ sed -i -e s/gen_initramfs_list.sh/gen_initramfs.sh/g $(git grep -l gen_initramfs_list.sh)Fixes: 80e715a06c2d ("initramfs: rename gen_initramfs_list.sh to gen_initramfs.sh")Signed-off-by: Robert Richter <rrichter@amd.com>Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
Replace HTTP links with HTTPS ones: Documentation/driver-apiRationale:Reduces attack surface on kernel devs opening the links for MITMas HTTPS traffic is much harder to manipulate.Deterministic
Replace HTTP links with HTTPS ones: Documentation/driver-apiRationale:Reduces attack surface on kernel devs opening the links for MITMas HTTPS traffic is much harder to manipulate.Deterministic algorithm:For each file: If not .svg: For each line: If doesn't contain `\bxmlns\b`: For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`: If both the HTTP and HTTPS versions return 200 OK and serve the same content: Replace HTTP with HTTPS.Signed-off-by: Alexander A. Klimov <grandmaster@al2klimov.de>Link: https://lore.kernel.org/r/20200621133512.46311-1-grandmaster@al2klimov.deSigned-off-by: Jonathan Corbet <corbet@lwn.net>
docs: add SPDX tags to new index filesAll those new files I added are under GPL v2.0 license.Add the corresponding SPDX headers to them.Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@ker
docs: add SPDX tags to new index filesAll those new files I added are under GPL v2.0 license.Add the corresponding SPDX headers to them.Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
docs: early-userspace: move to driver-api guideThose documents describe a kAPI. So, add to the driver-apibook.Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>