GNU bug report logs - #6224
23.1; last-command docstring "multiple displays" info node link

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 6224 in the body.
You can then email your comments to 6224 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: Kevin Ryde <user42 <at> zip.com.au>
To: bug-gnu-emacs <at> gnu.org
Subject: 23.1; last-command docstring "multiple displays" info node link
Date: Thu, 20 May 2010 09:39:47 +1000

[Message part 1 (text/plain, inline)]

In the C-h v docstring of `last-command', pressing Ret on the link

    See Info node `(elisp)Multiple displays'.

gets an error

    No such node or anchor: Multiple displays

I suppose it's a typo for "Multiple Displays", in five spots altogether
in keyboard.c.  (Search and replace if the diff is out of date.)

2010-05-19  Kevin Ryde  <user42 <at> zip.com.au>

	* src/keyboard.c (last-command, keyboard-translate-table,
	overriding-terminal-local-map, system-key-alist,
	local-function-key-map): Docstring typo "Multiple Displays".

[keyboard.c.info-multiple-displays.diff (text/x-diff, inline)]

--- keyboard.c.~1.1026.~	2009-12-27 08:05:18.000000000 +1100
+++ keyboard.c	2010-05-20 09:33:41.000000000 +1000
@@ -12087,7 +12087,7 @@
 was a kill command.
 
 `last-command' has a separate binding for each terminal device.
-See Info node `(elisp)Multiple displays'.  */);
+See Info node `(elisp)Multiple Displays'.  */);
 
   DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
 		 doc: /* Same as `last-command', but never altered by Lisp code.  */);
@@ -12226,7 +12226,7 @@
 output.  See also `translation-table-for-input'.
 
 This variable has a separate binding for each terminal.  See Info node
-`(elisp)Multiple displays'.  */);
+`(elisp)Multiple Displays'.  */);
 
   DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
 	       doc: /* Non-nil means to always spawn a subshell instead of suspending.
@@ -12317,7 +12317,7 @@
 
 `overriding-terminal-local-map' has a separate binding for each
 terminal device.
-See Info node `(elisp)Multiple displays'.  */);
+See Info node `(elisp)Multiple Displays'.  */);
 
   DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
 	       doc: /* Keymap that overrides all other local keymaps.
@@ -12345,7 +12345,7 @@
 and SYMBOL is its name.
 
 `system-key-alist' has a separate binding for each terminal device.
-See Info node `(elisp)Multiple displays'.  */);
+See Info node `(elisp)Multiple Displays'.  */);
 
   DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map,
                  doc: /* Keymap that translates key sequences to key sequences during input.
@@ -12371,7 +12371,7 @@
 typing `ESC O P x' would return [f1 x].
 
 `local-function-key-map' has a separate binding for each terminal
-device.  See Info node `(elisp)Multiple displays'.  If you need to
+device.  See Info node `(elisp)Multiple Displays'.  If you need to
 define a binding on all terminals, change `function-key-map'
 instead.  Initially, `local-function-key-map' is an empty keymap that
 has `function-key-map' as its parent on all terminal devices.  */);

[Message part 3 (text/plain, inline)]

In GNU Emacs 23.1.1 (i486-pc-linux-gnu, GTK+ Version 2.16.5)
 of 2009-09-14 on raven, modified by Debian
configured using `configure  '--build=i486-linux-gnu' '--host=i486-linux-gnu' '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib' '--localstatedir=/var/lib' '--infodir=/usr/share/info' '--mandir=/usr/share/man' '--with-pop=yes' '--enable-locallisppath=/etc/emacs23:/etc/emacs:/usr/local/share/emacs/23.1/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/23.1/site-lisp:/usr/share/emacs/site-lisp:/usr/share/emacs/23.1/leim' '--with-x=yes' '--with-x-toolkit=gtk' '--with-toolkit-scroll-bars' 'build_alias=i486-linux-gnu' 'host_alias=i486-linux-gnu' 'CFLAGS=-DDEBIAN -g -O2' 'LDFLAGS=-g' 'CPPFLAGS=''

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_AU
  value of $XMODIFIERS: nil
  locale-coding-system: iso-latin-1-unix
  default-enable-multibyte-characters: t

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

From: Juri Linkov <juri <at> jurta.org>
To: Kevin Ryde <user42 <at> zip.com.au>
Cc: 6224 <at> debbugs.gnu.org
Subject: Re: bug#6224: 23.1;
	last-command docstring "multiple displays" info node link
Date: Thu, 20 May 2010 03:21:51 +0300

> In the C-h v docstring of `last-command', pressing Ret on the link
>
>     See Info node `(elisp)Multiple displays'.
>
> gets an error
>
>     No such node or anchor: Multiple displays
>
> I suppose it's a typo for "Multiple Displays", in five spots altogether
> in keyboard.c.  (Search and replace if the diff is out of date.)

BTW, do you have a command that automatically checks for broken links
in docstrings?

-- 
Juri Linkov
http://www.jurta.org/emacs/

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

From: Kevin Ryde <user42 <at> zip.com.au>
To: Juri Linkov <juri <at> jurta.org>
Cc: 6224 <at> debbugs.gnu.org
Subject: Re: bug#6224: 23.1;
	last-command docstring "multiple displays" info node link
Date: Thu, 20 May 2010 10:32:45 +1000

Juri Linkov <juri <at> jurta.org> writes:
>
> BTW, do you have a command that automatically checks for broken links
> in docstrings?

:-)  I threw down a couple of lines the other day

(defun my-emacs-info-xref-docstrings (filename-list)
  (require 'info-xref)
  (require 'lisp-mnt)
  (require 'help-mode)
  (dolist (filename filename-list)
    (lm-with-file filename
      (goto-char (point-min))
      (while (re-search-forward help-xref-info-regexp nil t)
        (let ((match (match-string 0))
              (node  (match-string 2)))
          (save-match-data ;; for the while loop
            (unless (string-match "\\`(" node)
              (setq node (concat "(emacs)" node)))
            (setq match (replace-regexp-in-string "\n" " " match))
            (setq node (replace-regexp-in-string "\n" " " node))
            (unless (or (string-match "%" node)
                        (info-xref-goto-node-p node))
              (lwarn 'emacs-info-xref-docstrings 'warning
                     "\n  %s:\n  no such node: %S"
                     filename match))))))))


to be used as say

(my-emacs-info-xref-docstrings (file-expand-wildcards "/down/emacs/src/*.c"))

or on your whole load-path

(progn
  (kill-buffer (get-buffer-create "*Warnings*"))
  (require 'cl)
  (dolist (dir load-path)
    (let ((lst (file-expand-wildcards (concat dir "/*.elc"))))
      (dolist (el (file-expand-wildcards (concat dir "/*.el")))
        (setq lst (remove (concat el "c") lst))
        (push el lst))
      (my-emacs-info-xref-docstrings lst))))

It picked up a typo in one of my own files.  I'm thinking of working it
up into a presentable form and adding to my info-xref.el (which is in
emacs).

I started with mapatoms and getting each `documentation', but a grep
through the .el doesn't load up lots of strings and can be applied to
packages without loading them.

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

From: Kevin Ryde <user42 <at> zip.com.au>
To: 6224 <at> debbugs.gnu.org
Subject: Re: bug#6224: 23.1;
	last-command docstring "multiple displays" info node link
Date: Thu, 20 May 2010 10:35:53 +1000

[Message part 1 (text/plain, inline)]

Oops, it's the emacs manual instead of the elisp manual too ...

[keyboard.c.info-multiple-displays-2.diff (text/x-diff, inline)]

--- keyboard.c.~1.1026.~	2009-12-27 08:05:18.000000000 +1100
+++ keyboard.c	2010-05-20 10:34:18.000000000 +1000
@@ -1,7 +1,7 @@
 /* Keyboard and mouse input; editor command loop.
    Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
                  1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
-                 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+                 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -12087,7 +12087,7 @@
 was a kill command.
 
 `last-command' has a separate binding for each terminal device.
-See Info node `(elisp)Multiple displays'.  */);
+See Info node `Multiple Displays'.  */);
 
   DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
 		 doc: /* Same as `last-command', but never altered by Lisp code.  */);
