From patchwork Thu Jul 13 03:08:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 119491 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:a6b2:0:b0:3e4:2afc:c1 with SMTP id c18csp1561242vqm; Wed, 12 Jul 2023 20:18:50 -0700 (PDT) X-Google-Smtp-Source: APBJJlFyRcv18r3iuW72R7cSvNIzX4My5lt4dMf36bxKmBBRuyclb2m1GqIOXWV7KNITjAiBDT7t X-Received: by 2002:a17:906:315a:b0:982:be38:a5df with SMTP id e26-20020a170906315a00b00982be38a5dfmr180100eje.63.1689218330483; Wed, 12 Jul 2023 20:18:50 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1689218330; cv=none; d=google.com; s=arc-20160816; b=r0NTyKqmvTzqzr//PsHsHaKUJKKxx0N2VoFvpfsXVJ9FzokqACCW5OZciY2AlACxrY Dh6pOm1wO2B9XmAbhfr47o8YsKUpf3lCjtEO3koWS6BcQbB0dHZ9i10p1Ttf5Pcoy136 RYG0jU+Mfik/jfDUfnYchhvicbcs6iXk/qz4sVOT7rNmmol7IOL+SIgeA9jbCamo0hrS NpgEsROdjLKD4D2Q1oKCgzrpNrrn+c+KQ6b6JnmU0JhLdJ/CTGqCcIaVU3/C15Ct1Znp nEjNO4OhtLT9Zi4QGoTajANU0XM1Q1gM4IxG6qpe0YdJPG5QOMyJ+LSAmrCPG5f6yM52 zcgw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=Y0sPLF5aVYVsJG2qcCZTDi+Jbzew9ykSv/hCoWV/WPI=; fh=ng8LCVjACgPsH/xdC6mWEYP3VwTLfZuWROrI7j1+imc=; b=gFWoiZW2fbs+2gcpRIt+CsMsyyIYO5IAW0vw6dvX6bg7i3Twrf1nF4SQgD148KjIvl EVlrDyFctkUxgwFClA6hNc6TSqVIONhviAfLmr2m0bNbBDOC9+P0LGWTHFZ9ean00+ZK XssDYIr5+NRbrFEwvNxrKTXoqIjlazwz0oLN6Yh9BrzwTBCmeAkY2JFR+51pmvBkgvlx PjPBBXCJ7+tFC2nQmsmb+T1SP+NvBeWrOXhWrooWp0lKa4vzN3ctDkZpfeiEX4frNXES o4j/GhsOzBVD0IiPns9dmU17eOfRJNi9ghYXDVQAidjt5fJyyFQZoc5a36IS4cR9pvrB O11A== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Gm1FOHM5; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id u19-20020a170906c41300b00987603d77c0si6783197ejz.508.2023.07.12.20.18.25; Wed, 12 Jul 2023 20:18:50 -0700 (PDT) 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; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Gm1FOHM5; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232731AbjGMDIh (ORCPT + 99 others); Wed, 12 Jul 2023 23:08:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37910 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230054AbjGMDIf (ORCPT ); Wed, 12 Jul 2023 23:08:35 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 782AF1BD4 for ; Wed, 12 Jul 2023 20:08:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=Y0sPLF5aVYVsJG2qcCZTDi+Jbzew9ykSv/hCoWV/WPI=; b=Gm1FOHM5A2OQWxfTBx2xtCY7qI rjgMpmJoRuRum6A+zb94Ptr/ljjUJS9qnjiWJ8YSkrzZCUP5PqOunrOVnC+0P1M2ydKHfrLZ/YT6Q FEgjj04uz1l9DDJjPSpQ8M8f3VqU1NFqZcTc+32J5FgmdKXaeJ8DYm9K0+Wpx4ZmKX5rLF2qIF7d5 NV7tWx+fn3zvyUOEQP+9gWYNjEWod6o39TWaPKEsoRNep24zR5U+P5fZolfrh3lN1rM82MeyxYFaJ I5euXRrsLYNGp+PXidAkRQf79LTs8EFobwilxODF7pJJAJdk81NDqEe8fIcTzOVVHv1+34bm3g39/ KAod/dVA==; Received: from [2601:1c2:980:9ec0::2764] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qJmgz-001nEP-2O; Thu, 13 Jul 2023 03:08:33 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org, Yury Norov , Andy Shevchenko , Rasmus Villemoes Cc: Randy Dunlap Subject: [PATCH] cpumask: eliminate kernel-doc warnings Date: Wed, 12 Jul 2023 20:08:32 -0700 Message-ID: <20230713030832.17900-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED, SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1771273800115933766 X-GMAIL-MSGID: 1771273800115933766 Update lib/cpumask.c and to fix all kernel-doc warnings: include/linux/cpumask.h:185: warning: Function parameter or member 'srcp1' not described in 'cpumask_first_and' include/linux/cpumask.h:185: warning: Function parameter or member 'srcp2' not described in 'cpumask_first_and' include/linux/cpumask.h:185: warning: Excess function parameter 'src1p' description in 'cpumask_first_and' include/linux/cpumask.h:185: warning: Excess function parameter 'src2p' description in 'cpumask_first_and' lib/cpumask.c:59: warning: Function parameter or member 'node' not described in 'alloc_cpumask_var_node' lib/cpumask.c:169: warning: Function parameter or member 'src1p' not described in 'cpumask_any_and_distribute' lib/cpumask.c:169: warning: Function parameter or member 'src2p' not described in 'cpumask_any_and_distribute' Fixes: 7b4967c53204 ("cpumask: Add alloc_cpumask_var_node()") Fixes: 839cad5fa54b ("cpumask: fix function description kernel-doc notation") Fixes: 93ba139ba819 ("cpumask: use find_first_and_bit()") Signed-off-by: Randy Dunlap Reviewed-by: Andy Shevchenko --- include/linux/cpumask.h | 8 ++++++-- lib/cpumask.c | 5 ++++- 2 files changed, 10 insertions(+), 3 deletions(-) diff -- a/lib/cpumask.c b/lib/cpumask.c --- a/lib/cpumask.c +++ b/lib/cpumask.c @@ -45,6 +45,7 @@ EXPORT_SYMBOL(cpumask_next_wrap); * alloc_cpumask_var_node - allocate a struct cpumask on a given node * @mask: pointer to cpumask_var_t where the cpumask is returned * @flags: GFP_ flags + * @node: memory node from which to allocate or %NUMA_NO_NODE * * Only defined when CONFIG_CPUMASK_OFFSTACK=y, otherwise is * a nop returning a constant 1 (in ) @@ -157,7 +158,9 @@ EXPORT_SYMBOL(cpumask_local_spread); static DEFINE_PER_CPU(int, distribute_cpu_mask_prev); /** - * cpumask_any_and_distribute - Return an arbitrary cpu within srcp1 & srcp2. + * cpumask_any_and_distribute - Return an arbitrary cpu within src1p & src2p. + * @src1p: first &cpumask for intersection + * @src2p: second &cpumask for intersection * * Iterated calls using the same srcp1 and srcp2 will be distributed within * their intersection. diff -- a/include/linux/cpumask.h b/include/linux/cpumask.h --- a/include/linux/cpumask.h +++ b/include/linux/cpumask.h @@ -175,8 +175,8 @@ static inline unsigned int cpumask_first /** * cpumask_first_and - return the first cpu from *srcp1 & *srcp2 - * @src1p: the first input - * @src2p: the second input + * @srcp1: the first input + * @srcp2: the second input * * Returns >= nr_cpu_ids if no cpus set in both. See also cpumask_next_and(). */ @@ -1197,6 +1197,10 @@ cpumap_print_bitmask_to_buf(char *buf, c /** * cpumap_print_list_to_buf - copies the cpumask into the buffer as * comma-separated list of cpus + * @buf: the buffer to copy into + * @mask: the cpumask to copy + * @off: in the string from which we are copying, we copy to @buf + * @count: the maximum number of bytes to print * * Everything is same with the above cpumap_print_bitmask_to_buf() * except the print format.