GNU bug report logs - #70163
29.3; hexl-mode incorrect docstring

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: thievol <at> posteo.net, 70163 <at> debbugs.gnu.org, schwab <at> linux-m68k.org
Subject: bug#70163: 29.3; hexl-mode incorrect docstring
Date: Thu, 04 Apr 2024 16:23:34 +0300

> From: Stefan Monnier <monnier <at> iro.umontreal.ca>
> Cc: Thierry Volpiatto <thievol <at> posteo.net>,  schwab <at> linux-m68k.org,
>   70163 <at> debbugs.gnu.org
> Date: Thu, 04 Apr 2024 08:54:24 -0400
> 
> > Stefan, why do we inject this ugly blurb into the text we return when
> > the library is not loaded? why not simply return the same as RAW does
> > in those cases?
> 
> Good question.  AFAIK this predates me, so we'd have to ask Richard.
> Maybe \<hexl-mode-map> should simply never expand to anything else than the
> empty string.

Maybe.  But meanwhile, the best I can suggest is this:

diff --git a/lisp/hexl.el b/lisp/hexl.el
index 1288cf4..28441a2 100644
--- a/lisp/hexl.el
+++ b/lisp/hexl.el
@@ -256,10 +256,10 @@ hexl-line-displen
 
 ;;;###autoload
 (defun hexl-mode (&optional arg)
-  "\\<hexl-mode-map>A mode for editing binary files in hex dump format.
-This is not an ordinary major mode; it alters some aspects
+  "A mode for editing binary files in hex dump format.
+\\<hexl-mode-map>This is not an ordinary major mode; it alters some aspects
 of the current mode's behavior, but not all; also, you can exit
-Hexl mode and return to the previous mode using `hexl-mode-exit'.
+Hexl mode and return to the previous mode using \\[hexl-mode-exit].
 
 This function automatically converts a buffer into the hexl format
 using the function `hexlify-buffer'.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.