I pushed the following patch to 4msysgit.git's mob branch
[ I finally found the mob branch at
ssh://mob@repo.or.cz/srv/git/git/mingw/4msysgit.git
which apparently was one git too much for my brain. ]
commit a9a42a347894edfbca33e48bed0fcd38ec334a35
help (msysgit): teach git help to open html from /doc/git/html/
Html pages will be opened using the default Windows application
configured for html. This code path is taken for msysgit (mingw).
It is assumed that html pages are installed at /doc/git/html.
This needs to be ensured by the msysgit superproject to make this
patch useful. html pages should be cloned from git.git's main
repo. This is the easiest way to get up-to-date documentation,
without requiring the complete tool chain to generate them
locally.
If html pages are not yet there, you can use the following
commands to get them:
mkdir -p /doc/git/html
cd /doc/git/html/
git init
git config remote.origin.url git://git.kernel.org/pub/scm/
git/git.git
git config remote.origin.fetch refs/heads/html:refs/remotes/
origin/html
git fetch
git checkout --track -b html origin/html
and update the html documentation with
git pull
The superproject should be setup in /share/GitMe/setup-msysgit.sh to
fetch the html pages as a submodule. But I don't understanding
submodules good enough to do so.
If you then type 'git help <command>' Firefox or Explorer or whatever
you configured as your default html viewer will show you the git help.
I think this is a good idea for Windows users.
Junio,
are you interested in such patches at this time. The patch doesn't
interfere with the existing code, but clutters it with ifdefs.
Steffen
This reminds me a patch I made before:
http://thread.gmane.org/gmane.comp.version-control.git/49217/focus=49575
With a little modification you can use ShellExecute to open html if
there is no suitable program to open it. The last commit on
mingw.git's mob branch does that (not based on my mentioned patch
though).
On 8/11/07, Steffen Prohaska [off-list ref] wrote:
I pushed the following patch to 4msysgit.git's mob branch
[ I finally found the mob branch at
ssh://mob@repo.or.cz/srv/git/git/mingw/4msysgit.git
which apparently was one git too much for my brain. ]
commit a9a42a347894edfbca33e48bed0fcd38ec334a35
help (msysgit): teach git help to open html from /doc/git/html/
Html pages will be opened using the default Windows application
configured for html. This code path is taken for msysgit (mingw).
It is assumed that html pages are installed at /doc/git/html.
This needs to be ensured by the msysgit superproject to make this
patch useful. html pages should be cloned from git.git's main
repo. This is the easiest way to get up-to-date documentation,
without requiring the complete tool chain to generate them
locally.
If html pages are not yet there, you can use the following
commands to get them:
mkdir -p /doc/git/html
cd /doc/git/html/
git init
git config remote.origin.url git://git.kernel.org/pub/scm/
git/git.git
git config remote.origin.fetch refs/heads/html:refs/remotes/
origin/html
git fetch
git checkout --track -b html origin/html
and update the html documentation with
git pull
The superproject should be setup in /share/GitMe/setup-msysgit.sh to
fetch the html pages as a submodule. But I don't understanding
submodules good enough to do so.
If you then type 'git help <command>' Firefox or Explorer or whatever
you configured as your default html viewer will show you the git help.
I think this is a good idea for Windows users.
Junio,
are you interested in such patches at this time. The patch doesn't
interfere with the existing code, but clutters it with ifdefs.
Steffen
-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
--
Duy
On 8/11/07, Nguyen Thai Ngoc Duy [off-list ref] wrote:
This reminds me a patch I made before:
http://thread.gmane.org/gmane.comp.version-control.git/49217/focus=49575
And the second patch:
http://article.gmane.org/gmane.comp.version-control.git/49216
With a little modification you can use ShellExecute to open html if
there is no suitable program to open it. The last commit on
mingw.git's mob branch does that (not based on my mentioned patch
though).
--
Duy
On Aug 12, 2007, at 2:16 AM, Nguyen Thai Ngoc Duy wrote:
On 8/11/07, Nguyen Thai Ngoc Duy [off-list ref] wrote:
quoted
This reminds me a patch I made before:
http://thread.gmane.org/gmane.comp.version-control.git/49217/
focus=49575
And the second patch:
http://article.gmane.org/gmane.comp.version-control.git/49216
quoted
With a little modification you can use ShellExecute to open html if
there is no suitable program to open it. The last commit on
mingw.git's mob branch does that (not based on my mentioned patch
though).
So we have three approached now:
1) Nguyen's approach using '--html'/core.help=html to explicitly
choose html as the format of choice. The core.htmlprogram is used
and a printf style format string can be used to specify required
command line parameters.
2) Junio's light-weight core.helpcmd, which gets passed the string
that would normally be passed to 'man'. Helpcmd needs to figure
out how to do the right thing. Most likely helpcmd would be a
small shell script that does the mapping to a file or url for
displaying the help. But it can also be a more complex thing,
for example load a Windows chm file and jump to a specific anchor,
or whatsoever.
3) Steffen's msysgit specific code path to display always locally
installed html pages on Windows, and never display 'man' pages.
From my perspective, (3) would be the fastest way to get a useful
git help in msysgit. It only needs to be applied and shipped. But
it provides no benefit for git.git on other architectures.
(2) is a very light-weight extension to core git, yet capable of
providing everything we need, or can think of in the future. It
makes sense to me to delegate the details how to find the help,
based on the git command, to an external helper.
Maybe I work a bit more on Junio's approach later the day. I would
like to see a useful help system in msysgit before advertising it
to a larger audience that has no git experience.
Steffen