From: Sven Verdoolaege <skimo@kotnet.org>
Date: Sat, 4 Dec 2010 13:47:36 +0000 (+0100)
Subject: doc: emphasize the need for isl_int_get_gmp and isl_int_set_gmp
X-Git-Tag: isl-0.05~19
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2bfb95f15be85c684807c97373f383026b44999b;p=platform%2Fupstream%2Fisl.git

doc: emphasize the need for isl_int_get_gmp and isl_int_set_gmp

Signed-off-by: Sven Verdoolaege <skimo@kotnet.org>
---

diff --git a/doc/user.pod b/doc/user.pod
index 74ffd1a..e0eb54b 100644
--- a/doc/user.pod
+++ b/doc/user.pod
@@ -195,7 +195,7 @@ are performed in exact integer arithmetic using C<GMP>.
 However, to allow future versions of C<isl> to optionally
 support fixed integer arithmetic, all calls to C<GMP>
 are wrapped inside C<isl> specific macros.
-The basic type is C<isl_int> and the following operations
+The basic type is C<isl_int> and the operations below
 are available on this type.
 The meanings of these operations are essentially the same
 as their C<GMP> C<mpz_> counterparts.
@@ -203,6 +203,10 @@ As always with C<GMP> types, C<isl_int>s need to be
 initialized with C<isl_int_init> before they can be used
 and they need to be released with C<isl_int_clear>
 after the last use.
+The user should not assume that an C<isl_int> is represented
+as a C<mpz_t>, but should instead explicitly convert between
+C<mpz_t>s and C<isl_int>s using C<isl_int_set_gmp> and
+C<isl_int_get_gmp> whenever a C<mpz_t> is required.
 
 =over