linux-kernel - Re: [PATCH v3] staging: sm750: Rename sm750_hw_cursor_* functions to snake

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <6418ca43e651b_2c274e294ae@iweiny-mobl.notmuch>
Date:   Mon, 20 Mar 2023 14:04:03 -0700
From:   Ira Weiny <ira.weiny@...el.com>
To:     Dan Carpenter <error27@...il.com>,
        Kloudifold <cloudifold.3125@...il.com>
CC:     <outreachy@...ts.linux.dev>, <teddy.wang@...iconmotion.com>,
        <sudipm.mukherjee@...il.com>, <gregkh@...uxfoundation.org>,
        <linux-staging@...ts.linux.dev>, <linux-kernel@...r.kernel.org>,
        <alison.schofield@...el.com>
Subject: Re: [PATCH v3] staging: sm750: Rename sm750_hw_cursor_* functions to
 snake_case

Dan Carpenter wrote:
> On Sat, Mar 18, 2023 at 09:35:49PM +0800, Kloudifold wrote:

[...]

> 
> > ---
> > Changes in v3:
> > - Add this changelog (Philipp)
> > - Move lkp tags and link to the correct location in commit log (Alison)
> > - Update the commit msg (Philip)
> > - Update the commit log (Bagas, Julia)
> > 
> > Changes in v2:
> > - Use new function names in call sites (LKP)
> > 
> > This v2 patch was prompted by an error reported by the Linux test
> > robot, which detected the compile error.
> > Reported-by: kernel test robot <lkp@...el.com>
> > Link: https://lore.kernel.org/oe-kbuild-all/202303110849.X24WnHnM-lkp@intel.com/
> > ---
> > ---
> 
> Delete these two --- lines.
> 

Yes the 2 --- lines are not needed but...

I'd like to clarify because I think some of the tools insert these
automatically.  I've included a bunch of examples below and the patches they
generate as examples.  Please follow along if you are not sure what I mean.

To summarize you should only insert 1 '---' line in your manually created
commit message.  Do not add one to the cover letter either.  Any other lines
which are created by the tools are fine.  Just leave them.

So for this example...

_This_ is _wrong_[1]

_This_ is _correct_[2]

The correct example [2] results in a patch like [3].

But notice how B4 has added my 'cover' into the single patch, patch?  And it
has a bunch of '---' lines?


Specifically:

<quote>
---
Nothing really to be said here.  This would be a cover letter if the
patch series had more than 1 patch in it...
---
Changes in v2:
        show version info example.
---
</quote>


This is because b4 defaults to using the cover letter as part of the single
patch background information.  When using b4 to send a single patch I leave my
cover letter blank.


So if you leave the b4 cover letter blank[4] you get a correctly formatted
patch as in [5].

But _please_ _note_ that there are still 3 '---' lines in the final patch
output.  2 of which are around the changes section.  The following quote is
perfectly fine.


<quote>
---
Changes in v2:
        show version info example.
---
</quote>

I hope this helps clarify because I'm worried that folks may be trying to edit
the emails that the tools are generating and I don't think that is required.

Ira



[1]
13:39:43 > git sh
commit b513858163640433f7938ff93848a5af1e675383 (HEAD -> b4/outreachy-demo)
Author: Ira Weiny <ira.weiny@...el.com>
Date:   Mon Mar 20 13:14:51 2023 -0700

    Documentation: Example staging doc change
    
    Update the documentation with an example showing how to update the
    documentation.
    
    Signed-off-by: Ira Weiny <ira.weiny@...el.com>
    
    ---
    Changes in v2:
            show version info example.
    ---

diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
index ded8254bc0d7..2de034ddd059 100644
--- a/Documentation/staging/index.rst
+++ b/Documentation/staging/index.rst
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
+Fixing staging documentation somehow.
+
 Unsorted Documentation
 ======================
 



[2]
13:41:03 > git sh
commit 352cbf83a2da890ba974c043ae6047a625210ea2 (HEAD -> b4/outreachy-demo)
Author: Ira Weiny <ira.weiny@...el.com>
Date:   Mon Mar 20 13:14:51 2023 -0700

    Documentation: Example staging doc change
    
    Update the documentation with an example showing how to update the
    documentation.
    
    Signed-off-by: Ira Weiny <ira.weiny@...el.com>
    ---
    Changes in v2:
            show version info example.

diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
index ded8254bc0d7..2de034ddd059 100644
--- a/Documentation/staging/index.rst
+++ b/Documentation/staging/index.rst
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
+Fixing staging documentation somehow.
+
 Unsorted Documentation
 ======================
 


[3]
<email headers>
...
Subject: [PATCH] Documentation: Example staging doc change
...
</email headers>

Update the documentation with an example showing how to update the
documentation.

Signed-off-by: Ira Weiny <ira.weiny@...el.com>
---
Nothing really to be said here.  This would be a cover letter if the
patch series had more than 1 patch in it...
---
Changes in v2:
        show version info example.
---
 Documentation/staging/index.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
index ded8254bc0d7..2de034ddd059 100644
--- a/Documentation/staging/index.rst
+++ b/Documentation/staging/index.rst
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
+Fixing staging documentation somehow.
+
 Unsorted Documentation
 ======================
 

---
base-commit: 38e04b3e4240a6d8fb43129ebad41608db64bc6f
change-id: 20230320-outreachy-demo-bfa128532a93

Best regards,
-- 
Ira Weiny <ira.weiny@...el.com>


[4]
Cover example

# Lines starting with # will be removed from the cover letter. You can
# use them to add notes or reminders to yourself. If you want to use
# markdown headers in your cover letter, start the line with ">#".

# You can add trailers to the cover letter. Any email addresses found in
# these trailers will be added to the addresses specified/generated
# during the b4 send stage. You can also run "b4 prep --auto-to-cc" to
# auto-populate the To: and Cc: trailers based on the code being
# modified.

To: Ira Weiny <ira.weiny@...el.com>
Signed-off-by: Ira Weiny <ira.weiny@...el.com>


[5]
<email headers>
...
Subject: [PATCH] Documentation: Example staging doc change
...
</email headers>

Update the documentation with an example showing how to update the
documentation.

Signed-off-by: Ira Weiny <ira.weiny@...el.com>
---
Changes in v2:
        show version info example.
---
 Documentation/staging/index.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
index ded8254bc0d7..2de034ddd059 100644
--- a/Documentation/staging/index.rst
+++ b/Documentation/staging/index.rst
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
+Fixing staging documentation somehow.
+
 Unsorted Documentation
 ======================
 

---
base-commit: 38e04b3e4240a6d8fb43129ebad41608db64bc6f
change-id: 20230320-outreachy-demo-bfa128532a93

Best regards,
-- 
Ira Weiny <ira.weiny@...el.com>