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 2B855C433FE for ; Tue, 5 Oct 2021 20:48:30 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 059C561207 for ; Tue, 5 Oct 2021 20:48:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236306AbhJEUuT (ORCPT ); Tue, 5 Oct 2021 16:50:19 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50122 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230019AbhJEUuS (ORCPT ); Tue, 5 Oct 2021 16:50:18 -0400 Received: from mail-io1-xd32.google.com (mail-io1-xd32.google.com [IPv6:2607:f8b0:4864:20::d32]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 65DD3C06174E for ; Tue, 5 Oct 2021 13:48:27 -0700 (PDT) Received: by mail-io1-xd32.google.com with SMTP id d18so422420iof.13 for ; Tue, 05 Oct 2021 13:48:27 -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=4JAounyxlXF7n2WVwFJo6n+C9+UfzRHnpBIfBKV5LNQ=; b=GJu7JAovro16Z37tagMQT4k19hLAf9ALlk4rf370ABKVo/d1DlVQsvzTliIRa/HUO9 xqz3AOmca6ryT6L9IevxPcnJCononpXMEDOxrlJ297J7J1MHiCQJOdKFpCKQDiTRqGWg 0E6RFK7cEtDdu2Z7Deju22n2oaTDSSU1MgA2oTWN6kcVa5+fTKeBkno0GnVPocOJS9qf fgM3kOhhcAT22Zi6zylifn6MYk/ufCEzlJJsJpONdWCuPAFImkt8Hfo+7Fyv0MYD+/OC T9YWQfNQsxrtSWp/+Dpt2uQA1ehuFT1J39buPJJPvilKxFsICOWo7n5NQ6IWPB1OQAEY Akvg== 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=4JAounyxlXF7n2WVwFJo6n+C9+UfzRHnpBIfBKV5LNQ=; b=FmnMkf7wyjX+wbvqbGbxJ5yMIPSqwhSaWVkFkFN53O4Y2aB9MX7ZreQ87sWYQcEhLu 72nacYg/pAfBqE5gzKOP1c7YQ7ixCZ9MzT9imKqQ4Pq9bK9RpT/9kxVfXbEw8X1Is1Kv c+UcAXIt3HUTxA8TdSxAg7mSmx9oZrZgCmPfFnE6Cg5o65XCmURzWmtwbQMvMD+0xXIG 9a6YPQJv2RNW900EkOhz8EhB8y9U+A3yeP+jAftVyI2F5lSbi5mNfjxyndcKWBVVDxwL 2/Yt1a01luXDycTK8dEHlc9/gca5Dlh/ymRScrBguDgTuJiA2ehBVZGsgBdy8nc1le+i 75Cw== X-Gm-Message-State: AOAM533kZVJ0IlWtMqeyNr0y0AoKB8zHFQdZTnvQm7pmGOmr55pWWxE/ AC3bRNqFG2zoadEpxIy34mNj51I2os+8xC1ShV+SYg== X-Google-Smtp-Source: ABdhPJwCJj5+yH7sLM+lpGrG9xVHf2JmvfdPa43mLgOen5lmNeZgLXbdjZ6QUDpA3X1+uEkmVCVN3XQEtCuigHeNbe4= X-Received: by 2002:a6b:f805:: with SMTP id o5mr3783415ioh.131.1633466906627; Tue, 05 Oct 2021 13:48:26 -0700 (PDT) MIME-Version: 1.0 References: <20211005053019.26284-1-rdunlap@infradead.org> <70b0b0c4-47d0-7bb3-3bdd-688a91074bfb@infradead.org> In-Reply-To: <70b0b0c4-47d0-7bb3-3bdd-688a91074bfb@infradead.org> From: Daniel Latypov Date: Tue, 5 Oct 2021 13:48:15 -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 Tue, Oct 5, 2021 at 11:54 AM Randy Dunlap wrote: > > On 10/5/21 9:21 AM, Daniel Latypov wrote: > > 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. > > > > Sure, go ahead with it, please. https://lore.kernel.org/linux-kselftest/20211005204632.3132652-1-dlatypov@google.com Ran `make htmldocs` and I don't see any references to kunit in the stdout or stderr, so I assume we're good now. > > -- > ~Randy