From: hearot <gabriel@hearot.it>
Date: Sun, 28 Oct 2018 09:01:39 +0000 (+0100)
Subject: math/big: fix a formula used as documentation
X-Git-Tag: go1.12beta1~615
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=f28191340eb7f9e2d32d792df1a279d6e4437b3d;p=gostls13.git

math/big: fix a formula used as documentation

The function documentation was wrong, it was using a wrong parameter. This change
replaces it with the right parameter.

The wrong formula was: q = (u1<<_W + u0 - r)/y
The function has got a parameter "v" (of type Word), not a parameter "y".
So, the right formula is: q = (u1<<_W + u0 - r)/v

Fixes #28444

Change-Id: I82e57ba014735a9fdb6262874ddf498754d30d33
Reviewed-on: https://go-review.googlesource.com/c/145280
Reviewed-by: Robert Griesemer <gri@golang.org>
---

diff --git a/src/math/big/arith.go b/src/math/big/arith.go
index ad352403a7..f9db9118eb 100644
--- a/src/math/big/arith.go
+++ b/src/math/big/arith.go
@@ -82,7 +82,7 @@ func nlz(x Word) uint {
 	return uint(bits.LeadingZeros(uint(x)))
 }
 
-// q = (u1<<_W + u0 - r)/y
+// q = (u1<<_W + u0 - r)/v
 // Adapted from Warren, Hacker's Delight, p. 152.
 func divWW_g(u1, u0, v Word) (q, r Word) {
 	if u1 >= v {