lkml.org 
[lkml]   [2020]   [Jul]   [17]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 18/25] Documentation/bpf/ringbuf.rst: fix sphinx warnings
    Date
    From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>

    Fix the following warnings:

    ringbuf.rst:197: WARNING: Unknown target name: "bench_ringbuf.c"

    Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
    ---
    Documentation/bpf/ringbuf.rst | 5 ++++-
    1 file changed, 4 insertions(+), 1 deletion(-)

    diff --git a/Documentation/bpf/ringbuf.rst b/Documentation/bpf/ringbuf.rst
    index 75f943f0009df..8e7c15a927740 100644
    --- a/Documentation/bpf/ringbuf.rst
    +++ b/Documentation/bpf/ringbuf.rst
    @@ -200,10 +200,13 @@ a self-pacing notifications of new data being availability.
    being available after commit only if consumer has already caught up right up to
    the record being committed. If not, consumer still has to catch up and thus
    will see new data anyways without needing an extra poll notification.
    -Benchmarks (see tools/testing/selftests/bpf/benchs/bench_ringbuf.c_) show that
    +Benchmarks (see `tools/testing/selftests/bpf/benchs/bench_ringbufs.c`_) show that
    this allows to achieve a very high throughput without having to resort to
    tricks like "notify only every Nth sample", which are necessary with perf
    buffer. For extreme cases, when BPF program wants more manual control of
    notifications, commit/discard/output helpers accept ``BPF_RB_NO_WAKEUP`` and
    ``BPF_RB_FORCE_WAKEUP`` flags, which give full control over notifications of
    data availability, but require extra caution and diligence in using this API.
    +
    +.. Links
    +.. _tools/testing/selftests/bpf/benchs/bench_ringbufs.c: benchs/bench_ringbufs.c
    \ No newline at end of file
    --
    2.27.0
    \
     
     \ /
      Last update: 2020-07-17 20:58    [W:4.118 / U:0.216 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site