diff options
| author |   Randy Dunlap <rdunlap@infradead.org> | 2018-04-16 12:32:55 -0700 |
|---|---|---|
| committer |   David S. Miller <davem@davemloft.net> | 2018-04-16 18:53:13 -0400 |
| commit | 5968a70d7af5f2abbd9d9f9c8e86da51f0a6b16d (patch) | |
| tree | 43bb11706900c554dc499ae8e8c31b12e4b66486 /Documentation | |
| parent | Merge branch 'tipc-Better-check-user-provided-attributes' (diff) | |
| download | linux-dev-5968a70d7af5f2abbd9d9f9c8e86da51f0a6b16d.tar.xz linux-dev-5968a70d7af5f2abbd9d9f9c8e86da51f0a6b16d.zip | |
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')
| -rw-r--r-- | Documentation/core-api/kernel-api.rst | 13 |
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 --------- |