linux-kernel - Re: Patch formatting

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] [day] [month] [year] [list]

Message-ID: <20210816072213.GA13349@1wt.eu>
Date:   Mon, 16 Aug 2021 09:22:13 +0200
From:   Willy Tarreau <w@....eu>
To:     John Paul Adrian Glaubitz <glaubitz@...sik.fu-berlin.de>
Cc:     zhao xc <xinchao.zhao.kernelz@...il.com>, ysato@...rs.osdn.me,
        dalias@...c.org, linux-sh@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: Patch formatting - Re:

On Mon, Aug 16, 2021 at 09:04:57AM +0200, John Paul Adrian Glaubitz wrote:
> Hi Zhao!
> 
> Thanks for your patch!
> 
> However, the patch has not been properly formatted and needs to be resend.
> 
> Could you follow this guide [1] and send your patch again in the correct
> format?

Adrian, it would be nice to give some hints about what has to be fixed,
because it's not necessarily easy to be able to figure this by comparing
one's patch to an example in a blog article.

Zhao, some hints:
  - the subject line doesn't make it obvious what subsystem is being touched.
    Often running "git log" on the file(s) you change can help you figure what
    others commonly use ;

  - the commit message is empty, it should carry a description of what you
    are trying to improve or fix, and when relevant, some indications about
    how you decided to address that. A good hint is to think that you're
    trying to "sell" your patch to someone else who will become responsible
    for maintaining it, thus put all the selling arguments there :-)

  - often a Cc list is desired if it touches areas that may impact others,
    as well as their maintainers ;

  - using git-send-email like in the article is generally preferred as it
    makes the process smoother on the receiver's end. It can look scary
    at first, making you fear to accidentally send poorly formatted
    e-mails, but in practice it's rare, and recipients are used to seeing
    this and are very tolerant to this :-)

And yes, reading Nick's article is definitely a good idea!

> Thanks,
> Adrian

Regards,
Willy