git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: git-browse-help?

From
Jeff King <peff@peff.net>
Date
Dec 16, 2007, 07:21 UTC
Message-ID
<20071216072104.GA4892@sigill.intra.peff.net>
In-Reply-To
<7vabobn4i3.fsf@gitster.siamese.dyndns.org>
On Sat, Dec 15, 2007 at 11:26:44AM -0800, Junio C Hamano wrote:
> > Although I would have called it "git-help--browse" rather than
> > "git-browse--help" since
> 
> Good point.

And here is the patch (I based the change-sites off of the ones in your previous patch, plus a grep to double-check).

-- >8 -- rename git-browse--help to git-help--browse

The convention for helper scripts has been git-$TOOL--$HELPER. Since this is a "browse" helper for the "help" tool, git-help--browse is a more sensible name.

Signed-off-by: Jeff King <peff@peff.net>
---
 .gitignore                                 |    2 +-
 Documentation/git-help.txt                 |    4 ++--
 Makefile                                   |    2 +-
 git-browse--help.sh => git-help--browse.sh |    0 
 help.c                                     |    2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)
 rename git-browse--help.sh => git-help--browse.sh (100%)
diff --git a/.gitignore b/.gitignore
index aef01c5..dab5bc2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,7 +12,6 @@ git-archive
 git-bisect
 git-blame
 git-branch
-git-browse--help
 git-bundle
 git-cat-file
 git-check-attr
@@ -52,6 +51,7 @@ git-gc
 git-get-tar-commit-id
 git-grep
 git-hash-object
+git-help--browse
 git-http-fetch
 git-http-push
 git-imap-send
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 8cd69e7..da3f718 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -47,13 +47,13 @@ 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-browse--help' helper script
+these config variables is set, the 'git-help--browse' helper script
 (called by 'git-help') will pick a suitable default.
 +
 You can explicitly provide a full path to your prefered 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-browse--help' assumes the tool
+'browser.firefox.path'. Otherwise, 'git-help--browse' assumes the tool
 is available in PATH.
 +
 Note that the script tries, as much as possible, to display the HTML
diff --git a/Makefile b/Makefile
index 62f1893..7776077 100644
--- a/Makefile
+++ b/Makefile
@@ -227,7 +227,7 @@ SCRIPT_SH = \
 	git-lost-found.sh git-quiltimport.sh git-submodule.sh \
 	git-filter-branch.sh \
 	git-stash.sh \
-	git-browse--help.sh
+	git-help--browse.sh
 
 SCRIPT_PERL = \
 	git-add--interactive.perl \
diff --git a/git-browse--help.sh b/git-help--browse.sh
similarity index 100%
rename from git-browse--help.sh
rename to git-help--browse.sh
diff --git a/help.c b/help.c
index f9ce6db..1302a61 100644
--- a/help.c
+++ b/help.c
@@ -331,7 +331,7 @@ static void show_info_page(const char *git_cmd)
 static void show_html_page(const char *git_cmd)
 {
 	const char *page = cmd_to_page(git_cmd);
-	execl_git_cmd("browse--help", page, NULL);
+	execl_git_cmd("help--browse", page, NULL);
 }
 
 void help_unknown_cmd(const char *cmd)
-- 
1.5.4.rc0.1122.g899d-dirty
Previous: Junio C Hamano
Message 9 of 9 in “git-browse-help?”
  1. Jeff KingDec 14, 2007
  2. Junio C HamanoDec 14, 2007
  3. Jeff KingDec 15, 2007
  4. Jeff KingDec 15, 2007
  5. Jeff KingDec 15, 2007
  6. Junio C HamanoDec 15, 2007
  7. Shawn O. PearceDec 15, 2007
  8. Junio C HamanoDec 15, 2007
  9. Jeff KingDec 16, 2007

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.