]> asedeno.scripts.mit.edu Git - linux.git/commitdiff
bpf: fix formatting for bpf_perf_event_read() helper doc
authorQuentin Monnet <quentin.monnet@netronome.com>
Mon, 30 Apr 2018 10:39:03 +0000 (11:39 +0100)
committerDaniel Borkmann <daniel@iogearbox.net>
Mon, 30 Apr 2018 11:53:11 +0000 (13:53 +0200)
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>
include/uapi/linux/bpf.h

index 23b334bba1a69fff71021960ae3dd21ffda60fc9..530ff6588d8f573ab507b8935e5fc595ec2e816e 100644 (file)
@@ -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