diff options
| author | Kees Cook <keescook@chromium.org> | 2022-09-02 14:33:44 -0700 |
|---|---|---|
| committer | Kees Cook <keescook@chromium.org> | 2022-10-28 16:07:57 -0700 |
| commit | 03699f271de1f4df6369cd379506539cd7d590d3 (patch) | |
| tree | db60c900ef8bc36fc9102f0e030f823087ba96fc /Documentation/core-api | |
| parent | 6f7630b1b5bc672b54c1285ee6aba752b446672c (diff) | |
| download | linux-03699f271de1f4df6369cd379506539cd7d590d3.tar.gz | |
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>
Diffstat (limited to 'Documentation/core-api')
| -rw-r--r-- | Documentation/core-api/kernel-api.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst index 06f4ab1226979..0d0c4f87057cb 100644 --- a/Documentation/core-api/kernel-api.rst +++ b/Documentation/core-api/kernel-api.rst @@ -36,6 +36,9 @@ String Conversions String Manipulation ------------------- +.. kernel-doc:: include/linux/fortify-string.h + :internal: + .. kernel-doc:: lib/string.c :export: |