From: Kevin M. Rosenberg <kevin@rosenberg.net>
Date: Fri, 22 Nov 2002 01:35:33 +0000 (+0000)
Subject: r3448: *** empty log message ***
X-Git-Tag: v1.6.1~257
X-Git-Url: http://git.kpe.io/?p=uffi.git;a=commitdiff_plain;h=005eb1c1210634a27fbc973d84004b5622456fc5

r3448: *** empty log message ***
---

diff --git a/debian/changelog b/debian/changelog
index 908080f..4cbbf51 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+cl-uffi (1.1.5-1) unstable; urgency=low
+
+  * Documentation changes
+
+ -- Kevin M. Rosenberg <kmr@debian.org>  Thu, 21 Nov 2002 18:35:26 -0700
+
 cl-uffi (1.1.4-1) unstable; urgency=low
 
   * OpenMCL/MCL fixes
diff --git a/debian/control b/debian/control
index a5fefc1..2e81ad5 100644
--- a/debian/control
+++ b/debian/control
@@ -3,7 +3,7 @@ Section: devel
 Priority: optional
 Maintainer: Kevin M. Rosenberg <kmr@debian.org>
 Build-Depends-Indep: debhelper (>= 4.0.0)
-Standards-Version: 3.5.7.1
+Standards-Version: 3.5.8.0
 
 Package: cl-uffi
 Architecture: all
diff --git a/doc/html.tar.gz b/doc/html.tar.gz
index 83147fa..e5331db 100644
Binary files a/doc/html.tar.gz and b/doc/html.tar.gz differ
diff --git a/doc/ref.sgml b/doc/ref.sgml
index 827ac07..39ae02e 100644
--- a/doc/ref.sgml
+++ b/doc/ref.sgml
@@ -1495,12 +1495,23 @@ if a cstring returned by a function is &null;.
 <partintro>
 <title>Overview</title>
 <para>
-	  &uffi; has functions to two types of <varname>C</varname>-compatible 
+
+	  &uffi; has functions to two types of
+<varname>C</varname>-compatible
 	  strings, <emphasis>cstring</emphasis> and <emphasis>foreign</emphasis> strings.
-cstrings are used as parameters to and from functions. An implementation, such as CMUCL,
-may not convert these to a foreign type for efficiency sake. Thus, it is not
-possible to "allocate" a cstring. In contrast, foreign strings
-always need to have memory for them.
+
+cstrings are used as parameters to and from functions. An
+implementation, such as CMUCL and Lispworks, a cstring may not be a
+foreign type but rather the Lisp string itself while on other
+platforms a cstring is a newly allocated foreign vector for storing
+characters. Thus, it is not possible to portably
+<emphasis>allocate</emphasis> a cstring. 
+</para>
+<para>
+In contrast, foreign strings
+are always a foreign vector of characters which have a memory
+allocated to hold them. Because of this, if you need to allocate memory to
+hold the return value of a string, use a foreign string and not a cstring.
 	</para>
 </partintro>
 
@@ -1602,7 +1613,7 @@ that returns a cstring.
       </refsect1>
       <refsect1>
 	<title>Side Effects</title>
-	<para>None.</para>
+	<para>On some implementations, this function allocates memory.</para>
       </refsect1>
       <refsect1>
 	<title>Affected by</title>
@@ -1704,7 +1715,7 @@ that returns a cstring.
       <refsect1>
 	<title>Description</title>
 	<para>
-	  Binds a lexical variable to a newly allocated <varname>cstring</varname>. Automatically frees <varname>cstring</varname>.
+	  Binds a symbol to a cstring created from conversion of a string. Automatically frees the <varname>cstring</varname>.
 	</para>
       </refsect1>
       <refsect1>
diff --git a/doc/uffi.pdf b/doc/uffi.pdf
index 21ed592..f591354 100644
Binary files a/doc/uffi.pdf and b/doc/uffi.pdf differ