diff options
| author | Glenn Morris | 2009-09-11 06:42:13 +0000 |
|---|---|---|
| committer | Glenn Morris | 2009-09-11 06:42:13 +0000 |
| commit | d35d0238944a59ed437b7cc9c600f40047ee7ea6 (patch) | |
| tree | f4e3e02b0a5ed22ddc0b8aeb035fc9c7e8e4c665 | |
| parent | 4f32d22e7fe0ce064d63b5a5c6464488b234f2e3 (diff) | |
| download | emacs-d35d0238944a59ed437b7cc9c600f40047ee7ea6.tar.gz emacs-d35d0238944a59ed437b7cc9c600f40047ee7ea6.zip | |
Reformat doc-strings for make-docfile.
| -rw-r--r-- | lisp/ChangeLog | 4 | ||||
| -rw-r--r-- | lisp/paths.el | 13 | ||||
| -rw-r--r-- | lisp/version.el | 23 |
3 files changed, 22 insertions, 18 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index edf617df1a9..dfa8fdb830d 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -4,6 +4,10 @@ | |||
| 4 | 4 | ||
| 5 | 2009-09-11 Glenn Morris <rgm@gnu.org> | 5 | 2009-09-11 Glenn Morris <rgm@gnu.org> |
| 6 | 6 | ||
| 7 | * paths.el (prune-directory-list, gnus-nntp-service, rmail-file-name): | ||
| 8 | * version.el (emacs-copyright, emacs-major-version) | ||
| 9 | (emacs-minor-version): Reformat doc-strings for make-docfile. | ||
| 10 | |||
| 7 | * apropos.el (apropos-documentation-check-doc-file): Exclude unbound | 11 | * apropos.el (apropos-documentation-check-doc-file): Exclude unbound |
| 8 | functions and variables, since they must be stuff specific to some other | 12 | functions and variables, since they must be stuff specific to some other |
| 9 | platform. | 13 | platform. |
diff --git a/lisp/paths.el b/lisp/paths.el index 385df8488e6..401a981cd87 100644 --- a/lisp/paths.el +++ b/lisp/paths.el | |||
| @@ -32,11 +32,12 @@ | |||
| 32 | ;;; Code: | 32 | ;;; Code: |
| 33 | 33 | ||
| 34 | ;; Docstrings in this file should, where reasonable, follow the | 34 | ;; Docstrings in this file should, where reasonable, follow the |
| 35 | ;; conventions described in bindings.el, so that they get put in the | 35 | ;; conventions described in make-docfile, so that they get put in the |
| 36 | ;; DOC file rather than in memory. | 36 | ;; DOC file rather than in memory. |
| 37 | 37 | ||
| 38 | (defun prune-directory-list (dirs &optional keep reject) | 38 | (defun prune-directory-list (dirs &optional keep reject) |
| 39 | "Return a copy of DIRS with all non-existent directories removed. | 39 | "\ |
| 40 | Return a copy of DIRS with all non-existent directories removed. | ||
| 40 | The optional argument KEEP is a list of directories to retain even if | 41 | The optional argument KEEP is a list of directories to retain even if |
| 41 | they don't exist, and REJECT is a list of directories to remove from | 42 | they don't exist, and REJECT is a list of directories to remove from |
| 42 | DIRS, even if they exist; REJECT takes precedence over KEEP. | 43 | DIRS, even if they exist; REJECT takes precedence over KEEP. |
| @@ -121,8 +122,8 @@ the environment variable INFOPATH is set.") | |||
| 121 | The name of the host running an NNTP server. | 122 | The name of the host running an NNTP server. |
| 122 | The null string means use the local host as the server site.") | 123 | The null string means use the local host as the server site.") |
| 123 | 124 | ||
| 124 | (defvar gnus-nntp-service "nntp" | 125 | (defvar gnus-nntp-service "nntp" "\ |
| 125 | "NNTP service name, usually \"nntp\" or 119. | 126 | NNTP service name, usually \"nntp\" or 119. |
| 126 | Go to a local news spool if its value is nil, in which case `gnus-nntp-server' | 127 | Go to a local news spool if its value is nil, in which case `gnus-nntp-server' |
| 127 | should be set to `(system-name)'.") | 128 | should be set to `(system-name)'.") |
| 128 | 129 | ||
| @@ -130,8 +131,8 @@ should be set to `(system-name)'.") | |||
| 130 | *The name of your organization, as a string. | 131 | *The name of your organization, as a string. |
| 131 | The `ORGANIZATION' environment variable is used instead if defined.") | 132 | The `ORGANIZATION' environment variable is used instead if defined.") |
| 132 | 133 | ||
| 133 | (defcustom rmail-file-name "~/RMAIL" | 134 | (defcustom rmail-file-name "~/RMAIL" "\ |
| 134 | "Name of user's primary mail file." | 135 | Name of user's primary mail file." |
| 135 | :type 'string | 136 | :type 'string |
| 136 | :group 'rmail | 137 | :group 'rmail |
| 137 | :version "21.1") | 138 | :version "21.1") |
diff --git a/lisp/version.el b/lisp/version.el index 269c3660e75..01347a5735a 100644 --- a/lisp/version.el +++ b/lisp/version.el | |||
| @@ -1,7 +1,7 @@ | |||
| 1 | ;;; version.el --- record version number of Emacs -*- no-byte-compile: t -*- | 1 | ;;; version.el --- record version number of Emacs -*- no-byte-compile: t -*- |
| 2 | 2 | ||
| 3 | ;; Copyright (C) 1985, 1992, 1994, 1995, 1999, 2000, 2001, 2002, | 3 | ;; Copyright (C) 1985, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003, |
| 4 | ;; 2003, 2004, 2005, 2006, 2007, 2008, 2009 | 4 | ;; 2004, 2005, 2006, 2007, 2008, 2009 |
| 5 | ;; Free Software Foundation, Inc. | 5 | ;; Free Software Foundation, Inc. |
| 6 | 6 | ||
| 7 | ;; Maintainer: FSF | 7 | ;; Maintainer: FSF |
| @@ -24,24 +24,23 @@ | |||
| 24 | 24 | ||
| 25 | ;;; Commentary: | 25 | ;;; Commentary: |
| 26 | 26 | ||
| 27 | ;; This file is loaded uncompiled when dumping Emacs. | ||
| 28 | ;; Doc-strings should adhere to the conventions of make-docfile. | ||
| 29 | |||
| 27 | ;;; Code: | 30 | ;;; Code: |
| 28 | 31 | ||
| 29 | (defconst emacs-copyright "Copyright (C) 2009 Free Software Foundation, Inc." | 32 | (defconst emacs-copyright "Copyright (C) 2009 Free Software Foundation, Inc." "\ |
| 30 | "Short copyright string for this version of Emacs.") | 33 | Short copyright string for this version of Emacs.") |
| 31 | 34 | ||
| 32 | (defconst emacs-version "23.1.50" "\ | 35 | (defconst emacs-version "23.1.50" "\ |
| 33 | Version numbers of this version of Emacs.") | 36 | Version numbers of this version of Emacs.") |
| 34 | 37 | ||
| 35 | (defconst emacs-major-version | 38 | (defconst emacs-major-version (progn (string-match "^[0-9]+" emacs-version) (string-to-number (match-string 0 emacs-version))) "\ |
| 36 | (progn (string-match "^[0-9]+" emacs-version) | 39 | Major version number of this version of Emacs. |
| 37 | (string-to-number (match-string 0 emacs-version))) | ||
| 38 | "Major version number of this version of Emacs. | ||
| 39 | This variable first existed in version 19.23.") | 40 | This variable first existed in version 19.23.") |
| 40 | 41 | ||
| 41 | (defconst emacs-minor-version | 42 | (defconst emacs-minor-version (progn (string-match "^[0-9]+\\.\\([0-9]+\\)" emacs-version) (string-to-number (match-string 1 emacs-version))) "\ |
| 42 | (progn (string-match "^[0-9]+\\.\\([0-9]+\\)" emacs-version) | 43 | Minor version number of this version of Emacs. |
| 43 | (string-to-number (match-string 1 emacs-version))) | ||
| 44 | "Minor version number of this version of Emacs. | ||
| 45 | This variable first existed in version 19.23.") | 44 | This variable first existed in version 19.23.") |
| 46 | 45 | ||
| 47 | (defconst emacs-build-time (current-time) "\ | 46 | (defconst emacs-build-time (current-time) "\ |