From 19acf1d02b0ba62eb6b0b572592632ced36957e4 Mon Sep 17 00:00:00 2001 From: Kaz Kylheku Date: Sat, 8 Jul 2017 21:04:07 -0700 Subject: doc: change Buffers heading. * txr.1: This change to the buffers heading causes the buf identifier to be cross-referenced, which is useful to people browsing the FFI section. Fixing some wording too. --- txr.1 | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/txr.1 b/txr.1 index 82c6ee4f..ac5da841 100644 --- a/txr.1 +++ b/txr.1 @@ -52931,11 +52931,16 @@ named .codn RTLD_LOCAL , .IR "et cetera" . -.SS* Buffers +.coSS The @ buf type -Buffers are vector-like objects specialized for holding binary data. Buffers -support operations specialized toward the encoding of Lisp values into -machine-oriented data types, and decoding such data types into Lisp values. +Object of the type +.code buf +are +.IR buffers : +vector-like objects specialized for holding binary data represented as +a sequence of 8 bit bytes. Buffers support operations specialized toward the +encoding of Lisp values into machine-oriented data types, and decoding such +data types into Lisp values. Buffers are particularly useful in conjunction with the Foreign Function Interface (FFI), since they can be used to prepare arbitrary data which -- cgit v1.2.3