From patchwork Thu Dec 7 21:05:45 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 175376 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:bcd1:0:b0:403:3b70:6f57 with SMTP id r17csp5063045vqy; Thu, 7 Dec 2023 13:06:17 -0800 (PST) X-Google-Smtp-Source: AGHT+IGw3HvvcLi10s4Duh3EwTd1/ycgwR7NVsTwu01x0GUnwSDcodmNZdMA5iudx+6idsrJSvWZ X-Received: by 2002:a05:6a00:4b4c:b0:6cd:e963:af1e with SMTP id kr12-20020a056a004b4c00b006cde963af1emr203341pfb.11.1701983177037; Thu, 07 Dec 2023 13:06:17 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1701983177; cv=none; d=google.com; s=arc-20160816; b=Ob/ivIf16fMcTem2SIwAJXIQBT3IblNU95l+cbnaKDL6ro7DRIFNp4VgPclEr2HO4z h52TIcnSaFEPoUZd30n5efRJOGRjjU+3hQdvaodD2Omhk51N6mkSwrfLzRXxyW+L/ubS sVoWcbR237GSpAJPS5ZqehVQlrc6lFqlhqqn+dRBfG/1iggJR2Y0yaSY4rOV5TtaehCt Sco6HljaJtacKKeyjBPiefN7X49SameA4P7uutf4e360tq3xng0+EW6eZE1Cw3PSsuRB L2baLEKtKgu15bXSCmuwdMdZu5ZFlQ06yPVwt+GL7DnC0+G9CfoZgjgt2RmPTrvZU0ta nt7w== 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 :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=hL5xjtU3PgLOkzLLg6qbcOrjWytwsj2hMsOpXV2FUmM=; fh=MVN8dvpG9w/7LcjxGbdfOtkYY9yQJWtf+RvN8rZi7cE=; b=c/j+DusLpyzjzRJgyadJOKBsfjASjpBKLhr9aE6b3ATSNRrAH7qy9YhB+LQdQ6+mJE B6UE9nDcjj5+KeLv7Tysu8trNRHRDUTRFGCunwITJFUZ+xw/T3W7ymW2TY+U32FLHApP hf+MzIbq+k7/1wvAk6ThVc7wHt51VFEwyyCN7AV84n+7VItPlTjHuveGDOHllVpyr9Rc SLtlqUJxUnsu88i6KloitZJ49PwgdCIuQXXekb1byR8qbAHF2lZkG1RNb7bRTM4vxVkp B3aqWRCcyWKLW2bGtTvaAnxp10U4lhiuvZEfBZe1dfMTU4YaPcsVHSZDgPKqnI2tApDs t6Yw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=0yeJZBhF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from morse.vger.email (morse.vger.email. [23.128.96.31]) by mx.google.com with ESMTPS id s13-20020a65690d000000b005c1cc53612dsi285460pgq.500.2023.12.07.13.06.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 07 Dec 2023 13:06:17 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) client-ip=23.128.96.31; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=0yeJZBhF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by morse.vger.email (Postfix) with ESMTP id 18388803EBBA; Thu, 7 Dec 2023 13:06:14 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at morse.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1443925AbjLGVF7 (ORCPT + 99 others); Thu, 7 Dec 2023 16:05:59 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41262 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1443935AbjLGVFp (ORCPT ); Thu, 7 Dec 2023 16:05:45 -0500 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 85757171A for ; Thu, 7 Dec 2023 13:05:48 -0800 (PST) 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:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=hL5xjtU3PgLOkzLLg6qbcOrjWytwsj2hMsOpXV2FUmM=; b=0yeJZBhFkG8ngQQvMfVExW/jp8 SeFkdvbr8W4FQ7BKuXRv0C7BcVS518cWcbaC7GwkLXIGo6LUcN84BAGzZVRiAvjfzd0DP/8B95vY3 1bkW1L2UddS8fVrYuRl0eH1QsYsJQOZGKm0Ne9CSNuIvO+KqWNIid/IfWy6y8dXS9ht9wXFuRvI06 lInAStxFQV/QRK8JEFQuivvfywPfAtSfHGUolM/cIxnhrgkBIeLvB4lNE/RDB/7nEt9QJBdFi84Iz 0GxI8e0gPw2WcrvV3yU+NBDTdE8oAfPp2ShyWwe0Q6VK/3C2hImatmEoQEdPcXhQbHhJMQZ0n87Vj y+9zlfQw==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rBLZ6-00Duw1-1E; Thu, 07 Dec 2023 21:05:48 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Dan Williams , Vishal Verma , Dave Jiang , Ira Weiny , nvdimm@lists.linux.dev Subject: [PATCH 3/3] nvdimm/namespace: fix kernel-doc for function params Date: Thu, 7 Dec 2023 13:05:45 -0800 Message-ID: <20231207210545.24056-3-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20231207210545.24056-1-rdunlap@infradead.org> References: <20231207210545.24056-1-rdunlap@infradead.org> MIME-Version: 1.0 X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on morse.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (morse.vger.email [0.0.0.0]); Thu, 07 Dec 2023 13:06:14 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1784658711825063144 X-GMAIL-MSGID: 1784658711825063144 Adjust kernel-doc notation to prevent warnings when using -Wall. namespace_devs.c:76: warning: No description found for return value of 'nd_is_uuid_unique' namespace_devs.c:343: warning: No description found for return value of 'shrink_dpa_allocation' namespace_devs.c:668: warning: No description found for return value of 'grow_dpa_allocation' namespace_devs.c:958: warning: No description found for return value of 'namespace_update_uuid' namespace_devs.c:1665: warning: Function parameter or member 'nd_mapping' not described in 'create_namespace_pmem' namespace_devs.c:1665: warning: Excess function parameter 'nspm' description in 'create_namespace_pmem' namespace_devs.c:1665: warning: No description found for return value of 'create_namespace_pmem' Signed-off-by: Randy Dunlap Cc: Dan Williams Cc: Vishal Verma Cc: Dave Jiang Cc: Ira Weiny Cc: nvdimm@lists.linux.dev Reviewed-by: Ira Weiny --- drivers/nvdimm/namespace_devs.c | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff -- a/drivers/nvdimm/namespace_devs.c b/drivers/nvdimm/namespace_devs.c --- a/drivers/nvdimm/namespace_devs.c +++ b/drivers/nvdimm/namespace_devs.c @@ -71,6 +71,8 @@ static int is_namespace_uuid_busy(struct * nd_is_uuid_unique - verify that no other namespace has @uuid * @dev: any device on a nvdimm_bus * @uuid: uuid to check + * + * Returns: %true if the uuid is unique, %false if not */ bool nd_is_uuid_unique(struct device *dev, uuid_t *uuid) { @@ -337,6 +339,8 @@ static int scan_free(struct nd_region *n * adjust_resource() the allocation to @n, but if @n is larger than the * allocation delete it and find the 'new' last allocation in the label * set. + * + * Returns: %0 on success on -errno on error */ static int shrink_dpa_allocation(struct nd_region *nd_region, struct nd_label_id *label_id, resource_size_t n) @@ -662,6 +666,8 @@ void release_free_pmem(struct nvdimm_bus * allocations from the start of an interleave set and end at the first * BLK allocation or the end of the interleave set, whichever comes * first. + * + * Returns: %0 on success on -errno on error */ static int grow_dpa_allocation(struct nd_region *nd_region, struct nd_label_id *label_id, resource_size_t n) @@ -951,6 +957,8 @@ static ssize_t uuid_show(struct device * * @dev: namespace type for generating label_id * @new_uuid: incoming uuid * @old_uuid: reference to the uuid storage location in the namespace object + * + * Returns: %0 on success on -errno on error */ static int namespace_update_uuid(struct nd_region *nd_region, struct device *dev, uuid_t *new_uuid, @@ -1656,8 +1664,10 @@ static int select_pmem_id(struct nd_regi /** * create_namespace_pmem - validate interleave set labelling, retrieve label0 * @nd_region: region with mappings to validate - * @nspm: target namespace to create + * @nd_mapping: container of dpa-resource-root + labels * @nd_label: target pmem namespace label to evaluate + * + * Returns: the created &struct device on success or -errno on error */ static struct device *create_namespace_pmem(struct nd_region *nd_region, struct nd_mapping *nd_mapping,