tech@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Kristaps Dzonsons <kristaps@bsd.lv>
To: tech@mdocml.bsd.lv
Cc: Ingo Schwarze <schwarze@usta.de>
Subject: Re: mandocdb: do not use bogus files
Date: Sun, 13 Nov 2011 21:05:08 +0100	[thread overview]
Message-ID: <4EC022F4.7060008@bsd.lv> (raw)
In-Reply-To: <20111113184235.GI3374@iris.usta.de>

On 13/11/2011 19:42, Ingo Schwarze wrote:
> Hi,
>
> here is the first step towards usable titles in apropos(1) output.
>
> Currently, if you have a page /usr/share/man/man3p/FooBar::cAmEl.3p,
> you are quite lost, because apropos(1) will tell you
>
>    FOOBAR::CAMEL(3p) - my fancy Perl module
>
> but of course, this will not find the page:
>
>    man FOOBAR::CAMEL
>
> Also, imagine /usr/share/man/foobar/bogus.mdoc contained .Dt fancy 6,
> then apropos fancy would happily return
>
>    FANCY - my well hidden manual
>
> but of course man(1) will search for it in vain.
>
> Thus, only look for files in reasonable places, and save the filename
> stem (title), suffix (section), and architecture in the struct of,
> for later use by the indexer.
>
> OK?
>    Ingo

Ingo,

Yes, I like this as the default behaviour.  However, there must be a 
command-line flag not to do so, as I use mandocdb in my own directory 
structures.

You also need to free up the memory in ofile_free().

Furthermore, please amend mandocdb.8 to note which directories are 
visited and which are not (in the default case).  I also think it's a 
good idea to note skipped directories with a warning that's described in 
DIAGNOSTICS.  Since this is a .8, we should (in my humble opinion) be 
quite rigorous in what's done and what's not done.

Thoughts?

Kristaps
--
 To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv

  reply	other threads:[~2011-11-13 20:05 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-13 18:42 Ingo Schwarze
2011-11-13 20:05 ` Kristaps Dzonsons [this message]
2011-11-14  0:06   ` Ingo Schwarze
2011-11-14 19:13     ` Ingo Schwarze
2011-11-14 20:07       ` Kristaps Dzonsons
2011-11-14 23:34         ` Ingo Schwarze
2011-11-24 10:10           ` Kristaps Dzonsons

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

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

  git send-email \
    --in-reply-to=4EC022F4.7060008@bsd.lv \
    --to=kristaps@bsd.lv \
    --cc=schwarze@usta.de \
    --cc=tech@mdocml.bsd.lv \
    /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.
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 NNTP newsgroup(s).