Re: [PATCH 2/3] git-help: add -w|--web option to display html man page in a browser.

Christian Couder [off-list ref] writes:

Doing this and then ...

... doing this is wrong. People can set htmldir to somewhere other than
$(prefix)/share/doc/git-doc while building and installing, but you are
not telling the munged script where it is.

+init_browser_path() {
+	browser_path=`git config browser.$1.path`
+	test -z "$browser_path" && browser_path=$1
+}

Please do not contaminate the config file with something the user can
easily use a lot more standardized way (iow $PATH) to configure to his
taste.

I'd suggest dropping this bit.

Le jeudi 6 décembre 2007, Junio C Hamano a écrit :

Christian Couder [off-list ref] writes:

quoted

diff --git a/Documentation/Makefile b/Documentation/Makefile
index d886641..3e01718 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile

@@ -29,6 +29,7 @@ DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))

 prefix?=$(HOME)
 bindir?=$(prefix)/bin
+htmldir?=$(prefix)/share/doc/git-doc
 mandir?=$(prefix)/share/man
 man1dir=$(mandir)/man1
 man5dir=$(mandir)/man5

Doing this and then ...

quoted

diff --git a/Makefile b/Makefile
index a5a40ce..9204bfe 100644
--- a/Makefile
+++ b/Makefile

@@ -807,6 +808,7 @@ $(patsubst %.sh,%,$(SCRIPT_SH)) : % : %.sh
 	    -e 's|@@PERL@@|$(PERL_PATH_SQ)|g' \
 	    -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' \
 	    -e 's/@@NO_CURL@@/$(NO_CURL)/g' \
+	    -e 's|@@PREFIX@@|$(prefix_SQ)|g' \
 	    $@.sh >$@+ && \
 	chmod +x $@+ && \
 	mv $@+ $@

...

diff --git a/git-browse-help.sh b/git-browse-help.sh
new file mode 100755
index 0000000..11f8bfa
--- /dev/null
+++ b/git-browse-help.sh

@@ -0,0 +1,154 @@
+#!/bin/sh

...
+USAGE='[--browser=browser|--tool=browser] [cmd to display] ...'
+SUBDIRECTORY_OK=Yes
+OPTIONS_SPEC=
+. git-sh-setup
+
+PREFIX="@@PREFIX@@"
+GIT_VERSION="@@GIT_VERSION@@"
+
+# Directories that may contain html documentation:
+install_html_dir="$PREFIX/share/doc/git-doc"
+rpm_dir="$PREFIX/share/doc/git-core-$GIT_VERSION"

... doing this is wrong. People can set htmldir to somewhere other than
$(prefix)/share/doc/git-doc while building and installing, but you are
not telling the munged script where it is.

Yeah, I sent a fix for this.

quoted

+init_browser_path() {
+	browser_path=`git config browser.$1.path`
+	test -z "$browser_path" && browser_path=$1
+}

Please do not contaminate the config file with something the user can
easily use a lot more standardized way (iow $PATH) to configure to his
taste.

I'd suggest dropping this bit.

I stole this part from "git-mergetool.sh":

init_merge_tool_path() {
        merge_tool_path=`git config mergetool.$1.path`
        if test -z "$merge_tool_path" ; then
                case "$1" in
                        emerge)
                                merge_tool_path=emacs
                                ;;
                        *)
                                merge_tool_path=$1
                                ;;
                esac
        fi
}

So we should either drop it in "git-mergetool.sh" too or keep it in both 
scripts.

Thanks,
Christian.