Merge branch 'jc/maint-1.6.0-diff-borrow-carefully'

[git.git] / t / lib-rebase.sh

diff --git a/t/lib-rebase.sh b/t/lib-rebase.sh
index 762ffcfa0f0f25d64821ca0ffc08fe92b1a3c572..260a231933a3cc9ce1f96eeb5952f34d7dc18d72 100644 (file)
--- 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" >fake-editor.sh
        cat >> fake-editor.sh <<\EOF