WTF: patch "[PATCH] iio: fix kernel-doc build errors" was seriously submitted to be applied to the 4.14-stable tree?

WTF: patch "[PATCH] iio: fix kernel-doc build errors" was seriously submitted to be applied to the 4.14-stable tree?

[gregkh]

The patch below was submitted to be applied to the 4.14-stable tree.

I fail to see how this patch meets the stable kernel rules as found at
Documentation/process/stable-kernel-rules.rst.

I could be totally wrong, and if so, please respond to 
<stable@vger.kernel.org> and let me know why this patch should be
applied.  Otherwise, it is now dropped from my patch queues, never to be
seen again.

thanks,

greg k-h

------------------ original commit in Linus's tree ------------------

>From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17 00:00:00 2001
From: Randy Dunlap <rdunlap@infradead.org>
Date: Sun, 29 Oct 2017 17:06:01 -0700
Subject: [PATCH] iio: fix kernel-doc build errors

Fix build errors in kernel-doc notation. Symbols that end in '_'
have a special meaning, but adding a '*' makes them OK.

../drivers/iio/industrialio-core.c:635: ERROR: Unknown target name: "iio_val".
../drivers/iio/industrialio-core.c:642: ERROR: Unknown target name: "iio_val".

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: <Stable@vger.kernel.org>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
index 9c4cfd19b739..2f0998ebeed2 100644
--- a/drivers/iio/industrialio-core.c
+++ b/drivers/iio/industrialio-core.c
@@ -631,7 +631,7 @@ static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
  * iio_format_value() - Formats a IIO value into its string representation
  * @buf:	The buffer to which the formatted value gets written
  *		which is assumed to be big enough (i.e. PAGE_SIZE).
- * @type:	One of the IIO_VAL_... constants. This decides how the val
+ * @type:	One of the IIO_VAL_* constants. This decides how the val
  *		and val2 parameters are formatted.
  * @size:	Number of IIO value entries contained in vals
  * @vals:	Pointer to the values, exact meaning depends on the
@@ -639,7 +639,7 @@ static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
  *
  * Return: 0 by default, a negative number on failure or the
  *	   total number of characters written for a type that belongs
