[commit: ghc] master: Update integer_gmp_gcdext documentation. (45d5eff)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/45d5eff820aefd42454a7b9f25c4a61dbfca1ad5/ghc

>---------------------------------------------------------------

commit 45d5eff820aefd42454a7b9f25c4a61dbfca1ad5
Author: David Eichmann <davide at well-typed.com>
Date:   Mon Oct 15 13:54:49 2018 -0400

    Update integer_gmp_gcdext documentation.
    
    Reviewers: hvr, bgamari, monoidal
    
    Reviewed By: monoidal
    
    Subscribers: rwbarton, carter
    
    GHC Trac Issues: #15350
    
    Differential Revision: https://phabricator.haskell.org/D5091


>---------------------------------------------------------------

45d5eff820aefd42454a7b9f25c4a61dbfca1ad5
 libraries/integer-gmp/cbits/wrappers.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/libraries/integer-gmp/cbits/wrappers.c b/libraries/integer-gmp/cbits/wrappers.c
index 11e5179..2b5db34 100644
--- a/libraries/integer-gmp/cbits/wrappers.c
+++ b/libraries/integer-gmp/cbits/wrappers.c
@@ -279,16 +279,16 @@ integer_gmp_mpn_gcd(mp_limb_t r[],
 
 /* wraps mpz_gcdext()
  *
- * Set g to the greatest common divisor of x and y, and in addition
- * set s and t to coefficients satisfying x*s + y*t = g.
+ * Set g={g0,gn} to the greatest common divisor of x={x0,xn} and
+ * y={y0,yn}, and in addition set s={s0,sn} to coefficient
+ * satisfying x*s + y*t = g.
  *
- * The {gp,gn} array is zero-padded (as otherwise 'gn' can't be
- * reconstructed).
+ * The g0 array is zero-padded (so that gn is fixed).
  *
- * g must have space for exactly gn=min(xn,yn) limbs.
- * s must have space for at least yn limbs.
+ * g0 must have space for exactly gn=min(xn,yn) limbs.
+ * s0 must have space for at least yn limbs.
  *
- * return value: signed 'sn' of {sp,sn} where |sn| >= 1
+ * return value: signed 'sn' of s={s0,sn} where |sn| >= 1
  */
 mp_size_t
 integer_gmp_gcdext(mp_limb_t s0[], mp_limb_t g0[],