tech@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Kristaps Dzonsons <kristaps@bsd.lv>
To: tech@mdocml.bsd.lv
Subject: Re: mandocdb: handle formatted manuals
Date: Sat, 26 Nov 2011 13:01:57 +0100	[thread overview]
Message-ID: <4ED0D535.6040408@bsd.lv> (raw)
In-Reply-To: <20111126115429.GB13912@iris.usta.de>

>> There's a slight problem with this: when a file is entered into
>> mandocdb's databases, there's an implicit assumption that it was
>> parsed.  In other words, mandocdb entries are "safe" for mandoc.
>>
>> We need to clearly demark which files are "safe" and which are not.
>> In this way, progs interfacing with mandocdb databases can act
>> accordingly.
>>
>> The easiest way, of course, is a bit in the index file.  Can you
>> modify this patch, and the mandoc.index format, to do something like
>> that?
>
> I think that is clearly possible and may be useful.
>
> To avoid confounding patches across the two repositories,
> i'm first going to commit my unchanged patch to bsd.lv,
> even if that's going to cause the problems you describe for
> a short period of time, then write an additional patch to
> introduce the flag you suggest.
>
>> While we're updating the mandoc.index format, is there anything else
>> that should be going in there?
>
> Currently, we have
>
>    recno ->  filename \0 section \0 title \0 arch \0 description \0
>
> Given that the description will typically be dozens of characters,
> i don't think encoding the file type in a single byte with a set
> of #defines is worth the obfuscation, so i'd just make that
>
>    recno ->  type \0 filename \0 section \0 title \0 arch \0 description \0
>
> where type = ( mdoc | man | cat ).
>
> Do you agree with that?

Hi Ingo,

That's exactly what I had in mind.  I think it's pretty clear which 
areas will need the offset calculation.  mandocdb(8) will also need to 
be updated -- come to think of it, it already needs updating with the 
new types.  Do you want to do that, or shall I?

> I don't think any other information is required in the index.
>
> However, you planned to check endian-neutrality, right?

Yes, although this is purely a mechanical check (it is absolutely 
necessary).  I'll do this when your above changes have been checked in 
so we avoid clobbering each other.

Til then, I'll work almost exclusively with man.cgi and manup.  By the 
way, any suggestions for manup's name?  Just "man up" and tell me. ;)

Best,

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

  reply	other threads:[~2011-11-26 12:02 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-19  0:56 Ingo Schwarze
2011-11-24 10:25 ` Kristaps Dzonsons
2011-11-26 11:54   ` Ingo Schwarze
2011-11-26 12:01     ` Kristaps Dzonsons [this message]
2011-11-26 12:41       ` Ingo Schwarze

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=4ED0D535.6040408@bsd.lv \
    --to=kristaps@bsd.lv \
    --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).