[Gmp-commit] /var/hg/gmp: 2 new changesets

[mercurial at gmplib.org]

details:   /var/hg/gmp/rev/1512b9db532c
changeset: 16298:1512b9db532c
user:      Marco Bodrato <bodrato at mail.dm.unipi.it>
date:      Sat Feb 15 08:13:20 2014 +0100
description:
roinit_n: document the need for a readable limb.

details:   /var/hg/gmp/rev/89ae483c3c7c
changeset: 16299:89ae483c3c7c
user:      Marco Bodrato <bodrato at mail.dm.unipi.it>
date:      Sat Feb 15 08:35:20 2014 +0100
description:
ChangeLog

diffstat:

 ChangeLog    |  5 +++++
 doc/gmp.texi |  6 ++++--
 2 files changed, 9 insertions(+), 2 deletions(-)

diffs (35 lines):

diff -r cab67a423523 -r 89ae483c3c7c ChangeLog
--- a/ChangeLog	Fri Feb 14 10:46:57 2014 +0100
+++ b/ChangeLog	Sat Feb 15 08:35:20 2014 +0100
@@ -1,3 +1,8 @@
+2014-02-15 Marco Bodrato <bodrato at mail.dm.unipi.it>
+
+	* doc/gmp.texi (mpz_roinit_n, MPZ_ROINIT_N): Document that
+	at least a readable limb is required.
+
 2014-02-14  Niels Möller  <nisse at lysator.liu.se>
 
 	* doc/gmp.texi (Low-level Functions): Update docs for
diff -r cab67a423523 -r 89ae483c3c7c doc/gmp.texi
--- a/doc/gmp.texi	Fri Feb 14 10:46:57 2014 +0100
+++ b/doc/gmp.texi	Sat Feb 15 08:35:20 2014 +0100
@@ -4192,7 +4192,8 @@
 @deftypefun mpz_srcptr mpz_roinit_n (mpz_t @var{x}, const mp_limb_t *@var{xp}, mp_size_t @var{xs})
 Special initialization of @var{x}, using the given limb array and size.
 @var{x} should be treated as read-only: it can be passed safely as input to
-any mpz function, but not as an output. The size of the array is
+any mpz function, but not as an output. The array @var{xp} must point to at
+least a readable limb, its size is
 @math{@GMPabs{@var{xs}}}, and the sign of @var{x} is the sign of @var{xs}. For
 convenience, the function returns @var{x}, but cast to a const pointer type.
 @end deftypefun
@@ -4208,7 +4209,8 @@
 
 @deftypefn Macro mpz_t MPZ_ROINIT_N (mp_limb_t *@var{xp}, mp_size_t @var{xs})
 This macro expands to an initializer which can be assigned to an mpz_t
-variable. Unlike the @code{mpz_roinit_n} function, the limb array must be
+variable. The limb array @var{xp} must point to at least a readable limb,
+moreover, unlike the @code{mpz_roinit_n} function, the array must be
 normalized: if @var{xs} is non-zero, then
 @code{@var{xp}[@math{@GMPabs{@var{xs}}-1}]} must be non-zero. Intended
 primarily for constant values. Using it for non-constant values requires a C