[bpf-next] bpf, docs: Add introduction for use in the ISA Internet Draft

Commit Message

Dave Thaler April 22, 2024, 7:09 p.m. UTC

The proposed intro paragraph text is derived from the first paragraph
of the IETF BPF WG charter at https://datatracker.ietf.org/wg/bpf/about/

Signed-off-by: Dave Thaler <[e-mail]>
---
 Documentation/bpf/standardization/instruction-set.rst | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

Comments

David Vernet April 22, 2024, 7:38 p.m. UTC | #1

On Mon, Apr 22, 2024 at 12:09:42PM -0700, Dave Thaler wrote:
> The proposed intro paragraph text is derived from the first paragraph
> of the IETF BPF WG charter at https://datatracker.ietf.org/wg/bpf/about/
> 
> Signed-off-by: Dave Thaler <[e-mail]>
> ---
>  Documentation/bpf/standardization/instruction-set.rst | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/bpf/standardization/instruction-set.rst b/Documentation/bpf/standardization/instruction-set.rst
> index d03d90afb..b44bdacd0 100644
> --- a/Documentation/bpf/standardization/instruction-set.rst
> +++ b/Documentation/bpf/standardization/instruction-set.rst
> @@ -5,7 +5,11 @@
>  BPF Instruction Set Architecture (ISA)
>  ======================================
>  
> -This document specifies the BPF instruction set architecture (ISA).
> +eBPF (which is no longer an acronym for anything), also commonly
> +referred to as BPF, is a technology with origins in the Linux kernel
> +that can run untrusted programs in a privileged context such as an

Perhaps this should be phrased as:

...that can run untrusted programs in privileged contexts such as the
operating system kernel.

Not sure if that's actually a grammar correction but it sounds more
correct in my head. Wdyt?

Regardless:

Acked-by: David Vernet <[e-mail]>

> +operating system kernel. This document specifies the BPF instruction
> +set architecture (ISA).
>  
>  Documentation conventions
>  =========================
> -- 
> 2.40.1
> 
> -- 
> Bpf mailing list
> [e-mail]
> https://www.ietf.org/mailman/listinfo/bpf

Dave Thaler April 22, 2024, 8:18 p.m. UTC | #2

David Vernet <[e-mail]> writes: 
> On Mon, Apr 22, 2024 at 12:09:42PM -0700, Dave Thaler wrote:
> > The proposed intro paragraph text is derived from the first paragraph
> > of the IETF BPF WG charter at
> > https://datatracker.ietf.org/wg/bpf/about/
> >
> > Signed-off-by: Dave Thaler <[e-mail]>
> > ---
> >  Documentation/bpf/standardization/instruction-set.rst | 6 +++++-
> >  1 file changed, 5 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/bpf/standardization/instruction-set.rst
> > b/Documentation/bpf/standardization/instruction-set.rst
> > index d03d90afb..b44bdacd0 100644
> > --- a/Documentation/bpf/standardization/instruction-set.rst
> > +++ b/Documentation/bpf/standardization/instruction-set.rst
> > @@ -5,7 +5,11 @@
> >  BPF Instruction Set Architecture (ISA)
> > ======================================
> >
> > -This document specifies the BPF instruction set architecture (ISA).
> > +eBPF (which is no longer an acronym for anything), also commonly
> > +referred to as BPF, is a technology with origins in the Linux kernel
> > +that can run untrusted programs in a privileged context such as an
> 
> Perhaps this should be phrased as:
> 
> ...that can run untrusted programs in privileged contexts such as the
operating
> system kernel.
> 
> Not sure if that's actually a grammar correction but it sounds more
correct in my
> head. Wdyt?

That sounds less grammatically correct to my reading, since "contexts" would
be plural but "kernel" is singular.   The intent of the original sentence
was that
multiple programs (plural) can run in the same privileged context (singular)
such
as a kernel (singular).

Dave

David Vernet April 23, 2024, 8:11 p.m. UTC | #3

On Mon, Apr 22, 2024 at 01:18:05PM -0700, [e-mail] wrote:
> David Vernet <[e-mail]> writes: 
> > On Mon, Apr 22, 2024 at 12:09:42PM -0700, Dave Thaler wrote:
> > > The proposed intro paragraph text is derived from the first paragraph
> > > of the IETF BPF WG charter at
> > > https://datatracker.ietf.org/wg/bpf/about/
> > >
> > > Signed-off-by: Dave Thaler <[e-mail]>
> > > ---
> > >  Documentation/bpf/standardization/instruction-set.rst | 6 +++++-
> > >  1 file changed, 5 insertions(+), 1 deletion(-)
> > >
> > > diff --git a/Documentation/bpf/standardization/instruction-set.rst
> > > b/Documentation/bpf/standardization/instruction-set.rst
> > > index d03d90afb..b44bdacd0 100644
> > > --- a/Documentation/bpf/standardization/instruction-set.rst
> > > +++ b/Documentation/bpf/standardization/instruction-set.rst
> > > @@ -5,7 +5,11 @@
> > >  BPF Instruction Set Architecture (ISA)
> > > ======================================
> > >
> > > -This document specifies the BPF instruction set architecture (ISA).
> > > +eBPF (which is no longer an acronym for anything), also commonly
> > > +referred to as BPF, is a technology with origins in the Linux kernel
> > > +that can run untrusted programs in a privileged context such as an
> > 
> > Perhaps this should be phrased as:
> > 
> > ...that can run untrusted programs in privileged contexts such as the
> > operating system kernel.
> > 
> > Not sure if that's actually a grammar correction but it sounds more
> > correct in my head. Wdyt?
> 
> That sounds less grammatically correct to my reading, since "contexts"
> would be plural but "kernel" is singular.   The intent of the original
> sentence was that multiple programs (plural) can run in the same
> privileged context (singular) such as a kernel (singular).

Fair enough. My ack above stands.

Thanks,
David

[e-mail] April 26, 2024, 2:20 a.m. UTC | #4

Hello:

This patch was applied to bpf/bpf-next.git (master)
by Alexei Starovoitov <[e-mail]>:

On Mon, 22 Apr 2024 12:09:42 -0700 you wrote:
> The proposed intro paragraph text is derived from the first paragraph
> of the IETF BPF WG charter at https://datatracker.ietf.org/wg/bpf/about/
> 
> Signed-off-by: Dave Thaler <[e-mail]>
> ---
>  Documentation/bpf/standardization/instruction-set.rst | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)

Here is the summary with links:
  - [bpf-next] bpf, docs: Add introduction for use in the ISA Internet Draft
    https://git.kernel.org/bpf/bpf-next/c/e51b907d4032

You are awesome, thank you!

Patch

diff --git a/Documentation/bpf/standardization/instruction-set.rst b/Documentation/bpf/standardization/instruction-set.rst
index d03d90afb..b44bdacd0 100644
--- a/Documentation/bpf/standardization/instruction-set.rst
+++ b/Documentation/bpf/standardization/instruction-set.rst
@@ -5,7 +5,11 @@ 
 BPF Instruction Set Architecture (ISA)
 ======================================
 
-This document specifies the BPF instruction set architecture (ISA).
+eBPF (which is no longer an acronym for anything), also commonly
+referred to as BPF, is a technology with origins in the Linux kernel
+that can run untrusted programs in a privileged context such as an
+operating system kernel. This document specifies the BPF instruction
+set architecture (ISA).
 
 Documentation conventions
 =========================