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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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





[Index of Archives]     [Linux Samsung SoC]     [Linux Rockchip SoC]     [Linux Actions SoC]     [Linux for Synopsys ARC Processors]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]


  Powered by Linux