Initial support for external-formats for encoding foreign strings

[uffi.git] / doc / ref_string.xml

diff --git a/doc/ref_string.xml b/doc/ref_string.xml
index d488e12b38c7e76cedb4d6453760d673be7cb227..235950a8fa1cc34ce2715a1028850d24fd86e01c 100644 (file)
--- a/doc/ref_string.xml
+++ b/doc/ref_string.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
-<!ENTITY % myents SYSTEM "entities.xml">
+<!ENTITY % myents SYSTEM "entities.inc">
 %myents;
 ]>
 
@@ -52,7 +52,9 @@
          (result-code (c-gethostname name 256))
          (hostname (when (zerop result-code)
                      (uffi:convert-from-foreign-string name))))
-    (uffi:free-foreign-object name)
+    ;; UFFI does not yet provide a universal way to free
+    ;; memory allocated by C's malloc. At this point, a program
+    ;; needs to call C's free function to free such memory.
     (unless (zerop result-code)
       (error "gethostname() failed."))))
     </screen>