Skip to contentSkip to conversation

average: Clarify the restrictions

PATCH Superseded Jui-Tse Huang 2 participants 2 messages Jun 1, 2022

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 average: Clarify the restrictions

There is several restrictions in the EWMA helper macro that the developers should take care of, but the comment does not mentioned yet, thus, this patch clarify the restrictions.

---
 include/linux/average.h | 4 ++++
 1 file changed, 4 insertions(+)
include/linux/average.h +4 -0
index a1a8f09631ce..1618f6519c3d 100644
@@ -13,6 +13,10 @@
  * precision and fall-off coefficient determined at compile-time
  * and built into the generated helper funtions.
  *
+ * This implementation supports upto 30 bits of precition, and for
+ * usage concern, only the api of fetching non-fractional part is
+ * provided for now.
+ *
  * The first argument to the macro is the name that will be used
  * for the struct and helper functions.
  *
Signature · 1 line
2.34.1
#1 lore raw
Quoted 14 lines · Jui-Tse Huang

There is several restrictions in the EWMA helper macro that the developers should take care of, but the comment does not mentioned yet, thus, this patch clarify the restrictions.

---
  include/linux/average.h | 4 ++++
  1 file changed, 4 insertions(+)
include/linux/average.h +0 -0
index a1a8f09631ce..1618f6519c3d 100644

include/linux/average.h line 16

Quoted 4 lines
include/linux/average.h +1 -0
@@ -13,6 +13,10 @@
   * precision and fall-off coefficient determined at compile-time
   * and built into the generated helper funtions.
   *
+ * This implementation supports upto 30 bits of precition, and for

spelling: up to ... precision

include/linux/average.h line 18

Quoted 2 lines
include/linux/average.h +2 -0
+ * usage concern, only the api of fetching non-fractional part is
+ * provided for now.

spelling: "API for"

wording: remove "and for usage concern", just ", and only the API for" would be enough.

Thank you,
bruno