From: Andre Noll <maan@tuebingen.mpg.de>
Date: Mon, 24 Jul 2017 20:41:40 +0000 (+0200)
Subject: mood.c: Fix documentation of int_sqrt().
X-Git-Tag: v0.6.1~8^2~1
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=b1c682279994fd35a590a925a0f51647771d2002;ds=sidebyside

mood.c: Fix documentation of int_sqrt().

As pointed out by Peter Zijlstra on lkml, int_sqrt() is not
rough nor any approximation; it calculates the exact value of
floor(sqrt()). Document this.
---

diff --git a/mood.c b/mood.c
index c24b3d8b..bf6b3c9c 100644
--- a/mood.c
+++ b/mood.c
@@ -121,10 +121,9 @@ __a_const static uint32_t fls64(uint64_t v)
 }
 
 /*
- * Rough approximation to sqrt.
+ * Compute the integer square root floor(sqrt(x)).
  *
- * It returns an integer res with res * res <= x. Taken 2007 from the linux
- * source tree.
+ * Taken 2007 from the linux source tree.
  */
 __a_const static uint64_t int_sqrt(uint64_t x)
 {