; Improve documentation of a recent change

* lisp/progmodes/project.el (project-files-relative-names):
* etc/NEWS: Improve documentation of 'project-files-relative-names'.

(cherry picked from commit 8098ad9679c7f5ea19493bdae18227f7a81b3eb4)

diff --git a/etc/NEWS b/etc/NEWS
index f8430c25efe711b88b98468f677f2b37c2703a3f..69dbc6321076d3dc7b128f179dda17bdb1dcc152 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -699,9 +699,11 @@ you can add this to your init script:
 
     (setopt project-switch-commands #'project-prefix-or-any-command)
 
+---
 *** New variable 'project-files-relative-names'.
-Project backends can support it to improve the performance of their
-'project-files' implementation when this variable is non-nil.
+If it's non-nil, 'project-files' can return file names relative to the
+project root.  Project backends can use this to improve the performance
+of their 'project-files' implementation.
 
 ** VC
 

diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index 66ce548add9686e09b76b4a7981a88c41fad2b42..c647a542a92a31181204995ff8b8afdd8ae9b785 100644 (file)
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -319,10 +319,11 @@ end it with `/'.  DIR must be either `project-root' or one of
   (cdr project))
 
 (defvar project-files-relative-names nil
-  "When non-nil, `project-files' is allowed to return relative names.
-The names will be relative to the project root.  And this can only
-happen when all returned files are in the same directory. Meaning, the
-DIRS argument has to be nil or have only one element.")
+  "If non-nil, `project-files' is allowed to return relative file names.
+The file names should be relative to the project root.  And this can
+only happen when all returned files are in the same directory.
+In other words, the DIRS argument of `project-files' has to be nil or a
+list of only one element.")
 
 (cl-defgeneric project-files (project &optional dirs)
   "Return a list of files in directories DIRS in PROJECT.