GNU bug report logs - #8273
23.3; Problem with docstring for `debug'

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 8273 in the body.
You can then email your comments to 8273 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Reuben Thomas <rrt <at> sc3d.org>
To: bug-gnu-emacs <at> gnu.org
Subject: 23.3; Problem with docstring for `debug'
Date: Thu, 17 Mar 2011 14:50:59 +0000

Start emacs -Q; type:

C-h f debug RET

It says:

Enter debugger. To return, type
Uses keymap...

The keybinding at the end of the first line is missing, I guess because
debugger-continue hasn’t been autoloaded in any form.


In GNU Emacs 23.3.2 (i686-pc-linux-gnu, GTK+ Version 2.22.0)
 of 2011-03-02 on canta
Windowing system distributor `The X.Org Foundation', version 11.0.10900000
Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: en_GB.UTF-8
  value of $XMODIFIERS: nil
  locale-coding-system: utf-8-unix
  default enable-multibyte-characters: t

Major mode: Emacs-Lisp

Minor modes in effect:
  diff-auto-refine-mode: t
  recentf-mode: t
  show-paren-mode: t
  savehist-mode: t
  minibuffer-electric-default-mode: t
  iswitchb-mode: t
  icomplete-mode: t
  global-whitespace-mode: t
  global-auto-revert-mode: t
  desktop-save-mode: t
  mouse-wheel-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  column-number-mode: t
  line-number-mode: t
  transient-mark-mode: t

Recent input:
C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n 
C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-w C-_ C-x 
b <return> C-a C-y C-k C-p C-n C-n C-n C-n C-n C-n 
C-n C-n C-p C-p C-p C-p C-p C-p C-p C-p C-p C-p C-p 
C-p C-e C-b C-b <M-backspace> <M-backspace> d e b u 
g C-n <right> <right> <right> <M-backspace> <backspace> 
<down> <down> C-a E n t e r SPC L u a SPC d e b u g 
g <M-backspace> <M-backspace> C-h f d e b u g g e r 
<return> <backspace> <backspace> <backspace> <return> 
C-n C-n C-n C-n C-SPC C-f C-f C-f C-f C-f C-f C-f C-f 
C-f C-f C-f C-f C-f C-f C-f C-f C-w C-e C-e C-e C-e 
C-e <up> <up> C-x k <return> C-h f <up> <return> <right> 
<right> <right> <right> <right> <right> <right> <right> 
<right> <right> <right> <right> <right> <right> <right> 
<right> <right> <right> <right> <right> <right> <right> 
<right> <right> <right> <right> <right> <right> <right> 
<right> <right> <right> <right> <right> <right> <right> 
<right> <right> <right> <right> <right> <right> <right> 
<right> <right> <right> <right> <right> <right> <right> 
<right> <right> <right> <right> <right> <return> C-s 
t o SPC C-a C-x o C-h w d e b u g f g e r <backspace> 
<backspace> <backspace> <backspace> g e r - c o n t 
i n u e <return> <return> C-g C-x o C-s d e b u g g 
e r - c o n t n u e <backspace> <backspace> <backspace> 
o n u i i <backspace> <backspace> <backspace> <backspace> 
<backspace> i n u e C-s C-s C-s C-s C-s C-a C-s C-s 
C-s C-r C-r M-x r e p o r t - a <backspace> e m a c 
s - b u g <return>

Recent messages:
Type "q" to restore this window.
Mark set
Read only text copied to kill ring
Type "q" to restore this window.
Auto-saving...done
uncompressing debug.el.gz...done
Note: file is write protected
Mark saved where search started
Quit
Mark saved where search started [2 times]

Load-path shadows:
/home/rrt/local/share/emacs/site-lisp/popup hides /usr/local/share/emacs/23.3/site-lisp/auto-complete/popup
/home/rrt/local/share/emacs/site-lisp/fuzzy hides /usr/local/share/emacs/23.3/site-lisp/auto-complete/fuzzy
/home/rrt/.emacs.d/elpa/css-mode-1.0/css-mode hides /usr/local/share/emacs/23.3/site-lisp/css-mode/css-mode
/home/rrt/.emacs.d/elpa/dictionary-1.8.7/link hides /usr/local/share/emacs/23.3/site-lisp/dictionary-el/link
/home/rrt/.emacs.d/elpa/dictionary-1.8.7/connection hides /usr/local/share/emacs/23.3/site-lisp/dictionary-el/connection
/home/rrt/.emacs.d/elpa/dictionary-1.8.7/dictionary-init hides /usr/local/share/emacs/23.3/site-lisp/dictionary-el/dictionary-init
/home/rrt/.emacs.d/elpa/dictionary-1.8.7/dictionary hides /usr/local/share/emacs/23.3/site-lisp/dictionary-el/dictionary
/home/rrt/local/share/emacs/site-lisp/dict hides /usr/local/share/emacs/23.3/site-lisp/emacs-goodies-el/dict
/home/rrt/.emacs.d/elpa/css-mode-1.0/css-mode hides /usr/local/share/emacs/23.3/lisp/textmodes/css-mode
/usr/share/emacs-snapshot/site-lisp/ruby1.8-elisp/ruby-mode hides /usr/local/share/emacs/23.3/lisp/progmodes/ruby-mode
/home/rrt/.emacs.d/elpa/css-mode-1.0/css-mode hides /usr/share/emacs/site-lisp/css-mode/css-mode
/usr/local/share/emacs/23.3/site-lisp/auctex/tex-info hides /usr/share/emacs/site-lisp/auctex/tex-info
/usr/local/share/emacs/23.3/site-lisp/auctex/context-nl hides /usr/share/emacs/site-lisp/auctex/context-nl
/usr/local/share/emacs/23.3/site-lisp/auctex/context-en hides /usr/share/emacs/site-lisp/auctex/context-en
/usr/local/share/emacs/23.3/site-lisp/auctex/latex hides /usr/share/emacs/site-lisp/auctex/latex
/usr/local/share/emacs/23.3/site-lisp/auctex/tex-mik hides /usr/share/emacs/site-lisp/auctex/tex-mik
/usr/local/share/emacs/23.3/site-lisp/dictionary-el/lpath hides /usr/share/emacs/site-lisp/auctex/lpath
/usr/local/share/emacs/23.3/site-lisp/auctex/tex-buf hides /usr/share/emacs/site-lisp/auctex/tex-buf
/usr/local/share/emacs/23.3/site-lisp/auctex/tex-jp hides /usr/share/emacs/site-lisp/auctex/tex-jp
/usr/local/share/emacs/23.3/site-lisp/auctex/tex-bar hides /usr/share/emacs/site-lisp/auctex/tex-bar
/usr/local/share/emacs/23.3/site-lisp/auctex/tex hides /usr/share/emacs/site-lisp/auctex/tex
/usr/local/share/emacs/23.3/site-lisp/auctex/multi-prompt hides /usr/share/emacs/site-lisp/auctex/multi-prompt
/usr/local/share/emacs/23.3/site-lisp/auctex/tex-fptex hides /usr/share/emacs/site-lisp/auctex/tex-fptex
/usr/local/share/emacs/23.3/site-lisp/auctex/tex-font hides /usr/share/emacs/site-lisp/auctex/tex-font
/usr/local/share/emacs/23.3/site-lisp/auctex/tex-fold hides /usr/share/emacs/site-lisp/auctex/tex-fold
/usr/local/share/emacs/23.3/site-lisp/auctex/texmathp hides /usr/share/emacs/site-lisp/auctex/texmathp
/usr/local/share/emacs/23.3/site-lisp/auctex/context hides /usr/share/emacs/site-lisp/auctex/context
/usr/local/share/emacs/23.3/site-lisp/auctex/font-latex hides /usr/share/emacs/site-lisp/auctex/font-latex
/usr/local/share/emacs/23.3/site-lisp/auctex/bib-cite hides /usr/share/emacs/site-lisp/auctex/bib-cite
/usr/local/share/emacs/23.3/site-lisp/auctex/toolbar-x hides /usr/share/emacs/site-lisp/auctex/toolbar-x
/usr/local/share/emacs/23.3/site-lisp/auctex/tex-style hides /usr/share/emacs/site-lisp/auctex/tex-style

Features:
(shadow sort mail-extr message sendmail ecomplete rfc822 mml mml-sec
password-cache mm-decode mm-bodies mm-encode mailcap mail-parse rfc2231
rfc2047 rfc2045 qp ietf-drums mailabbrev nnheader gnus-util netrc
time-date mm-util mail-prsvr gmm-utils mailheader canlock hashcash
mail-utils emacsbug find-func arc-mode archive-mode vc-annotate grep
compile log-edit pcvs-util vc vc-dispatcher apropos help-mode view
add-log time-stamp multi-isearch sgml-mode nxml-uchnm rng-xsd xsd-regexp
rng-cmpct rng-nxml rng-valid rng-loc rng-uri rng-parse nxml-parse
rng-match rng-dt rng-util rng-pttrn nxml-ns nxml-mode nxml-outln
nxml-rap nxml-util nxml-glyph nxml-enc xmltok vc-bzr sha1 hex-util
parse-time vc-cvs tex-info texinfo tex jka-compr info m4-mode sh-script
executable diff-git diff-mode autoconf autoconf-mode inform-mode
noutline outline make-mode apache-mode vc-git face-remap filladapt
flyspell cperl-mode completing-help recentf tree-widget wid-edit
uniquify paren savehist minibuf-eldef iswitchb icomplete whitespace
autorevert time cus-start cus-load desktop server php-mode etags
cc-langs cc-mode cc-fonts cc-menus cc-cmds cc-styles cc-align cc-engine
cc-vars cc-defs speedbar sb-image ezimage dframe lua-mode regexp-opt
comint ring ropemacs pymacs smart-quotes ffap ispell
auto-dictionary-autoloads c-eldoc-autoloads css-mode-autoloads
dictionary-autoloads diff-git-autoloads dired-isearch-autoloads
full-ack-autoloads guess-style-autoloads javascript-autoloads
kill-ring-search-autoloads lambdacalc-autoloads magit-autoloads
mv-shell-autoloads tumble-autoloads http-post-simple-autoloads package
reporter advice advice-preload yasnippet help-fns derived edmacro kmacro
easymenu assoc cl cl-19 muse-autoloads emacs-goodies-el
emacs-goodies-custom emacs-goodies-loaddefs easy-mmode bbdb-autoloads
preview-latex tex-site auto-loads tooltip ediff-hook vc-hooks
lisp-float-type mwheel x-win x-dnd font-setting tool-bar dnd fontset
image fringe lisp-mode register page menu-bar rfn-eshadow timer select
scroll-bar mldrag mouse jit-lock font-lock syntax facemenu font-core
frame cham georgian utf-8-lang misc-lang vietnamese tibetan thai
tai-viet lao korean japanese hebrew greek romanian slovak czech european
ethiopic indian cyrillic chinese case-table epa-hook jka-cmpr-hook help
simple abbrev loaddefs button minibuffer faces cus-face files
text-properties overlay md5 base64 format env code-pages mule custom
widget hashtable-print-readable backquote make-network-process dbusbind
system-font-setting font-render-setting gtk x-toolkit x multi-tty emacs)

-- 
http://rrt.sc3d.org/

Message #8 received at 8273 <at> debbugs.gnu.org (full text, mbox):

From: Juanma Barranquero <lekktu <at> gmail.com>
To: Reuben Thomas <rrt <at> sc3d.org>
Cc: 8273 <at> debbugs.gnu.org
Subject: Re: bug#8273: 23.3; Problem with docstring for `debug'
Date: Thu, 17 Mar 2011 21:09:28 +0100

