[PATCH 2/2] lib/base64: fix copy-pasted @padding doc in base64_decode()

Josh Law posted 2 patches 1 week, 2 days ago
There is a newer version of this series
[PATCH 2/2] lib/base64: fix copy-pasted @padding doc in base64_decode()
Posted by Josh Law 1 week, 2 days ago
The @padding kernel-doc for base64_decode() says "whether to append
'=' padding characters", which was copy-pasted from base64_encode().
In the decode context, it controls whether the input is expected to
include padding, not whether to append it.

Signed-off-by: Josh Law <objecting@objecting.org>
---
 lib/base64.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/base64.c b/lib/base64.c
index 20dacee25f65..325c7332b049 100644
--- a/lib/base64.c
+++ b/lib/base64.c
@@ -122,7 +122,7 @@ EXPORT_SYMBOL_GPL(base64_encode);
  * @src: the string to decode.  Doesn't need to be NUL-terminated.
  * @srclen: the length of @src in bytes
  * @dst: (output) the decoded binary data
- * @padding: whether to append '=' padding characters
+ * @padding: whether the input is expected to include '=' padding characters
  * @variant: which base64 variant to use
  *
  * Decodes a string using the selected Base64 variant.
-- 
2.34.1