Jakub Narebski <jnareb@xxxxxxxxx> writes:
>> What I've often wished is that git's help system would output
>> something like:
>>
>> $ git help co
>> `git co' is aliased to `checkout'
>>
>> Here's the help entry for `checkout':
>>
>> GIT-CHECKOUT(1) Git Manual GIT-CHECKOUT(1)
>
> Wouldn't it be more useful to say something like this:
>
> $ git co --help
> `git co' is aliased to `checkout'
>
> You can see help entry for `checkout' with "git checkout --help"
>
> Then help is only copy'n'paste away.
Describe your algorithm to come up with the equivalent to the above
'checkout' in this example:
$ git one --help
`git one' is aliased to `!sh -c 'git show -s --pretty="format:%h (%s, %ai" "$@" | sed -e "s/ [012][0-9]:[0-5][0-9]:[0-5][0-9] [-+][0-9][0-9][0-9][0-9]$/)/"' -'
If we decide to punt on the '! <cmd>' form, i.e. "take the first token and
if it is a git command then do this special thing but otherwise don't make
things worse", then you could improve this example:
$ git lgf --help
'git lgf' is aliased to 'log --oneline --boundary --first-parent'
with "git log --help", but that is aiming too low for my taste.
If you are redesigning the help system, isn't it a shame that you are
discarding other tokens in the alias when giving help? Wouldn't it be
wonderful if you extracted the option descriptions for these three options
specified and showing only that, for example?
You would need to ensure that the manual pages for all commands share the
same structure to make that happen, which goes without saying.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html