[PATCH 1/2] kstrto*: add documentation

2012-09-30 Thread Eldad Zack
As J. Bruce Fields pointed out, kstrto* is currently lacking kerneldoc comments. This patch adds kerneldoc comments to common variants of kstrto*: kstrto(u)l, kstrto(u)ll and kstrto(u)int. Cc: J. Bruce Fields Signed-off-by: Eldad Zack --- v2: includes typo fix from Joe Perches , added details

[PATCH 1/2] kstrto*: add documentation

2012-09-30 Thread Eldad Zack
As J. Bruce Fields bfie...@fieldses.org pointed out, kstrto* is currently lacking kerneldoc comments. This patch adds kerneldoc comments to common variants of kstrto*: kstrto(u)l, kstrto(u)ll and kstrto(u)int. Cc: J. Bruce Fields bfie...@fieldses.org Signed-off-by: Eldad Zack

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread Eldad Zack
On Thu, 12 Jul 2012, J. Bruce Fields wrote: > On Fri, Jul 13, 2012 at 12:09:37AM +0200, Eldad Zack wrote: > > > > On Thu, 12 Jul 2012, J. Bruce Fields wrote: > > I am not sure if I understand _parse_integer correctly (which is called > > to do the actual parsing and has a very nice comment to

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread J. Bruce Fields
On Fri, Jul 13, 2012 at 12:09:37AM +0200, Eldad Zack wrote: > > On Thu, 12 Jul 2012, J. Bruce Fields wrote: > > On Thu, Jul 12, 2012 at 10:53:13PM +0200, Eldad Zack wrote: > > > +/** > > > + * kstrtoul - convert a string to an unsigned long > > > > Also, is it worth mentioning that the number is

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread Eldad Zack
On Thu, 12 Jul 2012, J. Bruce Fields wrote: > On Thu, Jul 12, 2012 at 10:53:13PM +0200, Eldad Zack wrote: > > +/** > > + * kstrtoul - convert a string to an unsigned long > > Also, is it worth mentioning that the number is required to be followed > by a string or newline? I am not sure if I

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread J. Bruce Fields
On Thu, Jul 12, 2012 at 10:53:13PM +0200, Eldad Zack wrote: > As J. Bruce Fields pointed out, kstrto* is > currently lacking kerneldoc comments. > This patch adds kerneldoc comments to common variants of kstrto*: > kstrto(u)l, kstrto(u)ll and kstrto(u)int. > > Cc: J. Bruce Fields >

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread Stephen Boyd
On 07/12/12 14:17, Stephen Boyd wrote: > On 07/12/12 13:53, Eldad Zack wrote: >> diff --git a/include/linux/kernel.h b/include/linux/kernel.h >> index e07f5e0..582df0f 100644 >> --- a/include/linux/kernel.h >> +++ b/include/linux/kernel.h >> @@ -220,6 +220,16 @@ int __must_check _kstrtol(const

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread Stephen Boyd
On 07/12/12 13:53, Eldad Zack wrote: > > diff --git a/include/linux/kernel.h b/include/linux/kernel.h > index e07f5e0..582df0f 100644 > --- a/include/linux/kernel.h > +++ b/include/linux/kernel.h > @@ -220,6 +220,16 @@ int __must_check _kstrtol(const char *s, unsigned int > base, long *res); >

[PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread Eldad Zack
As J. Bruce Fields pointed out, kstrto* is currently lacking kerneldoc comments. This patch adds kerneldoc comments to common variants of kstrto*: kstrto(u)l, kstrto(u)ll and kstrto(u)int. Cc: J. Bruce Fields Signed-off-by: Eldad Zack --- include/linux/kernel.h | 36

[PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread Eldad Zack
As J. Bruce Fields bfie...@fieldses.org pointed out, kstrto* is currently lacking kerneldoc comments. This patch adds kerneldoc comments to common variants of kstrto*: kstrto(u)l, kstrto(u)ll and kstrto(u)int. Cc: J. Bruce Fields bfie...@fieldses.org Signed-off-by: Eldad Zack

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread Stephen Boyd
On 07/12/12 13:53, Eldad Zack wrote: diff --git a/include/linux/kernel.h b/include/linux/kernel.h index e07f5e0..582df0f 100644 --- a/include/linux/kernel.h +++ b/include/linux/kernel.h @@ -220,6 +220,16 @@ int __must_check _kstrtol(const char *s, unsigned int base, long *res); int

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread Stephen Boyd
On 07/12/12 14:17, Stephen Boyd wrote: On 07/12/12 13:53, Eldad Zack wrote: diff --git a/include/linux/kernel.h b/include/linux/kernel.h index e07f5e0..582df0f 100644 --- a/include/linux/kernel.h +++ b/include/linux/kernel.h @@ -220,6 +220,16 @@ int __must_check _kstrtol(const char *s,

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread J. Bruce Fields
On Thu, Jul 12, 2012 at 10:53:13PM +0200, Eldad Zack wrote: As J. Bruce Fields bfie...@fieldses.org pointed out, kstrto* is currently lacking kerneldoc comments. This patch adds kerneldoc comments to common variants of kstrto*: kstrto(u)l, kstrto(u)ll and kstrto(u)int. Cc: J. Bruce Fields

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread Eldad Zack
On Thu, 12 Jul 2012, J. Bruce Fields wrote: On Thu, Jul 12, 2012 at 10:53:13PM +0200, Eldad Zack wrote: +/** + * kstrtoul - convert a string to an unsigned long Also, is it worth mentioning that the number is required to be followed by a string or newline? I am not sure if I understand

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread J. Bruce Fields
On Fri, Jul 13, 2012 at 12:09:37AM +0200, Eldad Zack wrote: On Thu, 12 Jul 2012, J. Bruce Fields wrote: On Thu, Jul 12, 2012 at 10:53:13PM +0200, Eldad Zack wrote: +/** + * kstrtoul - convert a string to an unsigned long Also, is it worth mentioning that the number is required to

Re: [PATCH 1/2] kstrto*: add documentation

2012-07-12 Thread Eldad Zack
On Thu, 12 Jul 2012, J. Bruce Fields wrote: On Fri, Jul 13, 2012 at 12:09:37AM +0200, Eldad Zack wrote: On Thu, 12 Jul 2012, J. Bruce Fields wrote: I am not sure if I understand _parse_integer correctly (which is called to do the actual parsing and has a very nice comment to it) - but