Re: [PATCH v2] mm/page_alloc: fix documentation error and remove magic numbers

[Andrew Morton]

On Wed, 24 Jun 2020 18:01:31 +0100 Matthew Wilcox <willy@xxxxxxxxxxxxx> wrote:

> On Wed, Jun 24, 2020 at 12:49:43PM -0400, Joel Savitz wrote:
> > When I increased the upper bound of the min_free_kbytes value in
> > ee8eb9a5fe863, I forgot to tweak the above comment to reflect
> > the new value. This patch fixes that mistake.
> > 
> > In addition, this patch replaces the magic number bounds with symbolic
> > constants to clarify the logic.
> > 
> > changes from v1:
> > - declare constants via enum instead of separate integers
> > 
> > Suggested-by: John Hubbard <jhubbard@xxxxxxxxxx>
> > Suggested-by: Vlastimil Babka <vbabka@xxxxxxx>
> > Signed-off-by: Joel Savitz <jsavitz@xxxxxxxxxx>
> 
> NAK.  Just fix the documentation.  It's bad form to combine two completely
> different things in one patch anyway.

I don't think the enums add value anyway - if these numbers are only
used in a single place, it's clearer to just open-code them.

One advantage of using a #define/enum for single-use constants is that
the #define/enum site provides a neat location for documenting
(commenting) the reasoning behind the particular values which were
chosen.  But this patch didn't do that.