unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Brice Waegeneire <brice@waegenei.re>
To: "Ludovic Courtès" <ludo@gnu.org>
Cc: Guix Devel <guix-devel@gnu.org>,
	Maxim Cournoyer <maxim.cournoyer@gmail.com>
Subject: Re: Getting rid of the mandb profile hook?
Date: Wed, 03 Mar 2021 21:50:31 +0100	[thread overview]
Message-ID: <0170f58ece0b1bfd193f1566c37eddb8@waegenei.re> (raw)
In-Reply-To: <87ft1cqq94.fsf@gnu.org>

Hello Ludovic,

On 2021-03-03 15:13, Ludovic Courtès wrote:
>>> I’m thinking we could get rid of the mandb hook.  However, the
>>> functionality matters IMO (we need good tools so users can browse 
>>> local
>>> documentation; mandb is not that good but better than no search
>>> mechanism.)  Here are several options that come to mind:
>>> 
>>>   1. Provide a ‘man’ wrapper or modify the ‘man-db’ package such that
>>>      the database gets built on the first use of ‘man -k’, unless 
>>> it’s
>>>      already up-to-date.
>> 
>> That would mean the database would live in some user-specific writable
>> area of the file system correct (where?), right?  And could use the
>> common 'update' mechanism of man-db to make it as fast as possible.
>> 
>> This sounds good from a performance perpective, but could introduce
>> cache issues every now and then (if man-db changes a lot).  I wouldn't
>> expect much problem given how mature man-db is, but that's one thing 
>> to
>> consider.
> 
> I looked a bit at man-db, thinking it must have that already done more
> or less.  Indeed, one can run “mandb -uc” to create the database.
> 
> The problem is that it insists on writing databases and ‘CACHEDIR.TAG’
> files in the same directory as man pages.  In our case, these are all
> read-only, so just prints a warning for each directory and keeps going.
> 
> It looks like man-db is not written with a situation like ours in mind.

What about using mandoc¹, the manpage compiler from OpenBSD, instead of
man-db? As from it's manual it support specifying the database location:

“makewhatis -d dir [file ...]”²

It isn't packaged in Guix yet, but other Linux distros have done it, 
some
  are even using it as their default.

> [...]
> 
> One option I contemplated at one point is to simply have fewer man 
> pages
> in the first place.  :-)  There were packages that install man pages
> when they shouldn’t.  This led to commits like
> 305eefc0627eb1d047e6fc4320d7e56897719ab8 and
> 4b797193d7508ddc53bb1ff7a267a0d50c1fe298 (and parent commits).

More outputs would be great tho having a way to force the installation 
of
specifics outputs for every installed package would improve quality of
live.  For a specific example in that case, when installing ncurses from
  the cli it would install it's man output too if you always want man 
page
  to be installed.

¹ https://mandoc.bsd.lv/
² https://www.mankier.com/8/makewhatis.mandoc

Cheers,
- Brice


  reply	other threads:[~2021-03-03 20:51 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-05 18:31 Getting rid of the mandb profile hook? Ludovic Courtès
2020-12-05 18:51 ` Pierre Neidhardt
2020-12-05 20:18 ` Ryan Prior
2020-12-06  0:37 ` Ricardo Wurmus
2020-12-08 10:47   ` Ludovic Courtès
2021-02-27 13:05 ` Maxim Cournoyer
2021-03-03 14:13   ` Ludovic Courtès
2021-03-03 20:50     ` Brice Waegeneire [this message]
2021-03-10 10:20       ` Ludovic Courtès
2021-04-02 16:56       ` Ludovic Courtès

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=0170f58ece0b1bfd193f1566c37eddb8@waegenei.re \
    --to=brice@waegenei.re \
    --cc=guix-devel@gnu.org \
    --cc=ludo@gnu.org \
    --cc=maxim.cournoyer@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).