From f52fe349a337ef198abc54acfdbb6f21db91dc4a Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sun, 5 May 2024 08:20:39 +0300 Subject: [PATCH] ; 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) --- etc/NEWS | 6 ++++-- lisp/progmodes/project.el | 9 +++++---- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/etc/NEWS b/etc/NEWS index f8430c25efe..69dbc632107 100644 --- 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 66ce548add9..c647a542a92 100644 --- 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. -- 2.39.5