comparison mercurial/commands.py @ 18474:e031e10cdc06 stable

help: document '@' bookmark in 'help bookmarks' and 'help clone'
author Kevin Bullock <kbullock@ringworld.org>
date Fri, 25 Jan 2013 11:06:30 -0600
parents 2096e025a728
children 1fb9890c55bd
comparison
equal deleted inserted replaced
18473:692cbda1eb50 18474:e031e10cdc06
783 Bookmarks can be pushed and pulled between repositories (see :hg:`help 783 Bookmarks can be pushed and pulled between repositories (see :hg:`help
784 push` and :hg:`help pull`). This requires both the local and remote 784 push` and :hg:`help pull`). This requires both the local and remote
785 repositories to support bookmarks. For versions prior to 1.8, this means 785 repositories to support bookmarks. For versions prior to 1.8, this means
786 the bookmarks extension must be enabled. 786 the bookmarks extension must be enabled.
787 787
788 If you set a bookmark called '@', new clones of the repository will
789 have that revision checked out (and the bookmark made active) by
790 default.
791
788 With -i/--inactive, the new bookmark will not be made the active 792 With -i/--inactive, the new bookmark will not be made the active
789 bookmark. If -r/--rev is given, the new bookmark will not be made 793 bookmark. If -r/--rev is given, the new bookmark will not be made
790 active even if -i/--inactive is not given. If no NAME is given, the 794 active even if -i/--inactive is not given. If no NAME is given, the
791 current active bookmark will be marked inactive. 795 current active bookmark will be marked inactive.
792 ''' 796 '''
1143 resulting clone will contain only the specified changesets and 1147 resulting clone will contain only the specified changesets and
1144 their ancestors. These options (or 'clone src#rev dest') imply 1148 their ancestors. These options (or 'clone src#rev dest') imply
1145 --pull, even for local source repositories. Note that specifying a 1149 --pull, even for local source repositories. Note that specifying a
1146 tag will include the tagged changeset but not the changeset 1150 tag will include the tagged changeset but not the changeset
1147 containing the tag. 1151 containing the tag.
1152
1153 If the source repository has a bookmark called '@' set, that
1154 revision will be checked out in the new repository by default.
1148 1155
1149 To check out a particular version, use -u/--update, or 1156 To check out a particular version, use -u/--update, or
1150 -U/--noupdate to create a clone with no working directory. 1157 -U/--noupdate to create a clone with no working directory.
1151 1158
1152 .. container:: verbose 1159 .. container:: verbose