From: Stefan Monnier <monnier@iro.umontreal.ca>
Date: Sun, 7 Nov 2021 05:11:28 +0000 (-0400)
Subject: * doc/lispref/tips.texi (Coding Conventions): Mention GNU "path" convention
X-Git-Tag: emacs-29.0.90~3671^2~114
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f80fd099fc6653c9893b5522c0d520c0ae1f5133;p=emacs.git

* doc/lispref/tips.texi (Coding Conventions): Mention GNU "path" convention

Suggested by Ihor Radchenko <yantar92@gmail.com>.
---

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index fa764f18b5c..cbfcbd8d14f 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -252,6 +252,13 @@ themselves; Lisp programmers find this disconcerting.
 Please put a copyright notice and copying permission notice on the
 file if you distribute copies.  @xref{Library Headers}.
 
+@item
+For variables holding (or functions returning) a file or directory name,
+avoid using @code{path} in its name, preferring @code{file},
+@code{file-name}, or @code{directory} instead, since Emacs follows the
+GNU convention to use the term @emph{path} only for search paths,
+which are lists of directory names.
+
 @end itemize
 
 @node Key Binding Conventions