diff mbox series

Documentation: submitting-patches: Disqualify style fixes from Fixes: tag

Message ID 20230316082034.14191-1-bagasdotme@gmail.com
State New
Headers
Series Documentation: submitting-patches: Disqualify style fixes from Fixes: tag |

Commit Message

Bagas Sanjaya March 16, 2023, 8:20 a.m. UTC 
  An interpretation of submitting-patches.rst regarding Fixes: tag
interprets that the tag can be attributed to all kinds of issues
(including coding style ones). However, from the discussion on Outreachy
mailing list [1], Greg noted that the tag should not be meant for
patches that fix coding style issues.

Clarify the position on the doc.

Link: https://lore.kernel.org/outreachy/ZBFPnZbvdI46Ah6r@kroah.com/ [1]
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/process/submitting-patches.rst | 3 +++
 1 file changed, 3 insertions(+)


base-commit: 6015b1aca1a233379625385feb01dd014aca60b5

Comments

Krzysztof Kozlowski March 16, 2023, 8:23 a.m. UTC | #1 
On 16/03/2023 09:20, Bagas Sanjaya wrote:
> An interpretation of submitting-patches.rst regarding Fixes: tag
> interprets that the tag can be attributed to all kinds of issues
> (including coding style ones). However, from the discussion on Outreachy
> mailing list [1], Greg noted that the tag should not be meant for
> patches that fix coding style issues.
> 
> Clarify the position on the doc.
> 
> Link: https://lore.kernel.org/outreachy/ZBFPnZbvdI46Ah6r@kroah.com/ [1]
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/process/submitting-patches.rst | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
> index 69ce64e03c70f8..564418e42ffc01 100644
> --- a/Documentation/process/submitting-patches.rst
> +++ b/Documentation/process/submitting-patches.rst
> @@ -568,6 +568,9 @@ process nor the requirement to Cc: stable@vger.kernel.org on all stable
>  patch candidates. For more information, please read
>  Documentation/process/stable-kernel-rules.rst.
>  
> +Note: Fixes: tag is appropriate only for real issues (e.g. reported bugs
> +or compiler warnings). Coding style fixes should not bear this tag.

I think it is pretty clear already. The doc says:
"If your patch fixes a bug in a specific commit,"

and you are now repeating this.

Coding style is not a bug, but that's obvious.

Best regards,
Krzysztof
Theodore Ts'o March 16, 2023, 2:55 p.m. UTC | #2 
On Thu, Mar 16, 2023 at 09:26:21AM +0100, Greg KH wrote:
> > Coding style is not a bug, but that's obvious.
> 
> I agree, let's not make this file even longer than it is if at all
> possible.
>

I've actually been wondering if there is some way to split the file
since it's quite large already.  It's been unclear to me whether that
would make it easier or harder to find stuff though.  :-/

      	      	     	       	  - Ted
Jonathan Corbet March 16, 2023, 3:01 p.m. UTC | #3 
"Theodore Ts'o" <tytso@mit.edu> writes:

> On Thu, Mar 16, 2023 at 09:26:21AM +0100, Greg KH wrote:
>> > Coding style is not a bug, but that's obvious.
>> 
>> I agree, let's not make this file even longer than it is if at all
>> possible.
>>
>
> I've actually been wondering if there is some way to split the file
> since it's quite large already.  It's been unclear to me whether that
> would make it easier or harder to find stuff though.  :-/

I made a pass over it a few years ago and managed to shorten it a fair
amount, but it clearly still needs attention.  This is one of our most
important and heavily referenced documents, and it would be nice if
newcomers didn't feel like they were being asked to read a version of
War and Peace written by Kafka before they can contribute.

I'll try to find time to think about this some.

jon
Bagas Sanjaya March 17, 2023, 7:53 a.m. UTC | #4 
On 3/16/23 15:23, Krzysztof Kozlowski wrote:
> I think it is pretty clear already. The doc says:
> "If your patch fixes a bug in a specific commit,"
> 

Oops, I don't see the whole file before writing this patch.
Thanks anyway!
diff mbox series

Patch

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 69ce64e03c70f8..564418e42ffc01 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -568,6 +568,9 @@  process nor the requirement to Cc: stable@vger.kernel.org on all stable
 patch candidates. For more information, please read
 Documentation/process/stable-kernel-rules.rst.
 
+Note: Fixes: tag is appropriate only for real issues (e.g. reported bugs
+or compiler warnings). Coding style fixes should not bear this tag.
+
 .. _the_canonical_patch_format:
 
 The canonical patch format