* [PATCH v11 07/11] Documentation: core-api: Add math.h macros and functions
[not found] <20240531170229.1270828-1-devarsht@ti.com>
@ 2024-05-31 17:12 ` Devarsh Thakkar
2024-05-31 17:41 ` Andy Shevchenko
2024-05-31 18:31 ` Randy Dunlap
0 siblings, 2 replies; 4+ messages in thread
From: Devarsh Thakkar @ 2024-05-31 17:12 UTC (permalink / raw)
To: mchehab, hverkuil-cisco, linux-media, linux-kernel,
benjamin.gaignard, sebastian.fricke, akpm, gregkh,
andriy.shevchenko, adobriyan, jani.nikula, p.zabel, airlied,
daniel, dri-devel, corbet, broonie, rdunlap, linux-doc
Cc: laurent.pinchart, praneeth, nm, vigneshr, a-bhatia1, j-luthra,
b-brnich, detheridge, p-mantena, vijayp, devarsht, andrzej.p,
nicolas, davidgow, dlatypov
Add documentation for rounding, scaling, absolute value and difference,
32-bit division related macros and functions exported by math.h header
file.
Signed-off-by: Devarsh Thakkar <devarsht@ti.com>
---
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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v11 07/11] Documentation: core-api: Add math.h macros and functions
2024-05-31 17:12 ` [PATCH v11 07/11] Documentation: core-api: Add math.h macros and functions Devarsh Thakkar
@ 2024-05-31 17:41 ` Andy Shevchenko
2024-05-31 18:31 ` Randy Dunlap
1 sibling, 0 replies; 4+ messages in thread
From: Andy Shevchenko @ 2024-05-31 17:41 UTC (permalink / raw)
To: Devarsh Thakkar
Cc: mchehab, hverkuil-cisco, linux-media, linux-kernel,
benjamin.gaignard, sebastian.fricke, akpm, gregkh, adobriyan,
jani.nikula, p.zabel, airlied, daniel, dri-devel, corbet, broonie,
rdunlap, linux-doc, laurent.pinchart, praneeth, nm, vigneshr,
a-bhatia1, j-luthra, b-brnich, detheridge, p-mantena, vijayp,
andrzej.p, nicolas, davidgow, dlatypov
On Fri, May 31, 2024 at 10:42:20PM +0530, Devarsh Thakkar wrote:
> Add documentation for rounding, scaling, absolute value and difference,
> 32-bit division related macros and functions exported by math.h header
> file.
As long as it renders correctly, fine to me
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v11 07/11] Documentation: core-api: Add math.h macros and functions
2024-05-31 17:12 ` [PATCH v11 07/11] Documentation: core-api: Add math.h macros and functions Devarsh Thakkar
2024-05-31 17:41 ` Andy Shevchenko
@ 2024-05-31 18:31 ` Randy Dunlap
2024-06-01 16:41 ` Devarsh Thakkar
1 sibling, 1 reply; 4+ messages in thread
From: Randy Dunlap @ 2024-05-31 18:31 UTC (permalink / raw)
To: Devarsh Thakkar, mchehab, hverkuil-cisco, linux-media,
linux-kernel, benjamin.gaignard, sebastian.fricke, akpm, gregkh,
andriy.shevchenko, adobriyan, jani.nikula, p.zabel, airlied,
daniel, dri-devel, corbet, broonie, linux-doc
Cc: laurent.pinchart, praneeth, nm, vigneshr, a-bhatia1, j-luthra,
b-brnich, detheridge, p-mantena, vijayp, andrzej.p, nicolas,
davidgow, dlatypov
Hi,
On 5/31/24 10:12 AM, Devarsh Thakkar wrote:
> Add documentation for rounding, scaling, absolute value and difference,
> 32-bit division related macros and functions exported by math.h header
> file.
>
I don't see any kernel-doc for division functions in this header file.
Do some division functions get rendered somehow?
Thanks.
> Signed-off-by: Devarsh Thakkar <devarsht@ti.com>
> ---
> 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
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v11 07/11] Documentation: core-api: Add math.h macros and functions
2024-05-31 18:31 ` Randy Dunlap
@ 2024-06-01 16:41 ` Devarsh Thakkar
0 siblings, 0 replies; 4+ messages in thread
From: Devarsh Thakkar @ 2024-06-01 16:41 UTC (permalink / raw)
To: Randy Dunlap, mchehab, hverkuil-cisco, linux-media, linux-kernel,
benjamin.gaignard, sebastian.fricke, akpm, gregkh,
andriy.shevchenko, adobriyan, jani.nikula, p.zabel, airlied,
daniel, dri-devel, corbet, broonie, linux-doc
Cc: laurent.pinchart, praneeth, nm, vigneshr, a-bhatia1, j-luthra,
b-brnich, detheridge, p-mantena, vijayp, andrzej.p, nicolas,
davidgow, dlatypov
On 01/06/24 00:01, Randy Dunlap wrote:
> Hi,
>
> On 5/31/24 10:12 AM, Devarsh Thakkar wrote:
>> Add documentation for rounding, scaling, absolute value and difference,
>> 32-bit division related macros and functions exported by math.h header
>> file.
>>
>
> I don't see any kernel-doc for division functions in this header file.
>
> Do some division functions get rendered somehow?
>
Good catch. I see couple of them having adequate documentation just
missing the sphynx syntax, will enable for DIV_ROUND_CLOSEST and
DIV_ROUND_CLOSEST_ULL.
Regards
Devarsh
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2024-06-01 16:42 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <20240531170229.1270828-1-devarsht@ti.com>
2024-05-31 17:12 ` [PATCH v11 07/11] Documentation: core-api: Add math.h macros and functions Devarsh Thakkar
2024-05-31 17:41 ` Andy Shevchenko
2024-05-31 18:31 ` Randy Dunlap
2024-06-01 16:41 ` Devarsh Thakkar
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox