From: Quentin Monnet <qmo@kernel.org>
To: Alexei Starovoitov <ast@kernel.org>,
Daniel Borkmann <daniel@iogearbox.net>,
Andrii Nakryiko <andrii@kernel.org>
Cc: Martin KaFai Lau <martin.lau@linux.dev>,
Eduard Zingerman <eddyz87@gmail.com>, Song Liu <song@kernel.org>,
Yonghong Song <yonghong.song@linux.dev>,
John Fastabend <john.fastabend@gmail.com>,
KP Singh <kpsingh@kernel.org>,
Stanislav Fomichev <sdf@google.com>, Hao Luo <haoluo@google.com>,
Jiri Olsa <jolsa@kernel.org>,
bpf@vger.kernel.org, Rameez Rehman <rameezrehman408@hotmail.com>,
Quentin Monnet <qmo@kernel.org>
Subject: [PATCH bpf-next 0/3] bpftool: Clean up indentation and formatting in docs
Date: Sun, 31 Mar 2024 21:03:43 +0100 [thread overview]
Message-ID: <20240331200346.29118-1-qmo@kernel.org> (raw)
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
next reply other threads:[~2024-03-31 20:03 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-31 20:03 Quentin Monnet [this message]
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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240331200346.29118-1-qmo@kernel.org \
--to=qmo@kernel.org \
--cc=andrii@kernel.org \
--cc=ast@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=daniel@iogearbox.net \
--cc=eddyz87@gmail.com \
--cc=haoluo@google.com \
--cc=john.fastabend@gmail.com \
--cc=jolsa@kernel.org \
--cc=kpsingh@kernel.org \
--cc=martin.lau@linux.dev \
--cc=rameezrehman408@hotmail.com \
--cc=sdf@google.com \
--cc=song@kernel.org \
--cc=yonghong.song@linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox