Linux-Doc Archive on lore.kernel.org
 help / color / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
Cc: ast@kernel.org, daniel@iogearbox.net, kafai@fb.com,
	songliubraving@fb.com, yhs@fb.com, andriin@fb.com,
	john.fastabend@gmail.com, kpsingh@chromium.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	netdev@vger.kernel.org, bpf@vger.kernel.org,
	clang-built-linux@googlegroups.com
Subject: Re: [PATCH] docs: bpf/ringbuf.rst: fix reference to nonexistent document
Date: Thu, 23 Jul 2020 14:36:18 -0600
Message-ID: <20200723143618.6be62996@lwn.net> (raw)
In-Reply-To: <20200718165107.625847-7-dwlsalmeida@gmail.com>

On Sat, 18 Jul 2020 13:51:01 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> Fix the following warnings:
> 
> ringbuf.rst:197: WARNING: Unknown target name: "bench_ringbuf.c"
> 
> There was no target defined for 'bench_ringbuf.c'. Also, the
> syntax used was wrong, in the sense that it would not highlight
> the entire path in the browser.
> 
> 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

But this still doesn't lead to anything useful, right?  That file is not
part of the documentation...  It seems better just to take out the "_"...

Thanks,

jon

      parent reply index

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-18 16:50 [PATCH] docs: admin-guide/mm/index: Fix " Daniel W. S. Almeida
2020-07-18 16:50 ` [PATCH] docs: watch_queue.rst: fix malformed inline literal Daniel W. S. Almeida
2020-07-23 20:22   ` Jonathan Corbet
2020-07-18 16:50 ` [PATCH] docs: kvm/api.rst: Fix indentation Daniel W. S. Almeida
2020-07-18 16:50 ` [PATCH] docs: staging/tee.rst: convert into definition list Daniel W. S. Almeida
2020-07-23 20:25   ` Jonathan Corbet
2020-07-18 16:50 ` [PATCH] docs: process/index.rst: Fix reference to nonexistent document Daniel W. S. Almeida
2020-07-20  1:02   ` Kees Cook
2020-07-20 12:39   ` Stephen Kitt
2020-07-23 20:26   ` Jonathan Corbet
2020-07-18 16:51 ` [PATCH] docs: admin-guide/index.rst: Add pstore-blk.rst Daniel W. S. Almeida
2020-07-20  1:01   ` Kees Cook
2020-07-23 20:20   ` Jonathan Corbet
2020-07-18 16:51 ` [PATCH] docs: firmware-guide/acpi/index.rst: Add intel-pmc-mux.rst Daniel W. S. Almeida
2020-07-18 16:51 ` [PATCH] docs: trace/index.rst: add histogram-design.rst Daniel W. S. Almeida
2020-07-23 20:16   ` Jonathan Corbet
     [not found] ` <20200718165107.625847-8-dwlsalmeida@gmail.com>
2020-07-18 17:45   ` [PATCH] docs: core-api/printk-formats.rst: use literal block syntax Andy Shevchenko
2020-07-19  2:55   ` Sergey Senozhatsky
2020-07-21 14:02   ` Sergey Senozhatsky
2020-07-21 14:24     ` Jonathan Corbet
2020-07-21 14:27       ` Sergey Senozhatsky
2020-07-23 20:29   ` Jonathan Corbet
     [not found] ` <20200718165107.625847-13-dwlsalmeida@gmail.com>
2020-07-23 20:14   ` [PATCH] docs: index.rst: Add watch_queue Jonathan Corbet
     [not found] ` <20200718165107.625847-10-dwlsalmeida@gmail.com>
2020-07-23 20:17   ` [PATCH] docs: bpf/index.rst: Add ringbuf.rst Jonathan Corbet
2020-07-23 20:21 ` [PATCH] docs: admin-guide/mm/index: Fix reference to nonexistent document Jonathan Corbet
     [not found] ` <20200718165107.625847-6-dwlsalmeida@gmail.com>
2020-07-23 20:27   ` [PATCH] docs: bpf/bpf_devel_QA.rst: fix " Jonathan Corbet
     [not found] ` <20200718165107.625847-7-dwlsalmeida@gmail.com>
2020-07-23 20:36   ` Jonathan Corbet [this message]

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=20200723143618.6be62996@lwn.net \
    --to=corbet@lwn.net \
    --cc=andriin@fb.com \
    --cc=ast@kernel.org \
    --cc=bpf@vger.kernel.org \
    --cc=clang-built-linux@googlegroups.com \
    --cc=daniel@iogearbox.net \
    --cc=dwlsalmeida@gmail.com \
    --cc=john.fastabend@gmail.com \
    --cc=kafai@fb.com \
    --cc=kpsingh@chromium.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=songliubraving@fb.com \
    --cc=yhs@fb.com \
    /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

Linux-Doc Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-doc/0 linux-doc/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-doc linux-doc/ https://lore.kernel.org/linux-doc \
		linux-doc@vger.kernel.org
	public-inbox-index linux-doc

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-doc


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git