- *	   to the IIO_VAL_... constant.
+ *	   to the IIO_VAL_* constant.
  */
 ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals)
 {

Re: WTF: patch "[PATCH] iio: fix kernel-doc build errors" was seriously submitted to be applied to the 4.14-stable tree?

[Randy Dunlap]

On 12/11/2017 01:14 PM, gregkh@linuxfoundation.org wrote:
> The patch below was submitted to be applied to the 4.14-stable tree.
> 
> I fail to see how this patch meets the stable kernel rules as found at
> Documentation/process/stable-kernel-rules.rst.
> 
> I could be totally wrong, and if so, please respond to 
> <stable@vger.kernel.org> and let me know why this patch should be
> applied.  Otherwise, it is now dropped from my patch queues, never to be
> seen again.
> 
> thanks,
> 
> greg k-h

Mind you, I'm not pushing for its inclusion in -stable, but I would say that
it meets all of the rules listed for inclusion, depending on how loosely or
how strongly one interprets some of the wording there.

ta.

> ------------------ original commit in Linus's tree ------------------
> 
> From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17 00:00:00 2001
> From: Randy Dunlap <rdunlap@infradead.org>
> Date: Sun, 29 Oct 2017 17:06:01 -0700
> Subject: [PATCH] iio: fix kernel-doc build errors
> 
> Fix build errors in kernel-doc notation. Symbols that end in '_'
> have a special meaning, but adding a '*' makes them OK.
> 
> ../drivers/iio/industrialio-core.c:635: ERROR: Unknown target name: "iio_val".
> ../drivers/iio/industrialio-core.c:642: ERROR: Unknown target name: "iio_val".
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: <Stable@vger.kernel.org>
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
> index 9c4cfd19b739..2f0998ebeed2 100644
> --- a/drivers/iio/industrialio-core.c
> +++ b/drivers/iio/industrialio-core.c
> @@ -631,7 +631,7 @@ static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
>   * iio_format_value() - Formats a IIO value into its string representation
>   * @buf:	The buffer to which the formatted value gets written
>   *		which is assumed to be big enough (i.e. PAGE_SIZE).
> - * @type:	One of the IIO_VAL_... constants. This decides how the val
> + * @type:	One of the IIO_VAL_* constants. This decides how the val
>   *		and val2 parameters are formatted.
>   * @size:	Number of IIO value entries contained in vals
>   * @vals:	Pointer to the values, exact meaning depends on the
> @@ -639,7 +639,7 @@ static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
>   *
>   * Return: 0 by default, a negative number on failure or the
>   *	   total number of characters written for a type that belongs
> - *	   to the IIO_VAL_... constant.
> + *	   to the IIO_VAL_* constant.
>   */
>  ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals)
>  {
> 


-- 
~Randy

Re: WTF: patch "[PATCH] iio: fix kernel-doc build errors" was seriously submitted to be applied to the 4.14-stable tree?

[Greg KH]

On Mon, Dec 11, 2017 at 02:02:18PM -0800, Randy Dunlap wrote:
> On 12/11/2017 01:14 PM, gregkh@linuxfoundation.org wrote:
> > The patch below was submitted to be applied to the 4.14-stable tree.
> > 
> > I fail to see how this patch meets the stable kernel rules as found at
> > Documentation/process/stable-kernel-rules.rst.
> > 
> > I could be totally wrong, and if so, please respond to 
> > <stable@vger.kernel.org> and let me know why this patch should be
> > applied.  Otherwise, it is now dropped from my patch queues, never to be
> > seen again.
> > 
> > thanks,
> > 
> > greg k-h
> 
> Mind you, I'm not pushing for its inclusion in -stable, but I would say that
> it meets all of the rules listed for inclusion, depending on how loosely or
> how strongly one interprets some of the wording there.

"Normal" build warnings/errors are great to fix, but documentation build
warnings are things I've never fixed for the stable trees before.

thanks,

greg k-h

Re: WTF: patch "[PATCH] iio: fix kernel-doc build errors" was seriously submitted to be applied to the 4.14-stable tree?

[Greg KH]

On Mon, Dec 11, 2017 at 02:02:18PM -0800, Randy Dunlap wrote:
> On 12/11/2017 01:14 PM, gregkh@linuxfoundation.org wrote:
> > The patch below was submitted to be applied to the 4.14-stable tree.
> > 
> > I fail to see how this patch meets the stable kernel rules as found at
> > Documentation/process/stable-kernel-rules.rst.
> > 
> > I could be totally wrong, and if so, please respond to 
> > <stable@vger.kernel.org> and let me know why this patch should be
> > applied.  Otherwise, it is now dropped from my patch queues, never to be
> > seen again.
> > 
> > thanks,
> > 
> > greg k-h
> 
> Mind you, I'm not pushing for its inclusion in -stable, but I would say that
> it meets all of the rules listed for inclusion, depending on how loosely or
> how strongly one interprets some of the wording there.
> 
> ta.
> 
> > ------------------ original commit in Linus's tree ------------------
> > 
> > From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17 00:00:00 2001
> > From: Randy Dunlap <rdunlap@infradead.org>
> > Date: Sun, 29 Oct 2017 17:06:01 -0700
> > Subject: [PATCH] iio: fix kernel-doc build errors
> > 
> > Fix build errors in kernel-doc notation. Symbols that end in '_'
> > have a special meaning, but adding a '*' makes them OK.
> > 
> > ../drivers/iio/industrialio-core.c:635: ERROR: Unknown target name: "iio_val".
> > ../drivers/iio/industrialio-core.c:642: ERROR: Unknown target name: "iio_val".
> > 
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > Cc: <Stable@vger.kernel.org>
> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > 
> > diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
> > index 9c4cfd19b739..2f0998ebeed2 100644
> > --- a/drivers/iio/industrialio-core.c
> > +++ b/drivers/iio/industrialio-core.c
> > @@ -631,7 +631,7 @@ static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
> >   * iio_format_value() - Formats a IIO value into its string representation
> >   * @buf:	The buffer to which the formatted value gets written
> >   *		which is assumed to be big enough (i.e. PAGE_SIZE).
> > - * @type:	One of the IIO_VAL_... constants. This decides how the val
> > + * @type:	One of the IIO_VAL_* constants. This decides how the val
> >   *		and val2 parameters are formatted.
> >   * @size:	Number of IIO value entries contained in vals
> >   * @vals:	Pointer to the values, exact meaning depends on the
> > @@ -639,7 +639,7 @@ static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
> >   *
> >   * Return: 0 by default, a negative number on failure or the
> >   *	   total number of characters written for a type that belongs
> > - *	   to the IIO_VAL_... constant.
> > + *	   to the IIO_VAL_* constant.
> >   */
> >  ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals)
> >  {

I can't duplicate this build error on 4.14 anyway, what do you have to
do to reproduce it?

'make htmldocs' doesn't show it.  It does show a bunch of documentation
build warnings, which maybe I should care about and get cleaned up, as
people will be using this kernel for a while...

thanks,

greg k-h

Re: WTF: patch "[PATCH] iio: fix kernel-doc build errors" was seriously submitted to be applied to the 4.14-stable tree?

[Randy Dunlap]

On 12/11/2017 02:25 PM, Greg KH wrote:
> On Mon, Dec 11, 2017 at 02:02:18PM -0800, Randy Dunlap wrote:
>> On 12/11/2017 01:14 PM, gregkh@linuxfoundation.org wrote:
>>> The patch below was submitted to be applied to the 4.14-stable tree.
>>>
>>> I fail to see how this patch meets the stable kernel rules as found at
>>> Documentation/process/stable-kernel-rules.rst.
>>>
>>> I could be totally wrong, and if so, please respond to 
>>> <stable@vger.kernel.org> and let me know why this patch should be
>>> applied.  Otherwise, it is now dropped from my patch queues, never to be
>>> seen again.
>>>
>>> thanks,
>>>
>>> greg k-h
>>
>> Mind you, I'm not pushing for its inclusion in -stable, but I would say that
>> it meets all of the rules listed for inclusion, depending on how loosely or
>> how strongly one interprets some of the wording there.
>>
>> ta.
>>
>>> ------------------ original commit in Linus's tree ------------------
>>>
>>> From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17 00:00:00 2001
>>> From: Randy Dunlap <rdunlap@infradead.org>
>>> Date: Sun, 29 Oct 2017 17:06:01 -0700
>>> Subject: [PATCH] iio: fix kernel-doc build errors
>>>
>>> Fix build errors in kernel-doc notation. Symbols that end in '_'
>>> have a special meaning, but adding a '*' makes them OK.
>>>
>>> ../drivers/iio/industrialio-core.c:635: ERROR: Unknown target name: "iio_val".
>>> ../drivers/iio/industrialio-core.c:642: ERROR: Unknown target name: "iio_val".
>>>
>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>> Cc: <Stable@vger.kernel.org>
>>> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>>>
>>> diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
>>> index 9c4cfd19b739..2f0998ebeed2 100644
>>> --- a/drivers/iio/industrialio-core.c
>>> +++ b/drivers/iio/industrialio-core.c
>>> @@ -631,7 +631,7 @@ static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
>>>   * iio_format_value() - Formats a IIO value into its string representation
>>>   * @buf:	The buffer to which the formatted value gets written
>>>   *		which is assumed to be big enough (i.e. PAGE_SIZE).
>>> - * @type:	One of the IIO_VAL_... constants. This decides how the val
>>> + * @type:	One of the IIO_VAL_* constants. This decides how the val
>>>   *		and val2 parameters are formatted.
>>>   * @size:	Number of IIO value entries contained in vals
>>>   * @vals:	Pointer to the values, exact meaning depends on the
>>> @@ -639,7 +639,7 @@ static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
>>>   *
>>>   * Return: 0 by default, a negative number on failure or the
>>>   *	   total number of characters written for a type that belongs
>>> - *	   to the IIO_VAL_... constant.
>>> + *	   to the IIO_VAL_* constant.
>>>   */
>>>  ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals)
>>>  {
> 
> I can't duplicate this build error on 4.14 anyway, what do you have to
> do to reproduce it?

I got it on 4.14.

> 'make htmldocs' doesn't show it.  It does show a bunch of documentation
> build warnings, which maybe I should care about and get cleaned up, as
> people will be using this kernel for a while...

I just do:
$ mkdir -p DOC1
$ make -j4 O=DOC1 htmldocs 2>&1 | tee doc1.out

> thanks,
> 
> greg k-h


-- 
~Randy

Re: WTF: patch "[PATCH] iio: fix kernel-doc build errors" was seriously submitted to be applied to the 4.14-stable tree?

[Greg KH]

On Mon, Dec 11, 2017 at 02:29:21PM -0800, Randy Dunlap wrote:
> On 12/11/2017 02:25 PM, Greg KH wrote:
> > On Mon, Dec 11, 2017 at 02:02:18PM -0800, Randy Dunlap wrote:
> >> On 12/11/2017 01:14 PM, gregkh@linuxfoundation.org wrote:
> >>> The patch below was submitted to be applied to the 4.14-stable tree.
> >>>
> >>> I fail to see how this patch meets the stable kernel rules as found at
> >>> Documentation/process/stable-kernel-rules.rst.
> >>>
> >>> I could be totally wrong, and if so, please respond to 
> >>> <stable@vger.kernel.org> and let me know why this patch should be
> >>> applied.  Otherwise, it is now dropped from my patch queues, never to be
> >>> seen again.
> >>>
> >>> thanks,
> >>>
> >>> greg k-h
> >>
> >> Mind you, I'm not pushing for its inclusion in -stable, but I would say that
> >> it meets all of the rules listed for inclusion, depending on how loosely or
> >> how strongly one interprets some of the wording there.
> >>
> >> ta.
> >>
> >>> ------------------ original commit in Linus's tree ------------------
> >>>
> >>> From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17 00:00:00 2001
> >>> From: Randy Dunlap <rdunlap@infradead.org>
> >>> Date: Sun, 29 Oct 2017 17:06:01 -0700
> >>> Subject: [PATCH] iio: fix kernel-doc build errors
> >>>
> >>> Fix build errors in kernel-doc notation. Symbols that end in '_'
> >>> have a special meaning, but adding a '*' makes them OK.
> >>>
> >>> ../drivers/iio/industrialio-core.c:635: ERROR: Unknown target name: "iio_val".
> >>> ../drivers/iio/industrialio-core.c:642: ERROR: Unknown target name: "iio_val".
> >>>
> >>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> >>> Cc: <Stable@vger.kernel.org>
> >>> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> >>>
> >>> diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
> >>> index 9c4cfd19b739..2f0998ebeed2 100644
> >>> --- a/drivers/iio/industrialio-core.c
> >>> +++ b/drivers/iio/industrialio-core.c
> >>> @@ -631,7 +631,7 @@ static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
> >>>   * iio_format_value() - Formats a IIO value into its string representation
> >>>   * @buf:	The buffer to which the formatted value gets written
> >>>   *		which is assumed to be big enough (i.e. PAGE_SIZE).
> >>> - * @type:	One of the IIO_VAL_... constants. This decides how the val
> >>> + * @type:	One of the IIO_VAL_* constants. This decides how the val
> >>>   *		and val2 parameters are formatted.
> >>>   * @size:	Number of IIO value entries contained in vals
> >>>   * @vals:	Pointer to the values, exact meaning depends on the
> >>> @@ -639,7 +639,7 @@ static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
> >>>   *
> >>>   * Return: 0 by default, a negative number on failure or the
> >>>   *	   total number of characters written for a type that belongs
> >>> - *	   to the IIO_VAL_... constant.
> >>> + *	   to the IIO_VAL_* constant.
> >>>   */
> >>>  ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals)
> >>>  {
> > 
> > I can't duplicate this build error on 4.14 anyway, what do you have to
> > do to reproduce it?
> 
> I got it on 4.14.
> 
> > 'make htmldocs' doesn't show it.  It does show a bunch of documentation
> > build warnings, which maybe I should care about and get cleaned up, as
> > people will be using this kernel for a while...
> 
> I just do:
> $ mkdir -p DOC1
> $ make -j4 O=DOC1 htmldocs 2>&1 | tee doc1.out

Thanks, but I still do not see these errors on the 4.14.y tree.

greg k-h

RE: WTF: patch "[PATCH] iio: fix kernel-doc build errors" was seriously submitted to be applied to the 4.14-stable tree?

[Jonathan Cameron]

> -----Original Message-----
> From: Greg KH [mailto:gregkh@linuxfoundation.org]
> Sent: 12 December 2017 08:19
> To: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jonathan Cameron <jonathan.cameron@huawei.com>;
> Stable@vger.kernel.org
> Subject: Re: WTF: patch "[PATCH] iio: fix kernel-doc build errors" was seriously
> submitted to be applied to the 4.14-stable tree?
> 
> On Mon, Dec 11, 2017 at 02:29:21PM -0800, Randy Dunlap wrote:
> > On 12/11/2017 02:25 PM, Greg KH wrote:
> > > On Mon, Dec 11, 2017 at 02:02:18PM -0800, Randy Dunlap wrote:
> > >> On 12/11/2017 01:14 PM, gregkh@linuxfoundation.org wrote:
> > >>> The patch below was submitted to be applied to the 4.14-stable tree.
> > >>>
> > >>> I fail to see how this patch meets the stable kernel rules as found at
> > >>> Documentation/process/stable-kernel-rules.rst.
> > >>>
> > >>> I could be totally wrong, and if so, please respond to
> > >>> <stable@vger.kernel.org> and let me know why this patch should be
> > >>> applied.  Otherwise, it is now dropped from my patch queues, never to be
> > >>> seen again.
> > >>>
> > >>> thanks,
> > >>>
> > >>> greg k-h
> > >>
> > >> Mind you, I'm not pushing for its inclusion in -stable, but I would say that
> > >> it meets all of the rules listed for inclusion, depending on how loosely or
> > >> how strongly one interprets some of the wording there.
> > >>
> > >> ta.
I did wonder a bit on this one before tagging it.  Kind of pushing the limits :)
Sorry about that.

