Skip to contentSkip to conversation

nvdimm: Fix some kernel-doc comments

PATCH New Yang Li 1 participant 2 messages Dec 6, 2022 libnvdimm: non-volatile memory device

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 nvdimm: Fix some kernel-doc comments

Make the description of @nvdimm to @ndd in nvdimm_init_nsarea() and nvdimm_allocated_dpa() to clear the below warnings:

drivers/nvdimm/dimm_devs.c:59: warning: Function parameter or member 'ndd' not described in 'nvdimm_init_nsarea' drivers/nvdimm/dimm_devs.c:59: warning: Excess function parameter 'nvdimm' description in 'nvdimm_init_nsarea' drivers/nvdimm/dimm_devs.c:841: warning: Function parameter or member 'ndd' not described in 'nvdimm_allocated_dpa' drivers/nvdimm/dimm_devs.c:841: warning: Excess function parameter 'nvdimm' description in 'nvdimm_allocated_dpa'

---
 drivers/nvdimm/dimm_devs.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/nvdimm/dimm_devs.c +2 -2
index 1fc081dcf631..17b56171c2c2 100644
@@ -53,7 +53,7 @@ static int validate_dimm(struct nvdimm_drvdata *ndd)
 
 /**
  * nvdimm_init_nsarea - determine the geometry of a dimm's namespace area
- * @nvdimm: dimm to initialize
+ * @ndd: dimm to initialize
  */
 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd)
 {
@@ -833,7 +833,7 @@ struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
 
 /**
  * nvdimm_allocated_dpa - sum up the dpa currently allocated to this label_id
- * @nvdimm: container of dpa-resource-root + labels
+ * @ndd: container of dpa-resource-root + labels
  * @label_id: dpa resource name of the form pmem-<human readable uuid>
  */
 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
Signature · 1 line
2.20.1.7.g153144c
author
#1 lore raw

PATCH 1/1 nvdimm: make security_show() static

This symbol is not used outside of dimm_devs.c, so marks it static to silence missing prototype warning

drivers/nvdimm/dimm_devs.c:352:9: warning: no previous prototype for function 'security_show'

---
 drivers/nvdimm/dimm_devs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/nvdimm/dimm_devs.c +1 -1
index 17b56171c2c2..71fef964c5bc 100644
@@ -349,7 +349,7 @@ static ssize_t available_slots_show(struct device *dev,
 }
 static DEVICE_ATTR_RO(available_slots);
 
-ssize_t security_show(struct device *dev,
+static ssize_t security_show(struct device *dev,
 		struct device_attribute *attr, char *buf)
 {
 	struct nvdimm *nvdimm = to_nvdimm(dev);
Signature · 1 line
2.20.1.7.g153144c