-"""Branch command
-"""
-
__copyright__ = """
Copyright (C) 2005, Chuck Lever <cel@netapp.com>
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
-import sys, os, time
-from optparse import OptionParser, make_option
-
+import sys, os, time, re
+from stgit.argparse import opt
from stgit.commands.common import *
from stgit.utils import *
-from stgit import stack, git
-
-
-help = 'manage development branches'
-usage = """%prog [options] branch-name [commit-id]
-
+from stgit.out import *
+from stgit import argparse, stack, git, basedir
+from stgit.lib import log
+
+help = 'Branch operations: switch, list, create, rename, delete, ...'
+kind = 'stack'
+usage = ['',
+ '<branch>',
+ '--list',
+ '--create <new-branch> [<committish>]',
+ '--clone [<new-branch>]',
+ '--rename <old-name> <new-name>',
+ '--protect [<branch>]',
+ '--unprotect [<branch>]',
+ '--delete [--force] <branch>',
+ '--description=<description> [<branch>]']
+description = """
Create, clone, switch between, rename, or delete development branches
-within a git repository. By default, a single branch called 'master'
-is always created in a new repository. This subcommand allows you to
-manage several patch series in the same repository via GIT branches.
-
-When displaying the branches, the names can be prefixed with
-'s' (StGIT managed) or 'p' (protected)."""
-
-options = [make_option('-c', '--create',
- help = 'create a new development branch',
- action = 'store_true'),
- make_option('--clone',
- help = 'clone the contents of the current branch',
- action = 'store_true'),
- make_option('--delete',
- help = 'delete an existing development branch',
- action = 'store_true'),
- make_option('--force',
- help = 'force a delete when the series is not empty',
- action = 'store_true'),
- make_option('-l', '--list',
- help = 'list branches contained in this repository',
- action = 'store_true'),
- make_option('-p', '--protect',
- help = 'prevent "stg pull" from modifying this branch',
- action = 'store_true'),
- make_option('-r', '--rename',
- help = 'rename an existing development branch',
- action = 'store_true'),
- make_option('-u', '--unprotect',
- help = 'allow "stg pull" to modify this branch',
- action = 'store_true')]
-
+within a git repository.
+
+'stg branch'::
+ Display the name of the current branch.
+
+'stg branch' <branch>::
+ Switch to the given branch."""
+
+args = [argparse.all_branches]
+options = [
+ opt('-l', '--list', action = 'store_true',
+ short = 'List the branches contained in this repository', long = """
+ List each branch in the current repository, followed by its
+ branch description (if any). The current branch is prefixed
+ with '>'. Branches that have been initialized for StGit (with
+ stglink:init[]) are prefixed with 's'. Protected branches are
+ prefixed with 'p'."""),
+ opt('-c', '--create', action = 'store_true',
+ short = 'Create (and switch to) a new branch', long = """
+ Create (and switch to) a new branch. The new branch is already
+ initialized as an StGit patch stack, so you do not have to run
+ stglink:init[] manually. If you give a committish argument,
+ the new branch is based there; otherwise, it is based at the
+ current HEAD.
+
+ StGit will try to detect the branch off of which the new
+ branch is forked, as well as the remote repository from which
+ that parent branch is taken (if any), so that running
+ stglink:pull[] will automatically pull new commits from the
+ correct branch. It will warn if it cannot guess the parent
+ branch (e.g. if you do not specify a branch name as
+ committish)."""),
+ opt('--clone', action = 'store_true',
+ short = 'Clone the contents of the current branch', long = """
+ Clone the current branch, under the name <new-branch> if
+ specified, or using the current branch's name plus a
+ timestamp.
+
+ The description of the new branch is set to tell it is a clone
+ of the current branch. The parent information of the new
+ branch is copied from the current branch."""),
+ opt('-r', '--rename', action = 'store_true',
+ short = 'Rename an existing branch'),
+ opt('-p', '--protect', action = 'store_true',
+ short = 'Prevent StGit from modifying a branch', long = """
+ Prevent StGit from modifying a branch -- either the current
+ one, or one named on the command line."""),
+ opt('-u', '--unprotect', action = 'store_true',
+ short = 'Allow StGit to modify a branch', long = """
+ Allow StGit to modify a branch -- either the current one, or
+ one named on the command line. This undoes the effect of an
+ earlier 'stg branch --protect' command."""),
+ opt('--delete', action = 'store_true',
+ short = 'Delete a branch', long = """
+ Delete the named branch. If there are any patches left in the
+ branch, StGit will refuse to delete it unless you give the
+ '--force' flag.
+
+ A protected branch cannot be deleted; it must be unprotected
+ first (see '--unprotect' above).
+
+ If you delete the current branch, you are switched to the
+ "master" branch, if it exists."""),
+ opt('-d', '--description', short = 'Set the branch description'),
+ opt('--force', action = 'store_true',
+ short = 'Force a delete when the series is not empty')]
+
+directory = DirectoryGotoToplevel(log = False)
def __is_current_branch(branch_name):
- return crt_series.get_branch() == branch_name
+ return crt_series.get_name() == branch_name
def __print_branch(branch_name, length):
initialized = ' '
current = '>'
if branch.get_protected():
protected = 'p'
- print current + ' ' + initialized + protected + '\t' + \
- branch_name.ljust(length) + ' | ' + branch.get_description()
+ out.stdout(current + ' ' + initialized + protected + '\t'
+ + branch_name.ljust(length) + ' | ' + branch.get_description())
def __delete_branch(doomed_name, force = False):
doomed = stack.Series(doomed_name)
+ if __is_current_branch(doomed_name):
+ raise CmdException('Cannot delete the current branch')
if doomed.get_protected():
raise CmdException, 'This branch is protected. Delete is not permitted'
- print 'Deleting branch "%s"...' % doomed_name,
- sys.stdout.flush()
-
- if __is_current_branch(doomed_name):
- check_local_changes()
- check_conflicts()
- check_head_top_equal()
-
- if doomed_name != 'master':
- git.switch_branch('master')
-
+ out.start('Deleting branch "%s"' % doomed_name)
doomed.delete(force)
-
- if doomed_name != 'master':
- git.delete_branch(doomed_name)
-
- print 'done'
+ out.done()
def func(parser, options, args):
check_local_changes()
check_conflicts()
- check_head_top_equal()
+ check_head_top_equal(crt_series)
tree_id = None
- if len(args) == 2:
- tree_id = args[1]
+ if len(args) >= 2:
+ parentbranch = None
+ try:
+ branchpoint = git.rev_parse(args[1])
+
+ # parent branch?
+ head_re = re.compile('refs/(heads|remotes)/')
+ ref_re = re.compile(args[1] + '$')
+ for ref in git.all_refs():
+ if head_re.match(ref) and ref_re.search(ref):
+ # args[1] is a valid ref from the branchpoint
+ # setting above
+ parentbranch = args[1]
+ break;
+ except git.GitException:
+ # should use a more specific exception to catch only
+ # non-git refs ?
+ out.info('Don\'t know how to determine parent branch'
+ ' from "%s"' % args[1])
+ # exception in branch = rev_parse() leaves branchpoint unbound
+ branchpoint = None
+
+ tree_id = git_id(crt_series, branchpoint or args[1])
+
+ if parentbranch:
+ out.info('Recording "%s" as parent branch' % parentbranch)
+ else:
+ out.info('Don\'t know how to determine parent branch'
+ ' from "%s"' % args[1])
+ else:
+ # branch stack off current branch
+ parentbranch = git.get_head_file()
+
+ if parentbranch:
+ parentremote = git.identify_remote(parentbranch)
+ if parentremote:
+ out.info('Using remote "%s" to pull parent from'
+ % parentremote)
+ else:
+ out.info('Recording as a local branch')
+ else:
+ # no known parent branch, can't guess the remote
+ parentremote = None
- git.create_branch(args[0], tree_id)
- stack.Series(args[0]).init()
+ stack.Series(args[0]).init(create_at = tree_id,
+ parent_remote = parentremote,
+ parent_branch = parentbranch)
- print 'Branch "%s" created.' % args[0]
+ out.info('Branch "%s" created' % args[0])
+ log.compat_log_entry('branch --create')
return
elif options.clone:
if len(args) == 0:
- clone = crt_series.get_branch() + \
+ clone = crt_series.get_name() + \
time.strftime('-%C%y%m%d-%H%M%S')
elif len(args) == 1:
clone = args[0]
check_local_changes()
check_conflicts()
- check_head_top_equal()
+ check_head_top_equal(crt_series)
- print 'Cloning current branch to "%s"...' % clone,
- sys.stdout.flush()
+ out.start('Cloning current branch to "%s"' % clone)
crt_series.clone(clone)
- print 'done'
+ out.done()
+ log.copy_log(log.default_repo(), crt_series.get_name(), clone,
+ 'branch --clone')
return
elif options.delete:
if len(args) != 1:
parser.error('incorrect number of arguments')
__delete_branch(args[0], options.force)
+ log.delete_log(log.default_repo(), args[0])
return
elif options.list:
if len(args) != 0:
parser.error('incorrect number of arguments')
- branches = os.listdir(os.path.join(git.get_base_dir(), 'refs', 'heads'))
- branches.sort()
- max_len = max([len(i) for i in branches])
-
- print 'Available branches:'
- for i in branches:
- __print_branch(i, max_len)
+ branches = set(git.get_heads())
+ for br in set(branches):
+ m = re.match(r'^(.*)\.stgit$', br)
+ if m and m.group(1) in branches:
+ branches.remove(br)
+
+ if branches:
+ out.info('Available branches:')
+ max_len = max([len(i) for i in branches])
+ for i in sorted(branches):
+ __print_branch(i, max_len)
+ else:
+ out.info('No branches')
return
elif options.protect:
if len(args) == 0:
- branch_name = crt_series.get_branch()
+ branch_name = crt_series.get_name()
elif len(args) == 1:
branch_name = args[0]
else:
raise CmdException, 'Branch "%s" is not controlled by StGIT' \
% branch_name
- print 'Protecting branch "%s"...' % branch_name,
- sys.stdout.flush()
+ out.start('Protecting branch "%s"' % branch_name)
branch.protect()
- print 'done'
+ out.done()
return
stack.Series(args[0]).rename(args[1])
- print 'Renamed branch "%s" as "%s".' % (args[0], args[1])
-
+ out.info('Renamed branch "%s" to "%s"' % (args[0], args[1]))
+ log.rename_log(log.default_repo(), args[0], args[1], 'branch --rename')
return
elif options.unprotect:
if len(args) == 0:
- branch_name = crt_series.get_branch()
+ branch_name = crt_series.get_name()
elif len(args) == 1:
branch_name = args[0]
else:
raise CmdException, 'Branch "%s" is not controlled by StGIT' \
% branch_name
- print 'Unprotecting branch "%s"...' % branch_name,
- sys.stdout.flush()
+ out.info('Unprotecting branch "%s"' % branch_name)
branch.unprotect()
- print 'done'
+ out.done()
+
+ return
+
+ elif options.description is not None:
+
+ if len(args) == 0:
+ branch_name = crt_series.get_name()
+ elif len(args) == 1:
+ branch_name = args[0]
+ else:
+ parser.error('incorrect number of arguments')
+ branch = stack.Series(branch_name)
+
+ if not branch.is_initialised():
+ raise CmdException, 'Branch "%s" is not controlled by StGIT' \
+ % branch_name
+
+ branch.set_description(options.description)
return
check_local_changes()
check_conflicts()
- check_head_top_equal()
-
- print 'Switching to branch "%s"...' % args[0],
- sys.stdout.flush()
+ check_head_top_equal(crt_series)
+ out.start('Switching to branch "%s"' % args[0])
git.switch_branch(args[0])
-
- print 'done'
+ out.done()
return
# default action: print the current branch
if len(args) != 0:
parser.error('incorrect number of arguments')
- print crt_series.get_branch()
+ print crt_series.get_name()
~mdw / stgit / blobdiff