> It says:
>
> Enter debugger. To return, type
> Uses keymap...
>
> The keybinding at the end of the first line is missing, I guess because
> debugger-continue hasn’t been autoloaded in any form.

Yes. This is not specific to debug. Any docstring that includes a
keymap which has not yet been loaded suffers this problem.

    Juanma

Message #11 received at 8273 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: Juanma Barranquero <lekktu <at> gmail.com>
Cc: 8273 <at> debbugs.gnu.org, Reuben Thomas <rrt <at> sc3d.org>
Subject: Re: bug#8273: 23.3; Problem with docstring for `debug'
Date: Thu, 14 Jul 2011 21:00:34 +0200

Juanma Barranquero <lekktu <at> gmail.com> writes:

> Yes. This is not specific to debug. Any docstring that includes a
> keymap which has not yet been loaded suffers this problem.

So basically any autoloaded function that refers to a keymap in the doc
string will have incomplete doc strings?  (Until the file is loaded, of
course.)

That sounds unfortunate.  Should a dummy string be inserted into these
strings by `documentation' or something?  To at least show that there's
something missing?

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Message #14 received at 8273 <at> debbugs.gnu.org (full text, mbox):

From: Andreas Schwab <schwab <at> linux-m68k.org>
To: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
Cc: Juanma Barranquero <lekktu <at> gmail.com>, 8273 <at> debbugs.gnu.org,
	Reuben Thomas <rrt <at> sc3d.org>
Subject: Re: bug#8273: 23.3; Problem with docstring for `debug'
Date: Thu, 14 Jul 2011 21:25:16 +0200

