Re: mdocml: Store page titles in the correct case, and by default, only put

[Ingo Schwarze <schwarze@usta.de>]

Hi Kristaps,

Kristaps Dzonsons wrote on Sat, Nov 26, 2011 at 12:54:19PM +0100:
> On 26/11/2011 12:23, schwarze@mdocml.bsd.lv wrote:

>> Log Message:
>> -----------
>> Store page titles in the correct case, and by default, only
>> put stuff into the database that man(1) will be able to retrieve.
>> However, support an option to use all directories and files.
>> feedback and ok  kristaps@

> Some post-checkin comments.  First, I think we can make verbose and
> use_all into global statics, as they don't change and we're just
> cluttering the function prototypes with them.  No?

Yes.
I think a small number of global static variables is fine
in a small utility program, even though lots of global statics
tend to cause confusion in big systems.
So i like your suggestion.

> And second, in the manual, can you put the default usage following
> the arguments?
> 
>  Its arguments are as follows:
> 
>  -a    blah blah
> 
>  -b    blah blah
> 
>  By default, foo does this and that...
> 
> This is much easier to read and doesn't require that operators read
> each option to understand the defaults.

Yes, that makes sense.  By the same argument, i'd even move the
defaults *before* the options (leaving the fatal errors where
they are, of course).  When you are satisfied with the defaults,
you don't even need to read the options, and unless you understand
the defaults, the options (in particular -a) won't make much sense
to you.

I'm planning to handle these two tasks after putting the
unformatted parser in and adding the type field to the index
file.

Yours,
  Ingo
--
 To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv