2021-01-29 05:04:54

by bingjingc

[permalink] [raw]
Subject: [PATCH] parser: Fix kernel-doc markups

From: BingJing Chang <[email protected]>

Fix existing issues at the kernel-doc markups

Signed-off-by: BingJing Chang <[email protected]>
---
lib/parser.c | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/lib/parser.c b/lib/parser.c
index f5b3e5d..763acd7 100644
--- a/lib/parser.c
+++ b/lib/parser.c
@@ -11,7 +11,7 @@
#include <linux/string.h>

/**
- * match_one: - Determines if a string matches a simple pattern
+ * match_one - Determines if a string matches a simple pattern
* @s: the string to examine for presence of the pattern
* @p: the string containing the pattern
* @args: array of %MAX_OPT_ARGS &substring_t elements. Used to return match
@@ -89,7 +89,7 @@ static int match_one(char *s, const char *p, substring_t args[])
}

/**
- * match_token: - Find a token (and optional args) in a string
+ * match_token - Find a token (and optional args) in a string
* @s: the string to examine for token/argument pairs
* @table: match_table_t describing the set of allowed option tokens and the
* arguments that may be associated with them. Must be terminated with a
@@ -114,7 +114,7 @@ int match_token(char *s, const match_table_t table, substring_t args[])
EXPORT_SYMBOL(match_token);

/**
- * match_number: scan a number in the given base from a substring_t
+ * match_number - scan a number in the given base from a substring_t
* @s: substring to be scanned
* @result: resulting integer on success
* @base: base to use when converting string
@@ -147,7 +147,7 @@ static int match_number(substring_t *s, int *result, int base)
}

/**
- * match_u64int: scan a number in the given base from a substring_t
+ * match_u64int - scan a number in the given base from a substring_t
* @s: substring to be scanned
* @result: resulting u64 on success
* @base: base to use when converting string
@@ -174,7 +174,7 @@ static int match_u64int(substring_t *s, u64 *result, int base)
}

/**
- * match_int: - scan a decimal representation of an integer from a substring_t
+ * match_int - scan a decimal representation of an integer from a substring_t
* @s: substring_t to be scanned
* @result: resulting integer on success
*
@@ -189,7 +189,7 @@ int match_int(substring_t *s, int *result)
EXPORT_SYMBOL(match_int);

/**
- * match_u64: - scan a decimal representation of a u64 from
+ * match_u64 - scan a decimal representation of a u64 from
* a substring_t
* @s: substring_t to be scanned
* @result: resulting unsigned long long on success
@@ -206,7 +206,7 @@ int match_u64(substring_t *s, u64 *result)
EXPORT_SYMBOL(match_u64);

/**
- * match_octal: - scan an octal representation of an integer from a substring_t
+ * match_octal - scan an octal representation of an integer from a substring_t
* @s: substring_t to be scanned
* @result: resulting integer on success
*
@@ -221,7 +221,7 @@ int match_octal(substring_t *s, int *result)
EXPORT_SYMBOL(match_octal);

/**
- * match_hex: - scan a hex representation of an integer from a substring_t
+ * match_hex - scan a hex representation of an integer from a substring_t
* @s: substring_t to be scanned
* @result: resulting integer on success
*
@@ -236,7 +236,7 @@ int match_hex(substring_t *s, int *result)
EXPORT_SYMBOL(match_hex);

/**
- * match_wildcard: - parse if a string matches given wildcard pattern
+ * match_wildcard - parse if a string matches given wildcard pattern
* @pattern: wildcard pattern
* @str: the string to be parsed
*
@@ -287,7 +287,7 @@ bool match_wildcard(const char *pattern, const char *str)
EXPORT_SYMBOL(match_wildcard);

/**
- * match_strlcpy: - Copy the characters from a substring_t to a sized buffer
+ * match_strlcpy - Copy the characters from a substring_t to a sized buffer
* @dest: where to copy to
* @src: &substring_t to copy
* @size: size of destination buffer
@@ -310,7 +310,7 @@ size_t match_strlcpy(char *dest, const substring_t *src, size_t size)
EXPORT_SYMBOL(match_strlcpy);

/**
- * match_strdup: - allocate a new string with the contents of a substring_t
+ * match_strdup - allocate a new string with the contents of a substring_t
* @s: &substring_t to copy
*
* Description: Allocates and returns a string filled with the contents of
--
2.7.4


2021-01-29 06:41:48

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] parser: Fix kernel-doc markups

On 1/28/21 9:00 PM, bingjingc wrote:
> From: BingJing Chang <[email protected]>
>
> Fix existing issues at the kernel-doc markups
>
> Signed-off-by: BingJing Chang <[email protected]>
> ---
> lib/parser.c | 22 +++++++++++-----------
> 1 file changed, 11 insertions(+), 11 deletions(-)
>

Reviewed-by: Randy Dunlap <[email protected]>

thanks for the kernel-doc patch.

--
~Randy
netiquette: https://people.kernel.org/tglx/notes-about-netiquette

2021-02-03 18:14:10

by Jan Kara

[permalink] [raw]
Subject: Re: [PATCH] parser: Fix kernel-doc markups

On Thu 28-01-21 22:39:46, Randy Dunlap wrote:
> On 1/28/21 9:00 PM, bingjingc wrote:
> > From: BingJing Chang <[email protected]>
> >
> > Fix existing issues at the kernel-doc markups
> >
> > Signed-off-by: BingJing Chang <[email protected]>
> > ---
> > lib/parser.c | 22 +++++++++++-----------
> > 1 file changed, 11 insertions(+), 11 deletions(-)
> >
>
> Reviewed-by: Randy Dunlap <[email protected]>
>
> thanks for the kernel-doc patch.

Thanks for the patch and review. Since this is somewhat related to the
match_uint() fixes, I've just picked up this patch to my tree as well since
I don't think we have a designated lib/parser.c maintainer...

Honza
--
Jan Kara <[email protected]>
SUSE Labs, CR