Lars Magne Ingebrigtsen <larsi <at> gnus.org> writes:

> That sounds unfortunate.  Should a dummy string be inserted into these
> strings by `documentation' or something?  To at least show that there's
> something missing?

It already does.

Andreas.

-- 
Andreas Schwab, schwab <at> linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Message #17 received at 8273 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: Andreas Schwab <schwab <at> linux-m68k.org>
Cc: Juanma Barranquero <lekktu <at> gmail.com>, 8273 <at> debbugs.gnu.org,
	Reuben Thomas <rrt <at> sc3d.org>
Subject: Re: bug#8273: 23.3; Problem with docstring for `debug'
Date: Thu, 14 Jul 2011 21:27:39 +0200

Andreas Schwab <schwab <at> linux-m68k.org> writes:

> Lars Magne Ingebrigtsen <larsi <at> gnus.org> writes:
>
>> That sounds unfortunate.  Should a dummy string be inserted into these
>> strings by `documentation' or something?  To at least show that there's
>> something missing?
>
> It already does.

Ok; closing the bug now.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Message #22 received at 8273 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
Cc: Juanma Barranquero <lekktu <at> gmail.com>,
	Andreas Schwab <schwab <at> linux-m68k.org>, 8273 <at> debbugs.gnu.org,
	Reuben Thomas <rrt <at> sc3d.org>
Subject: Re: bug#8273: 23.3; Problem with docstring for `debug'
Date: Thu, 14 Jul 2011 16:25:38 -0400

