From: Zhang Boyang <zhangboyang.id@gmail.com>
To: linux-kernel@vger.kernel.org
Cc: Ferdinand Blomqvist <ferdinand.blomqvist@gmail.com>,
Thomas Gleixner <tglx@linutronix.de>,
Kees Cook <keescook@chromium.org>,
Randy Dunlap <rdunlap@infradead.org>,
Zhang Boyang <zhangboyang.id@gmail.com>
Subject: [PATCH v3 3/6] rslib: Fix obvious documentation mistakes
Date: Mon, 20 Jun 2022 14:20:12 +0800 [thread overview]
Message-ID: <20220620062015.15612-4-zhangboyang.id@gmail.com> (raw)
In-Reply-To: <20220620062015.15612-1-zhangboyang.id@gmail.com>
This patch fixes some obvious documentation mistakes.
Signed-off-by: Zhang Boyang <zhangboyang.id@gmail.com>
---
include/linux/rslib.h | 4 ++--
lib/reed_solomon/reed_solomon.c | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/include/linux/rslib.h b/include/linux/rslib.h
index 507fa14c03b2..cd0b5a7a5698 100644
--- a/include/linux/rslib.h
+++ b/include/linux/rslib.h
@@ -19,8 +19,8 @@
*
* @mm: Bits per symbol
* @nn: Symbols per block (= (1<<mm)-1)
- * @alpha_to: log lookup table
- * @index_of: Antilog lookup table
+ * @alpha_to: exp() lookup table
+ * @index_of: log() lookup table
* @genpoly: Generator polynomial
* @nroots: Number of generator roots = number of parity symbols
* @fcr: First consecutive root, index form
diff --git a/lib/reed_solomon/reed_solomon.c b/lib/reed_solomon/reed_solomon.c
index bb4f44c8edba..da46026a60b8 100644
--- a/lib/reed_solomon/reed_solomon.c
+++ b/lib/reed_solomon/reed_solomon.c
@@ -56,7 +56,7 @@ static DEFINE_MUTEX(rslistlock);
/**
* codec_init - Initialize a Reed-Solomon codec
- * @symsize: symbol size, bits (1-8)
+ * @symsize: the symbol size (number of bits)
* @gfpoly: Field generator polynomial coefficients
* @gffunc: Field generator function
* @fcr: first root of RS code generator polynomial, index form
--
2.30.2
next prev parent reply other threads:[~2022-06-20 6:21 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-20 6:20 [PATCH v3] rslib: Several improvements Zhang Boyang
2022-06-20 6:20 ` [PATCH v3 1/6] rslib: Fix incorrect documentation of rs_modnn() Zhang Boyang
2022-06-20 6:20 ` [PATCH v3 2/6] rslib: Replace hard-coded 1 with alpha_to[0] Zhang Boyang
2022-06-20 6:20 ` Zhang Boyang [this message]
2022-06-20 6:20 ` [PATCH v3 4/6] rslib: Fix kernel-doc style for rs_modnn() Zhang Boyang
2022-06-21 0:18 ` Randy Dunlap
2022-06-20 6:20 ` [PATCH v3 5/6] rslib: Improve the performance of encode_rs.c Zhang Boyang
2022-06-20 6:20 ` [PATCH v3 6/6] rslib: Fix integer overflow on large fcr or prim Zhang Boyang
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=20220620062015.15612-4-zhangboyang.id@gmail.com \
--to=zhangboyang.id@gmail.com \
--cc=ferdinand.blomqvist@gmail.com \
--cc=keescook@chromium.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=tglx@linutronix.de \
/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
all inboxes | Powered by JetHome®