From: Christian Couder <chriscool@tuxfamily.org>
Date: Sat, 2 Feb 2008 06:32:53 +0000 (+0100)
Subject: Rename 'git-help--browse.sh' to 'git-web--browse.sh'.
X-Git-Tag: v1.5.5-rc0~207^2~7
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/5884f1fe96b33d9666a78e660042b1e3e5f9f4d9
Rename 'git-help--browse.sh' to 'git-web--browse.sh'.
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index fb77ca3a57..ad41aabeb0 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -47,19 +47,19 @@ OPTIONS
+
The web browser can be specified using the configuration variable
'help.browser', or 'web.browser' if the former is not set. If none of
-these config variables is set, the 'git-help--browse' helper script
+these config variables is set, the 'git-web--browse' helper script
(called by 'git-help') will pick a suitable default.
+
You can explicitly provide a full path to your preferred browser by
setting the configuration variable 'browser.<tool>.path'. For example,
you can configure the absolute path to firefox by setting
-'browser.firefox.path'. Otherwise, 'git-help--browse' assumes the tool
+'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
is available in PATH.
+
Note that the script tries, as much as possible, to display the HTML
page in a new tab on an already opened browser.
+
-The following browsers are currently supported by 'git-help--browse':
+The following browsers are currently supported by 'git-web--browse':
+
* firefox (this is the default under X Window when not using KDE)
* iceweasel
diff --git a/Makefile b/Makefile
index a03fd2e9c9..d288378aa1 100644
--- a/Makefile
+++ b/Makefile
@@ -231,7 +231,7 @@ SCRIPT_SH = \
git-lost-found.sh git-quiltimport.sh git-submodule.sh \
git-filter-branch.sh \
git-stash.sh \
- git-help--browse.sh
+ git-web--browse.sh
SCRIPT_PERL = \
git-add--interactive.perl \
diff --git a/git-help--browse.sh b/git-help--browse.sh
deleted file mode 100755
index 8ed489d882..0000000000
--- a/git-help--browse.sh
+++ /dev/null
@@ -1,156 +0,0 @@
-#!/bin/sh
-#
-# This program launch a web browser on the html page
-# describing a git command.
-#
-# Copyright (c) 2007 Christian Couder
-# Copyright (c) 2006 Theodore Y. Ts'o
-#
-# This file is heavily stolen from git-mergetool.sh, by
-# Theodore Y. Ts'o (thanks) that is:
-#
-# Copyright (c) 2006 Theodore Y. Ts'o
-#
-# This file is licensed under the GPL v2, or a later version
-# at the discretion of Junio C Hamano or any other official
-# git maintainer.
-#
-
-USAGE='[--browser=browser|--tool=browser] [--config=conf.var] url/file ...'
-
-# This must be capable of running outside of git directory, so
-# the vanilla git-sh-setup should not be used.
-NONGIT_OK=Yes
-. git-sh-setup
-
-valid_tool() {
- case "$1" in
- firefox | iceweasel | konqueror | w3m | links | lynx | dillo)
- ;; # happy
- *)
- return 1
- ;;
- esac
-}
-
-init_browser_path() {
- browser_path=`git config browser.$1.path`
- test -z "$browser_path" && browser_path=$1
-}
-
-while test $# != 0
-do
- case "$1" in
- -b|--browser*|-t|--tool*)
- case "$#,$1" in
- *,*=*)
- browser=`expr "z$1" : 'z-[^=]*=\(.*\)'`
- ;;
- 1,*)
- usage ;;
- *)
- browser="$2"
- shift ;;
- esac
- ;;
- -c|--config*)
- case "$#,$1" in
- *,*=*)
- conf=`expr "z$1" : 'z-[^=]*=\(.*\)'`
- ;;
- 1,*)
- usage ;;
- *)
- conf="$2"
- shift ;;
- esac
- ;;
- --)
- break
- ;;
- -*)
- usage
- ;;
- *)
- break
- ;;
- esac
- shift
-done
-
-test $# = 0 && usage
-
-if test -z "$browser"
-then
- for opt in "$conf" "web.browser"
- do
- test -z "$opt" && continue
- browser="`git config $opt`"
- test -z "$browser" || break
- done
- if test -n "$browser" && ! valid_tool "$browser"; then
- echo >&2 "git config option $opt set to unknown browser: $browser"
- echo >&2 "Resetting to default..."
- unset browser
- fi
-fi
-
-if test -z "$browser" ; then
- if test -n "$DISPLAY"; then
- browser_candidates="firefox iceweasel konqueror w3m links lynx dillo"
- if test "$KDE_FULL_SESSION" = "true"; then
- browser_candidates="konqueror $browser_candidates"
- fi
- else
- browser_candidates="w3m links lynx"
- fi
-
- for i in $browser_candidates; do
- init_browser_path $i
- if type "$browser_path" > /dev/null 2>&1; then
- browser=$i
- break
- fi
- done
- test -z "$browser" && die "No known browser available."
-else
- valid_tool "$browser" || die "Unknown browser '$browser'."
-
- init_browser_path "$browser"
-
- if ! type "$browser_path" > /dev/null 2>&1; then
- die "The browser $browser is not available as '$browser_path'."
- fi
-fi
-
-case "$browser" in
- firefox|iceweasel)
- # Check version because firefox < 2.0 does not support "-new-tab".
- vers=$(expr "$($browser_path -version)" : '.* \([0-9][0-9]*\)\..*')
- NEWTAB='-new-tab'
- test "$vers" -lt 2 && NEWTAB=''
- nohup "$browser_path" $NEWTAB "$@" &
- ;;
- konqueror)
- case "$(basename "$browser_path")" in
- konqueror)
- # It's simpler to use kfmclient to open a new tab in konqueror.
- browser_path="$(echo "$browser_path" | sed -e 's/konqueror$/kfmclient/')"
- type "$browser_path" > /dev/null 2>&1 || die "No '$browser_path' found."
- eval "$browser_path" newTab "$@"
- ;;
- kfmclient)
- eval "$browser_path" newTab "$@"
- ;;
- *)
- nohup "$browser_path" "$@" &
- ;;
- esac
- ;;
- w3m|links|lynx)
- eval "$browser_path" "$@"
- ;;
- dillo)
- nohup "$browser_path" "$@" &
- ;;
-esac
diff --git a/git-web--browse.sh b/git-web--browse.sh
new file mode 100755
index 0000000000..8ed489d882
--- /dev/null
+++ b/git-web--browse.sh
@@ -0,0 +1,156 @@
+#!/bin/sh
+#
+# This program launch a web browser on the html page
+# describing a git command.
+#
+# Copyright (c) 2007 Christian Couder
+# Copyright (c) 2006 Theodore Y. Ts'o
+#
+# This file is heavily stolen from git-mergetool.sh, by
+# Theodore Y. Ts'o (thanks) that is:
+#
+# Copyright (c) 2006 Theodore Y. Ts'o
+#
+# This file is licensed under the GPL v2, or a later version
+# at the discretion of Junio C Hamano or any other official
+# git maintainer.
+#
+
+USAGE='[--browser=browser|--tool=browser] [--config=conf.var] url/file ...'
+
+# This must be capable of running outside of git directory, so
+# the vanilla git-sh-setup should not be used.
+NONGIT_OK=Yes
+. git-sh-setup
+
+valid_tool() {
+ case "$1" in
+ firefox | iceweasel | konqueror | w3m | links | lynx | dillo)
+ ;; # happy
+ *)
+ return 1
+ ;;
+ esac
+}
+
+init_browser_path() {
+ browser_path=`git config browser.$1.path`
+ test -z "$browser_path" && browser_path=$1
+}
+
+while test $# != 0
+do
+ case "$1" in
+ -b|--browser*|-t|--tool*)
+ case "$#,$1" in
+ *,*=*)
+ browser=`expr "z$1" : 'z-[^=]*=\(.*\)'`
+ ;;
+ 1,*)
+ usage ;;
+ *)
+ browser="$2"
+ shift ;;
+ esac
+ ;;
+ -c|--config*)
+ case "$#,$1" in
+ *,*=*)
+ conf=`expr "z$1" : 'z-[^=]*=\(.*\)'`
+ ;;
+ 1,*)
+ usage ;;
+ *)
+ conf="$2"
+ shift ;;
+ esac
+ ;;
+ --)
+ break
+ ;;
+ -*)
+ usage
+ ;;
+ *)
+ break
+ ;;
+ esac
+ shift
+done
+
+test $# = 0 && usage
+
+if test -z "$browser"
+then
+ for opt in "$conf" "web.browser"
+ do
+ test -z "$opt" && continue
+ browser="`git config $opt`"
+ test -z "$browser" || break
+ done
+ if test -n "$browser" && ! valid_tool "$browser"; then
+ echo >&2 "git config option $opt set to unknown browser: $browser"
+ echo >&2 "Resetting to default..."
+ unset browser
+ fi
+fi
+
+if test -z "$browser" ; then
+ if test -n "$DISPLAY"; then
+ browser_candidates="firefox iceweasel konqueror w3m links lynx dillo"
+ if test "$KDE_FULL_SESSION" = "true"; then
+ browser_candidates="konqueror $browser_candidates"
+ fi
+ else
+ browser_candidates="w3m links lynx"
+ fi
+
+ for i in $browser_candidates; do
+ init_browser_path $i
+ if type "$browser_path" > /dev/null 2>&1; then
+ browser=$i
+ break
+ fi
+ done
+ test -z "$browser" && die "No known browser available."
+else
+ valid_tool "$browser" || die "Unknown browser '$browser'."
+
+ init_browser_path "$browser"
+
+ if ! type "$browser_path" > /dev/null 2>&1; then
+ die "The browser $browser is not available as '$browser_path'."
+ fi
+fi
+
+case "$browser" in
+ firefox|iceweasel)
+ # Check version because firefox < 2.0 does not support "-new-tab".
+ vers=$(expr "$($browser_path -version)" : '.* \([0-9][0-9]*\)\..*')
+ NEWTAB='-new-tab'
+ test "$vers" -lt 2 && NEWTAB=''
+ nohup "$browser_path" $NEWTAB "$@" &
+ ;;
+ konqueror)
+ case "$(basename "$browser_path")" in
+ konqueror)
+ # It's simpler to use kfmclient to open a new tab in konqueror.
+ browser_path="$(echo "$browser_path" | sed -e 's/konqueror$/kfmclient/')"
+ type "$browser_path" > /dev/null 2>&1 || die "No '$browser_path' found."
+ eval "$browser_path" newTab "$@"
+ ;;
+ kfmclient)
+ eval "$browser_path" newTab "$@"
+ ;;
+ *)
+ nohup "$browser_path" "$@" &
+ ;;
+ esac
+ ;;
+ w3m|links|lynx)
+ eval "$browser_path" "$@"
+ ;;
+ dillo)
+ nohup "$browser_path" "$@" &
+ ;;
+esac
diff --git a/help.c b/help.c
index 058a397534..c35912bc55 100644
--- a/help.c
+++ b/help.c
@@ -347,7 +347,7 @@ static void show_html_page(const char *git_cmd)
get_html_page_path(&page_path, page);
- execl_git_cmd("help--browse", "-c", "help.browser", page_path.buf, NULL);
+ execl_git_cmd("web--browse", "-c", "help.browser", page_path.buf, NULL);
}
void help_unknown_cmd(const char *cmd)