[Freeipa-devel] [PATCH] Modified ipa help behavior

[Jakub Hrozek]

On Mon, Nov 22, 2010 at 04:14:03PM -0500, Simo Sorce wrote:
> On Mon, 22 Nov 2010 11:33:19 -0500
> Rob Crittenden <rcritten at redhat.com> wrote:
> 
> > So I'm wondering if we need to re-think how we'd documenting things.
> > 
> > Right now we have on the order of 178 commands. That is a LOT of man 
> > pages even if we used some sort of automated XML system. We just need
> > to do the right thing before GA.
> > 
> > Rather than combining the help from all the similar commands just
> > show the top-level and include a SEEALSO?
> > 
> > So for example for: ipa help hbac
> > 
> > We would just show the hbac top-level help and include a SEEALSO for 
> > hbacsvc and hbacsvcgroup rather than including those top-level help
> > as well?
> > 
> > Similarly for sudo.
> 
> Not saying we should follow example but git seem to just fetch and
> popup the man page when you run a --help request.
> 
> So it seem that git upstream decided to document stuff only in the
> manpages instead of providing contextual help.
> 
> It seem an interesting option, worth discussing imo.
> 
> Simo.

Depends on how verbose the manpage is, I guess. I often run --help just
to check the exact syntax of switches -- stuff like does ipa
group-add-member take --groups or --group?