contrib/win32/win32-build.txt

sparse-revlog: implement algorithm to write sparse delta chains (issue5480)

The classic behavior of revlog._isgooddeltainfo is to consider the span size
of the whole delta chain, and limit it to 4 * textlen.
Once sparse-revlog writing is allowed (and enforced with a requirement),
revlog._isgooddeltainfo considers the span of the largest chunk as the
distance used in the verification, instead of using the span of the whole
delta chain.

In order to compute the span of the largest chunk, we need to slice into
chunks a chain with the new revision at the top of the revlog, and take the
maximal span of these chunks. The sparse read density is a parameter to the
slicing, as it will stop when the global read density reaches this threshold.
For instance, a density of 50% means that 2 of 4 read bytes are actually used
for the reconstruction of the revision (the others are part of other chains).

This allows a new revision to be potentially stored with a diff against
another revision anywhere in the history, instead of forcing it in the last 4
* textlen. The result is a much better compression on repositories that have
many concurrent branches. Here are a comparison between using deltas from
current upstream (aggressive-merge-deltas on by default) and deltas from a
sparse-revlog

Comparison of `.hg/store/` size:

    mercurial (6.74% merges):
        before:     46,831,873 bytes
        after:      46,795,992 bytes (no relevant change)
    pypy (8.30% merges):
        before:    333,524,651 bytes
        after:     308,417,511 bytes -8%
    netbeans (34.21% merges):
        before:  1,141,847,554 bytes
        after:   1,131,093,161 bytes -1%
    mozilla-central (4.84% merges):
        before:  2,344,248,850 bytes
        after:   2,328,459,258 bytes -1%
    large-private-repo-A (merge 19.73%)
        before: 41,510,550,163 bytes
        after:   8,121,763,428 bytes -80%
    large-private-repo-B (23.77%)
        before: 58,702,221,709 bytes
        after:   8,351,588,828 bytes -76%

Comparison of `00manifest.d` size:

    mercurial (6.74% merges):
        before:      6,143,044 bytes
        after:       6,107,163 bytes
    pypy (8.30% merges):
        before:     52,941,780 bytes
        after:      27,834,082 bytes -48%
    netbeans (34.21% merges):
        before:    130,088,982 bytes
        after:     119,337,636 bytes -10%
    mozilla-central (4.84% merges):
        before:    215,096,339 bytes
        after:     199,496,863 bytes -8%
    large-private-repo-A (merge 19.73%)
        before: 33,725,285,081 bytes
        after:     390,302,545 bytes -99%
    large-private-repo-B (23.77%)
        before: 49,457,701,645 bytes
        after:   1,366,752,187 bytes -97%


The better delta chains provide a performance boost in relevant repositories:

    pypy, bundling 1000 revisions:
        before: 1.670s
        after:  1.149s -31%

Unbundling got a bit slower. probably because the sparse algorithm is still
pure
python.

    pypy, unbundling 1000 revisions:
        before: 4.062s
        after:  4.507s +10%

Performance of bundle/unbundle in repository with few concurrent branches (eg:
mercurial) are unaffected.

No significant differences have been noticed then timing `hg push` and `hg
pull` locally. More state timings are being gathered.

Same as for aggressive-merge-delta, better delta comes with longer delta
chains. Longer chains have a performance impact. For example. The length of
the chain needed to get the manifest of pypy's tip moves from 82 item to 1929
items. This moves the restore time from 3.88ms to 11.3ms.

Delta chain length is an independent issue that affects repository without
this changes. It will be dealt with independently.

No significant differences have been observed on repositories where
`sparse-revlog` have not much effect (mercurial, unity, netbeans). On pypy,
small differences have been observed on some operation affected by delta chain
building and retrieval.


    pypy, perfmanifest
        before: 0.006162s
        after:  0.017899s +190%

    pypy, commit:
        before: 0.382
        after:  0.376 -1%

    pypy, status:
        before: 0.157
        after:  0.168 +7%

More comprehensive and stable timing comparisons are in progress.

The standalone Windows installer for Mercurial is built in a somewhat
jury-rigged fashion.

