( )⚙ D6448 help: add help entry for internals.mergestate

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6448

help: add help entry for internals.mergestate
ClosedPublic

Authored by navaneeth.suresh on May 27 2019, 9:24 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG9d31581cc44e: help: add help entry for internals.mergestate
rHG2ae1e2ad4969: help: add help entry for internals.mergestate
Summary

This patch adds an entry for internals.mergestate as suggested
by @marmoute. Most of the help text is taken from merge.mergestate.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

navaneeth.suresh added a commit: rHG2ae1e2ad4969: help: add help entry for internals.mergestate.Jun 12 2019, 12:58 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG2ae1e2ad4969: help: add help entry for internals.mergestate (authored by navaneeth.suresh). · Explain Why
This revision was automatically updated to reflect the committed changes.
mharbison72 added a subscriber: mharbison72.Jun 13 2019, 12:32 PM

This needs some fixups to keep test-help.t and the Windows installer happy:

https://buildbot.mercurial-scm.org/builders/Win7%20x86_64%20hg%20tests/builds/1468/steps/run-tests.py%20%28python%202.7.13%29/logs/stdio

See 876f08f30ade for an example of how to fix the installer.

navaneeth.suresh added a comment.Jun 13 2019, 1:23 PM
In D6448#94994, @mharbison72 wrote:

This needs some fixups to keep test-help.t and the Windows installer happy:
https://buildbot.mercurial-scm.org/builders/Win7%20x86_64%20hg%20tests/builds/1468/steps/run-tests.py%20%28python%202.7.13%29/logs/stdio
See 876f08f30ade for an example of how to fix the installer.

Thanks! Doing that right away!

Revision Contents
Changeset List

Diff 15270

mercurial/help.py

(['censor'], _('Censor'), (['censor'], _('Censor'),
loaddoc('censor', subdir='internals')), loaddoc('censor', subdir='internals')),
(['changegroups'], _('Changegroups'), (['changegroups'], _('Changegroups'),
loaddoc('changegroups', subdir='internals')), loaddoc('changegroups', subdir='internals')),
(['config'], _('Config Registrar'), (['config'], _('Config Registrar'),
loaddoc('config', subdir='internals')), loaddoc('config', subdir='internals')),
(['extensions', 'extension'], _('Extension API'), (['extensions', 'extension'], _('Extension API'),
loaddoc('extensions', subdir='internals')), loaddoc('extensions', subdir='internals')),
(['mergestate'], _('Mergestate'),
loaddoc('mergestate', subdir='internals')),
(['requirements'], _('Repository Requirements'), (['requirements'], _('Repository Requirements'),
loaddoc('requirements', subdir='internals')), loaddoc('requirements', subdir='internals')),
(['revlogs'], _('Revision Logs'), (['revlogs'], _('Revision Logs'),
loaddoc('revlogs', subdir='internals')), loaddoc('revlogs', subdir='internals')),
(['wireprotocol'], _('Wire Protocol'), (['wireprotocol'], _('Wire Protocol'),
loaddoc('wireprotocol', subdir='internals')), loaddoc('wireprotocol', subdir='internals')),
(['wireprotocolrpc'], _('Wire Protocol RPC'), (['wireprotocolrpc'], _('Wire Protocol RPC'),
loaddoc('wireprotocolrpc', subdir='internals')), loaddoc('wireprotocolrpc', subdir='internals')),

mercurial/help/internals/mergestate.txt

  • This file was added.
The active mergestate is stored in ``.hg/merge`` when a merge is triggered
by commands like ``hg merge``, ``hg rebase``, etc. until the merge is
completed or aborted to track the 3-way merge state of individual files.
The contents of the directory are:
Conflicting files
-----------------
The local version of the conflicting files are stored with their
filenames as the hash of their paths.
state
-----
This mergestate file record is used by hg version prior to 2.9.1
and contains less data than ``state2``. If there is no contradiction
with ``state2``, we can assume that both are written at the same time.
In this case, data from ``state2`` is used. Otherwise, we use ``state``.
We read/write both ``state`` and ``state2`` records to ensure backward
compatibility.
state2
------
This record stores a superset of data in ``state``, including new kinds
of records in the future.
Each record can contain arbitrary content and has an associated type. This
`type` should be a letter. If `type` is uppercase, the record is mandatory:
versions of Mercurial that don't support it should abort. If `type` is
lowercase, the record can be safely ignored.
Currently known records:
| * L: the node of the "local" part of the merge (hexified version)
| * O: the node of the "other" part of the merge (hexified version)
| * F: a file to be merged entry
| * C: a change/delete or delete/change conflict
| * D: a file that the external merge driver will merge internally
| (experimental)
| * P: a path conflict (file vs directory)
| * m: the external merge driver defined for this merge plus its run state
| (experimental)
| * f: a (filename, dictionary) tuple of optional values for a given file
| * X: unsupported mandatory record type (used in tests)
| * x: unsupported advisory record type (used in tests)
| * l: the labels for the parts of the merge.
Merge driver run states (experimental):
| * u: driver-resolved files unmarked -- needs to be run next time we're
| about to resolve or commit
| * m: driver-resolved files marked -- only needs to be run before commit
| * s: success/skipped -- does not need to be run any more
Merge record states (indexed by filename):
| * u: unresolved conflict
| * r: resolved conflict
| * pu: unresolved path conflict (file conflicts with directory)
| * pr: resolved path conflict
| * d: driver-resolved conflict
The resolve command transitions between 'u' and 'r' for conflicts and
'pu' and 'pr' for path conflicts.
This format is a list of arbitrary records of the form:
[type][length][content]
`type` is a single character, `length` is a 4 byte integer, and
`content` is an arbitrary byte sequence of length `length`.
Mercurial versions prior to 3.7 have a bug where if there are
unsupported mandatory merge records, attempting to clear out the merge
state with hg update --clean or similar aborts. The 't' record type
works around that by writing out what those versions treat as an
advisory record, but later versions interpret as special: the first
character is the 'real' record type and everything onwards is the data.