Skip to contentSkip to conversation

docs/bpf: Fix most/least significant bit typos

PATCH In review Mahmoud Abumandour 3 participants 3 messages Mar 19, 2022 – Mar 21, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/bpf: Fix most/least significant bit typos

The LSB and MSB acronyms should not be followed by the word "bits". This fixes this issue and uses the full phrases "most/least significant bits" for better readibility.

---
 Documentation/bpf/classic_vs_extended.rst | 4 ++--
 Documentation/bpf/instruction-set.rst     | 3 ++-
 2 files changed, 4 insertions(+), 3 deletions(-)
Documentation/bpf/classic_vs_extended.rst +2 -2
index 2f81a81f5267..551d788659fa 100644
@@ -252,7 +252,7 @@ parts::
   +----------------+--------+--------------------+
   (MSB)                                      (LSB)
 
-Three LSB bits store instruction class which is one of:
+The three least significant bits store instruction class which is one of:
 
   ===================     ===============
   Classic BPF classes     eBPF classes
@@ -284,7 +284,7 @@ The 4th bit encodes the source operand ...
 	BPF_SRC(code) == BPF_X - use 'src_reg' register as source operand
 	BPF_SRC(code) == BPF_K - use 32-bit immediate as source operand
 
-... and four MSB bits store operation code.
+... and the four most significant bits store operation code.
 
 If BPF_CLASS(code) == BPF_ALU or BPF_ALU64 [ in eBPF ], BPF_OP(code) is one of::
 
Documentation/bpf/instruction-set.rst +2 -1
index 3704836fe6df..3d123a9b3f5c 100644
@@ -36,7 +36,8 @@ Unused fields shall be cleared to zero.
 Instruction classes
 -------------------
 
-The three LSB bits of the 'opcode' field store the instruction class:
+The three least significant bits of the 'opcode' field store the instruction
+class:
 
   =========  =====  ===============================
   class      value  description
Signature · 1 line
2.35.0
maintainer
#1 lore raw
Quoted 5 lines · Mahmoud Abumandour

The LSB and MSB acronyms should not be followed by the word "bits". This fixes this issue and uses the full phrases "most/least significant bits" for better readibility.

What "issue" is being fixed here? Why would you not use the acronyms? It's fine as-is, not applying it.

Thanks,
Daniel

maintainer
#2 lore raw
Quoted 9 lines · Daniel Borkmann
Quoted 5 lines · Mahmoud Abumandour

The LSB and MSB acronyms should not be followed by the word "bits". This fixes this issue and uses the full phrases "most/least significant bits" for better readibility.

What "issue" is being fixed here? Why would you not use the acronyms? It's fine as-is, not applying it.

I *think* that the nit being picked here is that the word "bits" after an acronym like MSB is redundant...

jon