Commit 3bd5a09b authored by Quentin Monnet's avatar Quentin Monnet Committed by Daniel Borkmann

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: c6b5fb86 ("bpf: add documentation for eBPF helpers (42-50)")
Signed-off-by: default avatarQuentin Monnet <quentin.monnet@netronome.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
parent 4d220ed0
...@@ -828,12 +828,12 @@ union bpf_attr { ...@@ -828,12 +828,12 @@ union bpf_attr {
* *
* Also, be aware that the newer helper * Also, be aware that the newer helper
* **bpf_perf_event_read_value**\ () is recommended over * **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 * quirks where error and counter value are used as a return code
* (which is wrong to do since ranges may overlap). This issue is * (which is wrong to do since ranges may overlap). This issue is
* fixed with bpf_perf_event_read_value(), which at the same time * fixed with **bpf_perf_event_read_value**\ (), which at the same
* provides more features over the **bpf_perf_event_read**\ () * time provides more features over the **bpf_perf_event_read**\
* interface. Please refer to the description of * () interface. Please refer to the description of
* **bpf_perf_event_read_value**\ () for details. * **bpf_perf_event_read_value**\ () for details.
* Return * Return
* The value of the perf event counter read from the map, or a * The value of the perf event counter read from the map, or a
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment