Skip to content

Better handle dependencies on Sphinx extensions

Mauro Carvalho Chehab linux-doc lkml 2 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest6 patches 1 replyIn review
  2. v24 patches 5 repliesSuperseded

Changes in v3 from the cover letter

- Changed the meta-tag used when --enable-lineno and --enable-fname are used at the scripts that generate ReST output.

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/6scripts/get_feat.pl: allow output the parsed file namesscripts/get_feat.pl+11 -00 replies
2/6docs: kernel_feat.py: add build dependenciesDocumentation/sphinx/kernel_feat.py+18 -20 replies
3/6docs: kernel_abi.py: add sphinx build dependenciesDocumentation/sphinx/kernel_abi.py+4 -00 replies
4/6docs: kernel_include.py: add sphinx build dependenciesDocumentation/sphinx/kernel_include.py+3 -00 replies
5/6scripts/get_abi: change the file/line number meta infoDocumentation/sphinx/kernel_abi.py scripts/get_abi.pl+3 -30 replies
6/6scripts/kernel-doc: change the line number meta infoDocumentation/sphinx/kerneldoc.py scripts/kernel-doc+3 -30 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v3 yet.

Read the v3 thread

Cover letter [PATCH v3 0/6] Better handle dependencies on Sphinx extensions

Sphinx has its own way to identify the need of rebuilding the documentation. It means that extensions need to use an internal API in order to notify about the need to consider other files.

The kerneldoc.py extension already does that, maintainers_include.py doesn't need (as it uses an API that internally does that), and kfigure.py does it on a different way. So, those are already safe.

However, other extensions don't notify nor implement their own checks, so, when a file that was parsed by them is changed, the corresponding documentation won't be rebuilt.

This series add support for it for ABI, features and kernel-include.

---

v3:
- Changed the meta-tag used when --enable-lineno and --enable-fname are used at the scripts that generate ReST output.

Mauro Carvalho Chehab (6):
scripts/get_feat.pl: allow output the parsed file names
docs: kernel_feat.py: add build dependencies
docs: kernel_abi.py: add sphinx build dependencies
docs: kernel_include.py: add sphinx build dependencies scripts/get_abi: change the file/line number meta info scripts/kernel-doc: change the line number meta info

 Documentation/sphinx/kernel_abi.py     |  6 +++++-
 Documentation/sphinx/kernel_feat.py    | 20 ++++++++++++++++++--
 Documentation/sphinx/kernel_include.py |  3 +++
 Documentation/sphinx/kerneldoc.py      |  2 +-
 scripts/get_abi.pl                     |  4 ++--
 scripts/get_feat.pl                    | 11 +++++++++++
 scripts/kernel-doc                     |  4 ++--
 7 files changed, 42 insertions(+), 8 deletions(-)
Signature · 1 line
2.35.1