[v1,1/1] Documentation: core-api: Drop :export: for int_log.h

Message ID 20230713165320.14199-1-andriy.shevchenko@linux.intel.com
State New
Headers
Series [v1,1/1] Documentation: core-api: Drop :export: for int_log.h |

Commit Message

Andy Shevchenko July 13, 2023, 4:53 p.m. UTC
  The :export: keyword makes sense only for C-files, where EXPORT_SYMBOL()
might appear. Otherwise kernel-doc may not produce anything out of this
file.

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Fixes: f97fa3dcb2db ("lib/math: Move dvb_math.c into lib/math/int_log.c")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 Documentation/core-api/kernel-api.rst | 1 -
 1 file changed, 1 deletion(-)
  

Comments

Randy Dunlap July 13, 2023, 6:58 p.m. UTC | #1
On 7/13/23 09:53, Andy Shevchenko wrote:
> The :export: keyword makes sense only for C-files, where EXPORT_SYMBOL()
> might appear. Otherwise kernel-doc may not produce anything out of this
> file.
> 
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Fixes: f97fa3dcb2db ("lib/math: Move dvb_math.c into lib/math/int_log.c")
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  Documentation/core-api/kernel-api.rst | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst
> index a526fbe06f86..ae92a2571388 100644
> --- a/Documentation/core-api/kernel-api.rst
> +++ b/Documentation/core-api/kernel-api.rst
> @@ -166,7 +166,6 @@ Integer log and power Functions
>  -------------------------------
>  
>  .. kernel-doc:: include/linux/int_log.h
> -   :export:
>  
>  .. kernel-doc:: lib/math/int_pow.c
>     :export:
  

Patch

diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst
index a526fbe06f86..ae92a2571388 100644
--- a/Documentation/core-api/kernel-api.rst
+++ b/Documentation/core-api/kernel-api.rst
@@ -166,7 +166,6 @@  Integer log and power Functions
 -------------------------------
 
 .. kernel-doc:: include/linux/int_log.h
-   :export:
 
 .. kernel-doc:: lib/math/int_pow.c
    :export: