DPDK patches and discussions
 help / color / mirror / Atom feed
* [PATCH] devtools: ignore new warnings on reported-by tag
@ 2025-08-20  9:50 Dariusz Sosnowski
  2025-08-20 10:35 ` Bruce Richardson
  2025-08-20 13:33 ` Thomas Monjalon
  0 siblings, 2 replies; 4+ messages in thread
From: Dariusz Sosnowski @ 2025-08-20  9:50 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev

There were 2 changes introduced in checkpatch.pl script [1][2]
which verify if Reported-by tag is followed by Link or Closes tag.
Example of the warning output:

    WARNING:BAD_REPORTED_BY_LINK:
      Reported-by: should be immediately followed by Closes:
      with a URL to the report

Original purpose is to link the patch to the mailing list discussion
and/or a bug report.

Since in DPDK these tags are not used, these warnings are false
positives and can be ignored in devtools/checkpatches.sh.

[1]: https://github.com/torvalds/linux/commit/d7f1d71e5ef630ab9e15b5821d297a9e1a5fa1da
[2]: https://github.com/torvalds/linux/commit/44c31888098a590b8ec5ba37009e5a983f7c4b46

Signed-off-by: Dariusz Sosnowski <dsosnowski@nvidia.com>
---
 devtools/checkpatches.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index 35037aa8f1..8c5b5d1380 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -33,7 +33,7 @@ VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,STRLCPY,\
 PREFER_KERNEL_TYPES,PREFER_FALLTHROUGH,BIT_MACRO,CONST_STRUCT,\
 SPLIT_STRING,LONG_LINE_STRING,C99_COMMENT_TOLERANCE,\
 LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
-NEW_TYPEDEFS,COMPARISON_TO_NULL,AVOID_BUG,EXPORT_SYMBOL"
+NEW_TYPEDEFS,COMPARISON_TO_NULL,AVOID_BUG,EXPORT_SYMBOL,BAD_REPORTED_BY_LINK"
 options="$options $DPDK_CHECKPATCH_OPTIONS"
 
 print_usage () {
-- 
2.39.5


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] devtools: ignore new warnings on reported-by tag
  2025-08-20  9:50 [PATCH] devtools: ignore new warnings on reported-by tag Dariusz Sosnowski
@ 2025-08-20 10:35 ` Bruce Richardson
  2025-08-20 13:33 ` Thomas Monjalon
  1 sibling, 0 replies; 4+ messages in thread
From: Bruce Richardson @ 2025-08-20 10:35 UTC (permalink / raw)
  To: Dariusz Sosnowski; +Cc: Thomas Monjalon, dev

