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