bpf: fix formatting for bpf_get_stack() helper doc

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@fb.com>
Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>

diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h
index 530ff6588d8f573ab507b8935e5fc595ec2e816e..8daef7326bb7d07aac37e0bfcd3f479d1a51a734 100644 (file)
--- 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
- *             to the context on which the tracing program is executed.
- *             To store the stacktrace, the bpf program provides *buf* with
- *             a nonnegative *size*.
- *
- *             The last argument, *flags*, holds the number of stack frames to
- *             skip (from 0 to 255), masked with
- *             **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
- *             the following flags:
- *
- *             **BPF_F_USER_STACK**
- *                     Collect a user space stack instead of a kernel stack.
- *             **BPF_F_USER_BUILD_ID**
- *                     Collect buildid+offset instead of ips for user stack,
- *                     only valid if **BPF_F_USER_STACK** is also specified.
- *
- *             **bpf_get_stack**\ () can collect up to
- *             **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject
- *             to sufficient large buffer size. Note that
- *             this limit can be controlled with the **sysctl** program, and
- *             that it should be manually increased in order to profile long
- *             user stacks (such as stacks for Java programs). To do so, use:
- *
- *     ::
- *
- *             # sysctl kernel.perf_event_max_stack=<new value>
+ *             Return a user or a kernel stack in bpf program provided buffer.
+ *             To achieve this, the helper needs *ctx*, which is a pointer
+ *             to the context on which the tracing program is executed.
+ *             To store the stacktrace, the bpf program provides *buf* with
+ *             a nonnegative *size*.
+ *
+ *             The last argument, *flags*, holds the number of stack frames to
+ *             skip (from 0 to 255), masked with
+ *             **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
+ *             the following flags:
+ *
+ *             **BPF_F_USER_STACK**
+ *                     Collect a user space stack instead of a kernel stack.
+ *             **BPF_F_USER_BUILD_ID**
+ *                     Collect buildid+offset instead of ips for user stack,
+ *                     only valid if **BPF_F_USER_STACK** is also specified.
+ *
+ *             **bpf_get_stack**\ () can collect up to
+ *             **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject
+ *             to sufficient large buffer size. Note that
+ *             this limit can be controlled with the **sysctl** program, and
+ *             that it should be manually increased in order to profile long
+ *             user stacks (such as stacks for Java programs). To do so, use:
+ *
+ *             ::
+ *
+ *                     # sysctl kernel.perf_event_max_stack=<new value>
  *
  *     Return
  *             a non-negative value equal to or less than size on success, or