On Wed, Aug 20, 2025 at 11:50:50AM +0200, Dariusz Sosnowski wrote:
> There were 2 changes introduced in checkpatch.pl script [1][2]
> which verify if Reported-by tag is followed by Link or Closes tag.
> Example of the warning output:
> 
>     WARNING:BAD_REPORTED_BY_LINK:
>       Reported-by: should be immediately followed by Closes:
>       with a URL to the report
> 
> Original purpose is to link the patch to the mailing list discussion
> and/or a bug report.
> 
> Since in DPDK these tags are not used, these warnings are false
> positives and can be ignored in devtools/checkpatches.sh.
> 
> [1]: https://github.com/torvalds/linux/commit/d7f1d71e5ef630ab9e15b5821d297a9e1a5fa1da
> [2]: https://github.com/torvalds/linux/commit/44c31888098a590b8ec5ba37009e5a983f7c4b46
> 
> Signed-off-by: Dariusz Sosnowski <dsosnowski@nvidia.com>
> ---
>  devtools/checkpatches.sh | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
> index 35037aa8f1..8c5b5d1380 100755
> --- a/devtools/checkpatches.sh
> +++ b/devtools/checkpatches.sh
> @@ -33,7 +33,7 @@ VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,STRLCPY,\
>  PREFER_KERNEL_TYPES,PREFER_FALLTHROUGH,BIT_MACRO,CONST_STRUCT,\
>  SPLIT_STRING,LONG_LINE_STRING,C99_COMMENT_TOLERANCE,\
>  LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
> -NEW_TYPEDEFS,COMPARISON_TO_NULL,AVOID_BUG,EXPORT_SYMBOL"
> +NEW_TYPEDEFS,COMPARISON_TO_NULL,AVOID_BUG,EXPORT_SYMBOL,BAD_REPORTED_BY_LINK"
>  options="$options $DPDK_CHECKPATCH_OPTIONS"
>  
Acked-by: Bruce Richardson <bruce.richardson@intel.com>


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] devtools: ignore new warnings on reported-by tag
  2025-08-20  9:50 [PATCH] devtools: ignore new warnings on reported-by tag Dariusz Sosnowski
  2025-08-20 10:35 ` Bruce Richardson
@ 2025-08-20 13:33 ` Thomas Monjalon
  2025-08-20 13:58   ` Dariusz Sosnowski
  1 sibling, 1 reply; 4+ messages in thread
From: Thomas Monjalon @ 2025-08-20 13:33 UTC (permalink / raw)
  To: Dariusz Sosnowski; +Cc: dev

20/08/2025 11:50, Dariusz Sosnowski:
> There were 2 changes introduced in checkpatch.pl script [1][2]
> which verify if Reported-by tag is followed by Link or Closes tag.
> Example of the warning output:
> 
>     WARNING:BAD_REPORTED_BY_LINK:
>       Reported-by: should be immediately followed by Closes:
>       with a URL to the report
> 
> Original purpose is to link the patch to the mailing list discussion
> and/or a bug report.
> 
> Since in DPDK these tags are not used, these warnings are false
> positives and can be ignored in devtools/checkpatches.sh.

We use "Reported-by", it gives credit to people doing this precious work.
But we don't mandate a link for this credit.

> [1]: https://github.com/torvalds/linux/commit/d7f1d71e5ef630ab9e15b5821d297a9e1a5fa1da
> [2]: https://github.com/torvalds/linux/commit/44c31888098a590b8ec5ba37009e5a983f7c4b46
> 
> Signed-off-by: Dariusz Sosnowski <dsosnowski@nvidia.com>
> ---
>  devtools/checkpatches.sh | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
> index 35037aa8f1..8c5b5d1380 100755
> --- a/devtools/checkpatches.sh
> +++ b/devtools/checkpatches.sh
> @@ -33,7 +33,7 @@ VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,STRLCPY,\
>  PREFER_KERNEL_TYPES,PREFER_FALLTHROUGH,BIT_MACRO,CONST_STRUCT,\
>  SPLIT_STRING,LONG_LINE_STRING,C99_COMMENT_TOLERANCE,\
>  LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
> -NEW_TYPEDEFS,COMPARISON_TO_NULL,AVOID_BUG,EXPORT_SYMBOL"
> +NEW_TYPEDEFS,COMPARISON_TO_NULL,AVOID_BUG,EXPORT_SYMBOL,BAD_REPORTED_BY_LINK"
>  options="$options $DPDK_CHECKPATCH_OPTIONS"




^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] devtools: ignore new warnings on reported-by tag
  2025-08-20 13:33 ` Thomas Monjalon
@ 2025-08-20 13:58   ` Dariusz Sosnowski
  0 siblings, 0 replies; 4+ messages in thread
From: Dariusz Sosnowski @ 2025-08-20 13:58 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev

On Wed, Aug 20, 2025 at 03:33:00PM +0200, Thomas Monjalon wrote:
> 20/08/2025 11:50, Dariusz Sosnowski:
> > There were 2 changes introduced in checkpatch.pl script [1][2]
> > which verify if Reported-by tag is followed by Link or Closes tag.
> > Example of the warning output:
> > 
> >     WARNING:BAD_REPORTED_BY_LINK:
> >       Reported-by: should be immediately followed by Closes:
> >       with a URL to the report
> > 
> > Original purpose is to link the patch to the mailing list discussion
> > and/or a bug report.
> > 
> > Since in DPDK these tags are not used, these warnings are false
> > positives and can be ignored in devtools/checkpatches.sh.
> 
> We use "Reported-by", it gives credit to people doing this precious work.
> But we don't mandate a link for this credit.

Sorry, maybe my commit message was misleading.
I was referring to Link and Closes tags in that last sentence.

The new check in checkpatch.pl will warn if there is no Link or Closes
tag assuming Reported-by is present.
It does not warn on Reported-by itself.

> /* snip */

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2025-08-20 14:00 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-08-20  9:50 [PATCH] devtools: ignore new warnings on reported-by tag Dariusz Sosnowski
2025-08-20 10:35 ` Bruce Richardson
2025-08-20 13:33 ` Thomas Monjalon
2025-08-20 13:58   ` Dariusz Sosnowski

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).