| Message ID | 20240531171220.1295881-1-devarsht@ti.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Add V4L2 M2M Driver for E5010 JPEG Encoder | expand |
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>
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 > --------- >
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
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 ---------
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(+)