Lars Magne Ingebrigtsen wrote:

>>> That sounds unfortunate.  Should a dummy string be inserted into these
>>> strings by `documentation' or something?  To at least show that there's
>>> something missing?
>>
>> It already does.
>
> Ok; closing the bug now.

Uhm, the actual issue is exactly the same as originally described.

C-h f debug

  Enter debugger.  To return, type 
  Uses keymap "debugger-mode-map", which is not currently defined.
  `M-x debugger-continue'.

Do you think this looks right? Because I don't.

Message #25 received at 8273 <at> debbugs.gnu.org (full text, mbox):

From: Andreas Schwab <schwab <at> linux-m68k.org>
To: Glenn Morris <rgm <at> gnu.org>
Cc: Juanma Barranquero <lekktu <at> gmail.com>,
	Lars Magne Ingebrigtsen <larsi <at> gnus.org>, 8273 <at> debbugs.gnu.org,
	Reuben Thomas <rrt <at> sc3d.org>
Subject: Re: bug#8273: 23.3; Problem with docstring for `debug'
Date: Thu, 14 Jul 2011 22:33:29 +0200

Glenn Morris <rgm <at> gnu.org> writes:

> Uhm, the actual issue is exactly the same as originally described.
>
> C-h f debug
>
>   Enter debugger.  To return, type 
>   Uses keymap "debugger-mode-map", which is not currently defined.
>   `M-x debugger-continue'.
>
> Do you think this looks right? Because I don't.

Move \{debugger-mode-map} at the start of the sentence?

Andreas.

-- 
Andreas Schwab, schwab <at> linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Message #28 received at 8273 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Andreas Schwab <schwab <at> linux-m68k.org>
Cc: Juanma Barranquero <lekktu <at> gmail.com>,
	Lars Magne Ingebrigtsen <larsi <at> gnus.org>, 8273 <at> debbugs.gnu.org,
	Reuben Thomas <rrt <at> sc3d.org>
Subject: Re: bug#8273: 23.3; Problem with docstring for `debug'
Date: Thu, 14 Jul 2011 16:46:00 -0400

Andreas Schwab wrote:

> Move \{debugger-mode-map} at the start of the sentence?

   Enter debugger.  \\<debugger-mode-map>`\\[debugger-continue]' returns from the debugger.

   Enter debugger.
   Uses keymap "debugger-mode-map", which is not currently defined.
   `M-x debugger-continue' returns from the debugger.

   Enter debugger.  `c' returns from the debugger.

Yeah, it's not bad IMO...

Message #31 received at 8273 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: Glenn Morris <rgm <at> gnu.org>
Cc: Juanma Barranquero <lekktu <at> gmail.com>,
	Andreas Schwab <schwab <at> linux-m68k.org>, 8273 <at> debbugs.gnu.org,
	Reuben Thomas <rrt <at> sc3d.org>
Subject: Re: bug#8273: 23.3; Problem with docstring for `debug'
Date: Fri, 15 Jul 2011 01:19:20 +0200

Glenn Morris <rgm <at> gnu.org> writes:

> Lars Magne Ingebrigtsen wrote:
>
>>>> That sounds unfortunate.  Should a dummy string be inserted into these
>>>> strings by `documentation' or something?  To at least show that there's
>>>> something missing?
>>>
>>> It already does.
>>
>> Ok; closing the bug now.
>
> Uhm, the actual issue is exactly the same as originally described.

I always take Andreas at his word.  :-)

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Previous Next

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