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="$2"; [ $# -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 if [ -z "$continue" -a $# -gt 0 ]; then
 170         name="$1"
 171         shift
 172         if [ -z "$remote" -a "$1" = "-r" ]; then
 173                 remote=1
 174                 shift;
 175                 rname="$1"
 176                 [ $# -eq 0 ] || shift
 177         fi
 178 fi
 179 [ -n "$continue" -o -n "$name" ] || { err "no branch name given"; usage 1; }
 180 [ -z "$remote" -o -n "$rname" ] || rname="$name"
 181 [ -z "$remote" -o -z "$msg$msgfile$topmsg$topmsgfile$nocommit$nodeps" ] || { err "-r may not be combined with other options"; usage 1; }
 182 [ $# -eq 0 -o -z "$remote" ] || { err "deps not allowed with -r"; usage 1; }
 183 [ $# -le 1 -o -z "$nodeps" ] || { err "--no-deps allows at most one <dep>"; usage 1; }
 184 [ -z "$msg" -o -z "$msgfile" ] || die "only one -F or -m option is allowed"
 185 [ -z "$continue" ] || is_active || die "no tg create is currently active"
 186 [ "$msgfile" != "-" -o "$topmsgfile" != "-" ] || { err "--message-file and --topmsg-file may not both be '-'"; usage 1; }
 187
 188 ## Fast-track creating branches based on remote ones
 189
 190 if [ -n "$rname" ]; then
 191         [ -n "$name" ] || die "no branch name given"
 192         ! ref_exists "refs/heads/$name" || die "branch '$name' already exists"
 193         ! ref_exists "refs/$topbases/$name" || die "'$topbases/$name' already exists"
 194         if [ -z "$base_remote" ]; then
 195                 die "no remote location given. Either use -r remote argument or set topgit.remote"
 196         fi
 197         has_remote "$rname" || die "no branch $rname in remote $base_remote"
 198         init_reflog "refs/$topases/$name"
 199         msg="tgcreate: $name -r $rname"
 200         tbrv="$(ref_exists_rev "refs/remotes/$base_remote/${topbases#heads/}/$rname")" ||
 201         tbrv="$(ref_exists_rev "refs/remotes/$base_remote/${oldbases#heads/}/$rname")" ||
 202         die "no branch $rname in remote $base_remote"
 203         git update-ref -m "$msg" "refs/$topbases/$name" "$tbrv" ""
 204         git update-ref -m "$msg" "refs/heads/$name" "refs/remotes/$base_remote/$rname" ""
 205         quiet_info "Topic branch $name based on $base_remote : $rname set up."
 206         exit 0
 207 fi
 208
 209 ## Auto-guess dependencies
 210
 211 deps="$*"
 212 if [ -z "$deps" ]; then
 213         if [ -z "$name" ] && is_active; then
 214                 # We are setting up the base branch now; resume merge!
 215                 name="$(cat "$git_dir/tg-create/name")"
 216                 deps="$(cat "$git_dir/tg-create/deps")"
 217                 merge="$(cat "$git_dir/tg-create/merge")"
 218                 msg="$(cat "$git_dir/tg-create/msg")"
 219                 topmsg="$(cat "$git_dir/tg-create/topmsg")"
 220                 nocommit="$(cat "$git_dir/tg-create/nocommit")"
 221                 noedit="$(cat "$git_dir/tg-create/noedit")"
 222                 warntop="$(cat "$git_dir/tg-create/warntop")"
 223                 quiet="$(cat "$git_dir/tg-create/quiet")"
 224                 restarted=1
 225                 quiet_info "Resuming $name setup..."
 226         else
 227                 # The common case
 228                 [ -z "$name" ] && die "no branch name given"
 229                 if [ -n "$nodeps" ]; then
 230                         deps="HEAD"
 231                 else
 232                         head="$(git symbolic-ref --quiet HEAD)" || :
 233                         [ -z "$head" ] || git rev-parse --verify --quiet "$head" -- ||
 234                                 die "refusing to auto-depend on unborn branch (use --no-deps)"
 235                         deps="${head#refs/heads/}"
 236                         [ "$deps" != "$head" ] || die "refusing to auto-depend on non-branch ref (${head:-detached HEAD})"
 237                         quiet_info "automatically marking dependency on $deps"
 238                 fi
 239         fi
 240 fi
 241
 242 unborn=
 243 if [ -n "$nodeps" ]; then
 244         # there can be only one dep and it need only be a committish
 245         # however, if it's HEAD and HEAD is an unborn branch that's okay too
 246         if [ "$deps" = "HEAD" ] && unborn="$(git symbolic-ref --quiet HEAD --)" && ! git rev-parse --verify --quiet HEAD -- >/dev/null; then
 247                 branchtype=ROOT
 248                 branchdesc=root
 249         else
 250                 unborn=
 251                 git rev-parse --quiet --verify "$deps^0" -- >/dev/null ||
 252                         die "unknown committish \"$deps\""
 253         fi
 254 fi
 255
 256 # Non-remote branch set up requires a clean tree unless the single dep is the same tree as HEAD
 257 [ -n "$restarted" ] || [ "$deps" = "HEAD" ] || {
 258         prefix=refs/heads/
 259         [ -z "$nodeps" ] || prefix=
 260         [ $# -eq 1 -a "$(git rev-parse --quiet --verify "$prefix$deps^{tree}" --)" = "$(git rev-parse --quiet --verify HEAD^{tree} --)" ] ||
 261                 (ensure_clean_tree) || {
 262                         [ $# -ne 1 ] || info "use \`git checkout $deps\` first and then try again"
 263                         exit 1
 264                 }
 265 }
 266
 267 [ -n "$merge" -o -n "$restarted" ] || merge="$deps "
 268
 269 if [ -z "$nodeps" ]; then
 270         olddeps="$deps"
 271         deps=
 272         while read d && [ -n "$d" ]; do
 273                 if [ "$d" = "HEAD" ]; then
 274                         sr="$(git symbolic-ref --quiet HEAD)" || :
 275                         [ -z "$sr" ] || git rev-parse --verify --quiet "$sr" -- ||
 276                                 die "refusing to depend on unborn branch (use --no-deps)"
 277                         [ -n "$sr" ] || die "cannot depend on a detached HEAD"
 278                         case "$sr" in refs/heads/*);;*)
 279                                 die "HEAD is a symref to other than refs/heads/..."
 280                         esac
 281                         d="${sr#refs/heads/}"
 282                 else
 283                         ref_exists "refs/heads/$d" || die "unknown branch dependency '$d'"
 284                 fi
 285                 case " $deps " in
 286                         *" $d "*)
 287                                 warn "ignoring duplicate depedency $d"
 288                                 ;;
 289                         *)
 290                                 deps="${deps:+$deps }$d"
 291                                 ;;
 292                 esac
 293         done <<-EOT
 294         $(sed 'y/ /\n/' <<-LIST
 295         $olddeps
 296         LIST
 297         )
 298         EOT
 299         unset olddeps
 300 fi
 301 if test="$(git symbolic-ref --quiet "$name" --)"; then case "$test" in
 302         refs/"$topbases"/*)
 303                 name="${test#refs/$topbases/}"
 304                 break;;
 305         refs/heads/*)
 306                 name="${test#refs/heads/}"
 307                 break;;
 308 esac; fi
 309 ! ref_exists "refs/heads/$name"  ||
 310         die "branch '$name' already exists"
 311 ! ref_exists "refs/$topbases/$name" ||
 312         die "'$topbases/$name' already exists"
 313 [ -n "$force" ] || ! ref_exists "refs/tags/$name" ||
 314         die "refusing to create branch with same name as existing tag '$name' without --force"
 315
 316 # Clean up any stale stuff
 317 rm -rf "$git_dir/tg-create"
 318
 319 # Barf now rather than later if missing ident
 320 ensure_ident_available
 321
 322 # Get messages
 323
 324 tab="$(printf '\t.')" && tab="${tab%?}"
 325 get_subject()
 326 {
 327         sed -n '1,/^$/p' |
 328         grep -i "^Subject[ $tab]*:" |
 329         sed -n "s/^[^: $tab][^: $tab]*[ $tab]*:[ $tab]*//; s/[ $tab][ $tab]*\$//; 1p" ||
 330         :
 331 }
 332
 333 if [ -z "$restarted" ]; then
 334         >"$git_dir/TG_EDITMSG"
 335         if [ -n "$msgfile" ]; then
 336                 if [ "$msgfile" = "-" ]; then
 337                         git stripspace >"$git_dir/TG_EDITMSG"
 338                 else
 339                         git stripspace <"$msgfile" >"$git_dir/TG_EDITMSG"
 340                 fi
 341         elif [ -n "$msg" ]; then
 342                 printf '%s\n' "$msg" | git stripspace >"$git_dir/TG_EDITMSG"
 343         fi
 344         if [ ! -s "$git_dir/TG_EDITMSG" ]; then
 345                 printf '%s\n' "tg create $name" | git stripspace >"$git_dir/TG_EDITMSG"
 346         fi
 347         msg="$(cat "$git_dir/TG_EDITMSG")"
 348         rm -f "$git_dir/TG_EDITMSG"
 349
 350         >"$git_dir/TG_EDITMSG"
 351         if [ -n "$topmsgfile" ]; then
 352                 if [ "$topmsgfile" = "-" ]; then
 353                         git stripspace >"$git_dir/TG_EDITMSG"
 354                 else
 355                         git stripspace <"$topmsgfile" >"$git_dir/TG_EDITMSG"
 356                 fi
 357         elif [ -n "$topmsg" ]; then
 358                 printf '%s\n' "$topmsg" | git stripspace >"$git_dir/TG_EDITMSG"
 359         fi
 360         if [ -s "$git_dir/TG_EDITMSG" ]; then
 361                 noedit=1
 362         else
 363                 author="$(git var GIT_AUTHOR_IDENT)"
 364                 author_addr="${author%> *}>"
 365                 {
 366                         echo "From: $author_addr"
 367                         ! header="$(git config topgit.to)" || echo "To: $header"
 368                         ! header="$(git config topgit.cc)" || echo "Cc: $header"
 369                         ! header="$(git config topgit.bcc)" || echo "Bcc: $header"
 370                         ! subject_prefix="$(git config topgit.subjectprefix)" || subject_prefix="$subject_prefix "
 371                         echo "Subject: [${subject_prefix}$branchtype] $name"
 372                         echo
 373                         echo "<$branchdesc description>"
 374                         echo
 375                         echo "Signed-off-by: $author_addr"
 376                         [ "$(git config --bool format.signoff)" = true ] && echo "Signed-off-by: $author_addr"
 377                 } | git stripspace >"$git_dir/TG_EDITMSG"
 378         fi
 379         if [ -z "$noedit" ]; then
 380                 cat <<EOT >>"$git_dir/TG_EDITMSG"
 381
 382 # Please enter the patch message for the new TopGit branch $name.
 383 # It will be stored in the .topmsg file and used to create the
 384 # patch header when \`tg patch\` is run on branch $name.
 385 # The "Subject:" line will appear in \`tg summary\` and \`tg info\` output.
 386 #
 387 # Lines starting with '#' will be ignored, and an empty patch
 388 # message aborts the \`tg create\` operation entirely.
 389 #
 390 # tg create ${nodeps:+--no-deps }$name $deps
 391 EOT
 392                 run_editor "$git_dir/TG_EDITMSG" ||
 393                 die "there was a problem with the editor '$tg_editor'"
 394                 git stripspace -s <"$git_dir/TG_EDITMSG" >"$git_dir/TG_EDITMSG"+
 395                 mv -f "$git_dir/TG_EDITMSG"+ "$git_dir/TG_EDITMSG"
 396                 [ -s "$git_dir/TG_EDITMSG" ] || die "nothing to do"
 397         fi
 398         subj="$(get_subject <"$git_dir/TG_EDITMSG")"
 399         if [ -z "$subj" ]; then
 400                 subj="$(sed -n "s/^[ $tab][ $tab]*//; 1p" <"$git_dir/TG_EDITMSG")";
 401                 case "$subj" in "["*);;*) subj="[$branchtype] $subj"; esac
 402                 printf '%s\n' "Subject: $subj" "" >"$git_dir/TG_EDITMSG"+
 403                 sed -n '2,$p' <"$git_dir/TG_EDITMSG" | git stripspace >>"$git_dir/TG_EDITMSG"+
 404                 mv -f "$git_dir/TG_EDITMSG"+ "$git_dir/TG_EDITMSG"
 405                 warntop=1
 406         fi
 407         topmsg="$(cat "$git_dir/TG_EDITMSG")"
 408         rm -f "$git_dir/TG_EDITMSG"
 409 fi
 410
 411
 412 ## Find starting commit to create the base
 413
 414 if [ -n "$merge" -a -z "$restarted" ]; then
 415         # Unshift the first item from the to-merge list
 416         branch="${merge%% *}"
 417         merge="${merge#* }"
 418         # We create a detached head so that we can abort this operation
 419         prefix=refs/heads/
 420         [ -z "$nodeps" ] || prefix=
 421         if [ -n "$unborn" ]; then
 422                 quiet_info "creating $name base with empty tree..."
 423         else
 424                 quiet_info "creating $name base from $branch..."
 425                 git checkout -q "$(git rev-parse --verify "$prefix$branch^0" --)"
 426         fi
 427 fi
 428
 429
 430 ## Set up the topic branch
 431
 432 init_reflog "refs/$topbases/$name"
 433 if [ -n "$unborn" ]; then
 434         mttree="$(git mktree </dev/null)"
 435         emsg="tg create empty $topbases/$name"
 436         [ "refs/heads/$name" = "$unborn" ] || emsg="Initial empty commit"
 437         mtcommit="$(git commit-tree  -m "$emsg" "$mttree")" || die "git commit-tree failed"
 438         git update-ref -m "tgcreate: create ${unborn#refs/heads/}" "HEAD" "$mtcommit" ""
 439         [ "refs/heads/$name" = "$unborn" ] || warn "branch ${unborn#refs/heads/} created with empty commit"
 440         git update-ref -m "tgcreate: set $topbases/$name" "refs/$topbases/$name" "HEAD" ""
 441         [ "refs/heads/$name" = "$unborn" ] || git checkout -b "$name"
 442 else
 443         git update-ref -m "tgcreate: set $topbases/$name" "refs/$topbases/$name" "HEAD" ""
 444         git checkout -b "$name"
 445 fi
 446
 447 if [ -n "$nodeps" ] || [ -z "$deps" ]; then
 448         >"$root_dir/.topdeps"
 449 else
 450         sed 'y/ /\n/' <<-EOT >"$root_dir/.topdeps"
 451         $deps
 452         EOT
 453 fi
 454 git add -f "$root_dir/.topdeps"
 455 printf '%s\n' "$topmsg" >"$root_dir/.topmsg"
 456 git add -f "$root_dir/.topmsg"
 457 printf '%s\n' "$msg" >"$git_dir/MERGE_MSG"
 458
 459 [ -z "$warntop" ] || warn ".topmsg content was reformatted into patch header"
 460 if [ -n "$nocommit" ]; then
 461         quiet_info "Topic branch $name set up."
 462         if [ -n "$noedit" ]; then
 463                 quiet_info "Please fill in .topmsg now and make the initial commit."
 464         else
 465                 quiet_info "Please make the initial commit."
 466         fi
 467         quiet_info "Remember to run $tgdisplay update afterwards."
 468         quiet_info "To abort:"
 469         quiet_info "  git$gitcdopt rm -f .top* && git$gitcdopt checkout ${deps%% *} && $tgdisplay delete $name"
 470         exit 0
 471 fi
 472
 473 git commit -m "$msg" "$root_dir/.topdeps" "$root_dir/.topmsg" || die "git commit failed"
 474 subj="$(get_subject <"$root_dir/.topmsg" |
 475         sed "s/^[^]]*]//; s/^[ $tab][ $tab]*//; s/[ $tab][ $tab]*\$//")"
 476 if [ -n "$subj" ]; then
 477         printf '%s\n' "$subj" ""
 478         sed -e '1,/^$/d' <"$root_dir/.topmsg"
 479 else
 480         cat "$root_dir/.topmsg"
 481 fi >"$git_dir/MERGE_MSG"
 482 quiet_info "Topic branch $name created."
 483 [ -n "$merge" ] || exit 0
 484 ## Merge other dependencies into the base
 485 quiet_info "Running $tgname update to merge in dependencies."
 486 set -- "$name"
 487 . "$TG_INST_CMDDIR"/tg-update