Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   "Fabio M. De Francesco" <fmdefrancesco@gmail.com>
To:     Ira Weiny <ira.weiny@intel.com>
Cc:     Jonathan Corbet <corbet@lwn.net>,
        Andrew Morton <akpm@linux-foundation.org>,
        SeongJae Park <sj@kernel.org>,
        Jiajian Ye <yejiajian2018@email.szu.edu.cn>,
        Thomas Gleixner <tglx@linutronix.de>,
        Matthew Wilcox <willy@infradead.org>,
        Peter Zijlstra <peterz@infradead.org>,
        outreachy@lists.linux.dev, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation/vm: Include kernel-doc from highmem-internal.h
Date:   Tue, 19 Apr 2022 00:05:07 +0200
Message-ID: <8118428.NyiUUSuA9g@leap>
In-Reply-To: <Yl3Z8Qll+zGo4v/D@iweiny-desk3>
References: <20220418081740.21001-1-fmdefrancesco@gmail.com> <Yl3Z8Qll+zGo4v/D@iweiny-desk3>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; charset="utf-8"
Precedence: bulk

On luned=C3=AC 18 aprile 2022 23:36:49 CEST Ira Weiny wrote:
> On Mon, Apr 18, 2022 at 10:17:40AM +0200, Fabio M. De Francesco wrote:
> > In Documentation/vm/highmem.rst the kernel-doc comments are missing,
> > therefore kunmap_local() and kunmap_atomic() are yet undocumented.
> >=20
> > Add a kernel-doc directive to include the above-mentioned kernel-doc
> > comments in highmem.rst.
> >=20
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Cc: Thomas Gleixner <tglx@linutronix.de>
> > Cc: Ira Weiny <ira.weiny@intel.com>
> > Cc: Matthew Wilcox <willy@infradead.org>
> > Cc: Peter Zijlstra <peterz@infradead.org>
> > Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
>=20
> I thought I saw a patch fly by which changed the comment of=20
kunmap_atomic() in
> include/linux/highmem-internal.h?  Did I miss that somewhere?

No, you're right. I had noticed just some minutes before reading your=20
review that a made a typo.

I wanted to write: "In Documentation/vm/highmem.rst some kernel-doc=20
comments are missing" instead for some unknown reason I wrote "the" in=20
place of "some" :(

I'll fix it ASAP.

> This is a good inclusion for now.  However, I think I would rather see=20
this as
> part of a new series which puts the bulk of the documentation with the=20
code as
> I proposed in patch 1/2 in your other series.

I have also read your review of the patch above. I agree with you that the=
=20
"how" should be placed in the kernel-doc comments in the code. And I also=20
agree that this patch should be part of a new version of a reorganized=20
series.

I'll start working on your suggestions by tomorrow morning (it's midnight=20
here in Italy).

> For this particular change:
>=20
> Reviewed-by: Ira Weiny <ira.weiny@intel.com>

Thank you so much for your review,

=46abio

> > ---
> >=20
> > This patch must be applied and built on top of=20
> > "[PATCH v3 2/2] Documentation/vm: Include kernel-doc to highmem.rst"
> > https://lore.kernel.org/lkml/20220415231917.25962-3-fmdefrancesco@gmail=
=2Ecom/
> >=20
> >  Documentation/vm/highmem.rst | 1 +
> >  1 file changed, 1 insertion(+)
> >=20
> > diff --git a/Documentation/vm/highmem.rst b/Documentation/vm/
highmem.rst
> > index 5dcee6233cd5..1a3e6a8f5d3e 100644
> > --- a/Documentation/vm/highmem.rst
> > +++ b/Documentation/vm/highmem.rst
> > @@ -161,3 +161,4 @@ Functions
> >  =3D=3D=3D=3D=3D=3D=3D=3D=3D
> > =20
> >  .. kernel-doc:: include/linux/highmem.h
> > +.. kernel-doc:: include/linux/highmem-internal.h
> > --=20
> > 2.34.1
> >=20
>=20