Support 'help' for custom/alias commands

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

 



Adding a custom comment (let?s call is ?foolish?) is easy but then you
someone types ?git help foolish?, they get some strange message about help
not being found.

There are two problems with this:

1. It?s hard for users to create good documentation in the same format as
the core git product 2. The git ?help? processing currently looks in one,
and one place only and that location is often ?locked down? meaning that
mere users cannot add their custom help to this directory.

I propose that #1 be solved by creating a command/tool and documentation
that explains how to mimic the input to the standard Git help files and have
them processed to create the HTML/HTML5/MAN help normally produced.  Ideally
it would do exactly the same processing as the core tools (perhaps even
having their docs built using this tool now) and use exactly the same
template files that core git uses.

I propose that #2 be solved by allowing a new set of ?git config? fields.
The layout should be sensible and should users to be able to set a git
variable which then means that the core git help finds their help text.
Possible we want to force

<where I installed my tool>/docs/man, or html, or html5

And the git config variable be something like
?help.custom.foolish=<where-foolish-is-installed>/docs?

Paul DS.

P.S. I have a perfectly respectable e-mail address at
paul_d_smith@xxxxxxxxxxx which I have used for years - why won't you accept
e-mails from it?






[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux