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

Message

Quentin Monnet March 31, 2024, 8:03 p.m. UTC

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(-)

Comments

[e-mail] April 2, 2024, 2 p.m. UTC | #1

Hello:

This series was applied to bpf/bpf-next.git (master)
by Daniel Borkmann <[e-mail]>:

On Sun, 31 Mar 2024 21:03:43 +0100 you wrote:
> 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.
> 
> [...]

Here is the summary with links:
  - [bpf-next,1/3] bpftool: Use simpler indentation in source rST for documentation
    https://git.kernel.org/bpf/bpf-next/c/f7b685436421
  - [bpf-next,2/3] bpftool: Remove useless emphasis on command description in man pages
    https://git.kernel.org/bpf/bpf-next/c/ea379b3ccc2e
  - [bpf-next,3/3] bpftool: Clean-up typos, punctuation, list formatting in docs
    https://git.kernel.org/bpf/bpf-next/c/a70f5d840a56

You are awesome, thank you!