Sane documentation inconsistency

Petter Reinholdtsen (pere@hungry.com)
Tue, 16 Mar 1999 19:01:22 +0100

While reading chapter 5, Network Protocol, I discovered that
SANE_String is missing from the encoding list. I began to wonder if
it is encoded as an array (size, elem1, elem2, ...), or as a sequence
described in 4.2.5. More later.

I also discovered that SANE_Char is inconsistently defined as '8-bit
ASCII', while it in section 4.2.5 is defined as 'ISO Latin 1'
(sometime refered to as ISO 8859/1).

I assume the latter is correct, and that section 5.5.1 should be
corrected. Enclosed is my suggested change.

After reading the source (sanei_codec_bin.c), I discovered that
strings are encoded like arrays including the trailing 0. I suggest
stating that in the network chapter. I enclose a suggested patch for
this too.

diff -c -r1.2 net.tex
*** net.tex 1999/02/28 19:13:08 1.2
--- net.tex 1999/03/16 17:59:15
***************
*** 79,86 ****
least-significant byte (big-endian byte-order).

\item[\code{\defn{SANE\_Char}}:] A character is currently encoded as an 8-bit
! ASCII value. An extension to support wider character sets (16 or 32
bits) is planned for the future, but not supported at this point.

\item[\code{\defn{SANE\_Handle}}:] A handle is encoded like a word.
The network backend needs to take care of converting these integer
--- 79,89 ----
least-significant byte (big-endian byte-order).

\item[\code{\defn{SANE\_Char}}:] A character is currently encoded as an 8-bit
! ISO LATIN-1 value. An extension to support wider character sets (16 or 32
bits) is planned for the future, but not supported at this point.
+
+ \item[\code{\defn{SANE\_String}}:] A string is encoded as a SANE_char
+ array. The trailing NULL byte is considered part of the array.

\item[\code{\defn{SANE\_Handle}}:] A handle is encoded like a word.
The network backend needs to take care of converting these integer

-- 
##>  Petter Reinholdtsen <##    | pere@td.org.uit.no
 O-  <SCRIPT Language="Javascript">window.close()</SCRIPT>
http://www.hungry.com/~pere/    | Go Mozilla, go! Go!

--
Source code, list archive, and docs: http://www.mostang.com/sane/
To unsubscribe: echo unsubscribe sane-devel | mail majordomo@mostang.com