Mercurial > public > mercurial-scm > hg-stable
diff mercurial/commands.py @ 19469:bf6bc4681383 stable
heads: modernize documentation (issue3992)
The old docs emphasized topological heads rather than branch heads and
incorrectly defined branch heads as not having children rather than
descendants.
author | Matt Mackall <mpm@selenic.com> |
---|---|
date | Sun, 21 Jul 2013 18:45:42 -0500 |
parents | 4a0d0616c47d |
children | e24531a23ae4 |
line wrap: on
line diff
--- a/mercurial/commands.py Fri Jul 19 16:45:44 2013 -0500 +++ b/mercurial/commands.py Sun Jul 21 18:45:42 2013 -0500 @@ -3320,19 +3320,17 @@ ] + templateopts, _('[-ct] [-r STARTREV] [REV]...')) def heads(ui, repo, *branchrevs, **opts): - """show current repository heads or show branch heads - - With no arguments, show all repository branch heads. - - Repository "heads" are changesets with no child changesets. They are - where development generally takes place and are the usual targets - for update and merge operations. Branch heads are changesets that have - no child changeset on the same branch. - - If one or more REVs are given, only branch heads on the branches - associated with the specified changesets are shown. This means - that you can use :hg:`heads foo` to see the heads on a branch - named ``foo``. + """show branch heads + + With no arguments, show all open branch heads in the repository. + Branch heads are changesets that have no child changesets on the + same branch. They are where development generally takes place and + are the usual targets for update and merge operations. + + If one or more REVs are given, only open branch heads on the + branches associated with the specified changesets are shown. This + means that you can use :hg:`heads .` to see the heads on the + currently checked-out branch. If -c/--closed is specified, also show branch heads marked closed (see :hg:`commit --close-branch`). @@ -3341,7 +3339,7 @@ STARTREV will be displayed. If -t/--topo is specified, named branch mechanics will be ignored and only - changesets without children will be shown. + topological heads (changesets with no children) will be shown. Returns 0 if matching heads are found, 1 if not. """