From 6d39f24728a9501b1a8d040f59fb434874a8585a Mon Sep 17 00:00:00 2001 From: ShengHuo ZHU Date: Thu, 16 Jan 2003 01:35:50 +0000 Subject: [PATCH] From the GNU coding standards: Please do not use the term ``pathname'' that is used in Unix documentation; use ``file name'' (two words) instead. We use the term ``path'' only for search paths, which are lists of directory names. --- lisp/ChangeLog | 26 ++++++++++++++++++++++++++ lisp/gnus-agent.el | 6 +++--- lisp/gnus-group.el | 2 +- lisp/gnus.el | 2 +- lisp/nnfolder.el | 2 +- lisp/nnheader.el | 6 +++--- lisp/nnimap.el | 2 +- lisp/nnmail.el | 4 ++-- lisp/nnsoup.el | 2 +- lisp/nnspool.el | 2 +- texi/ChangeLog | 12 ++++++++++++ texi/gnus.texi | 34 +++++++++++++++++----------------- texi/message.texi | 2 +- 13 files changed, 70 insertions(+), 32 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 5f77ff8f8..269b776b5 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,29 @@ +2003-01-15 ShengHuo ZHU + + * gnus-agent.el: Don't use `path'. + From the GNU coding standards: + + Please do not use the term ``pathname'' that is used in Unix + documentation; use ``file name'' (two words) instead. We use + the term ``path'' only for search paths, which are lists of + directory names. + + * nnsoup.el (nnsoup-file-name): Ditto. + + * nnmail.el (nnmail-pathname-coding-system): Ditto. + (nnmail-group-pathname): Ditto. + + * nnimap.el (nnimap-group-overview-filename): Ditto. + + * nnheader.el (nnheader-pathname-coding-system): Ditto. + (nnheader-group-pathname): Ditto. + + * nnfolder.el (nnfolder-group-pathname): Ditto. + + * gnus.el (gnus-home-directory): Ditto. + + * gnus-group.el (gnus-group-icon-list): Ditto. + 2003-01-16 Jesper Harder * message.el (message-mode-menu): Use it. diff --git a/lisp/gnus-agent.el b/lisp/gnus-agent.el index 603f65b23..3c2aa4308 100644 --- a/lisp/gnus-agent.el +++ b/lisp/gnus-agent.el @@ -234,12 +234,12 @@ node `(gnus)Server Buffer'.") (cadr gnus-command-method)))) (defsubst gnus-agent-directory () - "Path of the Gnus agent directory." + "The name of the Gnus agent directory." (nnheader-concat gnus-agent-directory (nnheader-translate-file-chars (gnus-agent-method)) "/")) (defun gnus-agent-lib-file (file) - "The full path of the Gnus agent library FILE." + "The full name of the Gnus agent library FILE." (expand-file-name file (file-name-as-directory (expand-file-name "agent.lib" (gnus-agent-directory))))) @@ -933,7 +933,7 @@ This can be added to `gnus-select-article-hook' or (delete-char 1)))))) (defun gnus-agent-group-path (group) - "Translate GROUP into a path." + "Translate GROUP into a file name." (if nnmail-use-long-file-names (gnus-group-real-name group) (nnheader-translate-file-chars diff --git a/lisp/gnus-group.el b/lisp/gnus-group.el index 1eaad6e7e..2cca87027 100644 --- a/lisp/gnus-group.el +++ b/lisp/gnus-group.el @@ -388,7 +388,7 @@ particular group line should be displayed, each form is evaluated. The icon from the file field after the first true form is used. You can change how those group lines are displayed by editing the file field. The File will either be found in the -`gnus-group-glyph-directory' or by designating absolute path to the +`gnus-group-glyph-directory' or by designating absolute name of the file. It is also possible to change and add form fields, but currently that diff --git a/lisp/gnus.el b/lisp/gnus.el index ed97ad893..3cf6c778e 100644 --- a/lisp/gnus.el +++ b/lisp/gnus.el @@ -1038,7 +1038,7 @@ REST is a plist of following: (defcustom gnus-home-directory "~/" "Directory variable that specifies the \"home\" directory. -All other Gnus path variables are initialized from this variable." +All other Gnus file and directory variables are initialized from this variable." :group 'gnus-files :type 'directory) diff --git a/lisp/nnfolder.el b/lisp/nnfolder.el index b50c6bde5..e6cd305de 100644 --- a/lisp/nnfolder.el +++ b/lisp/nnfolder.el @@ -1046,7 +1046,7 @@ This command does not work if you use short group names." (nnheader-message 5 ""))) (defun nnfolder-group-pathname (group) - "Make pathname for GROUP." + "Make file name for GROUP." (setq group (mm-encode-coding-string group nnmail-pathname-coding-system)) (let ((dir (file-name-as-directory (expand-file-name nnfolder-directory)))) diff --git a/lisp/nnheader.el b/lisp/nnheader.el index adc9c9d88..c13b52211 100644 --- a/lisp/nnheader.el +++ b/lisp/nnheader.el @@ -658,7 +658,7 @@ the line could be found." "Regexp that matches numerical file names.") (defvar nnheader-numerical-full-files (concat "/" nnheader-numerical-files) - "Regexp that matches numerical full file paths.") + "Regexp that matches numerical full file names.") (defsubst nnheader-file-to-number (file) "Take a FILE name and return the article number." @@ -824,10 +824,10 @@ without formatting." (<= level gnus-verbose-backends))) (defvar nnheader-pathname-coding-system 'iso-8859-1 - "*Coding system for pathname.") + "*Coding system for file name.") (defun nnheader-group-pathname (group dir &optional file) - "Make pathname for GROUP." + "Make file name for GROUP." (concat (let ((dir (file-name-as-directory (expand-file-name dir)))) ;; If this directory exists, we use it directly. diff --git a/lisp/nnimap.el b/lisp/nnimap.el index 3384028e4..f6c370538 100644 --- a/lisp/nnimap.el +++ b/lisp/nnimap.el @@ -564,7 +564,7 @@ If EXAMINE is non-nil the group is selected read-only." articles)))) (defun nnimap-group-overview-filename (group server) - "Make pathname for GROUP on SERVER." + "Make file name for GROUP on SERVER." (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory))) (uidvalidity (gnus-group-get-parameter (gnus-group-prefixed-name diff --git a/lisp/nnmail.el b/lisp/nnmail.el index 032fe931a..4851711a9 100644 --- a/lisp/nnmail.el +++ b/lisp/nnmail.el @@ -538,7 +538,7 @@ parameter. It should return nil, `warn' or `delete'." "Coding system used in reading inbox") (defvar nnmail-pathname-coding-system nil - "*Coding system for pathname.") + "*Coding system for file name.") (defun nnmail-find-file (file) "Insert FILE in server buffer safely." @@ -555,7 +555,7 @@ parameter. It should return nil, `warn' or `delete'." (file-error nil)))) (defun nnmail-group-pathname (group dir &optional file) - "Make pathname for GROUP." + "Make file name for GROUP." (concat (let ((dir (file-name-as-directory (expand-file-name dir)))) (setq group (nnheader-replace-duplicate-chars-in-string diff --git a/lisp/nnsoup.el b/lisp/nnsoup.el index e4c8271cc..4d9d88405 100644 --- a/lisp/nnsoup.el +++ b/lisp/nnsoup.el @@ -399,7 +399,7 @@ backend for the messages.") prefix)) (defun nnsoup-file-name (dir file) - "Return the full path of FILE (in any case) in DIR." + "Return the full name of FILE (in any case) in DIR." (let* ((case-fold-search t) (files (directory-files dir t)) (regexp (concat (regexp-quote file) "$"))) diff --git a/lisp/nnspool.el b/lisp/nnspool.el index d8709ec5e..4efdeaeb8 100644 --- a/lisp/nnspool.el +++ b/lisp/nnspool.el @@ -460,7 +460,7 @@ there.") (nnheader-report 'nnspool "No such newsgroup: %s" group))))) (defun nnspool-article-pathname (group &optional article) - "Find the path for GROUP." + "Find the file name for GROUP." (nnheader-group-pathname group nnspool-spool-directory article)) (provide 'nnspool) diff --git a/texi/ChangeLog b/texi/ChangeLog index 180211c8b..9f914c910 100644 --- a/texi/ChangeLog +++ b/texi/ChangeLog @@ -1,3 +1,15 @@ +2003-01-15 ShengHuo ZHU + + * gnus.texi: Don't use `path' in some cases. + From the GNU coding standards: + + Please do not use the term ``pathname'' that is used in Unix + documentation; use ``file name'' (two words) instead. We use + the term ``path'' only for search paths, which are lists of + directory names. + + * message.texi: Ditto. + 2003-01-15 Simon Josefsson * gnus.texi (X-Face): Revert substantial part of last fix. diff --git a/texi/gnus.texi b/texi/gnus.texi index d35d09260..b1ede104b 100644 --- a/texi/gnus.texi +++ b/texi/gnus.texi @@ -12505,19 +12505,19 @@ Where the news lib dir is (@file{/usr/lib/news/} by default). @item nnspool-active-file @vindex nnspool-active-file -The path to the active file. +The name of the active file. @item nnspool-newsgroups-file @vindex nnspool-newsgroups-file -The path to the group descriptions file. +The name of the group descriptions file. @item nnspool-history-file @vindex nnspool-history-file -The path to the news history file. +The name of the news history file. @item nnspool-active-times-file @vindex nnspool-active-times-file -The path to the active date file. +The name of the active date file. @item nnspool-nov-is-evil @vindex nnspool-nov-is-evil @@ -12817,7 +12817,7 @@ Keywords: @table @code @item :path -The path of the file. Defaults to the value of the @code{MAIL} +The file name. Defaults to the value of the @code{MAIL} environment variable or the value of @code{rmail-spool-directory} (usually something like @file{/usr/mail/spool/user-name}). @end table @@ -12828,7 +12828,7 @@ An example file mail source: (file :path "/usr/spool/mail/user-name") @end lisp -Or using the default path: +Or using the default file name: @lisp (file) @@ -12882,7 +12882,7 @@ Keywords: @table @code @item :path -The path of the directory where the files are. There is no default +The name of the directory where the files are. There is no default value. @item :suffix @@ -13016,7 +13016,7 @@ Keywords: @table @code @item :path -The path of the directory where the mails are stored. The default is +The name of the directory where the mails are stored. The default is taken from the @code{MAILDIR} environment variable or @samp{~/Maildir/}. @item :subdirs @@ -13736,18 +13736,18 @@ Here's how: Go to the group buffer. @item -Type `G f' and give the path to the mbox file when prompted to create an +Type @kbd{G f} and give the file name to the mbox file when prompted to create an @code{nndoc} group from the mbox file (@pxref{Foreign Groups}). @item -Type `SPACE' to enter the newly created group. +Type @kbd{SPACE} to enter the newly created group. @item -Type `M P b' to process-mark all articles in this group's buffer +Type @kbd{M P b} to process-mark all articles in this group's buffer (@pxref{Setting Process Marks}). @item -Type `B r' to respool all the process-marked articles, and answer +Type @kbd{B r} to respool all the process-marked articles, and answer @samp{nnml} when prompted (@pxref{Mail Group Commands}). @end enumerate @@ -22221,14 +22221,14 @@ Save table: (spam-stat-save) @table @code @item gnus-home-directory -All Gnus path variables will be initialized from this variable, which -defaults to @file{~/}. +All Gnus file and directory variables will be initialized from this +variable, which defaults to @file{~/}. @item gnus-directory @vindex gnus-directory -Most Gnus storage path variables will be initialized from this variable, -which defaults to the @samp{SAVEDIR} environment variable, or -@file{~/News/} if that variable isn't set. +Most Gnus storage file and directory variables will be initialized from +this variable, which defaults to the @samp{SAVEDIR} environment +variable, or @file{~/News/} if that variable isn't set. Note that Gnus is mostly loaded when the @file{.gnus.el} file is read. This means that other directory variables that are initialized from this diff --git a/texi/message.texi b/texi/message.texi index af88570bf..0fa85e4e0 100644 --- a/texi/message.texi +++ b/texi/message.texi @@ -1011,7 +1011,7 @@ supported. @vindex gpg-temp-directory Note, if you are using the @code{gpg.el} you must make sure that the -path specified by @code{gpg-temp-directory} have permissions 0700. +directory specified by @code{gpg-temp-directory} have permissions 0700. Creating your own OpenPGP key is described in detail in the documentation of your OpenPGP implementation, so we refer to it. -- 2.34.1