]> git.eshelyaron.com Git - emacs.git/commitdiff
* doc/lispref/tips.texi (Coding Conventions): Mention GNU "path" convention
authorStefan Monnier <monnier@iro.umontreal.ca>
Sun, 7 Nov 2021 05:11:28 +0000 (01:11 -0400)
committerStefan Monnier <monnier@iro.umontreal.ca>
Sun, 7 Nov 2021 05:11:28 +0000 (01:11 -0400)
Suggested by Ihor Radchenko <yantar92@gmail.com>.

doc/lispref/tips.texi

index fa764f18b5c2ccce44c2205e4253f267f4c8c6e4..cbfcbd8d14f7b86baede21fa914857a7207e8614 100644 (file)
@@ -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