Keith M Wesolowski wrote:
> On Thu, Sep 13, 2007 at 01:37:46PM -0500, Shawn Walker wrote:
>
>
>> The page you linked to outlines the reason:
>>
>> "`libtoolize --automake' is used by Automake to add libtool files to
>> your package, when AM_PROG_LIBTOOL appears in your `configure.in'."
>>
>> Developers that are contributing to existing open source projects that
>> use libtool will unfortunately need this.
>>
>
> Can we at least disable all the other modes of operation?
>
> More generally, what about warning the user that the commands are
> Obsolete, as specified by
> http://www.opensolaris.org/os/community/arc/policies/obsolete-eof/:
> "if feasable, add a warning mechanism that informs the user if/when
> the interface is used".
>
**All** OpenSolaris commands are supposed to have man pages, although
they may be vestigial man pages. They are supposed to minimally contain:
The SYNOPSIS
The ATTRIBUTES section
The DESCRIPTION section, which may only contain a textual reference
to where the real documentation is. (A one-line description is
also a
nice touch.)
(Not required, but "SEE ALSO" tends to be a nice thing.)
Example:
SYNOPSIS
foo [--bar] file
DESCRIPTION
The foo utility provides no real function, but some people desire it.
Documentation may be found under the following rock:
place
ATTRIBUTES
<usual attributes stuff>
SEE ALSO
snafu(1)
I included this example, just to make it clear how minimal this is.
Back to the issue...
Is it not sufficient that the ATTRIBUTES section characterize "libtoolize"
as Obsolete with additional text stating that the only "reasonable" use is
as "libtoolize --automake"?
- jek3
