Commit 8373f8c6 authored Oct 01, 2019 by Andy Shevchenko Committed by Rafael J. Wysocki Oct 15, 2019

ACPI / utils: Describe function parameters in kernel-doc

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>
Reviewed-by: Mika Westerberg <mika.westerberg@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

parent 4f5cafb5

drivers/acpi/utils.c

+7 −0

Original line number	Diff line number	Diff line
		@@ -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

Admin message