GNU bug report logs - #51416
[PATCH] profiles: Build the man database only if 'man-db' is in the profile.

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#51416: closed ([PATCH] profiles: Build the man database only
 if 'man-db' is in the profile.)
Date: Sat, 06 Nov 2021 22:24:01 +0000

[Message part 1 (text/plain, inline)]

Your message dated Sat, 06 Nov 2021 23:22:54 +0100
with message-id <87r1bsly9t.fsf_-_ <at> gnu.org>
and subject line Re: bug#51416: [PATCH] profiles: Build the man database only if 'man-db' is in the profile.
has caused the debbugs.gnu.org bug report #51416,
regarding [PATCH] profiles: Build the man database only if 'man-db' is in the profile.
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
51416: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=51416
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Ludovic Courtès <ludo <at> gnu.org>
To: guix-patches <at> gnu.org
Cc: Ludovic Courtès <ludo <at> gnu.org>
Subject: [PATCH] profiles: Build the man database only if 'man-db' is in the
 profile.
Date: Tue, 26 Oct 2021 19:33:28 +0200

This allows us to skip the expensive man-db profile hook in most cases.

Suggested by Liliana Marie Prikler <liliana.prikler <at> gmail.com>.

* guix/profiles.scm (manual-database/optional): New procedure.
(%default-profile-hooks): Use it instead of 'manual-database'.
---
 guix/profiles.scm | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

Hi!

As y’all know, computing the manual page database is CPU- and I/O-intensive
and thus a good candidate for removal, as discussed earlier¹.

I would prefer to provide a replacement for the ‘man -k’ functionality,
such as a Xapian-based full-text search².  Now, this hasn’t materialized
yet, but I feel it’s about time to remove that hook.

The other day Liliana came with a smart idea on IRC: to build the database
only when ‘man-db’ is also in the profile.  It’s a good way to not quite
make a decision :-), but it’s going to address the main pain point.

Thoughts?

Thanks,
Ludo’.

¹ https://lists.gnu.org/archive/html/guix-devel/2020-12/msg00052.html
  Thread continues in January and March.

² https://lists.gnu.org/archive/html/guix-devel/2021-04/msg00027.html

diff --git a/guix/profiles.scm b/guix/profiles.scm
index 9f30349c69..ffdd5f57f6 100644
--- a/guix/profiles.scm
+++ b/guix/profiles.scm
@@ -1682,6 +1682,16 @@ (define man-directory
                     `((type . profile-hook)
                       (hook . manual-database))))
 
+(define (manual-database/optional manifest)
+  "Return a derivation to build the manual database of MANIFEST, but only if
+MANIFEST contains the \"man-db\" package.  Otherwise, return #f."
+  ;; Building the man database (for "man -k") is expensive and rarely used.
+  ;; Build it only if the profile also contains "man-db".
+  (mlet %store-monad ((man-db (manifest-lookup-package manifest "man-db")))
+    (if man-db
+        (manual-database manifest)
+        (return #f))))
+
 (define (texlive-configuration manifest)
   "Return a derivation that builds a TeXlive configuration for the entries in
 MANIFEST."
@@ -1784,7 +1794,7 @@ (define %default-profile-hooks
   ;; This is the list of derivation-returning procedures that are called by
   ;; default when making a non-empty profile.
   (list info-dir-file
-        manual-database
+        manual-database/optional
         fonts-dir-file
         ghc-package-cache-file
         ca-certificate-bundle

base-commit: 0a42998a50e8bbe9e49142b21a570db00efe7491
-- 
2.33.0

[Message part 3 (message/rfc822, inline)]

From: Ludovic Courtès <ludo <at> gnu.org>
To: Oleg Pykhalov <go.wigust <at> gmail.com>
Cc: 51416-done <at> debbugs.gnu.org, Leo Famulari <leo <at> famulari.name>
Subject: Re: bug#51416: [PATCH] profiles: Build the man database only if
 'man-db' is in the profile.
Date: Sat, 06 Nov 2021 23:22:54 +0100

Hi,

Ludovic Courtès <ludo <at> gnu.org> skribis:

> Oleg Pykhalov <go.wigust <at> gmail.com> skribis:
>
>> Ludovic Courtès <ludo <at> gnu.org> writes:
>>
>> […]
>>
>>>   https://guix.gnu.org/manual/en/html_node/Documentation.html
>>>
>>> On Guix System, the system profile does include man-db by default.
>>
>> We probably should add a line in the documentation about 'man -k'
>> requirement on non Guix system, WDYT?  Otherwise +1 for the change.
>
> Yes, good idea, I’ll do that.

Done in 3c1158ac4e5ef825a9b9a229a233fabd7cef334e!

Thanks,
Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.