Mercurial > emacs
changeset 72719:8c9ac6f51916
(bindat-unpack): Doc fix.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Fri, 08 Sep 2006 11:59:33 +0000 |
| parents | 240ffd11cdc0 |
| children | a3c85e1915ad |
| files | lisp/emacs-lisp/bindat.el |
| diffstat | 1 files changed, 10 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/emacs-lisp/bindat.el Fri Sep 08 11:59:00 2006 +0000 +++ b/lisp/emacs-lisp/bindat.el Fri Sep 08 11:59:33 2006 +0000 @@ -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))