Re: [PATCH] mm: add comments on pglist_data zones

[Matthew Wilcox <willy@infradead.org>]

On Wed, May 20, 2020 at 09:53:00PM -0700, Ben Widawsky wrote:
> On 20-05-20 16:22:35, Matthew Wilcox wrote:
> > On Wed, May 20, 2020 at 01:54:43PM -0700, Ben Widawsky wrote:
> > > While making other modifications it was easy to confuse the two struct
> > > members node_zones and node_zonelists. For those already familiar with
> > > the code, this might seem to be a silly patch, but it's quite helpful to
> > > disambiguate the similar-sounding fields
> > > 
> > > While here, add a small comment on why nr_zones isn't simply MAX_NR_ZONES
> > 
> > It seems like a real shame to write all this excellent documentation
> > and not format it as kernel-doc.
> 
> I admit, I didn't look at all the kernel-doc files. Is there precedent there for
> documenting struct members like this? I'd be more than happy to try to document
> everything I've dug up in coming up to speed here. 
> 
> I've used the docs from Mel quite a bit and would very much like to pay it
> forward, as it were.

I appreciate your willingness!  Fortunately, we have excellent
documentation on adding more documentation ;-)

Documentation/doc-guide/kernel-doc.rst is where you'll want to start.
'Structure, union, and enumeration documentation' is the section.
Do read through the whole section before jumping in because you might
find it more clear to use the style in 'In-line member documentation
comments' rather than the style documented first.