aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2014-03-04 15:13:41 +0100
committerJuanma Barranquero2014-03-04 15:13:41 +0100
commitb01fa8381fa2f5762d1c1b7328a6c10fc3797eda (patch)
tree7b037a720aad87fd8a416bb6b637bf8eaa4e88c1
parent4242d21d559884e08e5b1bf13fbf8749de9b62d9 (diff)
downloademacs-b01fa8381fa2f5762d1c1b7328a6c10fc3797eda.tar.gz
emacs-b01fa8381fa2f5762d1c1b7328a6c10fc3797eda.zip
lisp/hexl.el: Fix typos in docstrings.
(hexl-address-region, hexl-ascii-region) (hexl-goto-hex-address, hexl-backward-char, hexl-forward-char) (hexl-backward-short, hexl-forward-short, hexl-backward-word) (hexl-forward-word, hexl-previous-line, hexl-next-line): Use "Hexl mode" for non-hyperlinked hexl-mode references in docstrings. (hexl-mode): Doc fix. (hexl-ascii-start-column, hexl-beginning-of-line, hexl-end-of-line) (hexl-mode-ruler): Fix typos in docstrings.
-rw-r--r--lisp/ChangeLog9
-rw-r--r--lisp/hexl.el40
2 files changed, 29 insertions, 20 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 4b4b85b4a47..e361990693d 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,14 @@
12014-03-04 Juanma Barranquero <lekktu@gmail.com> 12014-03-04 Juanma Barranquero <lekktu@gmail.com>
2 2
3 * hexl.el (hexl-address-region, hexl-ascii-region)
4 (hexl-goto-hex-address, hexl-backward-char, hexl-forward-char)
5 (hexl-backward-short, hexl-forward-short, hexl-backward-word)
6 (hexl-forward-word, hexl-previous-line, hexl-next-line):
7 Use "Hexl mode" for non-hyperlinked hexl-mode references in docstrings.
8 (hexl-mode): Doc fix.
9 (hexl-ascii-start-column, hexl-beginning-of-line, hexl-end-of-line)
10 (hexl-mode-ruler): Fix typos in docstrings.
11
3 * strokes.el (strokes-xpm-header, strokes-rate-stroke): Fix typos. 12 * strokes.el (strokes-xpm-header, strokes-rate-stroke): Fix typos.
4 (strokes-character, strokes-get-grid-position, strokes-list-strokes): 13 (strokes-character, strokes-get-grid-position, strokes-list-strokes):
5 Remove superfluous backslashes. 14 Remove superfluous backslashes.
diff --git a/lisp/hexl.el b/lisp/hexl.el
index 16948df96b0..5c23f491761 100644
--- a/lisp/hexl.el
+++ b/lisp/hexl.el
@@ -95,12 +95,12 @@ as that will override any bit grouping options set here."
95 95
96(defface hexl-address-region 96(defface hexl-address-region
97 '((t (:inherit header-line))) 97 '((t (:inherit header-line)))
98 "Face used in address area of hexl-mode buffer." 98 "Face used in address area of Hexl mode buffer."
99 :group 'hexl) 99 :group 'hexl)
100 100
101(defface hexl-ascii-region 101(defface hexl-ascii-region
102 '((t (:inherit header-line))) 102 '((t (:inherit header-line)))
103 "Face used in ascii area of hexl-mode buffer." 103 "Face used in ASCII area of Hexl mode buffer."
104 :group 'hexl) 104 :group 'hexl)
105 105
106(defvar hexl-max-address 0 106(defvar hexl-max-address 0
@@ -282,10 +282,10 @@ using the function `hexlify-buffer'.
282Each line in the buffer has an \"address\" (displayed in hexadecimal) 282Each line in the buffer has an \"address\" (displayed in hexadecimal)
283representing the offset into the file that the characters on this line 283representing the offset into the file that the characters on this line
284are at and 16 characters from the file (displayed as hexadecimal 284are at and 16 characters from the file (displayed as hexadecimal
285values grouped every `hexl-bits' bits) and as their ASCII values. 285values grouped every `hexl-bits' bits, and as their ASCII values).
286 286
287If any of the characters (displayed as ASCII characters) are 287If any of the characters (displayed as ASCII characters) are
288unprintable (control or meta characters) they will be replaced as 288unprintable (control or meta characters) they will be replaced by
289periods. 289periods.
290 290
291If `hexl-mode' is invoked with an argument the buffer is assumed to be 291If `hexl-mode' is invoked with an argument the buffer is assumed to be
@@ -309,8 +309,8 @@ A sample format:
309 000000b0: 7461 626c 6520 6368 6172 6163 7465 7220 table character 309 000000b0: 7461 626c 6520 6368 6172 6163 7465 7220 table character
310 000000c0: 7265 6769 6f6e 2e0a region.. 310 000000c0: 7265 6769 6f6e 2e0a region..
311 311
312Movement is as simple as movement in a normal Emacs text buffer. Most 312Movement is as simple as movement in a normal Emacs text buffer.
313cursor movement bindings are the same: use \\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line] 313Most cursor movement bindings are the same: use \\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line]
314to move the cursor left, right, down, and up. 314to move the cursor left, right, down, and up.
315 315
316Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl-end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are 316Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl-end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are
@@ -335,7 +335,7 @@ into the buffer at the current point.
335\\[hexl-insert-decimal-char] will insert a given decimal value (if it is between 0 and 255) 335\\[hexl-insert-decimal-char] will insert a given decimal value (if it is between 0 and 255)
336into the buffer at the current point. 336into the buffer at the current point.
337 337
338\\[hexl-mode-exit] will exit hexl-mode. 338\\[hexl-mode-exit] will exit `hexl-mode'.
339 339
340Note: saving the file with any of the usual Emacs commands 340Note: saving the file with any of the usual Emacs commands
341will actually convert it back to binary format while saving. 341will actually convert it back to binary format while saving.
@@ -565,7 +565,7 @@ This function is intended to be used as eldoc callback."
565 (format "Current address is %d/0x%08x" addr addr))) 565 (format "Current address is %d/0x%08x" addr addr)))
566 566
567(defun hexl-ascii-start-column () 567(defun hexl-ascii-start-column ()
568 "Column at which the ascii portion of the hexl display starts." 568 "Column at which the ASCII portion of the hexl display starts."
569 (+ 43 (/ 128 hexl-bits))) 569 (+ 43 (/ 128 hexl-bits)))
570 570
571(defun hexl-address-to-marker (address) 571(defun hexl-address-to-marker (address)
@@ -586,7 +586,7 @@ Signal error if ADDRESS is out of range."
586 (goto-char (hexl-address-to-marker address))) 586 (goto-char (hexl-address-to-marker address)))
587 587
588(defun hexl-goto-hex-address (hex-address) 588(defun hexl-goto-hex-address (hex-address)
589 "Go to hexl-mode address (hex string) HEX-ADDRESS. 589 "Go to Hexl mode address (hex string) HEX-ADDRESS.
590Signal error if HEX-ADDRESS is out of range." 590Signal error if HEX-ADDRESS is out of range."
591 (interactive "sHex Address: ") 591 (interactive "sHex Address: ")
592 (hexl-goto-address (hexl-hex-string-to-integer hex-address))) 592 (hexl-goto-address (hexl-hex-string-to-integer hex-address)))
@@ -615,17 +615,17 @@ Signal error if HEX-ADDRESS is out of range."
615;; move point functions 615;; move point functions
616 616
617(defun hexl-backward-char (arg) 617(defun hexl-backward-char (arg)
618 "Move to left ARG bytes (right if ARG negative) in hexl-mode." 618 "Move to left ARG bytes (right if ARG negative) in Hexl mode."
619 (interactive "p") 619 (interactive "p")
620 (hexl-goto-address (- (hexl-current-address) arg))) 620 (hexl-goto-address (- (hexl-current-address) arg)))
621 621
622(defun hexl-forward-char (arg) 622(defun hexl-forward-char (arg)
623 "Move to right ARG bytes (left if ARG negative) in hexl-mode." 623 "Move to right ARG bytes (left if ARG negative) in Hexl mode."
624 (interactive "p") 624 (interactive "p")
625 (hexl-goto-address (+ (hexl-current-address) arg))) 625 (hexl-goto-address (+ (hexl-current-address) arg)))
626 626
627(defun hexl-backward-short (arg) 627(defun hexl-backward-short (arg)
628 "Move to left ARG shorts (right if ARG negative) in hexl-mode." 628 "Move to left ARG shorts (right if ARG negative) in Hexl mode."
629 (interactive "p") 629 (interactive "p")
630 (hexl-goto-address (let ((address (hexl-current-address))) 630 (hexl-goto-address (let ((address (hexl-current-address)))
631 (if (< arg 0) 631 (if (< arg 0)
@@ -657,12 +657,12 @@ Signal error if HEX-ADDRESS is out of range."
657 address))) 657 address)))
658 658
659(defun hexl-forward-short (arg) 659(defun hexl-forward-short (arg)
660 "Move to right ARG shorts (left if ARG negative) in hexl-mode." 660 "Move to right ARG shorts (left if ARG negative) in Hexl mode."
661 (interactive "p") 661 (interactive "p")
662 (hexl-backward-short (- arg))) 662 (hexl-backward-short (- arg)))
663 663
664(defun hexl-backward-word (arg) 664(defun hexl-backward-word (arg)
665 "Move to left ARG words (right if ARG negative) in hexl-mode." 665 "Move to left ARG words (right if ARG negative) in Hexl mode."
666 (interactive "p") 666 (interactive "p")
667 (hexl-goto-address (let ((address (hexl-current-address))) 667 (hexl-goto-address (let ((address (hexl-current-address)))
668 (if (< arg 0) 668 (if (< arg 0)
@@ -694,18 +694,18 @@ Signal error if HEX-ADDRESS is out of range."
694 address))) 694 address)))
695 695
696(defun hexl-forward-word (arg) 696(defun hexl-forward-word (arg)
697 "Move to right ARG words (left if ARG negative) in hexl-mode." 697 "Move to right ARG words (left if ARG negative) in Hexl mode."
698 (interactive "p") 698 (interactive "p")
699 (hexl-backward-word (- arg))) 699 (hexl-backward-word (- arg)))
700 700
701(defun hexl-previous-line (arg) 701(defun hexl-previous-line (arg)
702 "Move vertically up ARG lines [16 bytes] (down if ARG negative) in hexl-mode. 702 "Move vertically up ARG lines [16 bytes] (down if ARG negative) in Hexl mode.
703If there is no byte at the target address move to the last byte in that line." 703If there is no byte at the target address move to the last byte in that line."
704 (interactive "p") 704 (interactive "p")
705 (hexl-next-line (- arg))) 705 (hexl-next-line (- arg)))
706 706
707(defun hexl-next-line (arg) 707(defun hexl-next-line (arg)
708 "Move vertically down ARG lines [16 bytes] (up if ARG negative) in hexl-mode. 708 "Move vertically down ARG lines [16 bytes] (up if ARG negative) in Hexl mode.
709If there is no byte at the target address move to the last byte in that line." 709If there is no byte at the target address move to the last byte in that line."
710 (interactive "p") 710 (interactive "p")
711 (hexl-goto-address (let ((address (+ (hexl-current-address) (* arg 16)))) 711 (hexl-goto-address (let ((address (+ (hexl-current-address) (* arg 16))))
@@ -739,12 +739,12 @@ With prefix arg N, puts point N bytes of the way from the true beginning."
739 (hexl-goto-address (- hexl-max-address (1- arg)))) 739 (hexl-goto-address (- hexl-max-address (1- arg))))
740 740
741(defun hexl-beginning-of-line () 741(defun hexl-beginning-of-line ()
742 "Goto beginning of line in hexl mode." 742 "Goto beginning of line in Hexl mode."
743 (interactive) 743 (interactive)
744 (goto-char (+ (* (/ (point) (hexl-line-displen)) (hexl-line-displen)) 11))) 744 (goto-char (+ (* (/ (point) (hexl-line-displen)) (hexl-line-displen)) 11)))
745 745
746(defun hexl-end-of-line () 746(defun hexl-end-of-line ()
747 "Goto end of line in hexl mode." 747 "Goto end of line in Hexl mode."
748 (interactive) 748 (interactive)
749 (hexl-goto-address (let ((address (logior (hexl-current-address) 15))) 749 (hexl-goto-address (let ((address (logior (hexl-current-address) 15)))
750 (if (> address hexl-max-address) 750 (if (> address hexl-max-address)
@@ -1099,7 +1099,7 @@ This function is assumed to be used as callback function for `hl-line-mode'."
1099 )) 1099 ))
1100 1100
1101(defun hexl-mode-ruler () 1101(defun hexl-mode-ruler ()
1102 "Return a string ruler for hexl mode." 1102 "Return a string ruler for Hexl mode."
1103 (let* ((highlight (mod (hexl-current-address) 16)) 1103 (let* ((highlight (mod (hexl-current-address) 16))
1104 (s (cdr (assq hexl-bits hexl-rulers))) 1104 (s (cdr (assq hexl-bits hexl-rulers)))
1105 (pos 0)) 1105 (pos 0))