Thread (3 messages) 3 messages, 2 authors, 2021-06-15

Re: [PATCH -next] acpi/nvs: fix doc warnings in nvs.c

From: "Rafael J. Wysocki" <rafael@kernel.org>
Date: 2021-06-09 13:12:29
Also in: lkml

On Tue, Jun 8, 2021 at 4:29 AM Baokun Li [off-list ref] wrote:
quoted hunk ↗ jump to hunk
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'

Signed-off-by: Baokun Li <redacted>
---
 drivers/acpi/nvs.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/acpi/nvs.c b/drivers/acpi/nvs.c
index 9f8712a557b3..4609a8a2e42d 100644
--- a/drivers/acpi/nvs.c
+++ b/drivers/acpi/nvs.c
@@ -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.
  *
  *     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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help