summaryrefslogtreecommitdiff
path: root/Documentation/core-api
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@infradead.org>2018-04-16 22:32:55 +0300
committerDavid S. Miller <davem@davemloft.net>2018-04-17 01:53:13 +0300
commit5968a70d7af5f2abbd9d9f9c8e86da51f0a6b16d (patch)
tree43bb11706900c554dc499ae8e8c31b12e4b66486 /Documentation/core-api
parent1c9f0a946d5c6d3d6a83cfee0e8bb4e886559a67 (diff)
downloadlinux-5968a70d7af5f2abbd9d9f9c8e86da51f0a6b16d.tar.xz
textsearch: fix kernel-doc warnings and add kernel-api section
Make lib/textsearch.c usable as kernel-doc. Add textsearch() function family to kernel-api documentation. Fix kernel-doc warnings in <linux/textsearch.h>: ../include/linux/textsearch.h:65: warning: Incorrect use of kernel-doc format: * get_next_block - fetch next block of data ../include/linux/textsearch.h:82: warning: Incorrect use of kernel-doc format: * finish - finalize/clean a series of get_next_block() calls Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'Documentation/core-api')
-rw-r--r--Documentation/core-api/kernel-api.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst
index ff335f8aeb39..92f30006adae 100644
--- a/Documentation/core-api/kernel-api.rst
+++ b/Documentation/core-api/kernel-api.rst
@@ -136,6 +136,19 @@ Sorting
.. kernel-doc:: lib/list_sort.c
:export:
+Text Searching
+--------------
+
+.. kernel-doc:: lib/textsearch.c
+ :doc: ts_intro
+
+.. kernel-doc:: lib/textsearch.c
+ :export:
+
+.. kernel-doc:: include/linux/textsearch.h
+ :functions: textsearch_find textsearch_next \
+ textsearch_get_pattern textsearch_get_pattern_len
+
UUID/GUID
---------