kernel/linux.git/Documentation/admin-guide/auxdisplay, branch v7.0-rc7Linux kernel stable tree (mirror)https://git.radix-linux.su/kernel/linux.git/atom?h=v7.0-rc72026-01-23T18:59:34+00:00Documentation: use a source-read extension for the index link boilerplate2026-01-23T18:59:34+00:00Jani Nikulajani.nikula@intel.com2026-01-23T14:31:49+00:00urn:sha1:a592a36e49372172d7c7551ec19ed18184c935e1
The root document usually has a special :ref:`genindex` link to the
generated index. This is also the case for Documentation/index.rst. The
other 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 html
builds.
This is obviously very tedious and repetitive. The link is also added to
all index.rst files in the hierarchy for SPHINXDIRS builds, not just the
root document.
Put the boilerplate in a sphinx-includes/subproject-index.rst file, and
include it at the end of the root document for subproject builds in an
ad-hoc source-read extension defined in conf.py.
For now, keep having the boilerplate in translations, because this
approach 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>
treewide: Miguel has moved2021-02-26T17:41:03+00:00Miguel Ojedaojeda@kernel.org2021-02-26T01:21:00+00:00urn:sha1:c131bd0b5448bb577b7a9ed48c4e528807e8d5af
Update contact info.
Link: https://lkml.kernel.org/r/20210206162524.GA11520@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
docs: admin-guide: add auxdisplay files to it after conversion to ReST2019-07-31T19:30:06+00:00Mauro Carvalho Chehabmchehab+samsung@kernel.org2019-07-26T12:51:21+00:00urn:sha1:76b5a6e8427159ad2b3b8764ebd6f3f5213be97e
Those two files describe userspace-faced information. While part of
it might fit on uAPI, it sounds to me that the admin guide is the
best place for them.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>