← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-10-31 04:39:04 UTC
  • mfrom: (3565.6.16 switch_nick)
  • Revision ID: pqm@pqm.ubuntu.com-20081031043904-52fnbfrloojemvcc
(mbp) branch nickname documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
2586
2586
 
2587
2587
 
2588
2588
class cmd_nick(Command):
2589
 
    """Print or set the branch nickname.  
2590
 
 
2591
 
    If unset, the tree root directory name is used as the nickname
2592
 
    To print the current nickname, execute with no argument.  
 
2589
    """Print or set the branch nickname.
 
2590
 
 
2591
    If unset, the tree root directory name is used as the nickname.
 
2592
    To print the current nickname, execute with no argument.
 
2593
 
 
2594
    Bound branches use the nickname of its master branch unless it is set
 
2595
    locally.
2593
2596
    """
2594
2597
 
2595
2598
    _see_also = ['info']
3762
3765
 
3763
3766
    Once converted into a checkout, commits must succeed on the master branch
3764
3767
    before they will be applied to the local branch.
 
3768
 
 
3769
    Bound branches use the nickname of its master branch unless it is set
 
3770
    locally, in which case binding will update the the local nickname to be
 
3771
    that of the master.
3765
3772
    """
3766
3773
 
3767
3774
    _see_also = ['checkouts', 'unbind']
4653
4660
    For heavyweight checkouts, this checks that there are no local commits
4654
4661
    versus the current bound branch, then it makes the local branch a mirror
4655
4662
    of the new location and binds to it.
4656
 
    
 
4663
 
4657
4664
    In both cases, the working tree is updated and uncommitted changes
4658
 
    are merged. The user can commit or revert these as they desire. The branch
4659
 
    nickname is also updated to be that of the branch being switched to.
 
4665
    are merged. The user can commit or revert these as they desire.
4660
4666
 
4661
4667
    Pending merges need to be committed or reverted before using switch.
4662
4668
 
4664
4670
    directory of the current branch. For example, if you are currently in a
4665
4671
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4666
4672
    /path/to/newbranch.
 
4673
 
 
4674
    Bound branches use the nickname of its master branch unless it is set
 
4675
    locally, in which case switching will update the the local nickname to be
 
4676
    that of the master.
4667
4677
    """
4668
4678
 
4669
4679
    takes_args = ['to_location']