BPF List
 help / color / mirror / Atom feed
* [PATCH bpf-next 0/3] bpftool: Clean up indentation and formatting in docs
@ 2024-03-31 20:03 Quentin Monnet
  2024-03-31 20:03 ` [PATCH bpf-next 1/3] bpftool: Use simpler indentation in source rST for documentation Quentin Monnet
                   ` (3 more replies)
  0 siblings, 4 replies; 5+ messages in thread
From: Quentin Monnet @ 2024-03-31 20:03 UTC (permalink / raw)
  To: Alexei Starovoitov, Daniel Borkmann, Andrii Nakryiko
  Cc: Martin KaFai Lau, Eduard Zingerman, Song Liu, Yonghong Song,
	John Fastabend, KP Singh, Stanislav Fomichev, Hao Luo, Jiri Olsa,
	bpf, Rameez Rehman, Quentin Monnet

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

-- 
2.34.1


^ permalink raw reply	[flat|nested] 5+ messages in thread
end of thread, other threads:[~2024-04-02 14:00 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-03-31 20:03 [PATCH bpf-next 0/3] bpftool: Clean up indentation and formatting in docs Quentin Monnet
2024-03-31 20:03 ` [PATCH bpf-next 1/3] bpftool: Use simpler indentation in source rST for documentation Quentin Monnet
2024-03-31 20:03 ` [PATCH bpf-next 2/3] bpftool: Remove useless emphasis on command description in man pages Quentin Monnet
2024-03-31 20:03 ` [PATCH bpf-next 3/3] bpftool: Clean-up typos, punctuation, list formatting in docs Quentin Monnet
2024-04-02 14:00 ` [PATCH bpf-next 0/3] bpftool: Clean up indentation and " patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox