Re: Online help and help-for-help improvements

[storm@cua.dk (Kim F. Storm)]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>>>> One way would be to simply add aliases for the new names
>>>> now for 22.2 release, and declare the old names obsolete
>>> 

Here's a patch for the Emacs 22 branch:

Index: etc/NEWS
===================================================================
RCS file: /cvsroot/emacs/emacs/etc/NEWS,v
retrieving revision 1.1465.2.66
diff -u -r1.1465.2.66 NEWS
--- etc/NEWS	3 Mar 2008 03:28:33 -0000	1.1465.2.66
+++ etc/NEWS	4 Mar 2008 18:11:41 -0000
@@ -42,8 +42,22 @@
 
 ** Support for GNU/kFreeBSD (GNU userland and FreeBSD kernel) was added.
 
 * Changes in Emacs 22.2
 
+** `describe-project' is renamed to `describe-gnu-project'.
+
+** `view-todo' is renamed to `view-emacs-news'.
+
 ** `find-name-dired' now uses -iname rather than -name
 for case-insensitive filesystems.  The default behavior is determined
 by the value of `read-file-name-completion-ignore-case'; if you don't

Index: lisp/help.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/help.el,v
retrieving revision 1.327.2.4
diff -u -r1.327.2.4 help.el
--- lisp/help.el	7 Jan 2008 02:44:43 -0000	1.327.2.4
+++ lisp/help.el	4 Mar 2008 18:13:05 -0000
@@ -53,8 +53,8 @@
     (define-key map "\C-f" 'view-emacs-FAQ)
     (define-key map "\C-m" 'view-order-manuals)
     (define-key map "\C-n" 'view-emacs-news)
-    (define-key map "\C-p" 'describe-project)
-    (define-key map "\C-t" 'view-todo)
+    (define-key map "\C-p" 'describe-gnu-project)
+    (define-key map "\C-t" 'view-emacs-todo)
     (define-key map "\C-w" 'describe-no-warranty)
 
     ;; This does not fit the pattern, but it is natural given the C-\ command.
@@ -292,7 +292,10 @@
   (view-file (expand-file-name "COPYING" data-directory))
   (goto-char (point-min)))
 
-(defun describe-project ()
+(defalias 'describe-project 'describe-gnu-project
+  "Display info on the GNU project.
+This function is deprecated.  Use `describe-gnu-project' instead.")
+(defun describe-gnu-project ()
   "Display info on the GNU project."
   (interactive)
   (view-file (expand-file-name "THE-GNU-PROJECT" data-directory))
@@ -396,7 +399,10 @@
 	   (point)))))))
 
 
-(defun view-todo (&optional arg)
+(defalias 'view-todo 'view-emacs-todo
+  "Display the Emacs TODO list.
+This function is deprecated.  Use `view-emacs-todo' instead.")
+(defun view-emacs-todo (&optional arg)
   "Display the Emacs TODO list."
   (interactive "P")
   (view-file (expand-file-name "TODO" data-directory)))

Index: lisp/menu-bar.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/menu-bar.el,v
retrieving revision 1.302.2.8
diff -u -r1.302.2.8 menu-bar.el
--- lisp/menu-bar.el	7 Jan 2008 02:44:30 -0000	1.302.2.8
+++ lisp/menu-bar.el	4 Mar 2008 18:13:41 -0000
@@ -1341,7 +1341,7 @@
 	      :help "Read the Introduction to Emacs Lisp Programming"))
 
 (define-key menu-bar-help-menu [about-gnu-project]
-  '(menu-item "About GNU" describe-project
+  '(menu-item "About GNU" describe-gnu-project
 	      :help "About the GNU System, GNU Project, and GNU/Linux"))
 (define-key menu-bar-help-menu [about-emacs]
   '(menu-item "About Emacs" about-emacs

Index: lisp/startup.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/startup.el,v
retrieving revision 1.436.2.15
diff -u -r1.436.2.15 startup.el
--- lisp/startup.el	2 Mar 2008 16:17:57 -0000	1.436.2.15
+++ lisp/startup.el	4 Mar 2008 18:14:03 -0000
@@ -1148,7 +1148,7 @@
 	   '("GNU/Linux"
 	     (lambda (button) (browse-url "http://www.gnu.org/gnu/linux-and-gnu.html"))
 	     "Browse http://www.gnu.org/gnu/linux-and-gnu.html")
-	 '("GNU" (lambda (button) (describe-project))
+	 '("GNU" (lambda (button) (describe-gnu-project))
 	   "Display info on the GNU project")))
      " operating system.\n"
      :face variable-pitch "To quit a partially entered command, type "
@@ -1207,7 +1207,7 @@
 	   '("GNU/Linux"
 	     (lambda (button) (browse-url "http://www.gnu.org/gnu/linux-and-gnu.html"))
 	     "Browse http://www.gnu.org/gnu/linux-and-gnu.html")
-	 '("GNU" (lambda (button) (describe-project))
+	 '("GNU" (lambda (button) (describe-gnu-project))
 	   "Display info on the GNU project.")))
      " operating system.\n"
      :face (lambda ()
@@ -1222,7 +1222,7 @@
      (lambda () emacs-copyright)
      "\n\n"
      :face variable-pitch
-     :link ("GNU and Freedom" (lambda (button) (describe-project)))
+     :link ("GNU and Freedom" (lambda (button) (describe-gnu-project)))
      "\tWhy we developed GNU Emacs, and the GNU operating system\n"
      :link ("Absence of Warranty" (lambda (button) (describe-no-warranty)))
      "\tGNU Emacs comes with "
@@ -1816,7 +1816,7 @@
   (insert "To follow a link, click Mouse-1 on it, or move to it and type RET.\n\n")
 
   (insert-button "GNU and Freedom"
-		 'action (lambda (button) (describe-project))
+		 'action (lambda (button) (describe-gnu-project))
 		 'follow-link t)
   (insert "\t\tWhy we developed GNU Emacs and the GNU system\n")
 

Index: man/help.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/man/Attic/help.texi,v
retrieving revision 1.53.2.1
diff -u -r1.53.2.1 help.texi
--- man/help.texi	9 Jan 2008 04:08:27 -0000	1.53.2.1
+++ man/help.texi	4 Mar 2008 18:14:27 -0000
@@ -606,7 +606,7 @@
 @kindex C-h C-n
 @findex view-emacs-news
 @kindex C-h C-p
-@findex describe-project
+@findex describe-gnu-project
 @kindex C-h C-t
 @findex view-emacs-todo
 @kindex C-h C-w
@@ -629,9 +629,9 @@
 recent version of Emacs (@code{view-emacs-news}).
 @item C-h C-p
 Display general information about the GNU Project
-(@code{describe-project}).
+(@code{describe-gnu-project}).
 @item C-h C-t
-Display the Emacs to-do list (@code{view-todo}).
+Display the Emacs to-do list (@code{view-emacs-todo}).
 @item C-h C-w
 Display the full details on the complete absence of warranty for GNU
 Emacs (@code{describe-no-warranty}).

-- 
Kim F. Storm <storm@cua.dk> http://www.cua.dk