Skip to contentSkip to conversation

acpi/nvs: fix doc warnings in nvs.c

PATCH In review Baokun Li 2 participants 3 messages Jun 8, 2021 – Jun 15, 2021 ACPI

lore
Share & tools
lore

Baokun Li

author
#0 lore raw

PATCH 1/1 acpi/nvs: fix doc warnings in nvs.c

Fixes the following W=1 kernel build warning(s):

drivers/acpi/nvs.c:94: warning: Function parameter or
member 'start' not described in 'suspend_nvs_register'
drivers/acpi/nvs.c:94: warning: Function parameter or
member 'size' not described in 'suspend_nvs_register'

---
 drivers/acpi/nvs.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/acpi/nvs.c +2 -2
index 9f8712a557b3..4609a8a2e42d 100644
@@ -83,8 +83,8 @@ static LIST_HEAD(nvs_list);
 
 /**
  *	suspend_nvs_register - register platform NVS memory region to save
- *	@start - physical address of the region
- *	@size - size of the region
+ *	@start: physical address of the region
+ *	@size: size of the region
  *
  *	The NVS region need not be page-aligned (both ends) and we arrange
  *	things so that the data from page-aligned addresses in this region will
Signature · 1 line
2.31.1
#1 lore raw
Quoted 18 lines · Baokun Li

Fixes the following W=1 kernel build warning(s):

drivers/acpi/nvs.c:94: warning: Function parameter or
member 'start' not described in 'suspend_nvs_register'
drivers/acpi/nvs.c:94: warning: Function parameter or
member 'size' not described in 'suspend_nvs_register'

---
 drivers/acpi/nvs.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/acpi/nvs.c +0 -0
index 9f8712a557b3..4609a8a2e42d 100644

drivers/acpi/nvs.c static LIST_HEAD(nvs_list); · line 87

Quoted 7 lines
drivers/acpi/nvs.c +2 -2
@@ -83,8 +83,8 @@ static LIST_HEAD(nvs_list);
 
 /**
  *     suspend_nvs_register - register platform NVS memory region to save
- *     @start - physical address of the region
- *     @size - size of the region
+ *     @start: physical address of the region
+ *     @size: size of the region

The format of this kerneldoc comment is still not following the common style after your change.

Please fix it completely.

Quoted 6 lines
drivers/acpi/nvs.c +0 -1
  *
  *     The NVS region need not be page-aligned (both ends) and we arrange
  *     things so that the data from page-aligned addresses in this region will
--

2.31.1

#2 lore raw

Thank you for your advice.

I'm about to send a patch v2 with the changes suggested by you.

Best Regards.

Quoted 37 lines · Rafael J. Wysocki
Quoted 17 lines · Baokun Li

Fixes the following W=1 kernel build warning(s):

drivers/acpi/nvs.c:94: warning: Function parameter or
member 'start' not described in 'suspend_nvs_register'
drivers/acpi/nvs.c:94: warning: Function parameter or
member 'size' not described in 'suspend_nvs_register'

---
  drivers/acpi/nvs.c | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)
drivers/acpi/nvs.c +0 -0
index 9f8712a557b3..4609a8a2e42d 100644

drivers/acpi/nvs.c static LIST_HEAD(nvs_list); · line 87

Quoted 7 lines
drivers/acpi/nvs.c +2 -2
@@ -83,8 +83,8 @@ static LIST_HEAD(nvs_list);
 
  /**
   *     suspend_nvs_register - register platform NVS memory region to save
- *     @start - physical address of the region
- *     @size - size of the region
+ *     @start: physical address of the region
+ *     @size: size of the region

The format of this kerneldoc comment is still not following the common style after your change.

Please fix it completely.

Quoted 6 lines
drivers/acpi/nvs.c +0 -1
   *
   *     The NVS region need not be page-aligned (both ends) and we arrange
   *     things so that the data from page-aligned addresses in this region will
--

2.31.1

.