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

[PATCH] Add help details to git help command.

From
SCSteven Cole <elenstev@mesatop.com>
Date
Apr 18, 2005, 04:42 UTC
Message-ID
<200504172242.26326.elenstev@mesatop.com>

There's a patch at the bottom of this, so please look at that first before my reading my whining immediately below.

I'm having some troubles with git pull, so this is just an ordinary diff. Otherwise, I would have used the in-house diff command.

<troubles> patch: **** Only garbage was found in the patch input. </troubles> <more troubles> Tracked branch, applying changes... error: bad signature error: verify header failed read_cache: Invalid argument error: bad signature error: verify header failed error: bad signature error: verify header failed </more troubles>

Anyway, it's late, and I'm sure there is an easy fix to the above.

Here is a patch which provides the comment lines in the associated script files when the git help command is invoked with an argument thusly:

[steven@spc git-pasky-new]$ ./git help merge
 Merge a branch to the current tree.
 Copyright (c) Petr Baudis, 2005
 Takes a parameter identifying the branch to be merged.
 Optional "-b base_commit" parameter specifies the base for the
 merge. "-a" parameter may come first to tell git merge
 to check out the full tree to the merge tree.
 It creates a new ,,merge/ directory, which is git-controlled
 but has only the changed files checked out. You then have to
 examine it and then do git commit, which will also automatically
 bring your working tree up-to-date.

--------- This patch will provide the comment lines in the shell script associated with the command, cleaned up a bit for presentation.

BUGS: This will also print any comments in the entire file, which may
not be desired.  If a command name and shell script filename
do not follow the usual convention, this won't work, e.g. ci for commit.
Signed-off-by: Steven Cole <elenstev@mesatop.com>

--- gp-newest-orig/git 2005-04-17 22:16:55.000000000 -0600 +++ gp-newest/git 2005-04-17 22:19:49.000000000 -0600

@@ -19,6 +19,11 @@
 
 
 help () {
+
+command=$1
+scriptfile=git$command.sh
+
+if [ ! $command ]; then
 	cat <<__END__
 The GIT scripted toolkit  $(gitversion.sh)
 
@@ -48,7 +53,10 @@
 	update		COMMIT_ID
 	version
 
+Additional help is available with: git help COMMAND
+
 Note that these expressions can be used interchangably as "ID"s:
+
 	empty string (current HEAD)
 	local (the local branch if tracking a remote one)
 	remote name (as registered with git addremote)
@@ -57,6 +65,10 @@
 	commit object hash (as returned by commit-id)
 	tree object hash (accepted only by some commands)
 __END__
+fi
+if [ ! $scriptfile = "git.sh" ]; then
+grep ^# $scriptfile | grep -v "!/bin" | cut -c 2-
+fi
 }
 
 
Next: Petr Baudis
Message 1 of 16 in “Add help details to git help command.”
  1. Add help details to git help command.Steven Cole, Apr 18, 2005
  2. Petr BaudisApr 18, 2005
  3. Steven ColeApr 18, 2005
  4. [RFC] Another way to provide help details. (was Re: [PATCH] Add help details to git help command.)Steven Cole, Apr 19, 2005
  5. Petr BaudisApr 19, 2005
  6. David GreavesApr 19, 2005
  7. Steven ColeApr 19, 2005
  8. Petr BaudisApr 19, 2005
  9. Steven ColeApr 19, 2005
  10. Petr BaudisApr 19, 2005
  11. David GreavesApr 19, 2005
  12. Steven ColeApr 19, 2005
  13. David GreavesApr 19, 2005
  14. Petr BaudisApr 20, 2005
  15. David GreavesApr 21, 2005
  16. Petr BaudisApr 23, 2005

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.