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 mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 83FB5C433EF for ; Tue, 5 Oct 2021 16:21:23 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 67B5C6137C for ; Tue, 5 Oct 2021 16:21:23 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235600AbhJEQXM (ORCPT ); Tue, 5 Oct 2021 12:23:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44240 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236227AbhJEQXL (ORCPT ); Tue, 5 Oct 2021 12:23:11 -0400 Received: from mail-il1-x131.google.com (mail-il1-x131.google.com [IPv6:2607:f8b0:4864:20::131]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9D441C061749 for ; Tue, 5 Oct 2021 09:21:20 -0700 (PDT) Received: by mail-il1-x131.google.com with SMTP id y17so14116328ilb.9 for ; Tue, 05 Oct 2021 09:21:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=bsPMAPw99iWd0WhV63c7spsKiJkbce1Wl9V5bVSV9pg=; b=spnTz/2AVm9ssDQTJRW4Zj0xMkfyc4oc4QYOcMnAfAf/K2+P+mOa868KMUc143wSAk FqDLdioJSXFbCbpPScDOZEBjcsQPlMz9HC5rMYQWAQKhDqE1CI9U9h0OEJxE1DlTemKD u2UupU3hBe96JEChCHLg61acTr5z9NWtfv+N0/p4rlUrTYwg88PfQP0z651JzaePaKkE G5IY5HpE67Y+OzHEti9VII1jaWlsg7K7Iqk0eV5O9+Ekjg+cpGzy9irVTeaPpxEweFJw NIlrOmdKUXev6er/IUAWJYPAlQwnTTs9jwpSKOc2iyaIigKs1vExz8Y/IyL7/PddW3jS /5wA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=bsPMAPw99iWd0WhV63c7spsKiJkbce1Wl9V5bVSV9pg=; b=l119QK38w+YnF6TpwhpyErVbkigQ7bvUa6KBDA4OZNq+iL3nw2QWbbzNTj25uS7UEd LtVl7bx3ulH1MhoGMvfKkLmky+4Zovw1gG/j4s91tCinA7KK9bhgl6Vps2vyiDB3c+XI PSAzM7UKaohEkqVnAD3ztzj1KGTCaKmFfRg5e5S7trRqGtqTh1tlURpPOtHqYceVeWag DnDkIIMx8tdstFNiGD1jXem1e6l92tPhCPBqWqys/wU8eucWolcVDNSatIBeJyaV6JLU YV0LM4VHHqFNAd85e3eGB0yDKSCxqfn1fez8KgLtZvWebAJzpvmAeZkN5tPvhPhXit0U iTfg== X-Gm-Message-State: AOAM533mLH4NCrdTmT8HtyQLXI5FB2Bb7lVeeCey8po7FCFhfusIjP4x YHHlzY62+tVcmYExbPpbNbBhdKy/KM8mN62rxJW/XQ== X-Google-Smtp-Source: ABdhPJxjnIt9fxcA7gsYZJBGPC7mrhjXzYlWAlc8dHZJsqIJ9d8TEQJ9LJ7pZryrjritrPfKbbUCiFfe10v/G+AmnSw= X-Received: by 2002:a05:6e02:12e6:: with SMTP id l6mr3648443iln.293.1633450879811; Tue, 05 Oct 2021 09:21:19 -0700 (PDT) MIME-Version: 1.0 References: <20211005053019.26284-1-rdunlap@infradead.org> In-Reply-To: <20211005053019.26284-1-rdunlap@infradead.org> From: Daniel Latypov Date: Tue, 5 Oct 2021 09:21:08 -0700 Message-ID: Subject: Re: [PATCH] kunit: fix kernel-doc warnings in doc. build To: Randy Dunlap Cc: linux-kernel@vger.kernel.org, Brendan Higgins , linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, Shuah Khan Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Mon, Oct 4, 2021 at 10:30 PM Randy Dunlap wrote: > > Fix documentation build warnings in : > > ../include/kunit/test.h:616: warning: Function parameter or member 'flags' not described in 'kunit_kmalloc_array' > ../include/kunit/test.h:616: warning: Excess function parameter 'gfp' description in 'kunit_kmalloc_array' > ../include/kunit/test.h:661: warning: Function parameter or member 'flags' not described in 'kunit_kcalloc' > ../include/kunit/test.h:661: warning: Excess function parameter 'gfp' description in 'kunit_kcalloc' > > Fixes: 0a756853586c ("kunit: test: add test resource management API") > Fixes: 7122debb4367 ("kunit: introduce kunit_kmalloc_array/kunit_kcalloc() helpers") > Signed-off-by: Randy Dunlap > Cc: Brendan Higgins > Cc: linux-kselftest@vger.kernel.org > Cc: kunit-dev@googlegroups.com > Cc: Daniel Latypov > Cc: Shuah Khan > --- > include/kunit/test.h | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > --- lnx-515-rc4.orig/include/kunit/test.h > +++ lnx-515-rc4/include/kunit/test.h > @@ -607,7 +607,7 @@ void kunit_remove_resource(struct kunit > * @test: The test context object. > * @n: number of elements. > * @size: The size in bytes of the desired memory. > - * @gfp: flags passed to underlying kmalloc(). > + * @flags: gfp flags passed to underlying kmalloc(). Thanks for catching this. But can we instead rename the parameters? I can send out a patch for that if you'd prefer. The other funcs here use `gfp_t gfp`, which is why this copy-pasted comment does too. In test.c, kmalloc_array() actually calls the parameter `gfp` as well. > * > * Just like `kmalloc_array(...)`, except the allocation is managed by the test case > * and is automatically cleaned up after the test case concludes. See &struct > @@ -653,7 +653,7 @@ static inline void *kunit_kzalloc(struct > * @test: The test context object. > * @n: number of elements. > * @size: The size in bytes of the desired memory. > - * @gfp: flags passed to underlying kmalloc(). > + * @flags: gfp flags passed to underlying kmalloc(). > * > * See kcalloc() and kunit_kmalloc_array() for more information. > */