linux-kernel - Re: [PATCH] mm/vmscan: restore zone_reclaim

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]

Date:   Mon, 29 Jun 2020 17:53:02 +0200
From:   Daniel Wagner <dwagner@...e.de>
To:     Dave Hansen <dave.hansen@...el.com>
Cc:     Dave Hansen <dave.hansen@...ux.intel.com>,
        linux-kernel@...r.kernel.org, linux-mm@...ck.org,
        ben.widawsky@...el.com, alex.shi@...ux.alibaba.com,
        tobin@...nel.org, cl@...ux.com, akpm@...ux-foundation.org,
        stable@...nel.org
Subject: Re: [PATCH] mm/vmscan: restore zone_reclaim_mode ABI

On Mon, Jun 29, 2020 at 07:36:15AM -0700, Dave Hansen wrote:
> On 6/29/20 12:13 AM, Daniel Wagner wrote:
> > I went to go add a new RECLAIM_* mode for the zone_reclaim_mode
> > sysctl.
> 
> This conveys my motivation.

You don't need to tell a story. As explained in the documetation
'Describe your changes', describe your change in imperative mood,
e.g. something like

  "Add RECLAIM_* mode for the the zone_reclaim_mode sysctl."

> > Like a good kernel developer, I also went to go update the
> > documentation.
> 
> This takes the opportunity to throw a tiny bit of shade in the direction
> of the other folks who modified the #define without updating the
> documentation.

What about something simple as, "Update the documetation to
match the implementation" or whatever makes it clear why
you are touching the documetation bits.

Anyway, I just wanted to help you to write better commit
messages. I understand, my help is not welcome.