* [PATCH 1/2] add --html-path to get the location of installed HTML docs
2009-04-05 1:33 [PATCH 0/2] Reliably open the installed HTML docs from git-gui Markus Heidelberg
@ 2009-04-05 1:35 ` Markus Heidelberg
2009-04-05 2:15 ` [PATCH v2 " Markus Heidelberg
2009-04-05 1:48 ` [PATCH 2/2 resend] git-gui: use `git --html-path` " Markus Heidelberg
1 sibling, 1 reply; 4+ messages in thread
From: Markus Heidelberg @ 2009-04-05 1:35 UTC (permalink / raw)
To: Junio C Hamano, Shawn O. Pearce; +Cc: git
This can be used in GUIs to open installed HTML documentation in the
browser.
Signed-off-by: Markus Heidelberg <markus.heidelberg@web.de>
---
Documentation/git.txt | 6 +++++-
Makefile | 1 +
contrib/completion/git-completion.bash | 1 +
exec_cmd.c | 6 ++++++
git.c | 5 ++++-
perl/Git.pm | 12 +++++++++++-
6 files changed, 28 insertions(+), 3 deletions(-)
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 7513c57..2ce5e6b 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -9,7 +9,7 @@ git - the stupid content tracker
SYNOPSIS
--------
[verse]
-'git' [--version] [--exec-path[=GIT_EXEC_PATH]]
+'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
[-p|--paginate|--no-pager]
[--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
[--help] COMMAND [ARGS]
@@ -178,6 +178,10 @@ help ...`.
environment variable. If no path is given, 'git' will print
the current setting and then exit.
+--html-path::
+ Print the path to wherever your git HTML documentation is installed
+ and exit.
+
-p::
--paginate::
Pipe all output into 'less' (or if set, $PAGER).
diff --git a/Makefile b/Makefile
index 7867eac..28ccad9 100644
--- a/Makefile
+++ b/Makefile
@@ -1308,6 +1308,7 @@ git.o git.spec \
exec_cmd.o: exec_cmd.c GIT-CFLAGS
$(QUIET_CC)$(CC) -o $*.o -c $(ALL_CFLAGS) \
'-DGIT_EXEC_PATH="$(gitexecdir_SQ)"' \
+ '-DGIT_HTML_PATH="$(htmldir_SQ)"' \
'-DBINDIR="$(bindir_relative_SQ)"' \
'-DPREFIX="$(prefix_SQ)"' \
$<
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index e72ce24..fdc5a24 100755
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -1870,6 +1870,7 @@ _git ()
--bare
--version
--exec-path
+ --html-path
--work-tree=
--help
"
diff --git a/exec_cmd.c b/exec_cmd.c
index 408e4e5..25e0521 100644
--- a/exec_cmd.c
+++ b/exec_cmd.c
@@ -84,6 +84,12 @@ const char *git_exec_path(void)
return system_path(GIT_EXEC_PATH);
}
+/* Returns the location to look for git HTML documentation. */
+const char *git_html_path(void)
+{
+ return system_path(GIT_HTML_PATH);
+}
+
static void add_path(struct strbuf *out, const char *path)
{
if (path && *path) {
diff --git a/git.c b/git.c
index c2b181e..ff934bd 100644
--- a/git.c
+++ b/git.c
@@ -5,7 +5,7 @@
#include "run-command.h"
const char git_usage_string[] =
- "git [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate|--no-pager] [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE] [--help] COMMAND [ARGS]";
+ "git [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path] [-p|--paginate|--no-pager] [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE] [--help] COMMAND [ARGS]";
const char git_more_info_string[] =
"See 'git help COMMAND' for more information on a specific command.";
@@ -75,6 +75,9 @@ static int handle_options(const char*** argv, int* argc, int* envchanged)
puts(git_exec_path());
exit(0);
}
+ } else if (!strcmp(cmd, "--html-path")) {
+ puts(git_html_path());
+ exit(0);
} else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
use_pager = 1;
} else if (!strcmp(cmd, "--no-pager")) {
diff --git a/perl/Git.pm b/perl/Git.pm
index 7d7f2b1..291ff5b 100644
--- a/perl/Git.pm
+++ b/perl/Git.pm
@@ -56,7 +56,7 @@ require Exporter;
@EXPORT_OK = qw(command command_oneline command_noisy
command_output_pipe command_input_pipe command_close_pipe
command_bidi_pipe command_close_bidi_pipe
- version exec_path hash_object git_cmd_try
+ version exec_path html_path hash_object git_cmd_try
remote_refs
temp_acquire temp_release temp_reset temp_path);
@@ -492,6 +492,16 @@ C<git --exec-path>). Useful mostly only internally.
sub exec_path { command_oneline('--exec-path') }
+=item html_path ()
+
+Return path to the Git html documentation (the same as
+C<git --html-path>). Useful mostly only internally.
+
+=cut
+
+sub html_path { command_oneline('--html-path') }
+
+
=item repo_path ()
Return path to the git repository. Must be called on a repository instance.
--
1.6.2.2.428.gea44ab
^ permalink raw reply related [flat|nested] 4+ messages in thread* [PATCH 2/2 resend] git-gui: use `git --html-path` to get the location of installed HTML docs
2009-04-05 1:33 [PATCH 0/2] Reliably open the installed HTML docs from git-gui Markus Heidelberg
2009-04-05 1:35 ` [PATCH 1/2] add --html-path to get the location of installed HTML docs Markus Heidelberg
@ 2009-04-05 1:48 ` Markus Heidelberg
1 sibling, 0 replies; 4+ messages in thread
From: Markus Heidelberg @ 2009-04-05 1:48 UTC (permalink / raw)
To: Junio C Hamano, Shawn O. Pearce; +Cc: git
Previously a hardcoded path $GIT_EXEC_PATH/../Documentation/ was used to
search for the documentation, when the user has asked for it via menu
"Help -> Online Documentation".
This didn't work for the default directory structure.
To find the path reliably, use the new git command line option, which
returns the correct path.
If the output of `git --html-path` is empty because git is not found or
the option is not yet supported in the installed git, the documentation
from kernel.org is launched. There is no additional guessing of the
right location of the installed docs.
Signed-off-by: Markus Heidelberg <markus.heidelberg@web.de>
---
Resend since the other mail didn't reach the list. This problem happens
far too often to me.
git-gui.sh | 33 +++++++++++++++++++++++++++++----
1 files changed, 29 insertions(+), 4 deletions(-)
diff --git a/git-gui.sh b/git-gui.sh
index b3aa732..259251b 100755
--- a/git-gui.sh
+++ b/git-gui.sh
@@ -122,6 +122,7 @@ unset oguimsg
set _appname {Git Gui}
set _gitdir {}
set _gitexec {}
+set _githtmldir {}
set _reponame {}
set _iscygwin {}
set _search_path {}
@@ -168,6 +169,28 @@ proc gitexec {args} {
return [eval [list file join $_gitexec] $args]
}
+proc githtmldir {args} {
+ global _githtmldir
+ if {$_githtmldir eq {}} {
+ if {[catch {set _githtmldir [git --html-path]}]} {
+ # Git not installed or option not yet supported
+ return {}
+ }
+ if {[is_Cygwin]} {
+ set _githtmldir [exec cygpath \
+ --windows \
+ --absolute \
+ $_githtmldir]
+ } else {
+ set _githtmldir [file normalize $_githtmldir]
+ }
+ }
+ if {$args eq {}} {
+ return $_githtmldir
+ }
+ return [eval [list file join $_githtmldir] $args]
+}
+
proc reponame {} {
return $::_reponame
}
@@ -2591,11 +2614,13 @@ if {![is_MacOSX]} {
}
-set doc_path [file dirname [gitexec]]
-set doc_path [file join $doc_path Documentation index.html]
+set doc_path [githtmldir]
+if {$doc_path ne {}} {
+ set doc_path [file join $doc_path index.html]
-if {[is_Cygwin]} {
- set doc_path [exec cygpath --mixed $doc_path]
+ if {[is_Cygwin]} {
+ set doc_path [exec cygpath --mixed $doc_path]
+ }
}
if {[file isfile $doc_path]} {
--
1.6.2.2.405.ge9fc3
^ permalink raw reply related [flat|nested] 4+ messages in thread