[PATCH v13 09/13] Documentation: core-api: Add math.h macros and functions

Devarsh Thakkar posted 13 patches 1 year, 8 months ago
There is a newer version of this series
[PATCH v13 09/13] Documentation: core-api: Add math.h macros and functions
Posted by Devarsh Thakkar 1 year, 8 months ago
Add documentation for rounding, scaling, absolute value and 32-bit division
related macros and functions exported by math.h header file.

Signed-off-by: Devarsh Thakkar <devarsht@ti.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
V13: No change
V12: Add Reviewed-by
V11: Fix title for math function header
V10: Patch introduced
V1->V9 (No change)
 Documentation/core-api/kernel-api.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst
index ae92a2571388..7de494e76fa6 100644
--- a/Documentation/core-api/kernel-api.rst
+++ b/Documentation/core-api/kernel-api.rst
@@ -185,6 +185,12 @@ Division Functions
 .. kernel-doc:: lib/math/gcd.c
    :export:
 
+Rounding, absolute value, division and 32-bit scaling functions
+---------------------------------------------------------------
+
+.. kernel-doc:: include/linux/math.h
+   :internal:
+
 UUID/GUID
 ---------
 
-- 
2.39.1
Re: [PATCH v13 09/13] Documentation: core-api: Add math.h macros and functions
Posted by Randy Dunlap 1 year, 7 months ago

On 6/7/24 6:31 AM, Devarsh Thakkar wrote:
> Add documentation for rounding, scaling, absolute value and 32-bit division
> related macros and functions exported by math.h header file.
> 
> Signed-off-by: Devarsh Thakkar <devarsht@ti.com>
> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

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

Thanks.

> ---
> V13: No change
> V12: Add Reviewed-by
> V11: Fix title for math function header
> V10: Patch introduced
> V1->V9 (No change)
>  Documentation/core-api/kernel-api.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst
> index ae92a2571388..7de494e76fa6 100644
> --- a/Documentation/core-api/kernel-api.rst
> +++ b/Documentation/core-api/kernel-api.rst
> @@ -185,6 +185,12 @@ Division Functions
>  .. kernel-doc:: lib/math/gcd.c
>     :export:
>  
> +Rounding, absolute value, division and 32-bit scaling functions
> +---------------------------------------------------------------
> +
> +.. kernel-doc:: include/linux/math.h
> +   :internal:
> +
>  UUID/GUID
>  ---------
>  

-- 
~Randy