[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20180430150833.gt2di56f4jembb2f@ast-mbp.dhcp.thefacebook.com>
Date: Mon, 30 Apr 2018 08:08:34 -0700
From: Alexei Starovoitov <alexei.starovoitov@...il.com>
To: Quentin Monnet <quentin.monnet@...ronome.com>
Cc: daniel@...earbox.net, ast@...nel.org, netdev@...r.kernel.org,
oss-drivers@...ronome.com, Yonghong Song <yhs@...com>
Subject: Re: [PATCH bpf-next 2/3] bpf: fix formatting for bpf_get_stack()
helper doc
On Mon, Apr 30, 2018 at 11:39:04AM +0100, Quentin Monnet wrote:
> Fix formatting (indent) for bpf_get_stack() helper documentation, so
> that the doc is rendered correctly with the Python script.
>
> Fixes: c195651e565a ("bpf: add bpf_get_stack helper")
> Cc: Yonghong Song <yhs@...com>
> Signed-off-by: Quentin Monnet <quentin.monnet@...ronome.com>
> ---
>
> Note: The error was a missing space between the '*' marking the
> comments, and the tabs. This expected mixed indent comes from the fact I
> started to write the doc as a RST, then copied my contents (tabs
> included) in the header file and added a " * " (with a space) prefix
> everywhere.
>
> On a second thought, using such indent style was maybe... not my best idea
> ever. Anyway, if indent for documenting eBPF helpers really gets to painful, we
> could relax parsing rules in the Python script to make things easier.
> ---
> include/uapi/linux/bpf.h | 54 ++++++++++++++++++++++++------------------------
> 1 file changed, 27 insertions(+), 27 deletions(-)
>
> diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
> index 530ff6588d8f..8daef7326bb7 100644
> --- a/include/uapi/linux/bpf.h
> +++ b/include/uapi/linux/bpf.h
> @@ -1770,33 +1770,33 @@ union bpf_attr {
> *
> * int bpf_get_stack(struct pt_regs *regs, void *buf, u32 size, u64 flags)
> * Description
> - * Return a user or a kernel stack in bpf program provided buffer.
> - * To achieve this, the helper needs *ctx*, which is a pointer
> + * Return a user or a kernel stack in bpf program provided buffer.
> + * To achieve this, the helper needs *ctx*, which is a pointer
I still don't quite get the difference.
It's replacing 2 tabs in above with 1 space + 2 tabs ?
Can you please teach the python script to accept both?
I bet that will be recurring mistake and it's impossible to spot in code review.
Powered by blists - more mailing lists