All of lore.kernel.org
 help / color / mirror / Atom feed
From: Donald Hunter <donald.hunter@gmail.com>
To: "Jesper D. Brouer" <netdev@brouer.com>
Cc: bpf@vger.kernel.org, linux-doc@vger.kernel.org,
	brouer@redhat.com, dave@dtucker.co.uk,
	Toke Hoiland Jorgensen <toke@redhat.com>
Subject: Re: [PATCH bpf-next v8 1/1] bpf, docs: document BPF_MAP_TYPE_ARRAY
Date: Tue, 25 Oct 2022 17:47:47 +0100	[thread overview]
Message-ID: <m2pmefyhn0.fsf@gmail.com> (raw)
In-Reply-To: <5cd2d8ee-a0aa-070f-17c8-dacd816f0927@brouer.com> (Jesper D. Brouer's message of "Tue, 25 Oct 2022 15:57:47 +0200")

"Jesper D. Brouer" <netdev@brouer.com> writes:

> On 21/10/2022 16.22, Donald Hunter wrote:
>> +
>> +Usage
>> +=====
>
> Can we make it more clear, that below refers to usage from BPF programs.
> E.g. changing title "Usage" to something else, or create a sub-section.
> Below we have subsections "Kernel BPF" and "Userspace", do set aside
> kernel-side and userspace API users.
>
> Sorry for bringing this up so late (v8), but I think it is important
> that the documentation makes it easy for the reader to quickly grasp
> which section is BPF-prog code and which is userspace libbpf APIs.
> IMHO this should then be consistent across out docs.

Agreed. I will add "Kernel BPF" and "Userspace" subsections consistently
for both Usage and Examples.

      reply	other threads:[~2022-10-25 17:50 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-21 14:22 [PATCH bpf-next v8 0/1] Document BPF_MAP_TYPE_ARRAY Donald Hunter
2022-10-21 14:22 ` [PATCH bpf-next v8 1/1] bpf, docs: document BPF_MAP_TYPE_ARRAY Donald Hunter
2022-10-24 12:01   ` Maryam Tahhan
2022-10-25 13:57   ` Jesper D. Brouer
2022-10-25 16:47     ` Donald Hunter [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=m2pmefyhn0.fsf@gmail.com \
    --to=donald.hunter@gmail.com \
    --cc=bpf@vger.kernel.org \
    --cc=brouer@redhat.com \
    --cc=dave@dtucker.co.uk \
    --cc=linux-doc@vger.kernel.org \
    --cc=netdev@brouer.com \
    --cc=toke@redhat.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.