From d35d0238944a59ed437b7cc9c600f40047ee7ea6 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Fri, 11 Sep 2009 06:42:13 +0000 Subject: [PATCH] Reformat doc-strings for make-docfile. --- lisp/ChangeLog | 4 ++++ lisp/paths.el | 13 +++++++------ 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 @@ 2009-09-11 Glenn Morris + * paths.el (prune-directory-list, gnus-nntp-service, rmail-file-name): + * version.el (emacs-copyright, emacs-major-version) + (emacs-minor-version): Reformat doc-strings for make-docfile. + * apropos.el (apropos-documentation-check-doc-file): Exclude unbound functions and variables, since they must be stuff specific to some other 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 @@ ;;; Code: ;; Docstrings in this file should, where reasonable, follow the -;; conventions described in bindings.el, so that they get put in the +;; conventions described in make-docfile, so that they get put in the ;; DOC file rather than in memory. (defun prune-directory-list (dirs &optional keep reject) - "Return a copy of DIRS with all non-existent directories removed. + "\ +Return a copy of DIRS with all non-existent directories removed. The optional argument KEEP is a list of directories to retain even if they don't exist, and REJECT is a list of directories to remove from DIRS, even if they exist; REJECT takes precedence over KEEP. @@ -121,8 +122,8 @@ the environment variable INFOPATH is set.") The name of the host running an NNTP server. The null string means use the local host as the server site.") -(defvar gnus-nntp-service "nntp" - "NNTP service name, usually \"nntp\" or 119. +(defvar gnus-nntp-service "nntp" "\ +NNTP service name, usually \"nntp\" or 119. Go to a local news spool if its value is nil, in which case `gnus-nntp-server' should be set to `(system-name)'.") @@ -130,8 +131,8 @@ should be set to `(system-name)'.") *The name of your organization, as a string. The `ORGANIZATION' environment variable is used instead if defined.") -(defcustom rmail-file-name "~/RMAIL" - "Name of user's primary mail file." +(defcustom rmail-file-name "~/RMAIL" "\ +Name of user's primary mail file." :type 'string :group 'rmail :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 @@ ;;; version.el --- record version number of Emacs -*- no-byte-compile: t -*- -;; Copyright (C) 1985, 1992, 1994, 1995, 1999, 2000, 2001, 2002, -;; 2003, 2004, 2005, 2006, 2007, 2008, 2009 +;; Copyright (C) 1985, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003, +;; 2004, 2005, 2006, 2007, 2008, 2009 ;; Free Software Foundation, Inc. ;; Maintainer: FSF @@ -24,24 +24,23 @@ ;;; Commentary: +;; This file is loaded uncompiled when dumping Emacs. +;; Doc-strings should adhere to the conventions of make-docfile. + ;;; Code: -(defconst emacs-copyright "Copyright (C) 2009 Free Software Foundation, Inc." - "Short copyright string for this version of Emacs.") +(defconst emacs-copyright "Copyright (C) 2009 Free Software Foundation, Inc." "\ +Short copyright string for this version of Emacs.") (defconst emacs-version "23.1.50" "\ Version numbers of this version of Emacs.") -(defconst emacs-major-version - (progn (string-match "^[0-9]+" emacs-version) - (string-to-number (match-string 0 emacs-version))) - "Major version number of this version of Emacs. +(defconst emacs-major-version (progn (string-match "^[0-9]+" emacs-version) (string-to-number (match-string 0 emacs-version))) "\ +Major version number of this version of Emacs. This variable first existed in version 19.23.") -(defconst emacs-minor-version - (progn (string-match "^[0-9]+\\.\\([0-9]+\\)" emacs-version) - (string-to-number (match-string 1 emacs-version))) - "Minor version number of this version of Emacs. +(defconst emacs-minor-version (progn (string-match "^[0-9]+\\.\\([0-9]+\\)" emacs-version) (string-to-number (match-string 1 emacs-version))) "\ +Minor version number of this version of Emacs. This variable first existed in version 19.23.") (defconst emacs-build-time (current-time) "\ -- 2.39.2