public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: David Vernet <void@manifault.com>
To: bpf@vger.kernel.org
Cc: ast@kernel.org, daniel@iogearbox.net, andrii@kernel.org,
	martin.lau@linux.dev, song@kernel.org, yonghong.song@linux.dev,
	john.fastabend@gmail.com, kpsingh@kernel.org, sdf@google.com,
	haoluo@google.com, jolsa@kernel.org,
	linux-kernel@vger.kernel.org, kernel-team@meta.com,
	hch@infradead.org, hawkinsw@obs.cr, dthaler@microsoft.com,
	bpf@ietf.org
Subject: [PATCH bpf-next 0/3] Clean up some standardization stuff
Date: Mon, 28 Aug 2023 10:59:45 -0500	[thread overview]
Message-ID: <20230828155948.123405-1-void@manifault.com> (raw)

The Documentation/bpf/standardization subdirectory contains documents
that will be standardized with the IETF. There are a few things we can
do to clean it up:

- Move linux-notes.rst back to Documentation/bpf. It doesn't belong in
  the standardization directory.
- Move ABI-specific verbiage from instruction-set.rst into a new abi.rst
  document. This document will be expanded significantly over time. For
  now, we just need to get anything describing ABI out of
  instruction-set.rst.
- Say BPF instead of eBPF in our documents. It's just creating
  confusion.

There is more we can and should do. For example, we should create a
maps.rst document that will be a proposed standard for cross platform
map types, and remove any relevant content from instruction-set.rst.
This can be done in a subsequent patch set.

David Vernet (3):
  bpf,docs: Move linux-notes.rst to root bpf docs tree
  bpf,docs: Add abi.rst document to standardization subdirectory
  bpf,docs: s/eBPF/BPF in standards documents

 Documentation/bpf/index.rst                   |  1 +
 .../bpf/{standardization => }/linux-notes.rst |  0
 Documentation/bpf/standardization/abi.rst     | 25 ++++++++++++
 Documentation/bpf/standardization/index.rst   |  2 +-
 .../bpf/standardization/instruction-set.rst   | 38 ++++++-------------
 5 files changed, 38 insertions(+), 28 deletions(-)
 rename Documentation/bpf/{standardization => }/linux-notes.rst (100%)
 create mode 100644 Documentation/bpf/standardization/abi.rst

-- 
2.41.0


             reply	other threads:[~2023-08-28 16:00 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-28 15:59 David Vernet [this message]
2023-08-28 15:59 ` [PATCH bpf-next 1/3] bpf,docs: Move linux-notes.rst to root bpf docs tree David Vernet
2023-08-28 15:59 ` [PATCH bpf-next 2/3] bpf,docs: Add abi.rst document to standardization subdirectory David Vernet
2023-08-28 15:59 ` [PATCH bpf-next 3/3] bpf,docs: s/eBPF/BPF in standards documents David Vernet
2023-08-30 14:40 ` [PATCH bpf-next 0/3] Clean up some standardization stuff patchwork-bot+netdevbpf

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=20230828155948.123405-1-void@manifault.com \
    --to=void@manifault.com \
    --cc=andrii@kernel.org \
    --cc=ast@kernel.org \
    --cc=bpf@ietf.org \
    --cc=bpf@vger.kernel.org \
    --cc=daniel@iogearbox.net \
    --cc=dthaler@microsoft.com \
    --cc=haoluo@google.com \
    --cc=hawkinsw@obs.cr \
    --cc=hch@infradead.org \
    --cc=john.fastabend@gmail.com \
    --cc=jolsa@kernel.org \
    --cc=kernel-team@meta.com \
    --cc=kpsingh@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=martin.lau@linux.dev \
    --cc=sdf@google.com \
    --cc=song@kernel.org \
    --cc=yonghong.song@linux.dev \
    /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