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