Merge branch 'sg/fsck-config-in-doc'
[gitweb.git] / t / lib-patch-mode.sh
index 06c3c9176207af6c27c924377f29cc2bd0c881e5..cfd76bf987bd902503cfcacd3e8ac1b9c4deb09c 100644 (file)
@@ -2,28 +2,40 @@
 
 . ./test-lib.sh
 
+# set_state <path> <worktree-content> <index-content>
+#
+# Prepare the content for path in worktree and the index as specified.
 set_state () {
        echo "$3" > "$1" &&
        git add "$1" &&
        echo "$2" > "$1"
 }
 
+# save_state <path>
+#
+# Save index/worktree content of <path> in the files _worktree_<path>
+# and _index_<path>
 save_state () {
        noslash="$(echo "$1" | tr / _)" &&
        cat "$1" > _worktree_"$noslash" &&
        git show :"$1" > _index_"$noslash"
 }
 
+# set_and_save_state <path> <worktree-content> <index-content>
 set_and_save_state () {
        set_state "$@" &&
        save_state "$1"
 }
 
+# verify_state <path> <expected-worktree-content> <expected-index-content>
 verify_state () {
        test "$(cat "$1")" = "$2" &&
        test "$(git show :"$1")" = "$3"
 }
 
+# verify_saved_state <path>
+#
+# Call verify_state with expected contents from the last save_state
 verify_saved_state () {
        noslash="$(echo "$1" | tr / _)" &&
        verify_state "$1" "$(cat _worktree_"$noslash")" "$(cat _index_"$noslash")"