linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
To: corbet@lwn.net, mchehab@kernel.org
Cc: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 18/25] Documentation/bpf/ringbuf.rst: fix sphinx warnings
Date: Fri, 17 Jul 2020 15:56:17 -0300	[thread overview]
Message-ID: <20200717185624.2009393-18-dwlsalmeida@gmail.com> (raw)
In-Reply-To: <20200717185624.2009393-1-dwlsalmeida@gmail.com>

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


  parent reply	other threads:[~2020-07-17 18:57 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-17 18:56 [PATCH 01/25] Documentation: amdgpu_device_suspend: Fix sphinx warning Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 02/25] Documentation: amdgpu_device_resume: " Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 03/25] Documentation: amdgpu_vram_mgr_del: fix sphinx warnings Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 04/25] Documentation: amdgpu_gtt_mgr_del: " Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 05/25] Documentation: serial_core.c: uart_get_rs485_mode: Fix " Daniel W. S. Almeida
2020-07-17 19:35   ` Randy Dunlap
2020-07-17 18:56 ` [PATCH 06/25] Documentation: usbstring: usb_validate_langid: " Daniel W. S. Almeida
2020-07-17 19:36   ` Randy Dunlap
2020-07-17 18:56 ` [PATCH 07/25] Documentation: gpio/driver.h: fix " Daniel W. S. Almeida
2020-07-17 19:37   ` Randy Dunlap
2020-07-17 19:48     ` Joe Perches
2020-07-17 21:18       ` Randy Dunlap
2020-07-17 18:56 ` [PATCH 08/25] Documentation: events/block.h: fix sphinx warning Daniel W. S. Almeida
2020-07-17 19:39   ` Randy Dunlap
     [not found]     ` <RO1PR80MB35622AF97F6C440884FF4B46A07C0@RO1PR80MB3562.lamprd80.prod.outlook.com>
2020-07-17 19:51       ` Jonathan Corbet
2020-07-17 18:56 ` [PATCH 09/25] Documentation: rcu/tree.c: rcu_nmi_enter: " Daniel W. S. Almeida
2020-07-17 19:40   ` Randy Dunlap
2020-07-17 18:56 ` [PATCH 10/25] Documentation: rculist.h: " Daniel W. S. Almeida
2020-07-17 19:40   ` Randy Dunlap
2020-07-17 18:56 ` [PATCH 11/25] Documentation: vmalloc.c: " Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 12/25] Documentation/admin-guide/mm/index.rst: Fix " Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 13/25] Documentation: watch_queue.rst: fix sphinx warnings Daniel W. S. Almeida
2020-07-17 19:42   ` Randy Dunlap
2020-07-17 19:50     ` Jonathan Corbet
2020-07-17 18:56 ` [PATCH 14/25] Documentation: kvm/api.rst: Fix " Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 15/25] Documentation: staging/tee.rst: fix " Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 16/25] Documentation/process/index.rst: Fix sphinx warning Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 17/25] Documentation/bpf/bpf_devel_QA.rst: fix " Daniel W. S. Almeida
2020-07-17 18:56 ` Daniel W. S. Almeida [this message]
2020-07-17 18:56 ` [PATCH 19/25] Documentation/core-api/printk-formats.rst: " Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 20/25] Documentation/admin-guide/device-mapper/dm-ebs.rst: fix sphinx warnings Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 21/25] Documentation/admin-guide/index.rst: fix sphinx warning Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 22/25] Documentation/bpf/index.rst: fix sphinx warning: Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 23/25] Documentation/firmware-guide/acpi/index.rst: fix sphinx warning Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 24/25] Documentation/trace/index.rst: " Daniel W. S. Almeida
2020-07-17 18:56 ` [PATCH 25/25] Documentation/index.rst: Add watch_queue Daniel W. S. Almeida
2020-07-17 19:06 ` [PATCH 01/25] Documentation: amdgpu_device_suspend: Fix sphinx warning Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200717185624.2009393-18-dwlsalmeida@gmail.com \
    --to=dwlsalmeida@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).