bug-mailutils
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Hardcoded prefix in documentation?


From: Sergey Poznyakoff
Subject: Re: Hardcoded prefix in documentation?
Date: Mon, 16 Dec 2002 12:03:18 +0200

> When talking with Jordi on irc, I noticed that we've got the prefix
> hardcoded in a number of places, where we either say "/usr", or
> "/usr/local/", should I cook up a patch to substitute in whatever the
> built $(prefix) is? I think it would be nice if the documentation
> reflected the actual installation.

Sure, it would be nice. However this would require the installer
to have texinfo package. Besides, the compiled info files are usually
included into the distribution tarball.

I'd propose to make the configuration script check for the presense
of makeinfo and then decide whether or not to rebuild the
docs.

Another thing I noticed: the title of the documentation says:
'mailutils, Programming Manual'. However a large part of the
documentation describes the utility programs. My proposition
is to split the documentation into three parts:

1. Programming Manual

This is a manual on how to use mailutils libraries
(libmailbox, libmuauth, libmu_scm). 

2. Library Reference

This will contain a concise description of library functions, types
and global variables. The actual contents of the manual up to the
chapter 'Programs' belongs here.

3. User Manual

A manual describing the utility programs shipped with mailutils. The
chapter 'Programs' of the current documentation is a good startpoint
for this.

Opinions?

Regards,
Sergey



reply via email to

[Prev in Thread] Current Thread [Next in Thread]