public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Devarsh Thakkar <devarsht@ti.com>
To: <mchehab@kernel.org>, <hverkuil-cisco@xs4all.nl>,
	<linux-media@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	<sebastian.fricke@collabora.com>,
	<andriy.shevchenko@linux.intel.com>, <jani.nikula@intel.com>,
	<jirislaby@kernel.org>, <corbet@lwn.net>, <broonie@kernel.org>,
	<rdunlap@infradead.org>, <linux-doc@vger.kernel.org>
Cc: <laurent.pinchart@ideasonboard.com>, <praneeth@ti.com>,
	<nm@ti.com>, <vigneshr@ti.com>, <a-bhatia1@ti.com>,
	<j-luthra@ti.com>, <b-brnich@ti.com>, <detheridge@ti.com>,
	<p-mantena@ti.com>, <vijayp@ti.com>, <devarsht@ti.com>,
	<andi.shyti@linux.intel.com>, <nicolas@ndufresne.ca>,
	<davidgow@google.com>, <dlatypov@google.com>
Subject: [PATCH 3/6] Documentation: core-api: Add math.h macros and functions
Date: Mon, 8 Jul 2024 21:29:40 +0530	[thread overview]
Message-ID: <20240708155943.2314427-4-devarsht@ti.com> (raw)
In-Reply-To: <20240708155943.2314427-1-devarsht@ti.com>

Add documentation for rounding, scaling, absolute value and 32-bit division
related macros and functions exported by math.h header file.

Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Devarsh Thakkar <devarsht@ti.com>
---
 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


  parent reply	other threads:[~2024-07-08 16:00 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-08 15:59 [PATCH 0/6] Add rounding macros and enable KUnit tests Devarsh Thakkar
2024-07-08 15:59 ` [PATCH 1/6] math.h: Add macros for rounding to closest value Devarsh Thakkar
2024-07-09  5:59   ` Jiri Slaby
2024-07-09 14:30     ` Devarsh Thakkar
2024-07-09  8:49   ` Nikolay Borisov
2024-07-20 10:01     ` Devarsh Thakkar
2024-07-09 17:18   ` Dave Martin
2024-07-20 11:36     ` Devarsh Thakkar
2024-07-08 15:59 ` [PATCH 2/6] math.h: Use kernel-doc syntax for divison macros Devarsh Thakkar
2024-07-08 15:59 ` Devarsh Thakkar [this message]
2024-07-08 15:59 ` [PATCH 4/6] lib: Add basic KUnit test for lib/math Devarsh Thakkar
2024-07-08 15:59 ` [PATCH 5/6] lib: math_kunit: Add tests for new macros related to rounding to nearest value Devarsh Thakkar
2024-07-08 15:59 ` [PATCH 6/6] media: imagination: Round to closest multiple for cropping region Devarsh Thakkar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240708155943.2314427-4-devarsht@ti.com \
    --to=devarsht@ti.com \
    --cc=a-bhatia1@ti.com \
    --cc=andi.shyti@linux.intel.com \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=b-brnich@ti.com \
    --cc=broonie@kernel.org \
    --cc=corbet@lwn.net \
    --cc=davidgow@google.com \
    --cc=detheridge@ti.com \
    --cc=dlatypov@google.com \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=j-luthra@ti.com \
    --cc=jani.nikula@intel.com \
    --cc=jirislaby@kernel.org \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=nicolas@ndufresne.ca \
    --cc=nm@ti.com \
    --cc=p-mantena@ti.com \
    --cc=praneeth@ti.com \
    --cc=rdunlap@infradead.org \
    --cc=sebastian.fricke@collabora.com \
    --cc=vigneshr@ti.com \
    --cc=vijayp@ti.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox