Skip to content

Commit fd045e5

Browse files
rddunlapweiny2
authored andcommitted
nvdimm/namespace: fix kernel-doc for function params
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' [iweiny: s/-errno/ERR_PTR(-errno)/] Signed-off-by: Randy Dunlap <[email protected]> Cc: Dan Williams <[email protected]> Cc: Vishal Verma <[email protected]> Cc: Dave Jiang <[email protected]> Cc: Ira Weiny <[email protected]> Cc: <[email protected]> Reviewed-by: Ira Weiny <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Ira Weiny <[email protected]>
1 parent 0e2b3d5 commit fd045e5

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

drivers/nvdimm/namespace_devs.c

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ static int is_namespace_uuid_busy(struct device *dev, void *data)
7171
* nd_is_uuid_unique - verify that no other namespace has @uuid
7272
* @dev: any device on a nvdimm_bus
7373
* @uuid: uuid to check
74+
*
75+
* Returns: %true if the uuid is unique, %false if not
7476
*/
7577
bool nd_is_uuid_unique(struct device *dev, uuid_t *uuid)
7678
{
@@ -337,6 +339,8 @@ static int scan_free(struct nd_region *nd_region,
337339
* adjust_resource() the allocation to @n, but if @n is larger than the
338340
* allocation delete it and find the 'new' last allocation in the label
339341
* set.
342+
*
343+
* Returns: %0 on success on -errno on error
340344
*/
341345
static int shrink_dpa_allocation(struct nd_region *nd_region,
342346
struct nd_label_id *label_id, resource_size_t n)
@@ -662,6 +666,8 @@ void release_free_pmem(struct nvdimm_bus *nvdimm_bus,
662666
* allocations from the start of an interleave set and end at the first
663667
* BLK allocation or the end of the interleave set, whichever comes
664668
* first.
669+
*
670+
* Returns: %0 on success on -errno on error
665671
*/
666672
static int grow_dpa_allocation(struct nd_region *nd_region,
667673
struct nd_label_id *label_id, resource_size_t n)
@@ -951,6 +957,8 @@ static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
951957
* @dev: namespace type for generating label_id
952958
* @new_uuid: incoming uuid
953959
* @old_uuid: reference to the uuid storage location in the namespace object
960+
*
961+
* Returns: %0 on success on -errno on error
954962
*/
955963
static int namespace_update_uuid(struct nd_region *nd_region,
956964
struct device *dev, uuid_t *new_uuid,
@@ -1656,8 +1664,10 @@ static int select_pmem_id(struct nd_region *nd_region, const uuid_t *pmem_id)
16561664
/**
16571665
* create_namespace_pmem - validate interleave set labelling, retrieve label0
16581666
* @nd_region: region with mappings to validate
1659-
* @nspm: target namespace to create
1667+
* @nd_mapping: container of dpa-resource-root + labels
16601668
* @nd_label: target pmem namespace label to evaluate
1669+
*
1670+
* Returns: the created &struct device on success or ERR_PTR(-errno) on error
16611671
*/
16621672
static struct device *create_namespace_pmem(struct nd_region *nd_region,
16631673
struct nd_mapping *nd_mapping,

0 commit comments

Comments
 (0)