procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Improve documentation of a recent change

Browse source 
* lisp/progmodes/project.el (project-files-relative-names):
* etc/NEWS: Improve documentation of 'project-files-relative-names'.
This commit is contained in:
Eli Zaretskii 2024-05-05 08:20:39 +03:00
parent 370b216f08
commit 8098ad9679
2 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
etc/NEWS
View file

@ -696,9 +696,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

9
lisp/progmodes/project.el
View file

@ -324,10 +324,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.