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

PATCH [email protected] 3 participants 7 messages Dec 11, 2017 – Dec 12, 2017

Subsystems (2)

Stable branch IIO

lore

Share & tools

lore

[email protected]

author maintainer

2017-12-11 21:14 UTC #0 lore raw

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 <[email protected]> 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 ------------------

Quoted 1 line

From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17 00:00:00 2001

From: Randy Dunlap <[email protected]>
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 <[email protected]>

Cc <[email protected]>

Signed-off-by Jonathan Cameron <[email protected]>

drivers/iio/industrialio-core.c +2 -2

index 9c4cfd19b739..2f0998ebeed2 100644
@@ -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 Dunlap

2017-12-11 22:02 UTC #1 lore raw

Quoted 5 lines · On 12/11/2017 01:14 PM, [email protected] 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.

Quoted 8 lines

I could be totally wrong, and if so, please respond to <[email protected]> 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.

Quoted 40 lines

------------------ original commit in Linus's tree ------------------
From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17 00:00:00 2001
From: Randy Dunlap <[email protected]>
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 <[email protected]>
Cc <[email protected]>
Signed-off-by Jonathan Cameron <[email protected]>
drivers/iio/industrialio-core.c +2 -2
index 9c4cfd19b739..2f0998ebeed2 100644
@@ -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)
 {

Signature · 1 line

~Randy

Greg KH

author maintainer

2017-12-11 22:20 UTC #2 lore raw

Quoted 11 lines · Randy Dunlap

Quoted 10 lines · On 12/11/2017 01:14 PM, [email protected] 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 <[email protected]> and let me know why this patch should be applied. Otherwise, it is now dropped from my patch queues, never to be seen again.

Quoted 7 lines

Quoted 3 lines
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

Greg KH

author maintainer

2017-12-11 22:25 UTC #3 lore raw

In reply to Randy Dunlap

Quoted 52 lines · Randy Dunlap

Quoted 5 lines · On 12/11/2017 01:14 PM, [email protected] 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.
Quoted 8 lines
I could be totally wrong, and if so, please respond to <[email protected]> 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.
Quoted 31 lines
------------------ original commit in Linus's tree ------------------
From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17 00:00:00 2001
From: Randy Dunlap <[email protected]>
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 <[email protected]>
Cc <[email protected]>
Signed-off-by Jonathan Cameron <[email protected]>
drivers/iio/industrialio-core.c +1 -1
index 9c4cfd19b739..2f0998ebeed2 100644
@@ -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,

Quoted 8 lines

drivers/iio/industrialio-core.c static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type, · line 645
Quoted 8 lines
drivers/iio/industrialio-core.c +1 -1
  *
  * 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

Randy Dunlap

2017-12-11 22:29 UTC #4 lore raw

Quoted 56 lines · Greg KH

Quoted 55 lines · Randy Dunlap
Quoted 5 lines · On 12/11/2017 01:14 PM, [email protected] 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.
Quoted 8 lines
I could be totally wrong, and if so, please respond to <[email protected]> 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.
Quoted 34 lines
------------------ original commit in Linus's tree ------------------
From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17 00:00:00 2001
From: Randy Dunlap <[email protected]>
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 <[email protected]>
Cc <[email protected]>
Signed-off-by Jonathan Cameron <[email protected]>
drivers/iio/industrialio-core.c +1 -1
index 9c4cfd19b739..2f0998ebeed2 100644
@@ -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

Quoted 8 lines

Quoted 5 lines
drivers/iio/industrialio-core.c static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type, · line 645
Quoted 5 lines
drivers/iio/industrialio-core.c +1 -1
- *	   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.

Quoted 3 lines

'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

Quoted 3 lines

thanks,
greg k-h

Signature · 1 line

~Randy

Greg KH

author maintainer

2017-12-12 08:19 UTC #5 lore raw

Quoted 68 lines · Randy Dunlap

Quoted 56 lines · Greg KH
Quoted 55 lines · Randy Dunlap
Quoted 5 lines · On 12/11/2017 01:14 PM, [email protected] 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.
Quoted 8 lines
I could be totally wrong, and if so, please respond to <[email protected]> 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.
Quoted 34 lines
------------------ original commit in Linus's tree ------------------
From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17 00:00:00 2001
From: Randy Dunlap <[email protected]>
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 <[email protected]>
Cc <[email protected]>
Signed-off-by Jonathan Cameron <[email protected]>
drivers/iio/industrialio-core.c +1 -1
index 9c4cfd19b739..2f0998ebeed2 100644
@@ -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
Quoted 8 lines
Quoted 5 lines
drivers/iio/industrialio-core.c static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type, · line 645
Quoted 5 lines
drivers/iio/industrialio-core.c +1 -1
- *	   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.

Quoted 7 lines

Quoted 3 lines
'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

Jonathan Cameron

2017-12-12 08:47 UTC #6 lore raw

Quoted 11 lines

-----Original Message-----
From: Greg KH [mailto:[email protected]]
Sent: 12 December 2017 08:19
To: Randy Dunlap <[email protected]>
Cc: Jonathan Cameron <[email protected]>; [email protected]
Subject: Re: WTF: patch "[PATCH] iio: fix kernel-doc build errors" was seriously submitted to be applied to the 4.14-stable tree?

Quoted 23 lines

Quoted 22 lines · Randy Dunlap
Quoted 21 lines · Greg KH
Quoted 20 lines · Randy Dunlap
Quoted 5 lines · On 12/11/2017 01:14 PM, [email protected] 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.
Quoted 8 lines
I could be totally wrong, and if so, please respond to <[email protected]> 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

Quoted 64 lines

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
------------------ original commit in Linus's tree ------------------
From c175cb7cd953782bbf4e8bdf088ad61440d6dde5 Mon Sep 17
00:00:00 2001
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
From: Randy Dunlap <[email protected]>
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".
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
../drivers/iio/industrialio-core.c:642: ERROR: Unknown target name:
"iio_val".
Quoted 10 lines
Quoted 10 lines
Quoted 10 lines
drivers/iio/industrialio-core.c static ssize_t __iio_format_value(char *buf, size_t
Quoted 10 lines
Signed-off-by Randy Dunlap <[email protected]>
Cc <[email protected]>
Signed-off-by Jonathan Cameron <[email protected]>
drivers/iio/industrialio-core.c +0 -0
index 9c4cfd19b739..2f0998ebeed2 100644
@@ -631,7 +631,7 @@ static ssize_t __iio_format_value(char *buf, size_t
len, unsigned int type,
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
drivers/iio/industrialio-core.c static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type,
Quoted 4 lines
drivers/iio/industrialio-core.c +0 -1
  * 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
Quoted 1 line
Quoted 1 line
Quoted 1 line
drivers/iio/industrialio-core.c static ssize_t __iio_format_value(char *buf, size_t · line 634
Quoted 1 line
drivers/iio/industrialio-core.c +1 -0
+ * @type:	One of the IIO_VAL_* constants. This decides how the
val
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
drivers/iio/industrialio-core.c static ssize_t __iio_format_value(char *buf, size_t
Quoted 4 lines
drivers/iio/industrialio-core.c +0 -0
  *		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,
Quoted 14 lines
Quoted 11 lines
Quoted 8 lines
drivers/iio/industrialio-core.c static ssize_t __iio_format_value(char *buf, size_t len, unsigned int type, · line 645
Quoted 8 lines
drivers/iio/industrialio-core.c +1 -1
  *
  * 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.
Quoted 7 lines
Quoted 3 lines
'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