From: Jonathan Corbet <corbet@lwn.net>
To: Dave Tucker <dave@dtucker.co.uk>, bpf@vger.kernel.org
Cc: ast@kernel.org, daniel@iogearbox.net, andrii@kernel.org,
kafai@fb.com, songliubraving@fb.com, john.fastabend@gmail.com,
kpsingh@kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH v3 bpf-next 2/2] bpf, docs: document BPF_MAP_TYPE_ARRAY
Date: Tue, 07 Dec 2021 08:36:16 -0700 [thread overview]
Message-ID: <87a6hc1l73.fsf@meer.lwn.net> (raw)
In-Reply-To: <fcab2596-104e-42fe-97b7-15dbfca64ea4@www.fastmail.com>
"Dave Tucker" <dave@dtucker.co.uk> writes:
> On Tue, 7 Dec 2021, at 14:53, Jonathan Corbet wrote:
>> Dave Tucker <dave@dtucker.co.uk> writes:
>>
>>> This commit adds documentation for the BPF_MAP_TYPE_ARRAY including
>>> kernel version introduced, usage and examples.
>>> It also documents BPF_MAP_TYPE_PERCPU_ARRAY since this is similar.
>>>
>>> Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
>>> ---
>>> Documentation/bpf/map_array.rst | 182 ++++++++++++++++++++++++++++++++
>>> 1 file changed, 182 insertions(+)
>>> create mode 100644 Documentation/bpf/map_array.rst
>>
>> When you add a new file, you need to add it to index.rst as well to
>> bring it into the docs build.
>
> I believe I responded to this comment in an earlier version of this patch set.
> The glob pattern in Documentaion/bpf/maps.rst includes this in the docs build.
Sorry...I even looked for :glob:, believe it or not, but not in
linux-next, sorry. Caffeine is taking effect now...
>> It's really better not to use ``literal markup`` for function names.
>> Just write function() and the right thing will happen, including
>> cross-reference links to the kerneldoc for that function if it exists.
>
> I've just tested this out, and for some reason it's not working as expected.
> It's not formatted as ``literal markup`` nor is it linked to kerneldoc.
> Perhaps because the issue is because these are part of tools/lib/bpf/bpf_helpers.h?
It can only link to kerneldoc that's actually pulled into the built
documentation. If there isn't a ".. kernel-doc::" directive for that
file (and it appears there is not) then Sphinx doesn't know about it.
Thanks,
jon
prev parent reply other threads:[~2021-12-07 15:36 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-07 13:31 [PATCH v3 bpf-next 0/2] bpf, docs: Document BPF_MAP_TYPE_ARRAY Dave Tucker
2021-12-07 13:31 ` [PATCH v3 bpf-next 1/2] bpf, docs: add kernel version to map_cgroup_storage Dave Tucker
2021-12-07 13:31 ` [PATCH v3 bpf-next 2/2] bpf, docs: document BPF_MAP_TYPE_ARRAY Dave Tucker
2021-12-07 14:53 ` Jonathan Corbet
2021-12-07 15:29 ` Dave Tucker
2021-12-07 15: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=87a6hc1l73.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=andrii@kernel.org \
--cc=ast@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=daniel@iogearbox.net \
--cc=dave@dtucker.co.uk \
--cc=john.fastabend@gmail.com \
--cc=kafai@fb.com \
--cc=kpsingh@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=songliubraving@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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.