[Guile-commits] 05/05: Document new interfaces

[Andy Wingo]

wingo pushed a commit to branch master
in repository guile.

commit 55ebf1b84a794ab908380d241215da9b40ab1f3e
Author: Andy Wingo <wingo@pobox.com>
AuthorDate: Tue Jan 12 12:24:59 2021 +0100

    Document new interfaces
    
    * NEWS: Update.
    * doc/ref/api-io.texi (Bytevector Ports): Add docs.
---
 NEWS                | 21 +++++++++++++++++++++
 doc/ref/api-io.texi | 13 +++++++++++++
 2 files changed, 34 insertions(+)

diff --git a/NEWS b/NEWS
index 6f4f6da..234885d 100644
--- a/NEWS
+++ b/NEWS
@@ -5,6 +5,27 @@ See the end for copying conditions.
 Please send Guile bug reports to bug-guile@gnu.org.
 
 
+Changes in 3.0.6 (since 3.0.5)
+
+* New interfaces and functionality
+
+** `call-with-port'
+
+See "Ports" in the manual.
+
+** `call-with-input-bytevector', `call-with-output-bytevector'
+
+See "Bytevector Ports" in the manual.
+
+* Incompatible changes
+
+** `call-with-output-string' closes port on normal exit
+
+This procedure used to leave the port open, even though there was no
+useful way to access it.  Now we clean it up more promptly, disposing
+any possible associated iconv descriptor.
+
+
 Changes in 3.0.5 (since 3.0.4)
 
 * New interfaces and functionality
diff --git a/doc/ref/api-io.texi b/doc/ref/api-io.texi
index 5029605..777f282 100644
--- a/doc/ref/api-io.texi
+++ b/doc/ref/api-io.texi
@@ -1166,6 +1166,19 @@ the data accumulated by the port, as illustrated below.
 The @var{transcoder} argument is currently not supported.
 @end deffn
 
+@deffn {Scheme Procedure} call-with-output-bytevector proc
+Call the one-argument procedure @var{proc} with a newly created
+bytevector output port.  When the function returns, the bytevector
+composed of the characters written into the port is returned.
+@var{proc} should not close the port.
+@end deffn
+
+@deffn {Scheme Procedure} call-with-input-bytevector bytevector proc
+Call the one-argument procedure @var{proc} with a newly created input
+port from which @var{bytevector}'s contents may be read.  The values
+yielded by the @var{proc} is returned.
+@end deffn
+
 
 @node String Ports
 @subsubsection String Ports