This is an archive of the discontinued Mercurial Phabricator instance.

Differential D11852

update: reformat the `commands.update.check` help
ClosedPublic

Authored by marmoute on Dec 3 2021, 9:10 AM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHGf77e4daaf612: update: reformat the `commands.update.check` help
Summary

This make the various option clearer.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

marmoute created this revision.Dec 3 2021, 9:10 AM
Alphare accepted this revision.Dec 3 2021, 9:17 AM
This revision is now accepted and ready to land.Dec 3 2021, 9:17 AM
marmoute added a commit: rHGf77e4daaf612: update: reformat the `commands.update.check` help.Dec 3 2021, 9:53 AM
Closed by commit rHGf77e4daaf612: update: reformat the `commands.update.check` help (authored by marmoute). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/helptext/config.txt (19 lines)
Mtests/test-help.t (40 lines)

Diff 31297

mercurial/helptext/config.txt

``status.terse`` ``status.terse``
Default value for the --terse flag, which condenses status output. Default value for the --terse flag, which condenses status output.
(default: empty) (default: empty)
``update.check`` ``update.check``
Determines what level of checking :hg:`update` will perform before moving Determines what level of checking :hg:`update` will perform before moving
to a destination revision. Valid values are ``abort``, ``none``, to a destination revision. Valid values are ``abort``, ``none``,
``linear``, and ``noconflict``. ``abort`` always fails if the working ``linear``, and ``noconflict``.
directory has uncommitted changes. ``none`` performs no checking, and may
result in a merge with uncommitted changes. ``linear`` allows any update - ``abort`` always fails if the working directory has uncommitted changes.
as long as it follows a straight line in the revision history, and may
trigger a merge with uncommitted changes. ``noconflict`` will allow any - ``none`` performs no checking, and may result in a merge with uncommitted changes.
update which would not trigger a merge with uncommitted changes, if any
are present. - ``linear`` allows any update as long as it follows a straight line in the
revision history, and may trigger a merge with uncommitted changes.
- ``noconflict`` will allow any update which would not trigger a merge with
uncommitted changes, if any are present.
(default: ``linear``) (default: ``linear``)
``update.requiredest`` ``update.requiredest``
Require that the user pass a destination when running :hg:`update`. Require that the user pass a destination when running :hg:`update`.
For example, :hg:`update .::` will be allowed, but a plain :hg:`update` For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
will be disallowed. will be disallowed.
(default: False) (default: False)

tests/test-help.t

$ hg help config.annotate.git $ hg help config.annotate.git
abort: help section not found: config.annotate.git abort: help section not found: config.annotate.git
[10] [10]
$ hg help config.update.check $ hg help config.update.check
"commands.update.check" "commands.update.check"
Determines what level of checking 'hg update' will perform before Determines what level of checking 'hg update' will perform before
moving to a destination revision. Valid values are "abort", "none", moving to a destination revision. Valid values are "abort", "none",
"linear", and "noconflict". "abort" always fails if the working "linear", and "noconflict".
directory has uncommitted changes. "none" performs no checking, and
may result in a merge with uncommitted changes. "linear" allows any - "abort" always fails if the working directory has uncommitted
update as long as it follows a straight line in the revision history, changes.
and may trigger a merge with uncommitted changes. "noconflict" will - "none" performs no checking, and may result in a merge with
allow any update which would not trigger a merge with uncommitted uncommitted changes.
changes, if any are present. (default: "linear") - "linear" allows any update as long as it follows a straight line in
the revision history, and may trigger a merge with uncommitted
changes.
- "noconflict" will allow any update which would not trigger a merge
with uncommitted changes, if any are present.
(default: "linear")
$ hg help config.commands.update.check $ hg help config.commands.update.check
"commands.update.check" "commands.update.check"
Determines what level of checking 'hg update' will perform before Determines what level of checking 'hg update' will perform before
moving to a destination revision. Valid values are "abort", "none", moving to a destination revision. Valid values are "abort", "none",
"linear", and "noconflict". "abort" always fails if the working "linear", and "noconflict".
directory has uncommitted changes. "none" performs no checking, and
may result in a merge with uncommitted changes. "linear" allows any - "abort" always fails if the working directory has uncommitted
update as long as it follows a straight line in the revision history, changes.
and may trigger a merge with uncommitted changes. "noconflict" will - "none" performs no checking, and may result in a merge with
allow any update which would not trigger a merge with uncommitted uncommitted changes.
changes, if any are present. (default: "linear") - "linear" allows any update as long as it follows a straight line in
the revision history, and may trigger a merge with uncommitted
changes.
- "noconflict" will allow any update which would not trigger a merge
with uncommitted changes, if any are present.
(default: "linear")
$ hg help config.ommands.update.check $ hg help config.ommands.update.check
abort: help section not found: config.ommands.update.check abort: help section not found: config.ommands.update.check
[10] [10]
Unrelated trailing paragraphs shouldn't be included Unrelated trailing paragraphs shouldn't be included