• Rameez Rehman's avatar
    bpftool: Use simpler indentation in source rST for documentation · f7b68543
    Rameez Rehman authored
    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: default avatarRameez Rehman <rameezrehman408@hotmail.com>
    Signed-off-by: default avatarQuentin Monnet <qmo@kernel.org>
    Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
    Link: https://lore.kernel.org/bpf/20240331200346.29118-2-qmo@kernel.org
    f7b68543
bpftool-net.rst 5.84 KB