Linux-ACPI Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] acpi/osl: fix a W=1 kernel-doc warning
@ 2019-06-03 20:28 Qian Cai
  2019-06-13 20:29 ` Rafael J. Wysocki
  0 siblings, 1 reply; 2+ messages in thread
From: Qian Cai @ 2019-06-03 20:28 UTC (permalink / raw)
  To: rjw, lenb; +Cc: linux-acpi, linux-kernel, Qian Cai

It appears that kernel-doc does not understand the return type *__ref,

drivers/acpi/osl.c:306: warning: cannot understand function prototype:
'void __iomem *__ref acpi_os_map_iomem(acpi_physical_address phys,
acpi_size size)

Signed-off-by: Qian Cai <cai@lca.pw>
---
 drivers/acpi/osl.c     | 4 ++--
 include/acpi/acpi_io.h | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/acpi/osl.c b/drivers/acpi/osl.c
index cc7507091dec..9c0edf2fc0dd 100644
--- a/drivers/acpi/osl.c
+++ b/drivers/acpi/osl.c
@@ -301,8 +301,8 @@ static void acpi_unmap(acpi_physical_address pg_off, void __iomem *vaddr)
  * During early init (when acpi_permanent_mmap has not been set yet) this
  * routine simply calls __acpi_map_table() to get the job done.
  */
-void __iomem *__ref
-acpi_os_map_iomem(acpi_physical_address phys, acpi_size size)
+void __iomem __ref
+*acpi_os_map_iomem(acpi_physical_address phys, acpi_size size)
 {
 	struct acpi_ioremap *map;
 	void __iomem *virt;
diff --git a/include/acpi/acpi_io.h b/include/acpi/acpi_io.h
index d0633fc1fc15..12d8bd333fe7 100644
--- a/include/acpi/acpi_io.h
+++ b/include/acpi/acpi_io.h
@@ -16,8 +16,8 @@ static inline void __iomem *acpi_os_ioremap(acpi_physical_address phys,
 
 extern bool acpi_permanent_mmap;
 
-void __iomem *__ref
-acpi_os_map_iomem(acpi_physical_address phys, acpi_size size);
+void __iomem __ref
+*acpi_os_map_iomem(acpi_physical_address phys, acpi_size size);
 void __ref acpi_os_unmap_iomem(void __iomem *virt, acpi_size size);
 void __iomem *acpi_os_get_iomem(acpi_physical_address phys, unsigned int size);
 
-- 
1.8.3.1


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

* Re: [PATCH] acpi/osl: fix a W=1 kernel-doc warning
  2019-06-03 20:28 [PATCH] acpi/osl: fix a W=1 kernel-doc warning Qian Cai
@ 2019-06-13 20:29 ` Rafael J. Wysocki
  0 siblings, 0 replies; 2+ messages in thread
From: Rafael J. Wysocki @ 2019-06-13 20:29 UTC (permalink / raw)
  To: Qian Cai; +Cc: lenb, linux-acpi, linux-kernel

On Monday, June 3, 2019 10:28:35 PM CEST Qian Cai wrote:
> It appears that kernel-doc does not understand the return type *__ref,
> 
> drivers/acpi/osl.c:306: warning: cannot understand function prototype:
> 'void __iomem *__ref acpi_os_map_iomem(acpi_physical_address phys,
> acpi_size size)
> 
> Signed-off-by: Qian Cai <cai@lca.pw>
> ---
>  drivers/acpi/osl.c     | 4 ++--
>  include/acpi/acpi_io.h | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/acpi/osl.c b/drivers/acpi/osl.c
> index cc7507091dec..9c0edf2fc0dd 100644
> --- a/drivers/acpi/osl.c
> +++ b/drivers/acpi/osl.c
> @@ -301,8 +301,8 @@ static void acpi_unmap(acpi_physical_address pg_off, void __iomem *vaddr)
>   * During early init (when acpi_permanent_mmap has not been set yet) this
>   * routine simply calls __acpi_map_table() to get the job done.
>   */
> -void __iomem *__ref
> -acpi_os_map_iomem(acpi_physical_address phys, acpi_size size)
> +void __iomem __ref
> +*acpi_os_map_iomem(acpi_physical_address phys, acpi_size size)
>  {
>  	struct acpi_ioremap *map;
>  	void __iomem *virt;
> diff --git a/include/acpi/acpi_io.h b/include/acpi/acpi_io.h
> index d0633fc1fc15..12d8bd333fe7 100644
> --- a/include/acpi/acpi_io.h
> +++ b/include/acpi/acpi_io.h
> @@ -16,8 +16,8 @@ static inline void __iomem *acpi_os_ioremap(acpi_physical_address phys,
>  
>  extern bool acpi_permanent_mmap;
>  
> -void __iomem *__ref
> -acpi_os_map_iomem(acpi_physical_address phys, acpi_size size);
> +void __iomem __ref
> +*acpi_os_map_iomem(acpi_physical_address phys, acpi_size size);
>  void __ref acpi_os_unmap_iomem(void __iomem *virt, acpi_size size);
>  void __iomem *acpi_os_get_iomem(acpi_physical_address phys, unsigned int size);
>  
> 

Applied, thanks!





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

end of thread, back to index

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-06-03 20:28 [PATCH] acpi/osl: fix a W=1 kernel-doc warning Qian Cai
2019-06-13 20:29 ` Rafael J. Wysocki

Linux-ACPI Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-acpi/0 linux-acpi/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-acpi linux-acpi/ https://lore.kernel.org/linux-acpi \
		linux-acpi@vger.kernel.org linux-acpi@archiver.kernel.org
	public-inbox-index linux-acpi


Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-acpi


AGPL code for this site: git clone https://public-inbox.org/ public-inbox