linux-acpi.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v1 1/5] ACPI / utils: Describe function parameters in kernel-doc
@ 2019-09-24 12:01 Andy Shevchenko
  2019-09-24 12:01 ` [PATCH v1 2/5] ACPI / utils: Introduce acpi_dev_hid_uid_match() helper Andy Shevchenko
                   ` (3 more replies)
  0 siblings, 4 replies; 10+ messages in thread
From: Andy Shevchenko @ 2019-09-24 12:01 UTC (permalink / raw)
  To: Joerg Roedel, iommu, Adrian Hunter, Ulf Hansson, linux-mmc,
	Rafael J. Wysocki, linux-acpi
  Cc: Andy Shevchenko

Kernel documentation script complains that some of the function parameters
are not described:

drivers/acpi/utils.c:462: warning: Function parameter or member 'handle' not described in 'acpi_handle_path'
drivers/acpi/utils.c:484: warning: Function parameter or member 'level' not described in 'acpi_handle_printk'
drivers/acpi/utils.c:484: warning: Function parameter or member 'handle' not described in 'acpi_handle_printk'
drivers/acpi/utils.c:484: warning: Function parameter or member 'fmt' not described in 'acpi_handle_printk'
drivers/acpi/utils.c:513: warning: Function parameter or member 'descriptor' not described in '__acpi_handle_debug'
drivers/acpi/utils.c:513: warning: Function parameter or member 'handle' not described in '__acpi_handle_debug'
drivers/acpi/utils.c:513: warning: Function parameter or member 'fmt' not described in '__acpi_handle_debug'

Describe function parameters where it's appropriate.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 drivers/acpi/utils.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/drivers/acpi/utils.c b/drivers/acpi/utils.c
index e3974a8f8fd4..dbd1c4cfd7d1 100644
--- a/drivers/acpi/utils.c
+++ b/drivers/acpi/utils.c
@@ -455,6 +455,7 @@ EXPORT_SYMBOL(acpi_evaluate_ost);
 
 /**
  * acpi_handle_path: Return the object path of handle
+ * @handle: ACPI device handle
  *
  * Caller must free the returned buffer
  */
@@ -473,6 +474,9 @@ static char *acpi_handle_path(acpi_handle handle)
 
 /**
  * acpi_handle_printk: Print message with ACPI prefix and object path
+ * @level: log level
+ * @handle: ACPI device handle
+ * @fmt: format string
  *
  * This function is called through acpi_handle_<level> macros and prints
  * a message with ACPI prefix and object path.  This function acquires
@@ -501,6 +505,9 @@ EXPORT_SYMBOL(acpi_handle_printk);
 #if defined(CONFIG_DYNAMIC_DEBUG)
 /**
  * __acpi_handle_debug: pr_debug with ACPI prefix and object path
+ * @descriptor: Dynamic Debug descriptor
+ * @handle: ACPI device handle
+ * @fmt: format string
  *
  * This function is called through acpi_handle_debug macro and debug
  * prints a message with ACPI prefix and object path. This function
-- 
2.23.0


^ permalink raw reply related	[flat|nested] 10+ messages in thread

end of thread, other threads:[~2019-09-24 17:34 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-09-24 12:01 [PATCH v1 1/5] ACPI / utils: Describe function parameters in kernel-doc Andy Shevchenko
2019-09-24 12:01 ` [PATCH v1 2/5] ACPI / utils: Introduce acpi_dev_hid_uid_match() helper Andy Shevchenko
2019-09-24 17:24   ` kbuild test robot
2019-09-24 17:24   ` kbuild test robot
2019-09-24 12:01 ` [PATCH v1 3/5] ACPI / LPSS: Switch to use acpi_dev_hid_uid_match() Andy Shevchenko
2019-09-24 16:52   ` kbuild test robot
2019-09-24 12:01 ` [PATCH v1 4/5] mmc: sdhci-acpi: " Andy Shevchenko
2019-09-24 17:34   ` kbuild test robot
2019-09-24 12:01 ` [PATCH v1 5/5] iommu/amd: " Andy Shevchenko
2019-09-24 12:16   ` Andy Shevchenko

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).