docs: advanced search with benchmark harness
Get series with b4
b4 am [email protected]Versions newest first · linked by author and title
- v3 Latest2 patches 0 repliesNew
- v21 patch 0 repliesSuperseded
- v11 patch 16 repliesSuperseded
Patches in v3 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/2 | docs: add advanced search for kernel documentationDocumentation/ Documentation/ Documentation/ +4 more | +2010 | 0 replies | |
| 2/2 | docs: add advanced search benchmark harness and instrumentationDocumentation/ Documentation/ MAINTAINERS +1 more | +1397 | 0 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v3 yet.
Cover letter [PATCH v3 0/2] docs: advanced search with benchmark harness
This series adds an Advanced Search interface for kernel documentation.
This is being proposed here rather than upstream Sphinx because the current implementation is tailored to the kernel documentation set and its navigation needs, and is integrated through kernel-local template and static-asset overrides rather than a generalized Sphinx extension interface.
Parts of the approach could potentially be abstracted further in the future, but this series is focused on solving the problem concretely for kernel documentation first rather than proposing a general-purpose Sphinx search redesign.
The first patch adds the feature itself: an advanced search page built on the existing Sphinx search data, with tabbed results for Symbols, Sections, Index entries, and Pages, richer filtering, more targeted identifier search, and bounded Pages summary loading with compatibility handling across supported Sphinx versions.
The second patch adds optional developer-side benchmark tooling and passive timing instrumentation used to validate runtime behavior and compare advanced search with stock Quick Search.
Jon previously noted that the window for larger merges has passed, so this is not intended as a request to take a large feature late in the current cycle. The immediate goal is to close the loop on the debugging and compatibility work around the earlier version, so the current implementation is available for testing and review ahead of future merge windows.
This version should address the compatibility issue Randy had reported with the earlier implementation. If Randy has time to try this updated version with the setup that exposed the earlier problem, I would appreciate confirmation that it now behaves correctly there.
Rito Rhymes (2):
docs: add advanced search for kernel documentation
docs: add advanced search benchmark harness and instrumentation
Documentation/doc-guide/sphinx.rst | 100 ++ Documentation/sphinx-static/custom.css | 288 ++++ Documentation/sphinx-static/kernel-search.js | 1264 ++++++++++++++++ Documentation/sphinx/templates/search.html | 117 ++ Documentation/sphinx/templates/searchbox.html | 30 + MAINTAINERS | 11 + tools/docs/bench_search_playwright.mjs | 1278 +++++++++++++++++ tools/docs/test_advanced_search.py | 312 ++++ 8 files changed, 3400 insertions(+) create mode 100644 Documentation/sphinx-static/kernel-search.js create mode 100644 Documentation/sphinx/templates/search.html create mode 100644 Documentation/sphinx/templates/searchbox.html create mode 100755 tools/docs/bench_search_playwright.mjs create mode 100755 tools/docs/test_advanced_search.py
Signature · 1 line
2.51.0