]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
guile: doc: Mention bytevectors.
authorLudovic Courtès <ludo@gnu.org>
Mon, 14 Mar 2016 09:44:08 +0000 (10:44 +0100)
committerNikos Mavrogiannopoulos <nmav@redhat.com>
Tue, 15 Mar 2016 10:50:56 +0000 (11:50 +0100)
* doc/gnutls-guile.texi (Representation of Binary Data): Mention bytevectors.
(Input and Output): Likewise.

doc/gnutls-guile.texi

index 8a085be435504104ae32db8cf367a994bdd0f530..0bb79959bb3114df9d65bb15a509b284c079bde0 100644 (file)
@@ -288,13 +288,14 @@ procedure applies to session.
 Many procedures operate on binary data.  For instance,
 @code{pkcs3-import-dh-parameters} expects binary data as input.
 
+@cindex bytevectors
 @cindex SRFI-4
 @cindex homogeneous vector
-
-Binary data is represented on the Scheme side using SRFI-4 homogeneous
-vectors (@pxref{SRFI-4,,, guile, The GNU Guile Reference Manual}).
-Although any type of homogeneous vector may be used, @code{u8vector}s
-(i.e., vectors of bytes) are highly recommended.
+Binary data is represented on the Scheme side using bytevectors
+(@pxref{Bytevectors,,, guile, The GNU Guile Reference Manual}).
+Homogeneous vectors such as SRFI-4 @code{u8vector}s can also be
+used@footnote{Historically, SRFI-4 @code{u8vector}s are the closest
+thing to bytevectors that Guile 1.8 and earlier supported.}.
 
 As an example, generating and then exporting Diffie-Hellman parameters
 in the PEM format can be done as follows:
@@ -385,9 +386,10 @@ applications do their own buffering.
 @findex record-receive!
 
 A lower-level I/O API is provided by @code{record-send} and
-@code{record-receive!} which take an SRFI-4 vector to represent the
-data sent or received.  While it might improve performance, it is much
-less convenient than the above and should rarely be needed.
+@code{record-receive!} which take a bytevector (or a SRFI-4 vector) to
+represent the data sent or received.  While it might improve
+performance, it is much less convenient than the session record port and
+should rarely be needed.
 
 
 @node Exception Handling