tg-create.sh

   1 #!/bin/sh
   2 # TopGit - A different patch queue manager
   3 # Copyright (C) Petr Baudis <pasky@suse.cz>  2008
   4 # Copyright (C) Kyle J. McKay <mackyle@gmail.com>  2015,2016,2017
   5 # All rights reserved.
   6 # GPLv2
   7
   8 deps= # List of dependent branches
   9 merge= # List of branches to be merged; subset of $deps
  10 name=
  11 rname= # Remote branch to base this one on
  12 remote=
  13 force=
  14 msg=
  15 msgfile=
  16 topmsg=
  17 topmsgfile=
  18 noedit=
  19 nocommit=
  20 nodeps=
  21 topmsg=
  22 warntop=
  23 quiet=
  24 branchtype=PATCH
  25 branchdesc=patch
  26
  27 USAGE="Usage: ${tgname:-tg} [... -r remote] create [-q] [-m <msg> | -F <file>] [--topmsg <msg> | --topmsg-file <file>] [-n] [--no-commit] [--base] [<name> [<dep>...|-r [<rname>]] ]"
  28
  29 usage()
  30 {
  31         if [ "${1:-0}" != 0 ]; then
  32                 printf '%s\n' "$USAGE" >&2
  33         else
  34                 printf '%s\n' "$USAGE"
  35         fi
  36         exit ${1:-0}
  37 }
  38
  39 quiet_info()
  40 {
  41         [ -n "$quiet" ] || info "$@"
  42 }
  43
  44 ## Parse options
  45
  46 while [ $# -gt 0 ]; do case "$1" in
  47         -h|--help)
  48                 usage
  49                 ;;
  50         --quiet|-q)
  51                 quiet=1
  52                 ;;
  53         --force|-f)
  54                 force=1
  55                 ;;
  56         --no-commit)
  57                 nocommit=1
  58                 ;;
  59         -n|--no-edit)
  60                 noedit=1
  61                 nocommit=1
  62                 ;;
  63         --no-deps|--base)
  64                 nodeps=1
  65                 branchtype=BASE
  66                 branchdesc=base
  67                 ;;
  68         -m|--message|--message=*)
  69                 case "$1" in --message=*)
  70                         x="$1"
  71                         shift
  72                         set -- --message "${x#--message=}" "$@"
  73                 esac
  74                 if [ $# -lt 2 ]; then
  75                         echo "The $1 option requires an argument" >&2
  76                         usage 1
  77                 fi
  78                 shift
  79                 msg="$1"
  80                 ;;
  81         --tm|--tm=*|--topmsg|--topmsg=*)
  82                 case "$1" in
  83                 --tm=*)
  84                         x="$1"
  85                         shift
  86                         set -- --tm "${x#--tm=}" "$@";;
  87                 --topmsg=*)
  88                         x="$1"
  89                         shift
  90                         set -- --topmsg "${x#--topmsg=}" "$@";;
  91                 esac
  92                 if [ $# -lt 2 ]; then
  93                         echo "The $1 option requires an argument" >&2
  94                         usage 1
  95                 fi
  96                 shift
  97                 topmsg="$1"
  98                 ;;
  99         -F|--file|--file=*)
 100                 case "$1" in --file=*)
 101                         x="$1"
 102                         shift
 103                         set -- --file "${x#--file=}" "$@"
 104                 esac
 105                 if [ $# -lt 2 ]; then
 106                         echo "The $1 option requires an argument" >&2
 107                         usage 1
 108                 fi
 109                 shift
 110                 msgfile="$1"
 111                 ;;
 112         --tF|--tF=*|--topmsg-file|--topmsg-file=*)
 113                 case "$1" in
 114                  --tF=*)
 115                         x="$1"
 116                         shift
 117                         set -- --tF "${x#--tF=}" "$@";;
 118                  --topmsg-file=*)
 119                         x="$1"
 120                         shift
 121                         set -- --topmsg-file "${x#--topmsg-file=}" "$@";;
 122                 esac
 123                 if [ $# -lt 2 ]; then
 124                         echo "The $1 option requires an argument" >&2
 125                         usage 1
 126                 fi
 127                 shift
 128                 topmsgfile="$1"
 129                 ;;
 130         -r)
 131                 remote=1
 132                 rname="$2"; [ $# -eq 0 ] || shift
 133                 ;;
 134         --)
 135                 shift
 136                 break
 137                 ;;
 138         -?*)
 139                 echo "Unknown option: $1" >&2
 140                 usage 1
 141                 ;;
 142         *)
 143                 break
 144                 ;;
 145 esac; shift; done
 146 ensure_work_tree
 147 [ $# -gt 0 -o -z "$rname" ] || set -- "$rname"
 148 if [ $# -gt 0 ]; then
 149         name="$1"
 150         shift
 151         if [ -z "$remote" -a "$1" = "-r" ]; then
 152                 remote=1
 153                 shift;
 154                 rname="$1"
 155                 [ $# -eq 0 ] || shift
 156         fi
 157 fi
 158 [ -n "$name" ] || { err "no branch name given"; usage 1; }
 159 [ -z "$remote" -o -n "$rname" ] || rname="$name"
 160 [ -z "$remote" -o -z "$msg$msgfile$topmsg$topmsgfile$nocommit$nodeps" ] || { err "-r may not be combined with other options"; usage 1; }
 161 [ $# -eq 0 -o -z "$remote" ] || { err "deps not allowed with -r"; usage 1; }
 162 [ $# -le 1 -o -z "$nodeps" ] || { err "--base (aka --no-deps) allows at most one <dep>"; usage 1; }
 163 [ -z "$msg" -o -z "$msgfile" ] || die "only one -F or -m option is allowed"
 164 [ "$msgfile" != "-" -o "$topmsgfile" != "-" ] || { err "--message-file and --topmsg-file may not both be '-'"; usage 1; }
 165
 166 ## Fast-track creating branches based on remote ones
 167
 168 if [ -n "$rname" ]; then
 169         [ -n "$name" ] || die "no branch name given"
 170         ! ref_exists "refs/heads/$name" || die "branch '$name' already exists"
 171         ! ref_exists "refs/$topbases/$name" || die "'$topbases/$name' already exists"
 172         if [ -z "$base_remote" ]; then
 173                 die "no remote location given. Either use -r remote argument or set topgit.remote"
 174         fi
 175         has_remote "$rname" || die "no branch $rname in remote $base_remote"
 176         init_reflog "refs/$topases/$name"
 177         msg="tgcreate: $name -r $rname"
 178         tbrv="$(ref_exists_rev "refs/remotes/$base_remote/${topbases#heads/}/$rname")" ||
 179         tbrv="$(ref_exists_rev "refs/remotes/$base_remote/${oldbases#heads/}/$rname")" ||
 180         die "no branch $rname in remote $base_remote"
 181         git update-ref -m "$msg" "refs/$topbases/$name" "$tbrv" ""
 182         git update-ref -m "$msg" "refs/heads/$name" "refs/remotes/$base_remote/$rname" ""
 183         quiet_info "Topic branch $name based on $base_remote : $rname set up."
 184         exit 0
 185 fi
 186
 187 ## Auto-guess dependencies
 188
 189 [ "$name" != "@" ] || name="HEAD"
 190 if [ -z "$*" ]; then
 191         # The common case
 192         [ -n "$name" ] || die "no branch name given"
 193         if [ -n "$nodeps" ]; then
 194                 deps="HEAD"
 195         else
 196                 head="$(git symbolic-ref --quiet HEAD)" || :
 197                 [ -z "$head" ] || git rev-parse --verify --quiet "$head" -- >/dev/null ||
 198                         die "refusing to auto-depend on unborn branch (use --base aka --no-deps)"
 199                 deps="${head#refs/heads/}"
 200                 [ "$deps" != "$head" ] || die "refusing to auto-depend on non-branch ref (${head:-detached HEAD})"
 201                 quiet_info "automatically marking dependency on $deps"
 202         fi
 203 else
 204         # verify each dep is valid and expand "@" to "HEAD" and "HEAD" to it's symref (unless detached)
 205         deps=
 206         head="$(git symbolic-ref --quiet HEAD)" || :
 207         for d in "$@"; do
 208                 [ "$d" != "@" ] || d="HEAD"
 209                 [ "$d" != "HEAD" ] || [ -z "$head" ] || d="$head"
 210                 case "$d" in
 211                         HEAD)
 212                                 die "cannot depend on detached HEAD"
 213                                 ;;
 214                         refs/heads/?*)
 215                                 d="${d#refs/heads/}"
 216                                 ;;
 217                         refs/*)
 218                                 die "cannot depend on non-branch ref '$d'"
 219                                 ;;
 220                 esac
 221                 ref_exists "refs/heads/$d" || {
 222                         ok=
 223                         case "refs/$d" in refs/heads/?*)
 224                                 d="${d#heads/}"
 225                                 ! ref_exists "refs/heads/$d" || ok=1
 226                                 ;;
 227                         esac
 228                         [ -n "$ok" ] ||  die "unknown branch dependency '$d'"
 229                 }
 230                 deps="${deps:+$deps }$d"
 231         done
 232 fi
 233
 234 unborn=
 235 if [ -n "$nodeps" ]; then
 236         # there can be only one dep and it need only be a committish
 237         # however, if it's HEAD and HEAD is an unborn branch that's okay too
 238         if [ "$deps" = "HEAD" ] && unborn="$(git symbolic-ref --quiet HEAD --)" && ! git rev-parse --verify --quiet HEAD -- >/dev/null; then
 239                 branchtype=ROOT
 240                 branchdesc=root
 241         else
 242                 unborn=
 243                 git rev-parse --quiet --verify "$deps^0" -- >/dev/null ||
 244                         die "unknown committish \"$deps\""
 245         fi
 246 fi
 247
 248 # Non-remote branch set up requires a clean tree unless the single dep is the same tree as a not unborn HEAD
 249 # Also the .topdeps and .topmsg files, if they exist, may not be overwriten unless they are "clean"
 250
 251 prefix=refs/heads/
 252 [ -z "$nodeps" ] || prefix=
 253 ensure_cmd=ensure_clean_tree
 254 if [ -n "$unborn" ]; then
 255         ensure_cmd=:
 256 elif [ $# -eq 1 ] && { [ "$deps" = "HEAD" ] ||
 257         [ "$(git rev-parse --quiet --verify "$prefix$deps^{tree}" --)" = "$(git rev-parse --quiet --verify HEAD^{tree} --)" ]; }; then
 258         ensure_cmd=:
 259 fi
 260 ($ensure_cmd && ensure_clean_topfiles ${unborn:+-u}) || {
 261         [ $# -ne 1 ] || [ "$deps" = "HEAD" ] || info "use \`git checkout $deps\` first and then try again"
 262         exit 1
 263 }
 264
 265 [ -n "$merge" ] || merge="$deps "
 266
 267 if [ -z "$nodeps" ]; then
 268         olddeps="$deps"
 269         deps=
 270         while read d && [ -n "$d" ]; do
 271                 if [ "$d" = "HEAD" ]; then
 272                         sr="$(git symbolic-ref --quiet HEAD)" || :
 273                         [ -z "$sr" ] || git rev-parse --verify --quiet "$sr" -- >/dev/null ||
 274                                 die "refusing to depend on unborn branch (use --base aka --no-deps)"
 275                         [ -n "$sr" ] || die "cannot depend on a detached HEAD"
 276                         case "$sr" in refs/heads/*);;*)
 277                                 die "HEAD is a symref to other than refs/heads/..."
 278                         esac
 279                         d="${sr#refs/heads/}"
 280                 else
 281                         ref_exists "refs/heads/$d" || die "unknown branch dependency '$d'"
 282                 fi
 283                 case " $deps " in
 284                         *" $d "*)
 285                                 warn "ignoring duplicate depedency $d"
 286                                 ;;
 287                         *)
 288                                 deps="${deps:+$deps }$d"
 289                                 ;;
 290                 esac
 291         done <<-EOT
 292         $(sed 'y/ /\n/' <<-LIST
 293         $olddeps
 294         LIST
 295         )
 296         EOT
 297         unset olddeps
 298 fi
 299 if test="$(git symbolic-ref --quiet "$name" --)"; then case "$test" in
 300         refs/"$topbases"/*)
 301                 name="${test#refs/$topbases/}"
 302                 break;;
 303         refs/heads/*)
 304                 name="${test#refs/heads/}"
 305                 break;;
 306 esac; fi
 307 ! ref_exists "refs/heads/$name" ||
 308         die "branch '$name' already exists"
 309 ! ref_exists "refs/$topbases/$name" ||
 310         die "'$topbases/$name' already exists"
 311 [ -n "$force" ] || ! ref_exists "refs/tags/$name" ||
 312         die "refusing to create branch with same name as existing tag '$name' without --force"
 313
 314 # Barf now rather than later if missing ident
 315 ensure_ident_available
 316
 317 if [ -n "$merge" ] && [ -z "$unborn" ]; then
 318         # make sure the checkout won't fail
 319         branch="${merge%% *}"
 320         prefix=refs/heads/
 321         [ -z "$nodeps" ] || prefix=
 322         git rev-parse --quiet --verify "$prefix$branch^0" >/dev/null ||
 323                 die "invalid dependency: $branch"
 324         git read-tree -n -u -m "$prefix$branch^0" ||
 325                 die "git checkout \"$branch\" would fail"
 326 fi
 327
 328 # Get messages
 329
 330 tab="$(printf '\t.')" && tab="${tab%?}"
 331 get_subject()
 332 {
 333         sed -n '1,/^$/p' |
 334         grep -i "^Subject[ $tab]*:" |
 335         sed -n "s/^[^: $tab][^: $tab]*[ $tab]*:[ $tab]*//; s/[ $tab][ $tab]*\$//; 1p" ||
 336         :
 337 }
 338
 339 >"$git_dir/TG_EDITMSG"
 340 if [ -n "$msgfile" ]; then
 341         if [ "$msgfile" = "-" ]; then
 342                 git stripspace >"$git_dir/TG_EDITMSG"
 343         else
 344                 git stripspace <"$msgfile" >"$git_dir/TG_EDITMSG"
 345         fi
 346 elif [ -n "$msg" ]; then
 347         printf '%s\n' "$msg" | git stripspace >"$git_dir/TG_EDITMSG"
 348 fi
 349 if [ ! -s "$git_dir/TG_EDITMSG" ]; then
 350         printf '%s\n' "tg create $name" | git stripspace >"$git_dir/TG_EDITMSG"
 351 fi
 352 msg="$(cat "$git_dir/TG_EDITMSG")"
 353 rm -f "$git_dir/TG_EDITMSG"
 354
 355 >"$git_dir/TG_EDITMSG"
 356 if [ -n "$topmsgfile" ]; then
 357         if [ "$topmsgfile" = "-" ]; then
 358                 git stripspace >"$git_dir/TG_EDITMSG"
 359         else
 360                 git stripspace <"$topmsgfile" >"$git_dir/TG_EDITMSG"
 361         fi
 362 elif [ -n "$topmsg" ]; then
 363         printf '%s\n' "$topmsg" | git stripspace >"$git_dir/TG_EDITMSG"
 364 fi
 365 if [ -s "$git_dir/TG_EDITMSG" ]; then
 366         noedit=1
 367 else
 368         author="$(git var GIT_AUTHOR_IDENT)"
 369         author_addr="${author%> *}>"
 370         {
 371                 echo "From: $author_addr"
 372                 ! header="$(git config topgit.to)" || echo "To: $header"
 373                 ! header="$(git config topgit.cc)" || echo "Cc: $header"
 374                 ! header="$(git config topgit.bcc)" || echo "Bcc: $header"
 375                 ! subject_prefix="$(git config topgit.subjectprefix)" || subject_prefix="$subject_prefix "
 376                 echo "Subject: [${subject_prefix}$branchtype] $name"
 377                 echo
 378                 echo "<$branchdesc description>"
 379                 echo
 380                 sobpfx='#'
 381                 [ z"$(git config --bool format.signoff 2>/dev/null)" != z"true" ] || sobpfx=
 382                 echo "${sobpfx}Signed-off-by: $author_addr"
 383         } | git stripspace >"$git_dir/TG_EDITMSG"
 384 fi
 385 if [ -z "$noedit" ]; then
 386         cat <<EOT >>"$git_dir/TG_EDITMSG"
 387
 388 # Please enter the patch message for the new TopGit branch $name.
 389 # It will be stored in the .topmsg file and used to create the
 390 # patch header when \`tg patch\` is run on branch $name.
 391 # The "Subject:" line will appear in \`tg summary\` and \`tg info\` output.
 392 #
 393 # Lines starting with '#' will be ignored, and an empty patch
 394 # message aborts the \`tg create\` operation entirely.
 395 #
 396 # tg create ${nodeps:+--base }$name $deps
 397 EOT
 398         run_editor "$git_dir/TG_EDITMSG" ||
 399         die "there was a problem with the editor '$tg_editor'"
 400         git stripspace -s <"$git_dir/TG_EDITMSG" >"$git_dir/TG_EDITMSG"+
 401         mv -f "$git_dir/TG_EDITMSG"+ "$git_dir/TG_EDITMSG"
 402         [ -s "$git_dir/TG_EDITMSG" ] || die "nothing to do"
 403 fi
 404 subj="$(get_subject <"$git_dir/TG_EDITMSG")"
 405 if [ -z "$subj" ]; then
 406         subj="$(sed -n "s/^[ $tab][ $tab]*//; 1p" <"$git_dir/TG_EDITMSG")";
 407         case "$subj" in "["*);;*) subj="[$branchtype] $subj"; esac
 408         printf '%s\n' "Subject: $subj" "" >"$git_dir/TG_EDITMSG"+
 409         sed -n '2,$p' <"$git_dir/TG_EDITMSG" | git stripspace >>"$git_dir/TG_EDITMSG"+
 410         mv -f "$git_dir/TG_EDITMSG"+ "$git_dir/TG_EDITMSG"
 411         warntop=1
 412 fi
 413 topmsg="$(cat "$git_dir/TG_EDITMSG")"
 414 rm -f "$git_dir/TG_EDITMSG"
 415
 416 ## Find starting commit to create the base
 417
 418 if [ -n "$merge" ]; then
 419         # Unshift the first item from the to-merge list
 420         branch="${merge%% *}"
 421         merge="${merge#* }"
 422         # We create a detached head so that we can abort this operation
 423         prefix=refs/heads/
 424         [ -z "$nodeps" ] || prefix=
 425         if [ -n "$unborn" ]; then
 426                 quiet_info "creating $name base with empty tree..."
 427         else
 428                 quiet_info "creating $name base from $branch..."
 429                 git checkout -q $iowopt "$(git rev-parse --verify "$prefix$branch^0" --)"
 430         fi
 431 fi
 432
 433 ## Set up the topic branch
 434
 435 git update-index --index-info <<EOT || die "git update-index failed"
 436 0 $nullsha$tab.topdeps
 437 0 $nullsha$tab.topmsg
 438 EOT
 439 rm -rf "$root_dir/.topdeps" "$root_dir/.topmsg"
 440 init_reflog "refs/$topbases/$name"
 441 if [ -n "$unborn" ]; then
 442         mttree="$(git mktree </dev/null)"
 443         emsg="tg create empty $name base"
 444         [ "refs/heads/$name" = "$unborn" ] || emsg="Initial empty commit"
 445         mtcommit="$(git commit-tree  -m "$emsg" "$mttree")" || die "git commit-tree failed"
 446         git update-ref -m "tgcreate: create ${unborn#refs/heads/}" "HEAD" "$mtcommit" ""
 447         [ "refs/heads/$name" = "$unborn" ] || warn "branch ${unborn#refs/heads/} created with empty commit"
 448         git update-ref -m "tgcreate: set $name base" "refs/$topbases/$name" "HEAD" ""
 449         [ "refs/heads/$name" = "$unborn" ] || git checkout $iowopt -b "$name"
 450 else
 451         basetree="$(git rev-parse --verify "HEAD^{tree}" --)" && [ -n "$basetree" ] || die "HEAD disappeared"
 452         baseptree="$(pretty_tree "HEAD" -r)" || die "pretty_tree HEAD -r (via git mktree) failed"
 453         if [ "$basetree" != "$baseptree" ]; then
 454                 bmsg="tg create $name base"
 455                 basecommit="$(git commit-tree -p "HEAD" -m "$bmsg" "$baseptree")" || die "git commit-tree failed"
 456         else
 457                 basecommit="HEAD"
 458         fi
 459         git update-ref -m "tgcreate: set $name base" "refs/$topbases/$name" "$basecommit" ""
 460         [ "$basecommit" = "HEAD" ] || git update-ref -m "tgcreate: set $name base" "HEAD" "$basecommit"
 461         git checkout $iowopt -b "$name"
 462 fi
 463
 464 if [ -n "$nodeps" ] || [ -z "$deps" ]; then
 465         >"$root_dir/.topdeps"
 466 else
 467         sed 'y/ /\n/' <<-EOT >"$root_dir/.topdeps"
 468         $deps
 469         EOT
 470 fi
 471 git add -f "$root_dir/.topdeps"
 472 printf '%s\n' "$topmsg" >"$root_dir/.topmsg"
 473 git add -f "$root_dir/.topmsg"
 474 rm -f "$git_dir/TGMERGE_MSG"
 475
 476 [ -z "$warntop" ] || warn ".topmsg content was reformatted into patch header"
 477 if [ -n "$nocommit" ]; then
 478         printf '%s\n' "$msg" >"$git_dir/MERGE_MSG"
 479         quiet_info "Topic branch $name set up."
 480         if [ -n "$noedit" ]; then
 481                 quiet_info "Please fill in .topmsg now and make the initial commit."
 482         else
 483                 quiet_info "Please make the initial commit."
 484         fi
 485         quiet_info "Remember to run $tgdisplay update afterwards."
 486         quiet_info "To abort:"
 487         quiet_info "  git$gitcdopt rm -f .top* && git$gitcdopt checkout ${deps%% *} && $tgdisplay delete $name"
 488         exit 0
 489 fi
 490
 491 git commit -m "$msg" "$root_dir/.topdeps" "$root_dir/.topmsg" || die "git commit failed"
 492 rawsubj="$(get_subject <"$root_dir/.topmsg")"
 493 nommsg=1
 494 case "$rawsubj" in *"["[Pp][Aa][Tt][Cc][Hh]"]"*)
 495         nommsg=
 496         subj="$(sed "s/^[^]]*]//; s/^[ $tab][ $tab]*//; s/[ $tab][ $tab]*\$//" <<-EOT
 497                 $rawsubj
 498         EOT
 499         )"
 500         {
 501                 [ -z "$subj" ] || printf '%s\n' "$subj" ""
 502                 sed -e '1,/^$/d' <"$root_dir/.topmsg"
 503         } >"$git_dir/MERGE_MSG"
 504 esac
 505 quiet_info "Topic branch $name created."
 506 [ -n "$merge" ] || exit 0
 507 ## Merge other dependencies into the base
 508 quiet_info "Running $tgname update to merge in dependencies."
 509 [ -n "$nommsg" ] || ! [ -f "$git_dir/MERGE_MSG" ] || mv -f "$git_dir/MERGE_MSG" "$git_dir/TGMERGE_MSG" || :
 510 set -- "$name"
 511 . "$TG_INST_CMDDIR"/tg-update