[PATCH 2/6] lib-rebase.sh: Document what set_fake_editor() does

From

Johannes Schindelin <johannes.schindelin@gmx.de>

Date

Jan 27, 2009, 17:46 UTC

Message-ID

<alpine.DEB.1.00.0901271846340.3586@pacific.mpi-cbg.de>

In-Reply-To

<alpine.DEB.1.00.0901271844340.3586@pacific.mpi-cbg.de>

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---

	Separated from 1/6 to make the code move more obvious.

 t/lib-rebase.sh |   12 ++++++++++++
 1 files changed, 12 insertions(+), 0 deletions(-)

diff --git a/t/lib-rebase.sh b/t/lib-rebase.sh
index 8c8caab..cda7778 100644
--- a/t/lib-rebase.sh
+++ b/t/lib-rebase.sh
@@ -1,5 +1,17 @@
 #!/bin/sh
 
+# After setting the fake editor with this function, you can
+#
+# - override the commit message with $FAKE_COMMIT_MESSAGE,
+# - amend the commit message with $FAKE_COMMIT_AMEND
+# - check that non-commit messages have a certain line count with $EXPECT_COUNT
+# - rewrite a rebase -i script with $FAKE_LINES in the form
+#
+#	"[<lineno1>] [<lineno2>]..."
+#
+#   If a line number is prefixed with "squash" or "edit", the respective line's
+#   command will be replaced with the specified one.
+
 set_fake_editor () {
 	echo "#!${SHELL_PATH-/bin_sh}" >fake-editor.sh
 	cat >> fake-editor.sh <<\EOF

-- 
1.6.1.482.g7d54be