From adf9a351f27edbaf434ab450f8c09e784ca1cf78 Mon Sep 17 00:00:00 2001 From: Andrew Morton Date: Mon, 29 Dec 2003 05:47:59 -0800 Subject: [PATCH] Add lib/parser.c kernel-doc From: Will Dyson Add documentation and comments to lib/parser.c and include/linux/parser.h --- include/linux/parser.h | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'include/linux/parser.h') diff --git a/include/linux/parser.h b/include/linux/parser.h index 5f982a1a2600..fa3332861a09 100644 --- a/include/linux/parser.h +++ b/include/linux/parser.h @@ -1,3 +1,14 @@ +/* + * linux/include/linux/parser.h + * + * Header for lib/parser.c + * Intended use of these functions is parsing filesystem argument lists, + * but could potentially be used anywhere else that simple option=arg + * parsing is required. + */ + + +/* associates an integer enumerator with a pattern string. */ struct match_token { int token; char *pattern; @@ -5,15 +16,16 @@ struct match_token { typedef struct match_token match_table_t[]; +/* Maximum number of arguments that match_token will find in a pattern */ enum {MAX_OPT_ARGS = 3}; +/* Describe the location within a string of a substring */ typedef struct { char *from; char *to; } substring_t; -int match_token(char *s, match_table_t table, substring_t args[]); - +int match_token(char *, match_table_t table, substring_t args[]); int match_int(substring_t *, int *result); int match_octal(substring_t *, int *result); int match_hex(substring_t *, int *result); -- cgit v1.2.3