03/04: services: file-database: Clarify 'excluded-directories' description.

[guix-commits]

civodul pushed a commit to branch master
in repository guix.

commit 2274d71f94e6973df1ebc312c88b876aaa19588a
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Tue Aug 22 11:00:25 2023 +0200

    services: file-database: Clarify 'excluded-directories' description.
    
    * gnu/services/admin.scm 
(file-database-configuration)[excluded-directories]:
    Mention that these are regexps.
    (%default-file-database-excluded-directories): Likewise.
    * doc/guix.texi (File Search Services): Adjust accordingly.
---
 doc/guix.texi          | 11 +++++------
 gnu/services/admin.scm | 10 +++++-----
 2 files changed, 10 insertions(+), 11 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index feb1d0375e..e8c67b0cd8 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -25099,12 +25099,11 @@ String or G-exp denoting an mcron schedule for the 
periodic
 @command{updatedb} job (@pxref{Guile Syntax,,, mcron, GNU@tie{}mcron}).
 
 @item @code{excluded-directories} (default 
@code{%default-file-database-excluded-directories})
-List of directories to ignore when building the file database.  By
-default, this includes @file{/tmp} and @file{/gnu/store}, which should
-instead be indexed by @command{guix locate} (@pxref{Invoking guix
-locate}).  This list is passed to the @option{--prunepaths} option of
-@command{updatedb} (@pxref{Invoking updatedb,,, find,
-GNU@tie{}Findutils}).
+List of regular expressions of directories to ignore when building the
+file database.  By default, this includes @file{/tmp} and @file{/gnu/store};
+the latter should instead be indexed by @command{guix locate} (@pxref{Invoking
+guix locate}).  This list is passed to the @option{--prunepaths} option of
+@command{updatedb} (@pxref{Invoking updatedb,,, find, GNU@tie{}Findutils}).
 @end table
 @end deftp
 
diff --git a/gnu/services/admin.scm b/gnu/services/admin.scm
index fa2407ed84..5cf74c6e4d 100644
--- a/gnu/services/admin.scm
+++ b/gnu/services/admin.scm
@@ -290,7 +290,7 @@ Old log files are removed or compressed according to the 
configuration.")
   "10 23 * * 0")
 
 (define %default-file-database-excluded-directories
-  ;; Directories excluded from the 'locate' database.
+  ;; Regexps of directories excluded from the 'locate' database.
   (list (%store-prefix)
         "/tmp" "/var/tmp" "/var/cache" ".*/\\.cache"
         "/run/udev"))
@@ -319,10 +319,10 @@ is taken.")
 @command{updatedb} job (@pxref{Guile Syntax,,, mcron, GNU@tie{}mcron}).")
   (excluded-directories
    (string-list %default-file-database-excluded-directories)
-   "List of directories to ignore when building the file database.  By
-default, this includes @file{/tmp} and @file{/gnu/store}, which should instead
-be indexed by @command{guix locate} (@pxref{Invoking guix locate}).  This list
-is passed to the @option{--prunepaths} option of
+   "List of regular expressions of directories to ignore when building the
+file database.  By default, this includes @file{/tmp} and @file{/gnu/store};
+the latter should instead be indexed by @command{guix locate} (@pxref{Invoking
+guix locate}).  This list is passed to the @option{--prunepaths} option of
 @command{updatedb} (@pxref{Invoking updatedb,,, find, GNU@tie{}Findutils})."))
 
 (define (file-database-mcron-jobs configuration)