contrib/packaging/inno/readme.txt
author Gregory Szorc <gregory.szorc@gmail.com>
Sun, 03 Mar 2019 09:10:52 -0800
changeset 41848 27eca52b1874
parent 41847 0f49b56d5d74
child 41849 d22198b4b3dd
permissions -rw-r--r--
inno: remove cacerts.pem from documentation The inno distribution no longer includes cacert.pem as of ca1ad8ef38be22 (April 2015). The docs were never updated. Differential Revision: https://phab.mercurial-scm.org/D6061
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     1
The standalone Windows installer for Mercurial is built in a somewhat
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     2
jury-rigged fashion.
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     3
12263
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
     4
It has the following prerequisites. Ensure to take the packages
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
     5
matching the mercurial version you want to build (32-bit or 64-bit).
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     6
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
     7
  Python 2.6 for Windows
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
     8
      http://www.python.org/download/releases/
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
     9
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    10
  A compiler:
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    11
    either MinGW
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    12
      http://www.mingw.org/
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    13
    or Microsoft Visual C++ 2008 SP1 Express Edition
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    14
      http://www.microsoft.com/express/Downloads/Download-2008.aspx
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    15
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    16
  Python for Windows Extensions
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    17
      http://sourceforge.net/projects/pywin32/
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    18
8058
a0555ae394b3 Add Python 2.6 support to win32 installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 7660
diff changeset
    19
  mfc71.dll (just download, don't install; not needed for Python 2.6)
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    20
      http://starship.python.net/crew/mhammond/win32/
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    21
12311
8afbf44cfe86 win32: update build instructions with correct CRT version
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12263
diff changeset
    22
  Visual C++ 2008 redistributable package (needed for >= Python 2.6 or if you compile with MSVC)
12263
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
    23
    for 32-bit:
12311
8afbf44cfe86 win32: update build instructions with correct CRT version
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12263
diff changeset
    24
      http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf
12263
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
    25
    for 64-bit:
12311
8afbf44cfe86 win32: update build instructions with correct CRT version
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12263
diff changeset
    26
      http://www.microsoft.com/downloads/details.aspx?familyid=bd2a6171-e2d6-4230-b809-9a8d7548c1b6
18960
170fc0949fb6 check-code: check txt files for trailing whitespace
Mads Kiilerich <madski@unity3d.com>
parents: 13246
diff changeset
    27
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    28
  The py2exe distutils extension
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    29
      http://sourceforge.net/projects/py2exe/
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    30
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    31
  GnuWin32 gettext utility (if you want to build translations)
9175
22979282d8ca Mention GnuWin32 gettext in win32 build instructions
Patrick Mezard <pmezard@gmail.com>
parents: 8058
diff changeset
    32
      http://gnuwin32.sourceforge.net/packages/gettext.htm
22979282d8ca Mention GnuWin32 gettext in win32 build instructions
Patrick Mezard <pmezard@gmail.com>
parents: 8058
diff changeset
    33
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    34
  Inno Setup
9356
9488a4d64fb5 iss: take version from iscc command line or __version__.py
Steve Borho <steve@borho.org>
parents: 9175
diff changeset
    35
      http://www.jrsoftware.org/isdl.php#qsp
9488a4d64fb5 iss: take version from iscc command line or __version__.py
Steve Borho <steve@borho.org>
parents: 9175
diff changeset
    36
13246
a01c52b08c5f win32: add cacert.pem file to Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12311
diff changeset
    37
      Get and install ispack-5.3.10.exe or later (includes Inno Setup Processor),
9356
9488a4d64fb5 iss: take version from iscc command line or __version__.py
Steve Borho <steve@borho.org>
parents: 9175
diff changeset
    38
      which is necessary to package Mercurial.
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    39
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    40
  ISTool - optional
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    41
      http://www.istool.org/default.aspx/
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    42
9179
9e5e2e07cf81 Update win32 build instructions for rst2html
Patrick Mezard <pmezard@gmail.com>
parents: 9175
diff changeset
    43
  Docutils
9e5e2e07cf81 Update win32 build instructions for rst2html
Patrick Mezard <pmezard@gmail.com>
parents: 9175
diff changeset
    44
      http://docutils.sourceforge.net/
7660
ceed5f8c4ebf Document how HTML documentation is built under Windows
Patrick Mezard <pmezard@gmail.com>
parents: 5081
diff changeset
    45
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    46
And, of course, Mercurial itself.
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    47
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    48
Once you have all this installed and built, clone a copy of the
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    49
Mercurial repository you want to package, and name the repo
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    50
C:\hg\hg-release.
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    51
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    52
In a shell, build a standalone copy of the hg.exe program.
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    53
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    54
Building instructions for MinGW:
5081
ea7b982b6c08 Remove trailing spaces
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4401
diff changeset
    55
  python setup.py build -c mingw32
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    56
  python setup.py py2exe -b 2
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    57
Note: the previously suggested combined command of "python setup.py build -c
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    58
mingw32 py2exe -b 2" doesn't work correctly anymore as it doesn't include the
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    59
extensions in the mercurial subdirectory.
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    60
If you want to create a file named setup.cfg with the contents:
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    61
[build]
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    62
compiler=mingw32
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    63
you can skip the first build step.
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    64
12311
8afbf44cfe86 win32: update build instructions with correct CRT version
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12263
diff changeset
    65
Building instructions with MSVC 2008 Express Edition:
12263
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
    66
  for 32-bit:
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
    67
    "C:\Program Files\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
    68
    python setup.py py2exe -b 2
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
    69
  for 64-bit:
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
    70
    "C:\Program Files\Microsoft Visual Studio 9.0\VC\vcvarsall.bat" x86_amd64
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
    71
    python setup.py py2exe -b 3
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    72
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    73
If you are using Python 2.6 or later, or if you are using MSVC 2008 to compile
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    74
mercurial, you must include the C runtime libraries in the installer. To do so,
12311
8afbf44cfe86 win32: update build instructions with correct CRT version
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12263
diff changeset
    75
install the Visual C++ 2008 redistributable package. Then in your windows\winsxs
8afbf44cfe86 win32: update build instructions with correct CRT version
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12263
diff changeset
    76
folder, locate the folder containing the dlls version 9.0.21022.8.
8afbf44cfe86 win32: update build instructions with correct CRT version
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12263
diff changeset
    77
For x86, it should be named like x86_Microsoft.VC90.CRT_(...)_9.0.21022.8(...).
8afbf44cfe86 win32: update build instructions with correct CRT version
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12263
diff changeset
    78
For x64, it should be named like amd64_Microsoft.VC90.CRT_(...)_9.0.21022.8(...).
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    79
Copy the files named msvcm90.dll, msvcp90.dll and msvcr90.dll into the dist
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    80
directory.
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
    81
Then in the windows\winsxs\manifests folder, locate the corresponding manifest
12311
8afbf44cfe86 win32: update build instructions with correct CRT version
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12263
diff changeset
    82
file (x86_Microsoft.VC90.CRT_(...)_9.0.21022.8(...).manifest for x86,
8afbf44cfe86 win32: update build instructions with correct CRT version
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12263
diff changeset
    83
amd64_Microsoft.VC90.CRT_(...)_9.0.21022.8(...).manifest for x64), copy it in the
12263
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
    84
dist directory and rename it to Microsoft.VC90.CRT.manifest.
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
    85
18960
170fc0949fb6 check-code: check txt files for trailing whitespace
Mads Kiilerich <madski@unity3d.com>
parents: 13246
diff changeset
    86
Before building the installer, you have to build Mercurial HTML documentation
10976
5ff192fb09ff contrib/win32: update build instructions after cbe400a8e217
Martin Geisler <mg@lazybytes.net>
parents: 9358
diff changeset
    87
(or fix mercurial.iss to not reference the doc directory):
7660
ceed5f8c4ebf Document how HTML documentation is built under Windows
Patrick Mezard <pmezard@gmail.com>
parents: 5081
diff changeset
    88
ceed5f8c4ebf Document how HTML documentation is built under Windows
Patrick Mezard <pmezard@gmail.com>
parents: 5081
diff changeset
    89
  cd doc
10976
5ff192fb09ff contrib/win32: update build instructions after cbe400a8e217
Martin Geisler <mg@lazybytes.net>
parents: 9358
diff changeset
    90
  mingw32-make html
7660
ceed5f8c4ebf Document how HTML documentation is built under Windows
Patrick Mezard <pmezard@gmail.com>
parents: 5081
diff changeset
    91
  cd ..
ceed5f8c4ebf Document how HTML documentation is built under Windows
Patrick Mezard <pmezard@gmail.com>
parents: 5081
diff changeset
    92
41846
765f836a9484 inno: move inno installer files to contrib/packaging/inno
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26805
diff changeset
    93
If you use ISTool, you open the
41847
0f49b56d5d74 inno: replace add_path.exe with a Pascal script
Gregory Szorc <gregory.szorc@gmail.com>
parents: 41846
diff changeset
    94
C:\hg\hg-release\contrib\packaging\inno-installer\mercurial.iss
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    95
file and type Ctrl-F9 to compile the installer file.
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    96
9356
9488a4d64fb5 iss: take version from iscc command line or __version__.py
Steve Borho <steve@borho.org>
parents: 9175
diff changeset
    97
Otherwise you run the Inno Setup compiler.  Assuming it's in the path
9488a4d64fb5 iss: take version from iscc command line or __version__.py
Steve Borho <steve@borho.org>
parents: 9175
diff changeset
    98
you should execute:
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
    99
41847
0f49b56d5d74 inno: replace add_path.exe with a Pascal script
Gregory Szorc <gregory.szorc@gmail.com>
parents: 41846
diff changeset
   100
  iscc contrib\packaging\inno-installer\mercurial.iss /dVERSION=foo
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
   101
9356
9488a4d64fb5 iss: take version from iscc command line or __version__.py
Steve Borho <steve@borho.org>
parents: 9175
diff changeset
   102
Where 'foo' is the version number you would like to see in the
9488a4d64fb5 iss: take version from iscc command line or __version__.py
Steve Borho <steve@borho.org>
parents: 9175
diff changeset
   103
'Add/Remove Applications' tool.  The installer will be placed into
9488a4d64fb5 iss: take version from iscc command line or __version__.py
Steve Borho <steve@borho.org>
parents: 9175
diff changeset
   104
a directory named Output/ at the root of your repository.
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
   105
If the /dVERSION=foo parameter is not given in the command line, the
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
   106
installer will retrieve the version information from the __version__.py file.
1291
a942bf419a64 Document Windows installer build process.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
   107
12263
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
   108
If you want to build an installer for a 64-bit mercurial, add /dARCH=x64 to
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
   109
your command line:
41847
0f49b56d5d74 inno: replace add_path.exe with a Pascal script
Gregory Szorc <gregory.szorc@gmail.com>
parents: 41846
diff changeset
   110
  iscc contrib\packaging\inno-installer\mercurial.iss /dARCH=x64
12263
5f19416056b4 win32: 64-bit Inno Setup installer
Pascal Quantin <pascal.quantin@gmail.com>
parents: 12262
diff changeset
   111
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
   112
To automate the steps above you may want to create a batchfile based on the
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
   113
following (MinGW build chain):
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
   114
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
   115
  echo [build] > setup.cfg
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
   116
  echo compiler=mingw32 >> setup.cfg
12262
df5386ae41b9 win32: update Inno Setup build instructions with up-to-date software
Pascal Quantin <pascal.quantin@gmail.com>
parents: 10976
diff changeset
   117
  python setup.py py2exe -b 2
7660
ceed5f8c4ebf Document how HTML documentation is built under Windows
Patrick Mezard <pmezard@gmail.com>
parents: 5081
diff changeset
   118
  cd doc
10976
5ff192fb09ff contrib/win32: update build instructions after cbe400a8e217
Martin Geisler <mg@lazybytes.net>
parents: 9358
diff changeset
   119
  mingw32-make html
7660
ceed5f8c4ebf Document how HTML documentation is built under Windows
Patrick Mezard <pmezard@gmail.com>
parents: 5081
diff changeset
   120
  cd ..
41847
0f49b56d5d74 inno: replace add_path.exe with a Pascal script
Gregory Szorc <gregory.szorc@gmail.com>
parents: 41846
diff changeset
   121
  iscc contrib\packaging\inno-installer\mercurial.iss /dVERSION=snapshot
4401
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
   122
d1dd16256114 Update Windows build instructions.
Lee Cantey <lcantey@gmail.com>
parents: 2384
diff changeset
   123
and run it from the root of the hg repository (c:\hg\hg-release).