Mercurial > public > mercurial-scm > hg-stable
comparison 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 |
comparison
equal
deleted
inserted
replaced
19468:82c512643bed | 19469:bf6bc4681383 |
---|---|
3318 ('a', 'active', False, _('show active branchheads only (DEPRECATED)')), | 3318 ('a', 'active', False, _('show active branchheads only (DEPRECATED)')), |
3319 ('c', 'closed', False, _('show normal and closed branch heads')), | 3319 ('c', 'closed', False, _('show normal and closed branch heads')), |
3320 ] + templateopts, | 3320 ] + templateopts, |
3321 _('[-ct] [-r STARTREV] [REV]...')) | 3321 _('[-ct] [-r STARTREV] [REV]...')) |
3322 def heads(ui, repo, *branchrevs, **opts): | 3322 def heads(ui, repo, *branchrevs, **opts): |
3323 """show current repository heads or show branch heads | 3323 """show branch heads |
3324 | 3324 |
3325 With no arguments, show all repository branch heads. | 3325 With no arguments, show all open branch heads in the repository. |
3326 | 3326 Branch heads are changesets that have no child changesets on the |
3327 Repository "heads" are changesets with no child changesets. They are | 3327 same branch. They are where development generally takes place and |
3328 where development generally takes place and are the usual targets | 3328 are the usual targets for update and merge operations. |
3329 for update and merge operations. Branch heads are changesets that have | 3329 |
3330 no child changeset on the same branch. | 3330 If one or more REVs are given, only open branch heads on the |
3331 | 3331 branches associated with the specified changesets are shown. This |
3332 If one or more REVs are given, only branch heads on the branches | 3332 means that you can use :hg:`heads .` to see the heads on the |
3333 associated with the specified changesets are shown. This means | 3333 currently checked-out branch. |
3334 that you can use :hg:`heads foo` to see the heads on a branch | |
3335 named ``foo``. | |
3336 | 3334 |
3337 If -c/--closed is specified, also show branch heads marked closed | 3335 If -c/--closed is specified, also show branch heads marked closed |
3338 (see :hg:`commit --close-branch`). | 3336 (see :hg:`commit --close-branch`). |
3339 | 3337 |
3340 If STARTREV is specified, only those heads that are descendants of | 3338 If STARTREV is specified, only those heads that are descendants of |
3341 STARTREV will be displayed. | 3339 STARTREV will be displayed. |
3342 | 3340 |
3343 If -t/--topo is specified, named branch mechanics will be ignored and only | 3341 If -t/--topo is specified, named branch mechanics will be ignored and only |
3344 changesets without children will be shown. | 3342 topological heads (changesets with no children) will be shown. |
3345 | 3343 |
3346 Returns 0 if matching heads are found, 1 if not. | 3344 Returns 0 if matching heads are found, 1 if not. |
3347 """ | 3345 """ |
3348 | 3346 |
3349 start = None | 3347 start = None |