search

ietf-wg-bpf / ebpf-docs

eBPF Standard Documentation
37 stars 5 forks source link

ISA: editorial nits #114

Closed dthaler closed 2 months ago

dthaler commented 3 months ago

I just did another read-through and found some more editorial nits which I plan to fix...

Section 1.1: "s16 is a types whose..." s/types/type/

Section 1.4: "tools as such compilers that..." s/as such/such as/

Section 2.1: the src_reg field correctly says "the source register number (0-10), except where otherwise specified", but dst_reg and offset are missing the "except where otherwise specified" phrases on their definitions, since some new instructions (SDIV, SMOD, MOVSX) reuse offset for other purposes, and the thread around future callx would use dst_reg for another purpose so having similar caveats on all three fields seems warranted.

Section 3.1: most places in the doc use "8-bit", "16-bit", "32-bit", and "64-bit" as adjectives. A couple places in this section are missing the hyphen so are inconsistent.

Section 3.2: most places in the doc put field names in single quotes like 'imm' when referencing them in normal text. A few places in this section, and one in section 3.1, are missing the single quotes so are inconsistent.

Section 4.2: "Where size is one of:" s/size/''/ for consistency with Section 4.1.

Section 5.1: "a IANA sub-registry" s/a/an/

Section 5.1.2: "to supercede the existing conformance group" s/supercede/supersede/

dthaler commented 3 months ago

Proposed fixes posted in https://mailarchive.ietf.org/arch/msg/bpf/KeggnZttOEWr1jmfgo5byzmKJHU/

dthaler commented 3 months ago

Merged in bpf-next: https://patchwork.kernel.org/project/netdevbpf/patch/20240405155245.3618-1-dthaler1968@gmail.com/

dthaler commented 2 months ago

Fixed in draft-02