Skip to contentSkip to conversation

docs/core-api: Add integer power functions to the list

PATCH In review Andy Shevchenko 2 participants 2 messages Jun 5, 2019 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/core-api: Add integer power functions to the list

Some times integer power functions, such as int_sqrt(), are needed, but there is nothing about them in the generated documentation.

Fill the gap by adding a reference to the corresponding exported functions.

---
 Documentation/core-api/kernel-api.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
Documentation/core-api/kernel-api.rst +9 -0
index 65ae2bf1f86d..824f24ccf401 100644
@@ -141,6 +141,15 @@ Base 2 log and power Functions
 .. kernel-doc:: include/linux/log2.h
    :internal:
 
+Integer power Functions
+-----------------------
+
+.. kernel-doc:: lib/math/int_pow.c
+   :export:
+
+.. kernel-doc:: lib/math/int_sqrt.c
+   :export:
+
 Division Functions
 ------------------
 
Signature · 1 line
2.20.1
Acked-by on v1 1/1
#1 lore raw
Quoted 6 lines · Andy Shevchenko

Some times integer power functions, such as int_sqrt(), are needed, but there is nothing about them in the generated documentation.

Fill the gap by adding a reference to the corresponding exported functions.

Quoted 27 lines
---
 Documentation/core-api/kernel-api.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
Documentation/core-api/kernel-api.rst +9 -0
index 65ae2bf1f86d..824f24ccf401 100644
@@ -141,6 +141,15 @@ Base 2 log and power Functions
 .. kernel-doc:: include/linux/log2.h
    :internal:
 
+Integer power Functions
+-----------------------
+
+.. kernel-doc:: lib/math/int_pow.c
+   :export:
+
+.. kernel-doc:: lib/math/int_sqrt.c
+   :export:
+
 Division Functions
 ------------------
 
Signature · 1 line
2.20.1
Signature · 2 lines
Sincerely yours,
Mike.