From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Thierry Volpiatto Newsgroups: gmane.emacs.bugs Subject: bug#70163: 29.3; hexl-mode incorrect docstring Date: Wed, 03 Apr 2024 17:04:58 +0000 Message-ID: <874jcil6md.fsf@posteo.net> References: <871q7mlc9v.fsf@posteo.net> <86plv68myf.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha512; protocol="application/pgp-signature" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="12723"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 70163@debbugs.gnu.org, Stefan Monnier To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Apr 03 19:04:22 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rs429-00034b-NQ for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 03 Apr 2024 19:04:21 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rs41v-0003ue-Il; Wed, 03 Apr 2024 13:04:08 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rs41m-0003tq-E2 for bug-gnu-emacs@gnu.org; Wed, 03 Apr 2024 13:04:00 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rs41m-0004jv-4r for bug-gnu-emacs@gnu.org; Wed, 03 Apr 2024 13:03:58 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rs41q-0005Hf-Gr for bug-gnu-emacs@gnu.org; Wed, 03 Apr 2024 13:04:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Thierry Volpiatto Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 03 Apr 2024 17:04:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 70163 X-GNU-PR-Package: emacs Original-Received: via spool by 70163-submit@debbugs.gnu.org id=B70163.171216383520257 (code B ref 70163); Wed, 03 Apr 2024 17:04:02 +0000 Original-Received: (at 70163) by debbugs.gnu.org; 3 Apr 2024 17:03:55 +0000 Original-Received: from localhost ([127.0.0.1]:59415 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rs41i-0005Ge-G4 for submit@debbugs.gnu.org; Wed, 03 Apr 2024 13:03:54 -0400 Original-Received: from mout02.posteo.de ([185.67.36.66]:55311) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rs41c-0005Fk-Os for 70163@debbugs.gnu.org; Wed, 03 Apr 2024 13:03:53 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 90522240105 for <70163@debbugs.gnu.org>; Wed, 3 Apr 2024 19:03:38 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1712163818; bh=VOPUXX65+cCBxi2FKhVvSiotTbPu+3OB8FG3x45y9dA=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Content-Type: Autocrypt:OpenPGP:From; b=Up13TEqk2ffbuffNkNUboaI1nU/XM2cgObq8JtlJlwg9KBpcDliOYD5gQX64jLco0 yACCHcIbFD7lCPXEsqaTp2FIdO6bJEo1FGUCcCuLgAaydygSzbRa0LNojgZBjBlFVv 3JUmtuCAfcrCHj75pZMp7rAWSUS8mrWy4bsRGJIRnoNkOqvI9MwlczttowBF0Q0kzl zmnVaJjb4rS9TEhZZIfQDT5/gJw+B9xU55q/hdAaLwe0agGj4J2RZhVf4ke6fUpYpF hYpo/1/HWJL2ka6klAHZZBEtoRI50WAkBvumDg6RfsrQk/hefw413RSzFn9Vd+gten NuOl19B5pgl4A== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4V8rgF3JHWz6tx8; Wed, 3 Apr 2024 19:03:37 +0200 (CEST) In-Reply-To: <86plv68myf.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 03 Apr 2024 18:50:32 +0300") Autocrypt: addr=thievol@posteo.net; prefer-encrypt=mutual; keydata=xsDNBF8ylcIBDADG+hy+zR6L4/vbdDDZuSaMmSrU3A5QZJpeBCvxTr7MpzzruZbhLPW1K3R6N2MA edi8Y+C8o27FVRIjpdbaKMGu9je7JV/TbUQYo3SOwCK1vM4LUn4V6ZLzSYkuiEt4eyMoiDdyvN0p kcK6P9x9DCetcEVszXzQg+yzCVrQ2hXWDXWT4M18EC3wtO7RHPouMqGiwBFhBAYErCqFWFxQHkfb tG/4yGyJ58rglb65O3qijjMWvYwcWZun9/7qm8Z4/4mHopmo2zgU+OrptnLSZfkZGz3Y7Uf452xQ GVq0Fv75NPvQru7y+DYVhuVXXyAmGxt+vf4rIiixMBbhKEPjcxEPAa2LTzex2IsTZR+QVG9uDnqC WcgaOEQ58fzXNvNhtwwF/Rgio2XWAJVdmFWS59/k9W58CIUSNKBMZh2XeGdEmtHvDtCxW3z6FJha 36RzOM3fMNNiAGdFZJA84gcdloJR+sHCDTTPT3784fjr+V8An7sI581NGFzkRQqPvEQCZbUAEQEA Ac0SdGhpZXZvbEBwb3N0ZW8ubmV0wsEOBBMBCgA4AhsDBQsJCAcCBhUKCQgLAgQWAgMBAh4BAheA FiEEI9twfRN7r3nig/xwDsVtFB0W75MFAmL3HCoACgkQDsVtFB0W75OVEAv/f6XxmtIFz08fUb8h Bp/zJP6IC4/rhhh+0GMRIRzLN8DK0jV8JCzYdFHiRJOy2lNIOpmrrCmjRRxferc2G42+ePFIsslx hU46VSz1Z83NwIG3mpdYNV5WUTUdgzxExHTNTFCd7NKv0nlHKQaA OpenPGP: url=https://posteo.de/keys/thievol@posteo.net.asc; preference=encrypt X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:282578 Archived-At: --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Eli Zaretskii writes: >> From: Thierry Volpiatto >> Date: Wed, 03 Apr 2024 15:02:52 +0000 >>=20 >>=20 >> Hexl-mode docstring specify "\" in its first line, this >> to specify some keybinding related to this map at end, as a result the >> documentation command returns a three line string, the first line beeing >> a blank line until hexl.el is loaded. I think docstrings generally >> should not have this specification in their first line. >>=20 >> (defun hexl-mode (&optional arg) >> "\\A mode for editing binary files in hex dump form= at. >> [...]=20 >> Most cursor movement bindings are the same: use \\[hexl-backward-c= har], >> [...] > > What do you suggest to do instead? Something like this? diff --git a/lisp/hexl.el b/lisp/hexl.el index 1288cf4d7fb..a10c1b35536 100644 =2D-- a/lisp/hexl.el +++ b/lisp/hexl.el @@ -256,7 +256,7 @@ as that will override any bit grouping options set here= ." =20 ;;;###autoload (defun hexl-mode (&optional arg) =2D "\\A mode for editing binary files in hex dump format. + "A mode for editing binary files in hex dump format. 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'. @@ -295,7 +295,7 @@ A sample format: 000000c0: 7265 6769 6f6e 2e0a region.. =20 Movement is as simple as movement in a normal Emacs text buffer. =2DMost cursor movement bindings are the same: use \\[hexl-backward-char], = \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line] +Most cursor movement bindings are the same: use \\\\[hexl-b= ackward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previ= ous-line] to move the cursor left, right, down, and up. =20 Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl= -end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are =2D-=20 Thierry --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQHHBAEBCgAxFiEEI9twfRN7r3nig/xwDsVtFB0W75MFAmYNjDoTHHRoaWV2b2xA cG9zdGVvLm5ldAAKCRAOxW0UHRbvk0a2DACBzQ5F2ug3dwVJVT4zHzqOU7jXXEYx +0WceZs8w5G3jkptn5XPXiRU9qg2fy2FnRJt15adnJsG+GqhHgE+Z03WwIy7hdjy LliDpHmjx/F952RrFNMt8bV3Y1HLx/6odjmijkT9ZaA15agsAFTJCix8RInthRYj MSXIVdvZbMdIYi1EaxnZnqU0VMvNeEAVuq07e3S2Qid2+4zy2V5BmN85Vg71C6xf J4hFNVDvzwvVyK442XfsFC7+/NpJF/jBeh0bhRf7bjN/INfy9Xuo6nfZ3ZjnfItK AwQYbLBLKjHH2/nuL3z/jXMwHVVleYLf2gvNlgsqZ29KttiNOm7M5zmser1gQGLF bvY0bkxd58Rif24efDylsioGVhqTzASRASaERDmDEMoDS4ii7WXq29SmWqoXT6+z R+v5q6qqY1g/X1dSaMvMtTspSkjxt9jdVvg0fatXkBoDp/mC+ZbWCN870iuXpoi9 9puBwv11TQbw71gjVEAmicNWUmv9OTTuIC8= =5nLU -----END PGP SIGNATURE----- --=-=-=--