view relnotes/5.1 @ 44363:f7459da77f23

nodemap: introduce an option to use mmap to read the nodemap mapping

The performance and memory benefit is much greater if we don't have to copy all
the data in memory for each information. So we introduce an option (on by
default) to read the data using mmap.

This changeset is the last one definition the API for index support nodemap
data. (they have to be able to use the mmaping).

Below are some benchmark comparing the best we currently have in 5.3 with the
final step of this series (using the persistent nodemap implementation in
Rust). The benchmark run `hg perfindex` with various revset and the following
variants:

Before:

 * do not use the persistent nodemap
 * use the CPython implementation of the index for nodemap
 * use mmapping of the changelog index

After:

 * use the MixedIndex Rust code, with the NodeTree object for nodemap access
   (still in review)
 * use the persistent nodemap data from disk
 * access the persistent nodemap data through mmap
 * use mmapping of the changelog index

The persistent nodemap greatly speed up  most operation on very large
repositories. Some of the previously very fast lookup end up a bit slower because
the persistent nodemap has to be setup. However the absolute slowdown is very
small and won't matters in the big picture.

Here are some numbers (in seconds) for the reference copy of mozilla-try:

Revset            Before   After     abs-change speedup

-10000:           0.004622 0.005532   0.000910  ×   0.83
-10:              0.000050 0.000132   0.000082  ×   0.37
tip               0.000052 0.000085   0.000033  ×   0.61
0 + (-10000:)     0.028222 0.005337  -0.022885  ×   5.29
0                 0.023521 0.000084  -0.023437  × 280.01
(-10000:) + 0     0.235539 0.005308  -0.230231  ×  44.37
(-10:) + :9       0.232883 0.000180  -0.232703  ×1293.79
(-10000:) + (:99) 0.238735 0.005358  -0.233377  ×  44.55
:99 + (-10000:)   0.317942 0.005593  -0.312349  ×  56.84
:9 + (-10:)       0.313372 0.000179  -0.313193  ×1750.68
:9                0.316450 0.000143  -0.316307  ×2212.93


On smaller repositories, the cost of nodemap related operation is not as big, so
the win is much more modest. Yet it helps shaving a handful of millisecond here
and there.

Here are some numbers (in seconds) for the reference copy of mercurial:

Revset            Before   After     abs-change speedup
-10:              0.000065 0.000097   0.000032  × 0.67
tip               0.000063 0.000078   0.000015  × 0.80
0                 0.000561 0.000079  -0.000482  × 7.10
-10000:           0.004609 0.003648  -0.000961  × 1.26
0 + (-10000:)     0.005023 0.003715  -0.001307  × 1.35
(-10:) + :9       0.002187 0.000108  -0.002079  ×20.25
(-10000:) + 0     0.006252 0.003716  -0.002536  × 1.68
(-10000:) + (:99) 0.006367 0.003707  -0.002660  × 1.71
:9 + (-10:)       0.003846 0.000110  -0.003736  ×34.96
:9                0.003854 0.000099  -0.003755  ×38.92
:99 + (-10000:)   0.007644 0.003778  -0.003866  × 2.02

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

== New Features ==

 * New config `commands.commit.post-status` shows status after successful
 commit.

 * `hg root` now has templating support, including support for showing
   where a repo share's source is. See `hg help -v root` for details.

 * New `--force-close-branch` flag for `hg commit` to forcibly close
   branch from a non-head changeset.

 * The curses-based interface for commands like `hg commit -i` now supports
   a range-select mechanism. Select the first line using space like before,
   navigate to the last line, and press X (capital x) to set all items in
   the range at once. Lowercase x has been added as a synonym for space to
   help reinforce the mechanism, and pressing enter/return continues to be a
   synonym for "toggle the current line and move down to the next item in
   this section."

== New Experimental Features ==

 * New config `experimental.log.topo` makes `hg log -G` use
   topological sorting. This is especially useful for aliases since it
   lets the alias accept an `-r` option while still using topological
   sorting with or without the `-r` (unlike if you use the `sort(...,
   topo)` revset).


== Bug Fixes  ==

 * issue4292: "hg log and {files} {file_adds} {file_mods} {file_dels}
   in template show wrong files on merged revision". See details in
   "Backwards Compatibility Changes".


== Backwards Compatibility Changes ==

 * Removed (experimental) support for log graph lines mixing
   parent/grandparent styles. Setting
   e.g. `experimental.graphstyle.parent = !` and
   `experimental.graphstyle.grandparent = 3.` would use `!` for the
   first three lines of the graph and then `.`. This is no longer
   supported.

 * If `ui.origbackuppath` had been (incorrectly) configured to point
   to a file, we will now replace that file by a directory and put
   backups in that directory. This is similar to how we would
   previously replace files *in* the configured directory by
   subdirectories.

* Template keyword `{file_mods}`, `{file_adds}`, and `{file_dels}`
   have changed behavior on merge commits. They used to be relative to
   the first parent, but they now consider both parents. `{file_adds}`
   shows files that exists in the commit but did not exist in either
   parent. `{file_dels}` shows files that do not exist in the commit
   but existed in either parent. `{file_mods}` show the remaining
   files from `{files}` that were not in the other two
   sets.


== Internal API Changes ==

 * Matchers are no longer iterable. Use `match.files()` instead.

 * `match.visitdir()` and `match.visitchildrenset()` now expect the
   empty string instead of '.' to indicate the root directory.

 * `util.dirs()` and `util.finddirs()` now include an entry for the
   root directory (empty string).

 * shelve is no longer an extension now. it will be turned on by default.

 * New API to manage unfinished operations: Earlier there were distinct APIs
   which dealt with unfinished states and separate lists maintaining them
   that are `cmdutil.afterresolvestates`, `cmdutil.unfinishedstates` and
   `cmdutil.STATES`. Now these have been unified to a single
   API which handles the various states and their utilities. This API
   has been added to `state.py`. Now instead of adding to these 3 lists
   independently a state for a new operation can be registered using
   `addunfinished()` in `state` module.

 * `cmdutil.checkunfinished()` now includes detection for merge too.

 * merge abort has been disallowed in case an operation of higher
   precedence is in progress to avoid cases of partial abort of
   operations.

 * We used to automatically attempt to make extensions compatible with
   Python 3 (by translating their source code while loading it). We no
   longer do that.