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

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

[Miklos Vajna]

These 2 functions were missing from the manpage.

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---
 Documentation/git-sh-setup.txt |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt
index 1ea1faa..fd024d7 100644
--- a/Documentation/git-sh-setup.txt
+++ b/Documentation/git-sh-setup.txt
@@ -44,6 +44,10 @@ set_reflog_action::
 	end-user action in the reflog, when the script updates a
 	ref.
 
+git_editor::
+	runs the proper editor based on GIT_EDITOR, core.editor, VISUAL or
+	EDITOR.
+
 is_bare_repository::
 	outputs `true` or `false` to the standard output stream
 	to indicate if the repository is a bare repository
@@ -57,6 +61,10 @@ require_work_tree::
 	if so.  Used by scripts that require working tree
 	(e.g. `checkout`).
 
+get_author_ident_from_commit::
+	outputs code for use with eval to set the GIT_AUTHOR_NAME,
+	GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit.
+
 
 Author
 ------
-- 
1.5.4.rc2-dirty

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

[Junio C Hamano]

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

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

[Miklos Vajna]

These 2 functions were missing from the manpage.

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---

On Fri, Dec 28, 2007 at 04:37:07PM -0800, Junio C Hamano <gitster@pobox.com> wrote:
> unusable, so I'd reword it like this:

here it is.

VMiklos

 Documentation/git-sh-setup.txt |    9 +++++++++
 1 files changed, 9 insertions(+), 0 deletions(-)

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
@@ -57,6 +62,10 @@ require_work_tree::
 	if so.  Used by scripts that require working tree
 	(e.g. `checkout`).
 
+get_author_ident_from_commit::
+	outputs code for use with eval to set the GIT_AUTHOR_NAME,
+	GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit.
+
 
 Author
 ------
-- 
1.5.4.rc2-dirty