cg-branch-add

   1 #!/usr/bin/env bash
   2 #
   3 # Add new remote branch
   4 # Copyright (c) Petr Baudis, 2005
   5 #
   6 # Takes the desired branch name and source location as parameters.
   7 #
   8 # This command lets you add to the list of 'remote branches'. Those are
   9 # branches in your local repository which correspond to some branches
  10 # in other repositories.
  11 #
  12 # After you add a remote branch, you can `cg-fetch` from it to get the
  13 # latest changes on the branch, as they appeared in the remote repository.
  14 #
  15 # Terminology note: This command concerns remote branches, not the local
  16 # ones (those managed by `cg-switch`).
  17 #
  18 # The possible source location specifiers are:
  19 #
  20 # 1. Local path - note that fetching will hardlink the objects if possible.
  21 #
  22 # 2. rsync - `rsync://host/path`
  23 #    THE rsync REPOSITORY ACCESS METHOD IS DEPRECATED AND WILL BE REMOVED
  24 #    IN THE FUTURE! The problem is that it will download _all_ data from
  25 #    the remote repository, including objects which do not belong to the
  26 #    one particular branch you want to fetch.
  27 #
  28 # 3. HTTP - `http://host/path`
  29 #
  30 # 4. HTTPS - `https://host/path`
  31 #
  32 # 5. FTP - 'ftp://host/path'
  33 #
  34 # 6. SSH - `git+ssh://host/path` or `host:path` (the latter can change);
  35 #    note that the path must be absolute in the first case.
  36 #
  37 # 7. git daemon - `git://host/path`
  38 #
  39 #
  40 # The URL can have a fragment part, which identifies a branch inside of
  41 # the remote repository (in the form "repoURL#branchname"). Otherwise,
  42 # Cogito defaults to whatever branch the repository's HEAD points to
  43 # at the time of each fetch.
  44 #
  45 # FILES
  46 # -----
  47 # $GIT_DIR/branches/BRANCH_NAME::
  48 #       Contains the source location of the remote branch.
  49 #
  50 # $GIT_DIR/refs/heads/BRANCH_NAME::
  51 #       Contains pointer to the latest commit in a branch. It can be more
  52 #       conveniently retrieved using `cg-object-id BRANCH_NAME`.
  53 #
  54 # EXAMPLE USAGE
  55 # -------------
  56 # Let's say you have a repository at `git+ssh://host/path/repo.git` and you
  57 # want to fetch its 'testing' branch to your local repository. In that case
  58 # you can do
  59 #
  60 #       $ cg-branch-add repo-testing 'git+ssh://host/path/repo.git#testing'
  61 #
  62 # and refer to it as 'repo-testing' anytime later:
  63 #
  64 #       $ cg-fetch repo-testing
  65 #
  66 # For example you can check the changes in the `repo-testing` branch compared
  67 # to your current branch:
  68 #
  69 #       $ cg-diff -r repo-testing
  70
  71 # Testsuite: Partial (used in many tests but a dedicated testsuite is missing)
  72
  73 USAGE="cg-branch-add BRANCH_NAME LOCATION"
  74 _git_wc_unneeded=1
  75
  76 . "${COGITO_LIB}"cg-Xlib || exit 1
  77
  78 name="${ARGS[0]}"
  79 location="${ARGS[1]}"
  80
  81 ([ -n "$name" ] && [ -n "$location" ] && ! [ -n "${ARGS[2]}" ]) || usage
  82 git-check-ref-format "refs/heads/$name" || \
  83         die "name contains invalid characters"
  84 if [ "$name" = "this" ] || [ "$name" = "HEAD" ]; then
  85         die "given branch name is reserved"
  86 fi
  87
  88 mkdir -p "$_git/branches/$(dirname "$name")"
  89 [ -s "$_git/branches/$name" ] && die "branch already exists"
  90 exists_ref "refs/heads/$name" && warn "branch head already exists"
  91
  92 if ! echo "$location" | grep -q ":" ; then
  93         location=$(echo "$location" | sed -e "s#^[^/]#$(pwd)\/&#" | normpath)
  94 fi
  95
  96 echo "$location" >"$_git/branches/$name"