From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Randy Dunlap <rdunlap@infradead.org>, linux-kernel@vger.kernel.org
Cc: Andrii Nakryiko <andrii@kernel.org>,
Alexei Starovoitov <ast@kernel.org>,
Daniel Borkmann <daniel@iogearbox.net>,
bpf@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org
Subject: Re: [PATCH 04/35] Documentation: bpf: correct spelling
Date: Fri, 27 Jan 2023 15:29:50 +0700 [thread overview]
Message-ID: <Y9OLfsdbciFfn8ci@debian.me> (raw)
In-Reply-To: <20230127064005.1558-5-rdunlap@infradead.org>
[-- Attachment #1: Type: text/plain, Size: 4020 bytes --]
On Thu, Jan 26, 2023 at 10:39:34PM -0800, Randy Dunlap wrote:
> diff -- a/Documentation/bpf/libbpf/libbpf_naming_convention.rst b/Documentation/bpf/libbpf/libbpf_naming_convention.rst
> --- a/Documentation/bpf/libbpf/libbpf_naming_convention.rst
> +++ b/Documentation/bpf/libbpf/libbpf_naming_convention.rst
> @@ -83,8 +83,8 @@ This prevents from accidentally exportin
> to be a part of ABI what, in turn, improves both libbpf developer- and
> user-experiences.
>
> -ABI versionning
> ----------------
> +ABI versioning
> +--------------
>
> To make future ABI extensions possible libbpf ABI is versioned.
> Versioning is implemented by ``libbpf.map`` version script that is
> @@ -148,7 +148,7 @@ API documentation convention
> The libbpf API is documented via comments above definitions in
> header files. These comments can be rendered by doxygen and sphinx
> for well organized html output. This section describes the
> -convention in which these comments should be formated.
> +convention in which these comments should be formatted.
>
> Here is an example from btf.h:
>
> diff -- a/Documentation/bpf/map_xskmap.rst b/Documentation/bpf/map_xskmap.rst
> --- a/Documentation/bpf/map_xskmap.rst
> +++ b/Documentation/bpf/map_xskmap.rst
> @@ -178,7 +178,7 @@ The following code snippet shows how to
>
> For an example on how create AF_XDP sockets, please see the AF_XDP-example and
> AF_XDP-forwarding programs in the `bpf-examples`_ directory in the `libxdp`_ repository.
> -For a detailed explaination of the AF_XDP interface please see:
> +For a detailed explanation of the AF_XDP interface please see:
>
> - `libxdp-readme`_.
> - `AF_XDP`_ kernel documentation.
> diff -- a/Documentation/bpf/ringbuf.rst b/Documentation/bpf/ringbuf.rst
> --- a/Documentation/bpf/ringbuf.rst
> +++ b/Documentation/bpf/ringbuf.rst
> @@ -124,7 +124,7 @@ buffer. Currently 4 are supported:
>
> - ``BPF_RB_AVAIL_DATA`` returns amount of unconsumed data in ring buffer;
> - ``BPF_RB_RING_SIZE`` returns the size of ring buffer;
> -- ``BPF_RB_CONS_POS``/``BPF_RB_PROD_POS`` returns current logical possition
> +- ``BPF_RB_CONS_POS``/``BPF_RB_PROD_POS`` returns current logical position
> of consumer/producer, respectively.
>
> Returned values are momentarily snapshots of ring buffer state and could be
> @@ -146,7 +146,7 @@ Design and Implementation
> This reserve/commit schema allows a natural way for multiple producers, either
> on different CPUs or even on the same CPU/in the same BPF program, to reserve
> independent records and work with them without blocking other producers. This
> -means that if BPF program was interruped by another BPF program sharing the
> +means that if BPF program was interrupted by another BPF program sharing the
> same ring buffer, they will both get a record reserved (provided there is
> enough space left) and can work with it and submit it independently. This
> applies to NMI context as well, except that due to using a spinlock during
> diff -- a/Documentation/bpf/verifier.rst b/Documentation/bpf/verifier.rst
> --- a/Documentation/bpf/verifier.rst
> +++ b/Documentation/bpf/verifier.rst
> @@ -192,7 +192,7 @@ checked and found to be non-NULL, all co
> As well as range-checking, the tracked information is also used for enforcing
> alignment of pointer accesses. For instance, on most systems the packet pointer
> is 2 bytes after a 4-byte alignment. If a program adds 14 bytes to that to jump
> -over the Ethernet header, then reads IHL and addes (IHL * 4), the resulting
> +over the Ethernet header, then reads IHL and adds (IHL * 4), the resulting
> pointer will have a variable offset known to be 4n+2 for some n, so adding the 2
> bytes (NET_IP_ALIGN) gives a 4-byte alignment and so word-sized accesses through
> that pointer are safe.
LGTM, thanks!
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
next prev parent reply other threads:[~2023-01-27 8:29 UTC|newest]
Thread overview: 78+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-27 6:39 [PATCH 00/35] Documentation: correct lots of spelling errors (series 1) Randy Dunlap
2023-01-27 6:39 ` [PATCH 02/35] Documentation: arm: correct spelling Randy Dunlap
2023-01-27 6:55 ` Mukesh Ojha
2023-01-27 6:39 ` [PATCH 01/35] Documentation: arm64: " Randy Dunlap
2023-01-27 7:02 ` Mukesh Ojha
2023-01-27 6:39 ` [PATCH 03/35] Documentation: block: " Randy Dunlap
2023-01-27 8:31 ` Bagas Sanjaya
2023-01-27 22:58 ` Randy Dunlap
2023-01-27 8:36 ` Mukesh Ojha
2023-01-27 6:39 ` [PATCH 04/35] Documentation: bpf: " Randy Dunlap
2023-01-27 8:29 ` Bagas Sanjaya [this message]
2023-01-28 19:38 ` Alexei Starovoitov
2023-01-30 14:24 ` David Vernet
2023-01-30 14:26 ` David Vernet
2023-01-27 6:39 ` [PATCH 05/35] Documentation: core-api: " Randy Dunlap
2023-01-27 15:25 ` Mukesh Ojha
2023-01-27 6:39 ` [PATCH 06/35] Documentation: fault-injection: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 07/35] Documentation: fb: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 08/35] Documentation: features: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 09/35] Documentation: firmware-guide/acpi: " Randy Dunlap
2023-01-30 15:52 ` Rafael J. Wysocki
2023-01-27 6:39 ` [PATCH 10/35] Documentation: hid: " Randy Dunlap
2023-01-27 16:20 ` srinivas pandruvada
2023-02-06 14:01 ` (subset) " Benjamin Tissoires
2023-01-27 6:39 ` [PATCH 11/35] Documentation: i2c: " Randy Dunlap
2023-01-27 7:14 ` Wolfram Sang
2023-01-27 8:26 ` Bagas Sanjaya
2023-01-27 22:34 ` Randy Dunlap
2023-01-27 6:39 ` [PATCH 12/35] Documentation: input: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 13/35] Documentation: isdn: " Randy Dunlap
2023-01-28 6:06 ` Jakub Kicinski
2023-01-27 6:39 ` [PATCH 14/35] Documentation: leds: " Randy Dunlap
2023-01-27 9:30 ` Lee Jones
2023-01-27 6:39 ` [PATCH 15/35] Documentation: litmus-tests: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 16/35] Documentation: livepatch: " Randy Dunlap
2023-01-27 10:52 ` Petr Mladek
2023-01-27 6:39 ` [PATCH 17/35] Documentation: locking: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 18/35] Documentation: mm: " Randy Dunlap
2023-01-27 6:44 ` HORIGUCHI NAOYA(堀口 直也)
2023-01-27 8:27 ` Bagas Sanjaya
2023-01-30 10:07 ` Mike Rapoport
2023-01-27 6:39 ` [PATCH 19/35] Documentation: openrisc: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 20/35] Documentation: PCI: " Randy Dunlap
2023-01-27 15:55 ` Bjorn Helgaas
2023-01-27 6:39 ` [PATCH 22/35] Documentation: power: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 21/35] Documentation: powerpc: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 23/35] Documentation: s390: " Randy Dunlap
2023-01-27 11:43 ` Heiko Carstens
2023-01-27 6:39 ` [PATCH 24/35] Documentation: scheduler: " Randy Dunlap
2023-01-27 15:33 ` Mukesh Ojha
2023-01-27 6:39 ` [PATCH 25/35] Documentation: security: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 26/35] Documentation: sound: " Randy Dunlap
2023-01-29 8:24 ` Takashi Iwai
2023-01-27 6:39 ` [PATCH 27/35] Documentation: spi: " Randy Dunlap
2023-01-27 6:39 ` [PATCH 28/35] Documentation: target: " Randy Dunlap
2023-02-08 23:13 ` Martin K. Petersen
2023-01-27 6:39 ` [PATCH 29/35] Documentation: timers: " Randy Dunlap
2023-01-27 6:40 ` [PATCH 30/35] Documentation: tools/rtla: " Randy Dunlap
2023-01-27 8:52 ` Daniel Bristot de Oliveira
2023-01-27 19:53 ` Steven Rostedt
2023-01-27 6:40 ` [PATCH 31/35] Documentation: trace: " Randy Dunlap
2023-01-27 7:05 ` Mukesh Ojha
2023-01-27 8:54 ` Daniel Bristot de Oliveira
2023-01-27 23:01 ` Randy Dunlap
2023-01-27 19:54 ` Steven Rostedt
2023-01-31 18:20 ` Suzuki K Poulose
2023-01-27 6:40 ` [PATCH 32/35] Documentation: usb: " Randy Dunlap
2023-01-27 6:40 ` [PATCH 33/35] Documentation: w1: " Randy Dunlap
2023-01-27 6:40 ` [PATCH 34/35] Documentation: x86: " Randy Dunlap
2023-01-27 6:40 ` [PATCH 35/35] Documentation: xtensa: " Randy Dunlap
2023-01-27 17:45 ` Max Filippov
2023-01-27 6:59 ` [PATCH 15/35] Documentation: litmus-tests: " David Howells
2023-01-27 14:59 ` Paul E. McKenney
2023-01-27 6:59 ` [PATCH 25/35] Documentation: security: " David Howells
2023-01-28 10:48 ` (subset) [PATCH 00/35] Documentation: correct lots of spelling errors (series 1) Mark Brown
2023-01-28 20:30 ` patchwork-bot+netdevbpf
2023-01-31 16:28 ` (subset) " Catalin Marinas
2023-02-14 16:57 ` Martin K. Petersen
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=Y9OLfsdbciFfn8ci@debian.me \
--to=bagasdotme@gmail.com \
--cc=andrii@kernel.org \
--cc=ast@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=corbet@lwn.net \
--cc=daniel@iogearbox.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.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).