@@ -12226,7 +12226,7 @@
 output.  See also `translation-table-for-input'.
 
 This variable has a separate binding for each terminal.  See Info node
-`(elisp)Multiple displays'.  */);
+`Multiple Displays'.  */);
 
   DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
 	       doc: /* Non-nil means to always spawn a subshell instead of suspending.
@@ -12317,7 +12317,7 @@
 
 `overriding-terminal-local-map' has a separate binding for each
 terminal device.
-See Info node `(elisp)Multiple displays'.  */);
+See Info node `Multiple Displays'.  */);
 
   DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
 	       doc: /* Keymap that overrides all other local keymaps.
@@ -12345,7 +12345,7 @@
 and SYMBOL is its name.
 
 `system-key-alist' has a separate binding for each terminal device.
-See Info node `(elisp)Multiple displays'.  */);
+See Info node `Multiple Displays'.  */);
 
   DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map,
                  doc: /* Keymap that translates key sequences to key sequences during input.
@@ -12371,7 +12371,7 @@
 typing `ESC O P x' would return [f1 x].
 
 `local-function-key-map' has a separate binding for each terminal
-device.  See Info node `(elisp)Multiple displays'.  If you need to
+device.  See Info node `Multiple Displays'.  If you need to
 define a binding on all terminals, change `function-key-map'
 instead.  Initially, `local-function-key-map' is an empty keymap that
 has `function-key-map' as its parent on all terminal devices.  */);

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

From: Kevin Ryde <user42 <at> zip.com.au>
To: 6224 <at> debbugs.gnu.org
Subject: Re: bug#6224: 23.1;
	last-command docstring "multiple displays" info node link
Date: Thu, 20 May 2010 10:55:47 +1000

Ah dear, third time lucky!, is it meant to be

    `(elisp)Multiple Terminals'

per the merger of "Multiple Displays" and "Multiple Terminals" in
frames.texi 2009-04-04 ...

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

From: Juri Linkov <juri <at> jurta.org>
To: Kevin Ryde <user42 <at> zip.com.au>
Cc: 6224 <at> debbugs.gnu.org
Subject: Re: bug#6224: 23.1;
	last-command docstring "multiple displays" info node link
Date: Thu, 20 May 2010 03:46:33 +0300

> I'm thinking of working it up into a presentable form and adding to my
> info-xref.el (which is in emacs).

Thanks, it would be a good addition to info-xref.el.

> I started with mapatoms and getting each `documentation', but a grep
> through the .el doesn't load up lots of strings and can be applied to
> packages without loading them.

How would you check docstrings of C primitives?  Maybe checking the
etc/DOC file will help?

-- 
Juri Linkov
http://www.jurta.org/emacs/

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

From: Kevin Ryde <user42 <at> zip.com.au>
To: Juri Linkov <juri <at> jurta.org>
Cc: 6224 <at> debbugs.gnu.org
Subject: Re: bug#6224: 23.1;
	last-command docstring "multiple displays" info node link
Date: Thu, 20 May 2010 11:06:21 +1000

Juri Linkov <juri <at> jurta.org> writes:
>
> Maybe checking the etc/DOC file will help?

Ah yeah, if you don't have the .c files handy.

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

From: Chong Yidong <cyd <at> stupidchicken.com>
To: Kevin Ryde <user42 <at> zip.com.au>
Cc: 6224-done <at> debbugs.gnu.org
Subject: Re: bug#6224: 23.1;
	last-command docstring "multiple displays" info node link
Date: Thu, 20 May 2010 10:49:55 -0400

Kevin Ryde <user42 <at> zip.com.au> writes:

> Ah dear, third time lucky!, is it meant to be
>
>     `(elisp)Multiple Terminals'
>
> per the merger of "Multiple Displays" and "Multiple Terminals" in
> frames.texi 2009-04-04 ...

Fixed, thanks.

Previous Next

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