On 05/17/2018 02:43 PM, Quentin Monnet wrote:
> Documentation for eBPF helpers can be parsed from bpf.h and eventually
> turned into a man page. Commit 6f96674dbd8c ("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: Quentin Monnet <quentin.mon...@netronome.com>

Applied to bpf-next, thanks Quentin! Btw in the current uapi description
some of the helpers have a new line before 'Return' and most have not. I
presume it doesn't really matter though we might want to do a one-time
cleanup on these cases at some point in time.

Reply via email to