# HG changeset patch
# User Torbjorn Granlund
# Date 1387402220 3600
# Node ID d19172622a7468610a9f65ddd0c8cae251a65d80
# Parent 7689dc0334e6d4a87038dd7f62e8c3bcf666cf64
(Lowlevel Functions): Rewrite mpn_set_str docs.
diff r 7689dc0334e6 r d19172622a74 doc/gmp.texi
 a/doc/gmp.texi Fri Oct 18 11:17:55 2013 +0200
+++ b/doc/gmp.texi Wed Dec 18 22:30:20 2013 +0100
@@ 5473,14 +5473,15 @@
be a value in the range 0 to @math{@var{base}1}, not an ASCII character.
@var{base} can vary from 2 to 256.
The return value is the number of limbs written to @var{rp}. If the most
significant input byte is nonzero then the high limb at @var{rp} will be
nonzero, and only that exact number of limbs will be required there.

If the most significant input byte is zero then there may be high zero limbs
written to @var{rp} and included in the return value.

@var{strsize} must be at least 1, and no overlap is permitted between
+The return value is the number of valid limbs written to @var{rp}. Iff the
+input string has no leading zero digits, the value at
+@var{rp}[@var{retval}@minus{}1] will be nonzero, else
+@var{rp}[@var{retval}@minus{}1] and subsequent limbs may be zero.
+
+The area at @var{rp} has to have space for the largest possible number with
+@var{strsize} digits in the chosen base, plus one extra limb.
+
+The input must have at least one byte, and no overlap is permitted between
@{@var{str},@var{strsize}@} and the result at @var{rp}.
@end deftypefun