• Quentin Monnet's avatar
    bpf: change eBPF helper doc parsing script to allow for smaller indent · eeacb716
    Quentin Monnet authored
    Documentation for eBPF helpers can be parsed from bpf.h and eventually
    turned into a man page. Commit 6f96674d ("bpf: relax constraints on
    formatting for eBPF helper documentation") changed the script used to
    parse it, in order to allow for different indent style and to ease the
    work for writing documentation for future helpers.
    The script currently considers that the first tab can be replaced by 6
    to 8 spaces. But the documentation for bpf_fib_lookup() uses a mix of
    tabs (for the "Description" part) and of spaces ("Return" part), and
    only has 5 space long indent for the latter.
    We probably do not want to change the values accepted by the script each
    time a new helper gets a new indent style. However, it is worth noting
    that with those 5 spaces, the "Description" and "Return" part *look*
    aligned in the generated patch and in `git show`, so it is likely other
    helper authors will use the same length. Therefore, allow for helper
    documentation to use 5 spaces only for the first indent level.
    Signed-off-by: default avatarQuentin Monnet <quentin.monnet@netronome.com>
    Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
bpf_helpers_doc.py 15.5 KB