Jonathan

> > >>
> > >>> ------------------ original commit in Linus's tree ------------------
> > >>>
> > >>> From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17
> 00:00:00 2001
> > >>> From: Randy Dunlap <rdunlap@infradead.org>
> > >>> Date: Sun, 29 Oct 2017 17:06:01 -0700
> > >>> Subject: [PATCH] iio: fix kernel-doc build errors
> > >>>
> > >>> Fix build errors in kernel-doc notation. Symbols that end in '_'
> > >>> have a special meaning, but adding a '*' makes them OK.
> > >>>
> > >>> ../drivers/iio/industrialio-core.c:635: ERROR: Unknown target name:
> "iio_val".
> > >>> ../drivers/iio/industrialio-core.c:642: ERROR: Unknown target name:
> "iio_val".
> > >>>
> > >>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > >>> Cc: <Stable@vger.kernel.org>
> > >>> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > >>>
> > >>> diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
> > >>> index 9c4cfd19b739..2f0998ebeed2 100644
> > >>> --- a/drivers/iio/industrialio-core.c
> > >>> +++ b/drivers/iio/industrialio-core.c
> > >>> @@ -631,7 +631,7 @@ static ssize_t __iio_format_value(char *buf, size_t
> len, unsigned int type,
> > >>>   * iio_format_value() - Formats a IIO value into its string representation
> > >>>   * @buf:	The buffer to which the formatted value gets written
> > >>>   *		which is assumed to be big enough (i.e. PAGE_SIZE).
> > >>> - * @type:	One of the IIO_VAL_... constants. This decides how the
> val
> > >>> + * @type:	One of the IIO_VAL_* constants. This decides how the
> val
> > >>>   *		and val2 parameters are formatted.
> > >>>   * @size:	Number of IIO value entries contained in vals
> > >>>   * @vals:	Pointer to the values, exact meaning depends on the
> > >>> @@ -639,7 +639,7 @@ static ssize_t __iio_format_value(char *buf, size_t
> len, unsigned int type,
> > >>>   *
> > >>>   * Return: 0 by default, a negative number on failure or the
> > >>>   *	   total number of characters written for a type that belongs
> > >>> - *	   to the IIO_VAL_... constant.
> > >>> + *	   to the IIO_VAL_* constant.
> > >>>   */
> > >>>  ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals)
> > >>>  {
> > >
> > > I can't duplicate this build error on 4.14 anyway, what do you have to
> > > do to reproduce it?
> >
> > I got it on 4.14.
> >
> > > 'make htmldocs' doesn't show it.  It does show a bunch of documentation
> > > build warnings, which maybe I should care about and get cleaned up, as
> > > people will be using this kernel for a while...
> >
> > I just do:
> > $ mkdir -p DOC1
> > $ make -j4 O=DOC1 htmldocs 2>&1 | tee doc1.out
> 
> Thanks, but I still do not see these errors on the 4.14.y tree.
> 
> greg k-h