Re: [PATCH] git-help: Try to find html pages without the git- prefix

2 messages, 2 authors, 2016-06-15 · open the first message on its own page

Re: [PATCH] git-help: Try to find html pages without the git- prefix

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:44:32

Christian Couder [off-list ref] writes:
We already have the following files following that scheme:

gitk.txt
gitattributes.txt
gitignore.txt
gitcli.txt
gitmodules.txt
git.txt

And for example the following commands are already working:

$ git help -w gitmodules
$ git help -m gitmodules
$ man gitmodules
That is not surprise as gitattributes(5), gitignore(5) and gitmodules(5)
work by design.  They are valid manual pages in section 5 (file formats).

I am not sure about hooks let alone gitcli --- they are not something you
would traditionally place in section 5.

It would be nice if "git help <any path you see in Documentation/>" worked
as expected, although I personally tend to go to the *.txt files ;-)

Re: [PATCH] git-help: Try to find html pages without the git- prefix

From: Christian Couder <hidden>
Date: 2016-06-15 22:44:32

Le mardi 29 avril 2008, Junio C Hamano a écrit :
Christian Couder [off-list ref] writes:
quoted
We already have the following files following that scheme:

gitk.txt
gitattributes.txt
gitignore.txt
gitcli.txt
gitmodules.txt
git.txt

And for example the following commands are already working:

$ git help -w gitmodules
$ git help -m gitmodules
$ man gitmodules
That is not surprise as gitattributes(5), gitignore(5) and gitmodules(5)
work by design.  They are valid manual pages in section 5 (file formats).

I am not sure about hooks let alone gitcli --- they are not something you
would traditionally place in section 5.
Aren't there other man sections where we could put them ?
It would be nice if "git help <any path you see in Documentation/>"
worked as expected, 
I agree and that means that we should find an appropriate man section for 
everything in "Documentation/". Otherwise how could "git help -m <any path 
you see in Documentation/>" work ?

Thanks,
Christian.
although I personally tend to go to the *.txt files 
;-)
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help