From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id C9E55C433F5 for ; Mon, 18 Apr 2022 22:05:17 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230496AbiDRWHz (ORCPT ); Mon, 18 Apr 2022 18:07:55 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58130 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230413AbiDRWHw (ORCPT ); Mon, 18 Apr 2022 18:07:52 -0400 Received: from mail-ed1-x52a.google.com (mail-ed1-x52a.google.com [IPv6:2a00:1450:4864:20::52a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3586CE03C; Mon, 18 Apr 2022 15:05:12 -0700 (PDT) Received: by mail-ed1-x52a.google.com with SMTP id 11so13957927edw.0; Mon, 18 Apr 2022 15:05:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=qvyMTbp6qzFtYs01g3/WRgGGqHIALLjUx9LyH/RZFQw=; b=jt8J3wmF1cufjRi2NhOBWl2z41tnRDI/8d1DDhxwtqFY2aY7Z+c5naIyB66DARgQm5 OFWtN+Xanr8XKb9dBpX2mgE4orYXWKjQzPBHuKUYaVMSKbOEvFA0TqL106mQ1FC8ilPp jM0EW/UHmX8BdKPibC4iZFlGLDwEF/YqCs7ISQf8q5IP3g/7axKLNFlhVerJMf30Sqrp mWYO+5LhENR7b9PIo3mAh1BUMZzpCDdYQIhQj2keM+EUlxYya9kDruL48q1EZ6G8ZbzZ 9+76fZGTMVEai3DOWgGkbWM+vMUrKE/gppTWtGCBVLmEe+JFT2cuynZ0NhXzX2/FvVSg 0UoQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=qvyMTbp6qzFtYs01g3/WRgGGqHIALLjUx9LyH/RZFQw=; b=fj8kQ9ekhz75rar+pWOBqWgOAWilTT9W1faVwqhUpL5Ud2Hl4qFNluhf13htJ5Fr1a 1GYM3GORoUIeGCcGe72PO1fcntKob0TRXMVGN0plX09qkwzLWXWYLgjcDV0vul1GSKG0 b2S9yh6vLbnMpm0CrnYwXWAGcFeyXESihUfYs6Jo629YIIQiutsHY+g6k6MAesj3zLWG sUjC40OnNu73zXkzougqSWvhpZrKh4r8GmH/2hZlSsJ2/djfSHSGm8PxsiWXPthFG5ha P3b6dzrcbMQH1DIucOo/EHJIyA5pS3o+iiFjPGl5NKcoEWrcpkVXuo3lyCJxd0aImvn5 PsUw== X-Gm-Message-State: AOAM533lD8p+oetSnmZSjsrE8ly8f9Esc5RFvVZYdtrjDO2CIn9OFaU6 POo1OH/HkSB+WZLqm/c3u6E= X-Google-Smtp-Source: ABdhPJyfCezo9Tr9RFzy90vhk2rAq++34sWEtmK4x+AGeOegyZ8ipPNU4litJv+L/weVN/9Oal7aUg== X-Received: by 2002:aa7:c946:0:b0:416:226f:f8a6 with SMTP id h6-20020aa7c946000000b00416226ff8a6mr14172729edt.360.1650319510489; Mon, 18 Apr 2022 15:05:10 -0700 (PDT) Received: from leap.localnet (host-79-50-86-254.retail.telecomitalia.it. [79.50.86.254]) by smtp.gmail.com with ESMTPSA id q19-20020a17090676d300b006e8ab621e6dsm5022698ejn.19.2022.04.18.15.05.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Apr 2022 15:05:09 -0700 (PDT) From: "Fabio M. De Francesco" To: Ira Weiny Cc: Jonathan Corbet , Andrew Morton , SeongJae Park , Jiajian Ye , Thomas Gleixner , Matthew Wilcox , Peter Zijlstra , 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: References: <20220418081740.21001-1-fmdefrancesco@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 > > Cc: Thomas Gleixner > > Cc: Ira Weiny > > Cc: Matthew Wilcox > > Cc: Peter Zijlstra > > Signed-off-by: Fabio M. De Francesco >=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 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