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                         deps="${head#refs/heads/}"
 226                         [ "$deps" != "$head" ] || die "refusing to auto-depend on non-branch ref (${head:-detached HEAD})"
 227                         quiet_info "Automatically marking dependency on $deps"
 228                 fi
 229         fi
 230 fi
 231
 232 # Non-remote branch set up requires a clean tree unless the single dep is the same tree as HEAD
 233 [ -n "$restarted" ] || [ "$deps" = "HEAD" ] || {
 234         prefix=refs/heads/
 235         [ -z "$nodeps" ] || prefix=
 236         [ $# -eq 1 -a "$(git rev-parse --verify "$prefix$deps^{tree}" --)" = "$(git rev-parse --verify HEAD^{tree} --)" ] ||
 237                 (ensure_clean_tree) || {
 238                         [ $# -ne 1 ] || info "use \`git checkout $deps\` first and then try again"
 239                         exit 1
 240                 }
 241 }
 242
 243 [ -n "$merge" -o -n "$restarted" ] || merge="$deps "
 244
 245 if [ -n "$nodeps" ]; then
 246         # there can be only one and it need only be a committish
 247         git rev-parse --quiet --verify "$deps^0" -- >/dev/null ||
 248                 die "unknown committish \"$deps\""
 249 else
 250         olddeps="$deps"
 251         deps=
 252         for d in $olddeps; do
 253                 if [ "$d" = "HEAD" ]; then
 254                         sr="$(git symbolic-ref --quiet HEAD || :)"
 255                         [ -n "$sr" ] || die "cannot depend on a detached HEAD"
 256                         case "$sr" in refs/heads/*) :;; *)
 257                                 die "HEAD is a symref to other than refs/heads/..."
 258                         esac
 259                         d="${sr#refs/heads/}"
 260                 else
 261                         ref_exists "refs/heads/$d" || die "unknown branch dependency '$d'"
 262                 fi
 263                 case " $deps " in
 264                         *" $d "*)
 265                                 warn "ignoring duplicate depedency $d"
 266                                 ;;
 267                         *)
 268                                 deps="${deps:+$deps }$d"
 269                                 ;;
 270                 esac
 271         done
 272         unset olddeps
 273 fi
 274 ! ref_exists "refs/heads/$name"  ||
 275         die "branch '$name' already exists"
 276 ! ref_exists "refs/top-bases/$name" ||
 277         die "'top-bases/$name' already exists"
 278 [ -n "$force" ] || ! ref_exists "refs/tags/$name" ||
 279         die "refusing to create branch with same name as existing tag '$name' without --force"
 280
 281 # Clean up any stale stuff
 282 rm -rf "$git_dir/tg-create"
 283
 284
 285 # Get messages
 286
 287 tab="$(printf '\t.')" && tab="${tab%?}"
 288 get_subject()
 289 {
 290         sed -n '1,/^$/p' |
 291         grep -i "^Subject[ $tab]*:" |
 292         sed -n "s/^[^: $tab][^: $tab]*[ $tab]*:[ $tab]*//; s/[ $tab][ $tab]*\$//; 1p" ||
 293         :
 294 }
 295
 296 if [ -z "$restarted" ]; then
 297         >"$git_dir/TG_EDITMSG"
 298         if [ -n "$msgfile" ]; then
 299                 if [ "$msgfile" = "-" ]; then
 300                         git stripspace >"$git_dir/TG_EDITMSG"
 301                 else
 302                         git stripspace <"$msgfile" >"$git_dir/TG_EDITMSG"
 303                 fi
 304         elif [ -n "$msg" ]; then
 305                 printf '%s\n' "$msg" | git stripspace >"$git_dir/TG_EDITMSG"
 306         fi
 307         if [ ! -s "$git_dir/TG_EDITMSG" ]; then
 308                 printf '%s\n' "tg create $name" | git stripspace >"$git_dir/TG_EDITMSG"
 309         fi
 310         msg="$(cat "$git_dir/TG_EDITMSG")"
 311         rm -f "$git_dir/TG_EDITMSG"
 312
 313         >"$git_dir/TG_EDITMSG"
 314         if [ -n "$topmsgfile" ]; then
 315                 if [ "$topmsgfile" = "-" ]; then
 316                         git stripspace >"$git_dir/TG_EDITMSG"
 317                 else
 318                         git stripspace <"$topmsgfile" >"$git_dir/TG_EDITMSG"
 319                 fi
 320         elif [ -n "$topmsg" ]; then
 321                 printf '%s\n' "$topmsg" | git stripspace >"$git_dir/TG_EDITMSG"
 322         fi
 323         if [ -s "$git_dir/TG_EDITMSG" ]; then
 324                 noedit=1
 325         else
 326                 author="$(git var GIT_AUTHOR_IDENT)"
 327                 author_addr="${author%> *}>"
 328                 {
 329                         echo "From: $author_addr"
 330                         ! header="$(git config topgit.to)" || echo "To: $header"
 331                         ! header="$(git config topgit.cc)" || echo "Cc: $header"
 332                         ! header="$(git config topgit.bcc)" || echo "Bcc: $header"
 333                         ! subject_prefix="$(git config topgit.subjectprefix)" || subject_prefix="$subject_prefix "
 334                         echo "Subject: [${subject_prefix}$branchtype] $name"
 335                         echo
 336                         echo "<$branchdesc description>"
 337                         echo
 338                         echo "Signed-off-by: $author_addr"
 339                         [ "$(git config --bool format.signoff)" = true ] && echo "Signed-off-by: $author_addr"
 340                 } | git stripspace >"$git_dir/TG_EDITMSG"
 341         fi
 342         if [ -z "$noedit" ]; then
 343                 cat <<EOT >>"$git_dir/TG_EDITMSG"
 344
 345 # Please enter the patch message for the new TopGit branch $name.
 346 # It will be stored in the .topmsg file and used to create the
 347 # patch header when \`tg patch\` is run on branch $name.
 348 # The "Subject:" line will appear in \`tg summary\` and \`tg info\` output.
 349 #
 350 # Lines starting with '#' will be ignored, and an empty patch
 351 # message aborts the \`tg create\` operation entirely.
 352 #
 353 # tg create ${nodeps:+--no-deps }$name $deps
 354 EOT
 355                 run_editor "$git_dir/TG_EDITMSG" || \
 356                 die "there was a problem with the editor '$tg_editor'"
 357                 git stripspace -s <"$git_dir/TG_EDITMSG" >"$git_dir/TG_EDITMSG"+
 358                 mv -f "$git_dir/TG_EDITMSG"+ "$git_dir/TG_EDITMSG"
 359                 [ -s "$git_dir/TG_EDITMSG" ] || die "nothing to do"
 360         fi
 361         subj="$(get_subject <"$git_dir/TG_EDITMSG")"
 362         if [ -z "$subj" ]; then
 363                 subj="$(sed -n "s/^[ $tab][ $tab]*//; 1p" <"$git_dir/TG_EDITMSG")";
 364                 case "$subj" in "["*) :;; *) subj="[$branchtype] $subj"; esac
 365                 printf '%s\n' "Subject: $subj" "" >"$git_dir/TG_EDITMSG"+
 366                 sed -n '2,$p' <"$git_dir/TG_EDITMSG" | git stripspace >>"$git_dir/TG_EDITMSG"+
 367                 mv -f "$git_dir/TG_EDITMSG"+ "$git_dir/TG_EDITMSG"
 368                 warntop=1
 369         fi
 370         topmsg="$(cat "$git_dir/TG_EDITMSG")"
 371         rm -f "$git_dir/TG_EDITMSG"
 372 fi
 373
 374
 375 ## Find starting commit to create the base
 376
 377 if [ -n "$merge" -a -z "$restarted" ]; then
 378         # Unshift the first item from the to-merge list
 379         branch="${merge%% *}"
 380         merge="${merge#* }"
 381         quiet_info "Creating $name base from $branch..."
 382         # We create a detached head so that we can abort this operation
 383         prefix=refs/heads/
 384         [ -z "$nodeps" ] || prefix=
 385         git checkout -q "$(git rev-parse --verify "$prefix$branch^0" --)"
 386 fi
 387
 388
 389 ## Merge other dependencies into the base
 390
 391 while [ -n "$merge" ]; do
 392         # Unshift the first item from the to-merge list
 393         branch="${merge%% *}"
 394         merge="${merge#* }"
 395         quiet_info "Merging $name base with $branch..."
 396
 397         if ! git merge -m "tgcreate: merge $branch into top-bases/$name" "$branch^0"; then
 398                 info "Please commit merge resolution and call: $tgdisplay create"
 399                 info "It is also safe to abort this operation using:"
 400                 info "git$gitcdopt reset --hard some_branch"
 401                 info "(You are on a detached HEAD now.)"
 402                 mkdir -p "$git_dir/tg-create"
 403                 printf '%s\n' "$name" >"$git_dir/tg-create/name"
 404                 printf '%s\n' "$deps" >"$git_dir/tg-create/deps"
 405                 printf '%s\n' "$merge" >"$git_dir/tg-create/merge"
 406                 printf '%s\n' "$msg" >"$git_dir/tg-create/msg"
 407                 printf '%s\n' "$topmsg" >"$git_dir/tg-create/topmsg"
 408                 printf '%s\n' "$nocommit" >"$git_dir/tg-create/nocommit"
 409                 printf '%s\n' "$noedit" >"$git_dir/tg-create/noedit"
 410                 printf '%s\n' "$warntop" >"$git_dir/tg-create/warntop"
 411                 printf '%s\n' "$quiet" >"$git_dir/tg-create/quiet"
 412                 exit 2
 413         fi
 414 done
 415
 416
 417 ## Set up the topic branch
 418
 419 if [ -n "$logrefupdates" ]; then
 420         mkdir -p "$git_dir/logs/refs/top-bases/$(dirname "$name")" 2>/dev/null || :
 421         { >>"$git_dir/logs/refs/top-bases/$name" || :; } 2>/dev/null
 422 fi
 423 git update-ref "refs/top-bases/$name" "HEAD" ""
 424 git checkout -b "$name"
 425
 426 if [ -n "$nodeps" ]; then
 427         >"$root_dir/.topdeps"
 428 else
 429         printf '%s\n' $deps >"$root_dir/.topdeps"
 430 fi
 431 git add -f "$root_dir/.topdeps"
 432 printf '%s\n' "$topmsg" >"$root_dir/.topmsg"
 433 git add -f "$root_dir/.topmsg"
 434 printf '%s\n' "$msg" >"$git_dir/MERGE_MSG"
 435
 436 [ -z "$warntop" ] || warn ".topmsg content was reformatted into patch header"
 437 if [ -n "$nocommit" ]; then
 438         quiet_info "Topic branch $name set up."
 439         if [ -n "$noedit" ]; then
 440                 quiet_info "Please fill in .topmsg now and make the initial commit."
 441         else
 442                 quiet_info "Please make the initial commit."
 443         fi
 444         quiet_info "To abort:"
 445         quiet_info "  git$gitcdopt rm -f .top* && git$gitcdopt checkout ${deps%% *} && $tgdisplay delete $name"
 446         exit 0
 447 fi
 448
 449 git commit -m "$msg" "$root_dir/.topdeps" "$root_dir/.topmsg" || die "git commit failed"
 450 subj="$(get_subject <"$root_dir/.topmsg" |
 451         sed "s/^[^]]*]//; s/^[ $tab][ $tab]*//; s/[ $tab][ $tab]*\$//")"
 452 if [ -n "$subj" ]; then
 453         printf '%s\n' "$subj" ""
 454         sed -e '1,/^$/d' <"$root_dir/.topmsg"
 455 else
 456         cat "$root_dir/.topmsg"
 457 fi >"$git_dir/MERGE_MSG"
 458 quiet_info "Topic branch $name created."
 459 exit 0
 460
 461 # vim:noet