]> git.proxmox.com Git - mirror_ubuntu-kernels.git/commit
string: Rewrite and add more kern-doc for the str*() functions
authorKees Cook <keescook@chromium.org>
Fri, 2 Sep 2022 21:33:44 +0000 (14:33 -0700)
committerKees Cook <keescook@chromium.org>
Fri, 28 Oct 2022 23:07:57 +0000 (16:07 -0700)
commit03699f271de1f4df6369cd379506539cd7d590d3
treedb60c900ef8bc36fc9102f0e030f823087ba96fc
parent6f7630b1b5bc672b54c1285ee6aba752b446672c
string: Rewrite and add more kern-doc for the str*() functions

While there were varying degrees of kern-doc for various str*()-family
functions, many needed updating and clarification, or to just be
entirely written. Update (and relocate) existing kern-doc and add missing
functions, sadly shaking my head at how many times I have written "Do
not use this function". Include the results in the core kernel API doc.

Cc: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Andy Shevchenko <andy@kernel.org>
Cc: Rasmus Villemoes <linux@rasmusvillemoes.dk>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: linux-hardening@vger.kernel.org
Tested-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/lkml/9b0cf584-01b3-3013-b800-1ef59fe82476@gmail.com
Signed-off-by: Kees Cook <keescook@chromium.org>
Documentation/core-api/kernel-api.rst
include/linux/fortify-string.h
lib/string.c
scripts/kernel-doc