annotate contrib/xml.rnc @ 43271:99394e6c5d12

rust-dirstate-status: add first Rust implementation of `dirstate.status`

Note: This patch also added the rayon crate as a Cargo dependency. It will
help us immensely in making Rust code parallel and easy to maintain. It is
a stable, well-known, and supported crate maintained by people on the Rust
team.

The current `dirstate.status` method has grown over the years through bug
reports and new features to the point where it got too big and too complex.

This series does not yet improve the logic, but adds a Rust fast-path to speed
up certain cases.

Tested on mozilla-try-2019-02-18 with zstd compression:
    - `hg diff` on an empty working copy:
        - c: 1.64(+-)0.04s
        - rust+c before this change: 2.84(+-)0.1s
        - rust+c: 849(+-)40ms
    - `hg commit` when creating a file:
        - c: 5.960s
        - rust+c before this change: 5.828s
        - rust+c: 4.668s
    - `hg commit` when updating a file:
        - c: 4.866s
        - rust+c before this change: 4.371s
        - rust+c: 3.855s
    - `hg status -mard`
        - c: 1.82(+-)0.04s
        - rust+c before this change: 2.64(+-)0.1s
        - rust+c: 896(+-)30ms

The numbers are clear: the current Rust `dirstatemap` implementation is super
slow, its performance needs to be addressed.
This will be done in a future series, immediately after this one, with the goal
of getting Rust to be at least to the speed of the Python + C implementation
in all cases before the 5.2 freeze. At worse, we gate dirstatemap to only be used
in those cases.

Cases where the fast-path is not executed:
    - for commands that need ignore support (`status`, for example)
    - if subrepos are found (should not be hard to add, but winter is coming)
    - any other matcher than an `alwaysmatcher`, like patterns, etc.
    - with extensions like `sparse` and `fsmonitor`

The next step after this is to rethink the logic to be closer to
Jane Street's Valentin Gatien-Baron's Rust fast-path which does a lot less
work when possible.

Differential Revision: https://phab.mercurial-scm.org/D7058

# RelaxNG schema for "xml" log style
# Inspired by Subversion's XML log format.

start = log
node.type = xsd:string  {minLength = "40" maxLength = "40"}

log = element log { logentry+ }
logentry = element logentry {
    logentry.attlist,
    branch*, tag*, hgparent*,
    author, date,
    msg, paths?, copies?, extra*
}
logentry.attlist =
    attribute revision {xsd:nonNegativeInteger}
  & attribute node {node.type}
branch = element branch { text }
tag = element tag { text }
hgparent = element parent {hgparent.attlist, text}
hgparent.attlist =
    attribute revision {xsd:integer {minInclusive = "-1"} }
  & attribute node {node.type}
author = element author { author.attlist, text }
author.attlist =
    attribute email {text}
date = element date {xsd:dateTime}
msg = element msg {msg.attlist, text}
msg.attlist =
    attribute xml:space {"preserve"}
paths = element paths { path* }
path = element path { path.attlist, text }
path.attlist =
    # Action: (A)dd, (M)odify, (R)emove
    attribute action {"A"|"M"|"R"}
copies = element copies { copy+ }
copy = element copy { copy.attlist, text }
copy.attlist =
    attribute source {text}
extra = element extra {extra.attlist, text}
extra.attlist =
    attribute key {text}