It has the following prerequisites. Ensure to take the packages
matching the mercurial version you want to build (32-bit or 64-bit).

  Python 2.6 for Windows
      http://www.python.org/download/releases/

  A compiler:
    either MinGW
      http://www.mingw.org/
    or Microsoft Visual C++ 2008 SP1 Express Edition
      http://www.microsoft.com/express/Downloads/Download-2008.aspx

  Python for Windows Extensions
      http://sourceforge.net/projects/pywin32/

  mfc71.dll (just download, don't install; not needed for Python 2.6)
      http://starship.python.net/crew/mhammond/win32/

  Visual C++ 2008 redistributable package (needed for >= Python 2.6 or if you compile with MSVC)
    for 32-bit:
      http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf
    for 64-bit:
      http://www.microsoft.com/downloads/details.aspx?familyid=bd2a6171-e2d6-4230-b809-9a8d7548c1b6

  The py2exe distutils extension
      http://sourceforge.net/projects/py2exe/

  GnuWin32 gettext utility (if you want to build translations)
      http://gnuwin32.sourceforge.net/packages/gettext.htm

  Inno Setup
      http://www.jrsoftware.org/isdl.php#qsp

      Get and install ispack-5.3.10.exe or later (includes Inno Setup Processor),
      which is necessary to package Mercurial.

  ISTool - optional
      http://www.istool.org/default.aspx/

  add_path (you need only add_path.exe in the zip file)
      http://www.barisione.org/apps.html#add_path

  Docutils
      http://docutils.sourceforge.net/

  CA Certs file
      http://curl.haxx.se/ca/cacert.pem

And, of course, Mercurial itself.

Once you have all this installed and built, clone a copy of the
Mercurial repository you want to package, and name the repo
C:\hg\hg-release.

In a shell, build a standalone copy of the hg.exe program.

Building instructions for MinGW:
  python setup.py build -c mingw32
  python setup.py py2exe -b 2
Note: the previously suggested combined command of "python setup.py build -c
mingw32 py2exe -b 2" doesn't work correctly anymore as it doesn't include the
extensions in the mercurial subdirectory.
If you want to create a file named setup.cfg with the contents:
[build]
compiler=mingw32
you can skip the first build step.

Building instructions with MSVC 2008 Express Edition:
  for 32-bit:
    "C:\Program Files\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86
    python setup.py py2exe -b 2
  for 64-bit:
    "C:\Program Files\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86_amd64
    python setup.py py2exe -b 3

Copy add_path.exe and cacert.pem files into the dist directory that just got created.

If you are using Python 2.6 or later, or if you are using MSVC 2008 to compile
mercurial, you must include the C runtime libraries in the installer. To do so,
install the Visual C++ 2008 redistributable package. Then in your windows\winsxs
folder, locate the folder containing the dlls version 9.0.21022.8.
For x86, it should be named like x86_Microsoft.VC90.CRT_(...)_9.0.21022.8(...).
For x64, it should be named like amd64_Microsoft.VC90.CRT_(...)_9.0.21022.8(...).
Copy the files named msvcm90.dll, msvcp90.dll and msvcr90.dll into the dist
directory.
Then in the windows\winsxs\manifests folder, locate the corresponding manifest
file (x86_Microsoft.VC90.CRT_(...)_9.0.21022.8(...).manifest for x86,
amd64_Microsoft.VC90.CRT_(...)_9.0.21022.8(...).manifest for x64), copy it in the
dist directory and rename it to Microsoft.VC90.CRT.manifest.

Before building the installer, you have to build Mercurial HTML documentation
(or fix mercurial.iss to not reference the doc directory):

  cd doc
  mingw32-make html
  cd ..

If you use ISTool, you open the C:\hg\hg-release\contrib\win32\mercurial.iss
file and type Ctrl-F9 to compile the installer file.

Otherwise you run the Inno Setup compiler.  Assuming it's in the path
you should execute:

  iscc contrib\win32\mercurial.iss /dVERSION=foo

Where 'foo' is the version number you would like to see in the
'Add/Remove Applications' tool.  The installer will be placed into
a directory named Output/ at the root of your repository.
If the /dVERSION=foo parameter is not given in the command line, the
installer will retrieve the version information from the __version__.py file.

If you want to build an installer for a 64-bit mercurial, add /dARCH=x64 to
your command line:
  iscc contrib\win32\mercurial.iss /dARCH=x64

To automate the steps above you may want to create a batchfile based on the
following (MinGW build chain):

  echo [build] > setup.cfg
  echo compiler=mingw32 >> setup.cfg
  python setup.py py2exe -b 2
  cd doc
  mingw32-make html
  cd ..
  iscc contrib\win32\mercurial.iss /dVERSION=snapshot

and run it from the root of the hg repository (c:\hg\hg-release).