Glenn Fowler wrote:
> re concerns about libast::optget() string out of sync with .1 man page
>
> I mentioned this in a previous post but it must have gotten lost
> amidst the volume of posts: the separate ksh93 sh.1 man page is an
> exception rather than the rule for ast section 1 utilities
>   

Right, this was my understanding of what the "upstream" does.

However it does *not* match the way we manage documentation in Solaris.

> in almost all other cases the optget() usage string *is* the man page src,
> and we have no intention of ever maintaining separate .1 man pages,
> save the traditional exceptions for the long ones like sh(1)
>
> if there are concerns about maintaining separate optget() usage strings
> and .1 text files for ast commands on solaris, then I recommend
> generating the man page from the --nroff output; this generation step
> would be a place to add solaris specific tags; something like
>
>       astcommand --nroff
>       solaris-maintained-man-additions
>
> as input to a script that generates the solaris man page text file
>   

This is a possibility, although there are still unanswered concerns 
about this.  At least one of these is that it totally short-cuts the 
professional writers, and our "standards" for man pages.  (For example, 
on Solaris, man pages include information about interface stability.  
This is probably meaningless to the ksh93 upstream project, but it *is* 
an important architectural consideration for Solaris.)

    - Garrett
> -- Glenn Fowler -- at&t Research, Florham Park NJ --
>
>   


Reply via email to