1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-20 03:30:27 +02:00

Remove documentation on uniform-vector-read!, uniform-vector-write

* NEWS: Add specific removal notice.
* doc/ref/api-data.texi: Remove documentation on uniform-vector-read!,
  uniform-vector-write.
This commit is contained in:
Daniel Llorens 2017-02-13 13:21:59 +01:00
parent bb7c7362c3
commit ffcdb7bddf
2 changed files with 7 additions and 33 deletions

7
NEWS
View file

@ -884,6 +884,13 @@ All code deprecated in Guile 2.0 has been removed. See older NEWS, and
check that your programs can compile without linker warnings and run
without runtime warnings. See "Deprecation" in the manual.
In particular, the following functions, which were deprecated in 2.0.10
but not specifically mentioned earlier in this file, have been removed:
*** `uniform-vector-read!' and `uniform-vector-write' have been
removed. Use `get-bytevector-n!' and `put-bytevector' from (rnrs io
ports) instead.
** Remove miscellaneous unused interfaces
We have removed accidentally public, undocumented interfaces that we

View file

@ -7568,39 +7568,6 @@ $\left(\matrix{%
@end example
@end deffn
@deffn {Scheme Procedure} uniform-array-read! ra [port_or_fd [start [end]]]
@deffnx {C Function} scm_uniform_array_read_x (ra, port_or_fd, start, end)
Attempt to read all elements of array @var{ra}, in lexicographic order, as
binary objects from @var{port_or_fd}.
If an end of file is encountered,
the objects up to that point are put into @var{ra}
(starting at the beginning) and the remainder of the array is
unchanged.
The optional arguments @var{start} and @var{end} allow
a specified region of a vector (or linearized array) to be read,
leaving the remainder of the vector unchanged.
@code{uniform-array-read!} returns the number of objects read.
@var{port_or_fd} may be omitted, in which case it defaults to the value
returned by @code{(current-input-port)}.
@end deffn
@deffn {Scheme Procedure} uniform-array-write ra [port_or_fd [start [end]]]
@deffnx {C Function} scm_uniform_array_write (ra, port_or_fd, start, end)
Writes all elements of @var{ra} as binary objects to
@var{port_or_fd}.
The optional arguments @var{start}
and @var{end} allow
a specified region of a vector (or linearized array) to be written.
The number of objects actually written is returned.
@var{port_or_fd} may be
omitted, in which case it defaults to the value returned by
@code{(current-output-port)}.
@end deffn
@node Shared Arrays
@subsubsection Shared Arrays