Re: [PATCH] git-sh-setup: document git_editor() and get_author_ident_from_commit()

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 29, 2007, 00:37 UTC
Message-ID: <7vlk7ecp58.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <1198880739-8480-1-git-send-email-vmiklos@frugalware.org>

Thanks.

"proper editor" felt a bit funny, and also it needs to be documented that it refuses to proceed when the default editor is unusable, so I'd reword it like this:

diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt
index 1ea1faa..505b4c9 100644
--- a/Documentation/git-sh-setup.txt
+++ b/Documentation/git-sh-setup.txt
@@ -44,6 +44,11 @@ set_reflog_action::
 	end-user action in the reflog, when the script updates a
 	ref.
 
+git_editor::
+	runs an editor of user's choice (GIT_EDITOR, core.editor, VISUAL or
+	EDITOR) on a given file, but error out if no editor is specified
+	and the terminal is dumb.
+
 is_bare_repository::
 	outputs `true` or `false` to the standard output stream
 	to indicate if the repository is a bare repository