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

From: libaokun (A)
Date: Tue Jun 15 2021 - 03:30:01 EST


Thank you for your advice.

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

Best Regards.


在 2021/6/9 21:12, Rafael J. Wysocki 写道:
On Tue, Jun 8, 2021 at 4:29 AM Baokun Li <libaokun1@xxxxxxxxxx> wrote:
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 <libaokun1@xxxxxxxxxx>
---
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

.