Skip to content

Commit 0e2b3d5

Browse files
rddunlapweiny2
authored andcommitted
nvdimm/dimm_devs: fix kernel-doc for function params
Adjust kernel-doc notation to prevent warnings when using -Wall. dimm_devs.c:59: warning: Function parameter or member 'ndd' not described in 'nvdimm_init_nsarea' dimm_devs.c:59: warning: Excess function parameter 'nvdimm' description in 'nvdimm_init_nsarea' dimm_devs.c:59: warning: No description found for return value of 'nvdimm_init_nsarea' dimm_devs.c:728: warning: No description found for return value of 'nd_pmem_max_contiguous_dpa' dimm_devs.c:773: warning: No description found for return value of 'nd_pmem_available_dpa' dimm_devs.c:844: warning: Function parameter or member 'ndd' not described in 'nvdimm_allocated_dpa' dimm_devs.c:844: warning: Excess function parameter 'nvdimm' description in 'nvdimm_allocated_dpa' dimm_devs.c:844: warning: No description found for return value of 'nvdimm_allocated_dpa' [iweiny: drop ND_CMD_* status code] Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Dan Williams <dan.j.williams@intel.com> Cc: Vishal Verma <vishal.l.verma@intel.com> Cc: Dave Jiang <dave.jiang@intel.com> Cc: Ira Weiny <ira.weiny@intel.com> Cc: <nvdimm@lists.linux.dev> Link: https://lore.kernel.org/r/20231207210545.24056-2-rdunlap@infradead.org Signed-off-by: Ira Weiny <ira.weiny@intel.com>
1 parent b192114 commit 0e2b3d5

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

drivers/nvdimm/dimm_devs.c

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@ static int validate_dimm(struct nvdimm_drvdata *ndd)
5353

5454
/**
5555
* nvdimm_init_nsarea - determine the geometry of a dimm's namespace area
56-
* @nvdimm: dimm to initialize
56+
* @ndd: dimm to initialize
57+
*
58+
* Returns: %0 if the area is already valid, -errno on error
5759
*/
5860
int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd)
5961
{
@@ -722,6 +724,9 @@ static unsigned long dpa_align(struct nd_region *nd_region)
722724
* contiguous unallocated dpa range.
723725
* @nd_region: constrain available space check to this reference region
724726
* @nd_mapping: container of dpa-resource-root + labels
727+
*
728+
* Returns: %0 if there is an alignment error, otherwise the max
729+
* unallocated dpa range
725730
*/
726731
resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region,
727732
struct nd_mapping *nd_mapping)
@@ -767,6 +772,8 @@ resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region,
767772
*
768773
* Validate that a PMEM label, if present, aligns with the start of an
769774
* interleave set.
775+
*
776+
* Returns: %0 if there is an alignment error, otherwise the unallocated dpa
770777
*/
771778
resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
772779
struct nd_mapping *nd_mapping)
@@ -836,8 +843,10 @@ struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
836843

837844
/**
838845
* nvdimm_allocated_dpa - sum up the dpa currently allocated to this label_id
839-
* @nvdimm: container of dpa-resource-root + labels
846+
* @ndd: container of dpa-resource-root + labels
840847
* @label_id: dpa resource name of the form pmem-<human readable uuid>
848+
*
849+
* Returns: sum of the dpa allocated to the label_id
841850
*/
842851
resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
843852
struct nd_label_id *label_id)

0 commit comments

Comments
 (0)