diff options
author | Rameez Rehman <rameezrehman408@hotmail.com> | 2024-03-31 23:03:44 +0300 |
---|---|---|
committer | Daniel Borkmann <daniel@iogearbox.net> | 2024-04-02 16:50:23 +0300 |
commit | f7b68543642136164ce7348945d3ada707c4e635 (patch) | |
tree | 2505ca965a9fed991aacf0086b220d3d41d15825 /tools/usb | |
parent | 623bdd58be3727318d374f0052f9dfff1e87b854 (diff) | |
download | linux-f7b68543642136164ce7348945d3ada707c4e635.tar.xz |
bpftool: Use simpler indentation in source rST for documentation
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 a
wrong level of indentation for documentation update.
Let's fix bpftool's indentation in docs once and for all:
- Let's use spaces, that are more common in rST files.
- Remove one level of indentation for the synopsis, the command
description, and the "see also" section. As a result, all sections
start with the same indentation level in the generated man page.
- Rewrap the paragraphs after the changes.
There is no content change in this patch, only indentation and
rewrapping changes. The wrapping in the generated source files for the
manual pages is changed, but the pages displayed with "man" remain the
same, apart from the adjusted indentation level on relevant sections.
[ Quentin: rebased on bpf-next, removed indent level for command
description and options, updated synopsis, command summary, and "see
also" sections. ]
Signed-off-by: Rameez Rehman <rameezrehman408@hotmail.com>
Signed-off-by: Quentin Monnet <qmo@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20240331200346.29118-2-qmo@kernel.org
Diffstat (limited to 'tools/usb')
0 files changed, 0 insertions, 0 deletions