linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mahmoud Abumandour <ma.mandourr@gmail.com>
To: linux-doc@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>,
	Alexei Starovoitov <ast@kernel.org>,
	Daniel Borkmann <daniel@iogearbox.net>,
	Andrii Nakryiko <andrii@kernel.org>,
	Martin KaFai Lau <kafai@fb.com>, Song Liu <songliubraving@fb.com>,
	Yonghong Song <yhs@fb.com>,
	John Fastabend <john.fastabend@gmail.com>,
	KP Singh <kpsingh@kernel.org>,
	Nathan Chancellor <nathan@kernel.org>,
	bpf@vger.kernel.org, Mahmoud Abumandour <ma.mandourr@gmail.com>
Subject: [PATCH] docs/bpf: Fix most/least significant bit typos
Date: Sat, 19 Mar 2022 18:43:37 +0200	[thread overview]
Message-ID: <20220319164337.1272312-1-ma.mandourr@gmail.com> (raw)

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.

Signed-off-by: Mahmoud Abumandour <ma.mandourr@gmail.com>
---
 Documentation/bpf/classic_vs_extended.rst | 4 ++--
 Documentation/bpf/instruction-set.rst     | 3 ++-
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/bpf/classic_vs_extended.rst b/Documentation/bpf/classic_vs_extended.rst
index 2f81a81f5267..551d788659fa 100644
--- a/Documentation/bpf/classic_vs_extended.rst
+++ b/Documentation/bpf/classic_vs_extended.rst
@@ -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::
 
diff --git a/Documentation/bpf/instruction-set.rst b/Documentation/bpf/instruction-set.rst
index 3704836fe6df..3d123a9b3f5c 100644
--- a/Documentation/bpf/instruction-set.rst
+++ b/Documentation/bpf/instruction-set.rst
@@ -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
-- 
2.35.0


             reply	other threads:[~2022-03-19 16:43 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-19 16:43 Mahmoud Abumandour [this message]
2022-03-21 15:19 ` [PATCH] docs/bpf: Fix most/least significant bit typos Daniel Borkmann
2022-03-21 16:12   ` Jonathan Corbet

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=20220319164337.1272312-1-ma.mandourr@gmail.com \
    --to=ma.mandourr@gmail.com \
    --cc=andrii@kernel.org \
    --cc=ast@kernel.org \
    --cc=bpf@vger.kernel.org \
    --cc=corbet@lwn.net \
    --cc=daniel@iogearbox.net \
    --cc=john.fastabend@gmail.com \
    --cc=kafai@fb.com \
    --cc=kpsingh@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=nathan@kernel.org \
    --cc=songliubraving@fb.com \
    --cc=yhs@fb.com \
    /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).