kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

subtree: add comments and sanity checks 

For each function in subtree, add a usage comment saying what the
arguments are, and add an `assert` checking the number of arguments.

In figuring out each thing's arguments in order to write those comments
and assertions, it turns out that find_existing_splits is written as if
it takes multiple 'revs', but it is in fact only ever passed a single
'rev':

	unrevs="$(find_existing_splits "$dir" "$rev")" || exit $?

So go ahead and codify that by documenting and asserting that it takes
exactly two arguments, one dir and one rev.

Signed-off-by: Luke Shumaker <lukeshu@datawire.io>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Luke Shumaker 2021-04-27 15:17:41 -06:00 committed by Junio C Hamano
parent cbb5de8b83
commit 5cdae0f6fd
1 changed files with 61 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
contrib/subtree/git-subtree.sh
View File

@ -55,6 +55,7 @@ arg_split_annotate=
arg_addmerge_squash= arg_addmerge_squash=
arg_addmerge_message= arg_addmerge_message=


# Usage: debug [MSG...]
debug () { debug () {
if test -n "$arg_debug" if test -n "$arg_debug"
then then
@ -62,6 +63,7 @@ debug () {
fi fi
} }


# Usage: progress [MSG...]
progress () { progress () {
if test -z "$GIT_QUIET" if test -z "$GIT_QUIET"
then then
@ -69,6 +71,7 @@ progress () {
fi fi
} }


# Usage: assert CMD...
assert () { assert () {
if ! "$@" if ! "$@"
then then
@ -192,7 +195,9 @@ main () {
"cmd_$arg_command" "$@" "cmd_$arg_command" "$@"
} }


# Usage: cache_setup
cache_setup () { cache_setup () {
assert test $# = 0
cachedir="$GIT_DIR/subtree-cache/$$" cachedir="$GIT_DIR/subtree-cache/$$"
rm -rf "$cachedir" || rm -rf "$cachedir" ||
die "Can't delete old cachedir: $cachedir" die "Can't delete old cachedir: $cachedir"
@ -203,6 +208,7 @@ cache_setup () {
debug "Using cachedir: $cachedir" >&2 debug "Using cachedir: $cachedir" >&2
} }


# Usage: cache_get [REVS...]
cache_get () { cache_get () {
for oldrev in "$@" for oldrev in "$@"
do do
@ -214,6 +220,7 @@ cache_get () {
done done
} }


# Usage: cache_miss [REVS...]
cache_miss () { cache_miss () {
for oldrev in "$@" for oldrev in "$@"
do do
@ -224,7 +231,9 @@ cache_miss () {
done done
} }


# Usage: check_parents PARENTS_EXPR INDENT
check_parents () { check_parents () {
assert test $# = 2
missed=$(cache_miss "$1") || exit $? missed=$(cache_miss "$1") || exit $?
local indent=$(($2 + 1)) local indent=$(($2 + 1))
for miss in $missed for miss in $missed
@ -237,11 +246,15 @@ check_parents () {
done done
} }


# Usage: set_notree REV
set_notree () { set_notree () {
assert test $# = 1
echo "1" > "$cachedir/notree/$1" echo "1" > "$cachedir/notree/$1"
} }


# Usage: cache_set OLDREV NEWREV
cache_set () { cache_set () {
assert test $# = 2
oldrev="$1" oldrev="$1"
newrev="$2" newrev="$2"
if test "$oldrev" != "latest_old" && if test "$oldrev" != "latest_old" &&
@ -253,7 +266,9 @@ cache_set () {
echo "$newrev" >"$cachedir/$oldrev" echo "$newrev" >"$cachedir/$oldrev"
} }


# Usage: rev_exists REV
rev_exists () { rev_exists () {
assert test $# = 1
if git rev-parse "$1" >/dev/null 2>&1 if git rev-parse "$1" >/dev/null 2>&1
then then
return 0 return 0
@ -262,17 +277,22 @@ rev_exists () {
fi fi
} }


# if a commit doesn't have a parent, this might not work. But we only want # Usage: try_remove_previous REV
#
# If a commit doesn't have a parent, this might not work. But we only want
# to remove the parent from the rev-list, and since it doesn't exist, it won't # to remove the parent from the rev-list, and since it doesn't exist, it won't
# be there anyway, so do nothing in that case. # be there anyway, so do nothing in that case.
try_remove_previous () { try_remove_previous () {
assert test $# = 1
if rev_exists "$1^" if rev_exists "$1^"
then then
echo "^$1^" echo "^$1^"
fi fi
} }


# Usage: find_latest_squash DIR
find_latest_squash () { find_latest_squash () {
assert test $# = 1
debug "Looking for latest squash ($dir)..." debug "Looking for latest squash ($dir)..."
dir="$1" dir="$1"
sq= sq=
@ -316,10 +336,12 @@ find_latest_squash () {
done || exit $? done || exit $?
} }


# Usage: find_existing_splits DIR REV
find_existing_splits () { find_existing_splits () {
assert test $# = 2
debug "Looking for prior splits..." debug "Looking for prior splits..."
dir="$1" dir="$1"
revs="$2" rev="$2"
main= main=
sub= sub=
local grep_format="^git-subtree-dir: $dir/*\$" local grep_format="^git-subtree-dir: $dir/*\$"
@ -328,7 +350,7 @@ find_existing_splits () {
grep_format="^Add '$dir/' from commit '" grep_format="^Add '$dir/' from commit '"
fi fi
git log --grep="$grep_format" \ git log --grep="$grep_format" \
--no-show-signature --pretty=format:'START %H%n%s%n%n%b%nEND%n' $revs | --no-show-signature --pretty=format:'START %H%n%s%n%n%b%nEND%n' "$rev" |
while read a b junk while read a b junk
do do
case "$a" in case "$a" in
@ -365,7 +387,9 @@ find_existing_splits () {
done || exit $? done || exit $?
} }


# Usage: copy_commit REV TREE FLAGS_STR
copy_commit () { copy_commit () {
assert test $# = 3
# We're going to set some environment vars here, so # We're going to set some environment vars here, so
# do it in a subshell to get rid of them safely later # do it in a subshell to get rid of them safely later
debug copy_commit "{$1}" "{$2}" "{$3}" debug copy_commit "{$1}" "{$2}" "{$3}"
@ -391,7 +415,9 @@ copy_commit () {
) || die "Can't copy commit $1" ) || die "Can't copy commit $1"
} }


# Usage: add_msg DIR LATEST_OLD LATEST_NEW
add_msg () { add_msg () {
assert test $# = 3
dir="$1" dir="$1"
latest_old="$2" latest_old="$2"
latest_new="$3" latest_new="$3"
@ -410,7 +436,9 @@ add_msg () {
EOF EOF
} }


# Usage: add_squashed_msg REV DIR
add_squashed_msg () { add_squashed_msg () {
assert test $# = 2
if test -n "$arg_addmerge_message" if test -n "$arg_addmerge_message"
then then
echo "$arg_addmerge_message" echo "$arg_addmerge_message"
@ -419,7 +447,9 @@ add_squashed_msg () {
fi fi
} }


# Usage: rejoin_msg DIR LATEST_OLD LATEST_NEW
rejoin_msg () { rejoin_msg () {
assert test $# = 3
dir="$1" dir="$1"
latest_old="$2" latest_old="$2"
latest_new="$3" latest_new="$3"
@ -438,7 +468,9 @@ rejoin_msg () {
EOF EOF
} }


# Usage: squash_msg DIR OLD_SUBTREE_COMMIT NEW_SUBTREE_COMMIT
squash_msg () { squash_msg () {
assert test $# = 3
dir="$1" dir="$1"
oldsub="$2" oldsub="$2"
newsub="$3" newsub="$3"
@ -460,12 +492,16 @@ squash_msg () {
echo "git-subtree-split: $newsub" echo "git-subtree-split: $newsub"
} }


# Usage: toptree_for_commit COMMIT
toptree_for_commit () { toptree_for_commit () {
assert test $# = 1
commit="$1" commit="$1"
git rev-parse --verify "$commit^{tree}" || exit $? git rev-parse --verify "$commit^{tree}" || exit $?
} }


# Usage: subtree_for_commit COMMIT DIR
subtree_for_commit () { subtree_for_commit () {
assert test $# = 2
commit="$1" commit="$1"
dir="$2" dir="$2"
git ls-tree "$commit" -- "$dir" | git ls-tree "$commit" -- "$dir" |
@ -479,7 +515,9 @@ subtree_for_commit () {
done || exit $? done || exit $?
} }


# Usage: tree_changed TREE [PARENTS...]
tree_changed () { tree_changed () {
assert test $# -gt 0
tree=$1 tree=$1
shift shift
if test $# -ne 1 if test $# -ne 1
@ -496,7 +534,9 @@ tree_changed () {
fi fi
} }


# Usage: new_squash_commit OLD_SQUASHED_COMMIT OLD_NONSQUASHED_COMMIT NEW_NONSQUASHED_COMMIT
new_squash_commit () { new_squash_commit () {
assert test $# = 3
old="$1" old="$1"
oldsub="$2" oldsub="$2"
newsub="$3" newsub="$3"
@ -511,7 +551,9 @@ new_squash_commit () {
fi fi
} }


# Usage: copy_or_skip REV TREE NEWPARENTS
copy_or_skip () { copy_or_skip () {
assert test $# = 3
rev="$1" rev="$1"
tree="$2" tree="$2"
newparents="$3" newparents="$3"
@ -586,7 +628,9 @@ copy_or_skip () {
fi fi
} }


# Usage: ensure_clean
ensure_clean () { ensure_clean () {
assert test $# = 0
if ! git diff-index HEAD --exit-code --quiet 2>&1 if ! git diff-index HEAD --exit-code --quiet 2>&1
then then
die "Working tree has modifications. Cannot add." die "Working tree has modifications. Cannot add."
@ -597,12 +641,16 @@ ensure_clean () {
fi fi
} }


# Usage: ensure_valid_ref_format REF
ensure_valid_ref_format () { ensure_valid_ref_format () {
assert test $# = 1
git check-ref-format "refs/heads/$1" || git check-ref-format "refs/heads/$1" ||
die "'$1' does not look like a ref" die "'$1' does not look like a ref"
} }


# Usage: process_split_commit REV PARENTS INDENT
process_split_commit () { process_split_commit () {
assert test $# = 3
local rev="$1" local rev="$1"
local parents="$2" local parents="$2"
local indent=$3 local indent=$3
@ -654,6 +702,8 @@ process_split_commit () {
cache_set latest_old "$rev" cache_set latest_old "$rev"
} }


# Usage: cmd_add REV
# Or: cmd_add REPOSITORY REF
cmd_add () { cmd_add () {


ensure_clean ensure_clean
@ -681,7 +731,9 @@ cmd_add () {
fi fi
} }


# Usage: cmd_add_repository REPOSITORY REFSPEC
cmd_add_repository () { cmd_add_repository () {
assert test $# = 2
echo "git fetch" "$@" echo "git fetch" "$@"
repository=$1 repository=$1
refspec=$2 refspec=$2
@ -689,9 +741,11 @@ cmd_add_repository () {
cmd_add_commit FETCH_HEAD cmd_add_commit FETCH_HEAD
} }


# Usage: cmd_add_commit REV
cmd_add_commit () { cmd_add_commit () {
# The rev has already been validated by cmd_add(), we just # The rev has already been validated by cmd_add(), we just
# need to normalize it. # need to normalize it.
assert test $# = 1
rev=$(git rev-parse --verify "$1^{commit}") || exit $? rev=$(git rev-parse --verify "$1^{commit}") || exit $?


debug "Adding $dir as '$rev'..." debug "Adding $dir as '$rev'..."
@ -722,6 +776,7 @@ cmd_add_commit () {
say >&2 "Added dir '$dir'" say >&2 "Added dir '$dir'"
} }


# Usage: cmd_split [REV]
cmd_split () { cmd_split () {
if test $# -eq 0 if test $# -eq 0
then then
@ -801,6 +856,7 @@ cmd_split () {
exit 0 exit 0
} }


# Usage: cmd_merge REV
cmd_merge () { cmd_merge () {
test $# -eq 1 || test $# -eq 1 ||
die "You must provide exactly one revision. Got: '$*'" die "You must provide exactly one revision. Got: '$*'"
@ -837,6 +893,7 @@ cmd_merge () {
fi fi
} }


# Usage: cmd_pull REPOSITORY REMOTEREF
cmd_pull () { cmd_pull () {
if test $# -ne 2 if test $# -ne 2
then then
@ -848,6 +905,7 @@ cmd_pull () {
cmd_merge FETCH_HEAD cmd_merge FETCH_HEAD
} }


# Usage: cmd_push REPOSITORY REMOTEREF
cmd_push () { cmd_push () {
if test $# -ne 2 if test $# -ne 2
then then