[PATCH v3] average: Clarify the restrictions

[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.

Signed-off-by: Jui-Tse Huang <juitse.huang@xxxxxxxxx>
Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---

Notes:
    v3: fix typo (Randy Dunlap)
    v2: fix spelling and wording (Bruno Randolf)

 include/linux/average.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/include/linux/average.h b/include/linux/average.h
index a1a8f09631ce..9c3c8b5b518e 100644
--- a/include/linux/average.h
+++ b/include/linux/average.h
@@ -11,7 +11,10 @@
  *
  * This implements a fixed-precision EWMA algorithm, with both the
  * precision and fall-off coefficient determined at compile-time
- * and built into the generated helper funtions.
+ * and built into the generated helper functions.
+ *
+ * This implementation supports up to 30 bits of precision, and only
+ * the API for 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.
-- 
2.34.1