[Emacs-diffs] Changes to emacs/lisp/emacs-lisp/bindat.el,v

[Richard M. Stallman]

CVSROOT:        /cvsroot/emacs
Module name:    emacs
Changes by:     Richard M. Stallman <rms>       06/09/08 11:59:33

Index: bindat.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/emacs-lisp/bindat.el,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -b -r1.14 -r1.15
--- bindat.el   11 Aug 2006 09:26:03 -0000      1.14
+++ bindat.el   8 Sep 2006 11:59:33 -0000       1.15
@@ -66,13 +66,13 @@
 ;;
 ;;  The corresponding Lisp bindat specification looks like this:
 ;;
-;;  (setq header-spec
+;;  (setq header-bindat-spec
 ;;    '((dest-ip   ip)
 ;;     (src-ip    ip)
 ;;     (dest-port u16)
 ;;     (src-port  u16)))
 ;;
-;;  (setq data-spec
+;;  (setq data-bindat-spec
 ;;    '((type      u8)
 ;;     (opcode    u8)
 ;;     (length    u16r)  ;; little endian order
@@ -80,12 +80,12 @@
 ;;     (data      vec (length))
 ;;     (align     4)))
 ;;
-;;  (setq packet-spec
-;;    '((header    struct header-spec)
+;;  (setq packet-bindat-spec
+;;    '((header    struct header-bindat-spec)
 ;;     (items     u8)
 ;;     (fill      3)
 ;;     (item      repeat (items)
-;;                (struct data-spec))))
+;;                (struct data-bindat-spec))))
 ;;
 ;;
 ;;  A binary data representation may look like
@@ -121,6 +121,9 @@
 ;; Binary Data Structure Specification Format
 ;; ------------------------------------------
 
+;; We recommend using names that end in `-bindat-spec'; such names
+;; are recognized automatically as "risky" variables.
+
 ;; The data specification is formatted as follows:
 
 ;; SPEC    ::= ( ITEM... )
@@ -342,8 +345,8 @@
 
 (defun bindat-unpack (spec bindat-raw &optional bindat-idx)
   "Return structured data according to SPEC for binary data in BINDAT-RAW.
-BINDAT-RAW is a unibyte string or vector.  Optional third arg BINDAT-IDX 
specifies
-the starting offset in BINDAT-RAW."
+BINDAT-RAW is a unibyte string or vector.
+Optional third arg BINDAT-IDX specifies the starting offset in BINDAT-RAW."
   (when (multibyte-string-p bindat-raw)
     (error "String is multibyte"))
   (unless bindat-idx (setq bindat-idx 0))