diff options
| author | Quentin Monnet | 2018-04-30 12:39:03 +0200 |
|---|---|---|
| committer | Daniel Borkmann | 2018-04-30 13:53:11 +0200 |
| commit | 3bd5a09b529c03bac354c9d48e688ed2aca934fd (patch) | |
| tree | 3a427d683181a4e00bd7a3065b8a906b6499bfc8 /include/uapi/linux/bpf.h | |
| parent | bpf: remove tracepoints from bpf core (diff) | |
| download | kernel-qcow2-linux-3bd5a09b529c03bac354c9d48e688ed2aca934fd.tar.gz kernel-qcow2-linux-3bd5a09b529c03bac354c9d48e688ed2aca934fd.tar.xz kernel-qcow2-linux-3bd5a09b529c03bac354c9d48e688ed2aca934fd.zip | |
bpf: fix formatting for bpf_perf_event_read() helper doc
Some edits brought to the last iteration of BPF helper functions
documentation introduced an error with RST formatting. As a result, most
of one paragraph is rendered in bold text when only the name of a helper
should be. Fix it, and fix formatting of another function name in the
same paragraph.
Fixes: c6b5fb8690fa ("bpf: add documentation for eBPF helpers (42-50)")
Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Diffstat (limited to 'include/uapi/linux/bpf.h')
| -rw-r--r-- | include/uapi/linux/bpf.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/uapi/linux/bpf.h b/include/uapi/linux/bpf.h index 23b334bba1a6..530ff6588d8f 100644 --- a/include/uapi/linux/bpf.h +++ b/include/uapi/linux/bpf.h @@ -828,12 +828,12 @@ union bpf_attr { * * Also, be aware that the newer helper * **bpf_perf_event_read_value**\ () is recommended over - * **bpf_perf_event_read*\ () in general. The latter has some ABI + * **bpf_perf_event_read**\ () in general. The latter has some ABI * quirks where error and counter value are used as a return code * (which is wrong to do since ranges may overlap). This issue is - * fixed with bpf_perf_event_read_value(), which at the same time - * provides more features over the **bpf_perf_event_read**\ () - * interface. Please refer to the description of + * fixed with **bpf_perf_event_read_value**\ (), which at the same + * time provides more features over the **bpf_perf_event_read**\ + * () interface. Please refer to the description of * **bpf_perf_event_read_value**\ () for details. * Return * The value of the perf event counter read from the map, or a |