Fix Navigation Issues in Docs
Status from this message: This series was applied to bpf/bpf-next.git (master)
Get series with b4
b4 am [email protected]Versions newest first
Patches in v1 All 3 applied
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/3 | docs: change underline in btf to match style guideDocumentation/ | +22 | 0 replies | Applied |
| 2/3 | docs: Rename bpf_lsm.rst to prog_lsm.rstDocumentation/ MAINTAINERS | +1 | 1 reply | Applied |
| 3/3 | docs: fix ordering of bpf documentationDocumentation/ Documentation/ Documentation/ +6 more | +80 | 0 replies | Applied |
Reviews trailers per patch
1 of 3 patches has a Reviewed-by or Acked-by.
| Patch | KP Singh |
|---|---|
| 1/3 | |
| 2/3 | A-b |
| 3/3 |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.
Cover letter [PATCH bpf-next 0/3] Fix Navigation Issues in Docs
This patch set fixes a couple of documentation issues that was causing some strange behaviour when the sidebar was rendered in the HTML docs.
1. The underlines in the BTF document weren't following the docs guidelines, which I believe caused an issue rendering the TOC with my other patches applied
2. Mixing the Sphix toctree with named sections was causing name stutter in the sidebar navigation. For example:
| BPF Type Format
| - BPF Type Format
3. The libbpf API documentation wasn't referenced in a toctree
It also renames bpf_lsm.rst to prog_lsm.rst such that documentation for program types can be included in the toctree via glob for prog_*
Dave Tucker (3):
docs: change underline in btf to match style guide
docs: Rename bpf_lsm.rst to prog_lsm.rst
docs: fix ordering of bpf documentation
Documentation/bpf/btf.rst | 44 ++++-----
Documentation/bpf/faq.rst | 11 +++
Documentation/bpf/helpers.rst | 7 ++
Documentation/bpf/index.rst | 97 +++----------------
Documentation/bpf/libbpf/index.rst | 4 +-
Documentation/bpf/maps.rst | 9 ++
Documentation/bpf/other.rst | 9 ++
.../bpf/{bpf_lsm.rst => prog_lsm.rst} | 0
Documentation/bpf/programs.rst | 9 ++
Documentation/bpf/syscall_api.rst | 11 +++
Documentation/bpf/test_debug.rst | 9 ++
MAINTAINERS | 2 +-
12 files changed, 103 insertions(+), 109 deletions(-)
create mode 100644 Documentation/bpf/faq.rst
create mode 100644 Documentation/bpf/helpers.rst
create mode 100644 Documentation/bpf/maps.rst
create mode 100644 Documentation/bpf/other.rst
rename Documentation/bpf/{bpf_lsm.rst => prog_lsm.rst} (100%)
create mode 100644 Documentation/bpf/programs.rst
create mode 100644 Documentation/bpf/syscall_api.rst
create mode 100644 Documentation/bpf/test_debug.rstSignature · 1 line
2.33.1