Skip to content

bpftool: Clean up indentation and formatting in docs

Quentin Monnet bpf 1 version Applied

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

  1. v1 Latest3 patches 0 repliesApplied 3/3

Patches in v1 All 3 applied

#Subject and filesSizeRepliesApplied
1/3bpftool: Use simpler indentation in source rST for documentationtools/bpf/bpftool/Documentation/Makefile tools/bpf/bpftool/Documentation/bpftool-btf.rst tools/bpf/bpftool/Documentation/bpftool-cgroup.rst +11 more+880 -9630 repliesApplied
2/3bpftool: Remove useless emphasis on command description in man pagestools/bpf/bpftool/Documentation/bpftool-btf.rst tools/bpf/bpftool/Documentation/bpftool-cgroup.rst tools/bpf/bpftool/Documentation/bpftool-feature.rst +8 more+61 -610 repliesApplied
3/3bpftool: Clean-up typos, punctuation, list formatting in docstools/bpf/bpftool/Documentation/bpftool-cgroup.rst tools/bpf/bpftool/Documentation/bpftool-gen.rst tools/bpf/bpftool/Documentation/bpftool-iter.rst+35 -400 repliesApplied

Reviews trailers per patch

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

Read the v1 thread

Cover letter [PATCH bpf-next 0/3] bpftool: Clean up indentation and formatting in docs

The rST manual pages for bpftool would use a mix of tabs and spaces for indentation. While this is the norm in C code, this is rather unusual for rST documents, and over time we've seen many contributors use wrong levels of indentation for documentation update. This series simplifies the indentation in the rST files by removing some unnecessary levels of indent, and by using spaces only for what remains.

This clean-up is done in the firt patch. The following two patches contain some additional formatting clean-ups or typo fixes.

Rameez Rehman did most of the work; I added a few fixes myself, rebased, and formatted the patch set.

Rameez Rehman (3):
bpftool: Use simpler indentation in source rST for documentation
bpftool: Remove useless emphasis on command description in man pages
bpftool: Clean-up typos, punctuation, list formatting in docs

 tools/bpf/bpftool/Documentation/Makefile      |   6 +-
 .../bpf/bpftool/Documentation/bpftool-btf.rst | 116 +++--
 .../bpftool/Documentation/bpftool-cgroup.rst  | 193 ++++----
 .../bpftool/Documentation/bpftool-feature.rst | 115 +++--
 .../bpf/bpftool/Documentation/bpftool-gen.rst | 338 +++++++-------
 .../bpftool/Documentation/bpftool-iter.rst    |  52 +--
 .../bpftool/Documentation/bpftool-link.rst    |  73 ++-
 .../bpf/bpftool/Documentation/bpftool-map.rst | 232 +++++-----
 .../bpf/bpftool/Documentation/bpftool-net.rst |  98 ++--
 .../bpftool/Documentation/bpftool-perf.rst    |  34 +-
 .../bpftool/Documentation/bpftool-prog.rst    | 426 +++++++++---------
 .../Documentation/bpftool-struct_ops.rst      |  71 ++-
 tools/bpf/bpftool/Documentation/bpftool.rst   |  60 +--
 .../bpftool/Documentation/common_options.rst  |  26 +-
 14 files changed, 876 insertions(+), 964 deletions(-)
Signature · 1 line
2.34.1