diff mbox series

Documentation: core-api: add generic parser docbook

Message ID 20241120060711.159783-1-rdunlap@infradead.org (mailing list archive)
State New
Headers show
Series Documentation: core-api: add generic parser docbook | expand

Commit Message

Randy Dunlap Nov. 20, 2024, 6:07 a.m. UTC 
Add the simple generic parser to the core-api docbook.
It can be used for parsing all sorts of options throughout the kernel.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: Eric Biggers <ebiggers@kernel.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: linux-fsdevel@vger.kernel.org
---
 Documentation/core-api/index.rst  |    1 +
 Documentation/core-api/parser.rst |   17 +++++++++++++++++
 lib/parser.c                      |    5 +++--
 3 files changed, 21 insertions(+), 2 deletions(-)
diff mbox series

Patch

--- linux-next-20241118.orig/Documentation/core-api/index.rst
+++ linux-next-20241118/Documentation/core-api/index.rst
@@ -53,6 +53,7 @@  Library functionality that is used throu
    floating-point
    union_find
    min_heap
+   parser
 
 Low level entry and exit
 ========================
--- /dev/null
+++ linux-next-20241118/Documentation/core-api/parser.rst
@@ -0,0 +1,17 @@ 
+.. SPDX-License-Identifier: GPL-2.0+
+
+==============
+Generic parser
+==============
+
+Overview
+========
+
+The generic parser is a simple parser for parsing mount options,
+filesystem options, driver options, subsystem options, etc.
+
+Parser API
+==========
+
+.. kernel-doc:: lib/parser.c
+   :export:
--- linux-next-20241118.orig/lib/parser.c
+++ linux-next-20241118/lib/parser.c
@@ -275,8 +275,9 @@  EXPORT_SYMBOL(match_hex);
  *
  * Description: Parse the string @str to check if matches wildcard
  * pattern @pattern. The pattern may contain two types of wildcards:
- *   '*' - matches zero or more characters
- *   '?' - matches one character
+ *
+ * * '*' - matches zero or more characters
+ * * '?' - matches one character
  *
  * Return: If the @str matches the @pattern, return true, else return false.
  */