upstream/mercurial-mirror Files · contrib/win32/ReadMe.html

wix: functionality to automate building WiX installers...

wix: functionality to automate building WiX installers Like we did for Inno Setup, we want to make it easier to produce WiX installers. This commit does that. We introduce a new hgpackaging.wix module for performing all the high-level tasks required to produce WiX installers. This required miscellaneous enhancements to existing code in hgpackaging, including support for signing binaries. A new build.py script for calling into the module APIs has been created. It behaves very similarly to the Inno Setup build.py script. Unlike Inno Setup, we didn't have code in the repo previously to generate WiX installers. It appears that all existing automation for building WiX installers lives in the https://bitbucket.org/tortoisehg/thg-winbuild repository - most notably in its setup.py file. My strategy for inventing the code in this commit was to step through the code in that repo's setup.py and observe what it was doing. Despite the length of setup.py in that repository, the actual amount of steps required to produce a WiX installer is actually quite low. It consists of a basic py2exe build plus invocations of candle.exe and light.exe to produce the MSI. One rabbit hole that gave me fits was locating the Visual Studio 9 C Runtime merge modules. These merge modules are only present on your system if you have a full Visual Studio 2008 installation. Fortunately, I have a copy of Visual Studio 2008 and was able to install all the required updates. I then uploaded these merge modules to a personal repository on GitHub. That is where the added code references them from. We probably don't need to ship the merge modules. But that is for another day. The installs from the MSIs produced with the new automation differ from the last official MSI in the following ways: * Our HTML manual pages have UNIX line endings instead of Windows. * We ship modules in the mercurial.pure package. It appears the upstream packaging code is not including this package due to omission (they supply an explicit list of packages that has drifted out of sync with our setup.py). * We do not ship various distutils.* modules. This is because virtualenvs have a custom distutils/__init__.py that automagically imports distutils from its original location and py2exe gets confused by this. We don't use distutils in core Mercurial and don't provide a usable python.exe, so this omission should be acceptable. * The version of the enum package is different and we ship an enum.pyc instead of an enum/__init__.py. * The version of the docutils package is different and we ship a different set of files. * The version of Sphinx is drastically newer and we ship a number of files the old version did not. (I'm not sure why we ship Sphinx - I think it is a side-effect of the way the THG code was installing dependencies.) * We ship the idna package (dependent of requests which is a dependency of newer versions of Sphinx). * The version of imagesize is different and we ship an imagesize.pyc instead of an imagesize/__init__.pyc. * The version of the jinja2 package is different and the sets of files differs. * We ship the packaging package, which is a dependency for Sphinx. * The version of the pygments package is different and the sets of files differs. * We ship the requests package, which is a dependency for Sphinx. * We ship the snowballstemmer package, which is a dependency for Sphinx. * We ship the urllib3 package, which is a dependency for requests, which is a dependency for Sphinx. * We ship a newer version of the futures package, which includes a handful of extra modules that match Python 3 module names. # no-check-commit because foo_bar naming Differential Revision: https://phab.mercurial-scm.org/D6097

av6 - - Load All Authors

File last commit:

r41534:8427fea0 stable


                r42087:4371f543

default

Download file

             ReadMe.html
        
                    162 lines
            
             | 4.6 KiB
            
                | text/html
            
             |
                HtmlLexer
            
             / contrib / win32 / ReadMe.html
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
      <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

      <html>

        <head>

          <title>Mercurial for Windows</title>

        Thomas Arendsen Hein
    
Remove trailing spaces

              r5081
            
          <meta http-equiv="Content-Type" content="text/html;charset=utf-8" >

        Lee Cantey
    
update windows readme to document msys/mingw rxvt problems.

              r2091
            
          <style type="text/css">

            <!--

        Martin Geisler
    
contrib/win32: add simple style sheet

              r8441
            
            html {

              font-family: sans-serif;

              margin: 1em 2em;

            }

            p {

              margin-top: 0.5em;

              margin-bottom: 0.5em;

            }

            pre {

              margin: 0.25em 0em;

              padding: 0.5em;

              background-color: #EEE;

              border: thin solid #CCC;

            }

            .indented {

              padding-left: 10pt;

        Lee Cantey
    
update windows readme to document msys/mingw rxvt problems.

              r2091
            
            }

            -->

          </style>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        </head>

        <body>

        Matt Mackall
    
Remove hard-coded version numbers and release notes from packaging

              r3863
            
          <h1>Mercurial for Windows</h1>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
          <p>Welcome to Mercurial for Windows!</p>

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            Mercurial is a command-line application. You must run it from

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
            the Windows command prompt (or if you're hard core, a <a

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
            href="http://www.mingw.org/">MinGW</a> shell).

          </p>

        Thomas Arendsen Hein
    
Remove trailing spaces

              r5081
            
        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p class="indented">

            <i>Note: the standard <a href="http://www.mingw.org/">MinGW</a>

            msys startup script uses rxvt which has problems setting up

            standard input and output. Running bash directly works

            correctly.</i>

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            For documentation, please visit the <a

        Matt Mackall
    
urls: bulk-change primary website URLs

              r26421
            
            href="https://mercurial-scm.org/">Mercurial web site</a>.

        Bryan O'Sullivan
    
Update binary installer files.

              r4723
            
            You can also download a free book, <a

        Kevin Bullock
    
packaging: update book URL in Mac and Windows READMEs

              r34922
            
            href="https://book.mercurial-scm.org/">Mercurial: The Definitive

        Martin Geisler
    
contrib/win32: updated title of the hgbook

              r8440
            
            Guide</a>.

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            By default, Mercurial installs to <tt>C:\Program

            Files\Mercurial</tt>. The Mercurial command is called

            <tt>hg.exe</tt>.

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
          <h1>Testing Mercurial after you've installed it</h1>

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            The easiest way to check that Mercurial is installed properly is

            to just type the following at the command prompt:

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
          <pre>

      hg

      </pre>

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            This command should print a useful help message. If it does,

            other Mercurial commands should work fine for you.

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        Lee Cantey
    
Add section for configuration notes with initial note about the default editor

              r2307
            
          <h1>Configuration notes</h1>

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <h4>Default editor</h4>

          <p>

            The default editor for commit messages is 'notepad'. You can set

        Martin Geisler
    
contrib/win32: format file names and env vars with <tt>

              r8439
            
            the <tt>EDITOR</tt> (or <tt>HGEDITOR</tt>) environment variable

            to specify your preference or set it in <tt>mercurial.ini</tt>:

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          </p>

        Lee Cantey
    
Update configuration note with mercurial.ini change from Thomas

              r2321
            
          <pre>

      [ui]

      editor = whatever

      </pre>

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <h4>Configuring a Merge program</h4>

          <p>

            It should be emphasized that Mercurial by itself doesn't attempt

            to do a Merge at the file level, neither does it make any

            attempt to Resolve the conflicts.

          </p>

        Lee Cantey
    
Add notes about configuring a merge program

              r4386
            
        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            By default, Mercurial will use the merge program defined by the

        Martin Geisler
    
contrib/win32: format file names and env vars with <tt>

              r8439
            
            <tt>HGMERGE</tt> environment variable, or uses the one defined

            in the <tt>mercurial.ini</tt> file. (see <a

        Matt Mackall
    
urls: bulk-change primary website URLs

              r26421
            
            href="https://mercurial-scm.org/wiki/MergeProgram">MergeProgram</a>

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
            on the Mercurial Wiki for more information)

          </p>

        Lee Cantey
    
Add section for configuration notes with initial note about the default editor

              r2307
            
        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
          <h1>Reporting problems</h1>

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            Before you report any problems, please consult the <a

        Matt Mackall
    
urls: bulk-change primary website URLs

              r26421
            
            href="https://mercurial-scm.org/">Mercurial web site</a>

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
            and see if your question is already in our list of <a

        Matt Mackall
    
urls: bulk-change primary website URLs

              r26421
            
            href="https://mercurial-scm.org/wiki/FAQ">Frequently

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
            Answered Questions</a> (the "FAQ").

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            If you cannot find an answer to your question, please feel free

            to send mail to the Mercurial mailing list, at <a

        av6
    
win32: update link to mailing list in readme

              r29666
            
            href="mailto:mercurial@mercurial-scm.org">mercurial@mercurial-scm.org</a>.

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
            <b>Remember</b>, the more useful information you include in your

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
            report, the easier it will be for us to help you!

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            If you are IRC-savvy, that's usually the fastest way to get

            help. Go to <tt>#mercurial</tt> on <tt>irc.freenode.net</tt>.

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
          <h1>Author and copyright information</h1>

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            Mercurial was written by <a href="http://www.selenic.com">Matt

            Mackall</a>, and is maintained by Matt and a team of volunteers.

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            The Windows installer was written by <a

            href="http://www.serpentine.com/blog">Bryan O'Sullivan</a>.

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

        av6
    
copyright: update to 2019...

              r41534
            
            Mercurial is Copyright 2005-2019 Matt Mackall and others. See

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
            the <tt>Contributors.txt</tt> file for a list of contributors.

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            Mercurial is free software; you can redistribute it and/or

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
            modify it under the terms of the <a

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
            href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">GNU

        Matt Mackall
    
Update license to GPLv2+

              r10263
            
            General Public License version 2</a> or any later version.

        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        Martin Geisler
    
contrib/win32: indent and word wrap consistently

              r8438
            
          <p>

            Mercurial is distributed in the hope that it will be useful, but

            <b>without any warranty</b>; without even the implied warranty

            of <b>merchantability</b> or <b>fitness for a particular

            purpose</b>. See the GNU General Public License for more

            details.

          </p>

        Bryan O'Sullivan
    
Turn the win32 README into a HTML file for now.

              r1288
            
        </body>

      </html>

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
		<html>
		<head>
		<title>Mercurial for Windows</title>
Thomas Arendsen Hein Remove trailing spaces	r5081	<meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
Lee Cantey update windows readme to document msys/mingw rxvt problems.	r2091	<style type="text/css">
		<!--
Martin Geisler contrib/win32: add simple style sheet	r8441	html {
		font-family: sans-serif;
		margin: 1em 2em;
		}

		p {
		margin-top: 0.5em;
		margin-bottom: 0.5em;
		}

		pre {
		margin: 0.25em 0em;
		padding: 0.5em;
		background-color: #EEE;
		border: thin solid #CCC;
		}

		.indented {
		padding-left: 10pt;
Lee Cantey update windows readme to document msys/mingw rxvt problems.	r2091	}
		-->
		</style>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288	</head>

		<body>
Matt Mackall Remove hard-coded version numbers and release notes from packaging	r3863	<h1>Mercurial for Windows</h1>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
		<p>Welcome to Mercurial for Windows!</p>

Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		Mercurial is a command-line application. You must run it from
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288	the Windows command prompt (or if you're hard core, a <a
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	href="http://www.mingw.org/">MinGW</a> shell).
		</p>
Thomas Arendsen Hein Remove trailing spaces	r5081
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p class="indented">
		<i>Note: the standard <a href="http://www.mingw.org/">MinGW</a>
		msys startup script uses rxvt which has problems setting up
		standard input and output. Running bash directly works
		correctly.</i>
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		For documentation, please visit the <a
Matt Mackall urls: bulk-change primary website URLs	r26421	href="https://mercurial-scm.org/">Mercurial web site</a>.
Bryan O'Sullivan Update binary installer files.	r4723	You can also download a free book, <a
Kevin Bullock packaging: update book URL in Mac and Windows READMEs	r34922	href="https://book.mercurial-scm.org/">Mercurial: The Definitive
Martin Geisler contrib/win32: updated title of the hgbook	r8440	Guide</a>.
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		By default, Mercurial installs to <tt>C:\Program
		Files\Mercurial</tt>. The Mercurial command is called
		<tt>hg.exe</tt>.
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
		<h1>Testing Mercurial after you've installed it</h1>

Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		The easiest way to check that Mercurial is installed properly is
		to just type the following at the command prompt:
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
		<pre>
		hg
		</pre>

Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		This command should print a useful help message. If it does,
		other Mercurial commands should work fine for you.
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
Lee Cantey Add section for configuration notes with initial note about the default editor	r2307	<h1>Configuration notes</h1>
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<h4>Default editor</h4>
		<p>
		The default editor for commit messages is 'notepad'. You can set
Martin Geisler contrib/win32: format file names and env vars with <tt>	r8439	the <tt>EDITOR</tt> (or <tt>HGEDITOR</tt>) environment variable
		to specify your preference or set it in <tt>mercurial.ini</tt>:
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	</p>
Lee Cantey Update configuration note with mercurial.ini change from Thomas	r2321	<pre>
		[ui]
		editor = whatever
		</pre>

Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<h4>Configuring a Merge program</h4>
		<p>
		It should be emphasized that Mercurial by itself doesn't attempt
		to do a Merge at the file level, neither does it make any
		attempt to Resolve the conflicts.
		</p>
Lee Cantey Add notes about configuring a merge program	r4386
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		By default, Mercurial will use the merge program defined by the
Martin Geisler contrib/win32: format file names and env vars with <tt>	r8439	<tt>HGMERGE</tt> environment variable, or uses the one defined
		in the <tt>mercurial.ini</tt> file. (see <a
Matt Mackall urls: bulk-change primary website URLs	r26421	href="https://mercurial-scm.org/wiki/MergeProgram">MergeProgram</a>
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	on the Mercurial Wiki for more information)
		</p>
Lee Cantey Add section for configuration notes with initial note about the default editor	r2307
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288	<h1>Reporting problems</h1>

Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		Before you report any problems, please consult the <a
Matt Mackall urls: bulk-change primary website URLs	r26421	href="https://mercurial-scm.org/">Mercurial web site</a>
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	and see if your question is already in our list of <a
Matt Mackall urls: bulk-change primary website URLs	r26421	href="https://mercurial-scm.org/wiki/FAQ">Frequently
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	Answered Questions</a> (the "FAQ").
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		If you cannot find an answer to your question, please feel free
		to send mail to the Mercurial mailing list, at <a
av6 win32: update link to mailing list in readme	r29666	href="mailto:mercurial@mercurial-scm.org">mercurial@mercurial-scm.org</a>.
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288	<b>Remember</b>, the more useful information you include in your
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	report, the easier it will be for us to help you!
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		If you are IRC-savvy, that's usually the fastest way to get
		help. Go to <tt>#mercurial</tt> on <tt>irc.freenode.net</tt>.
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
		<h1>Author and copyright information</h1>

Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		Mercurial was written by <a href="http://www.selenic.com">Matt
		Mackall</a>, and is maintained by Matt and a team of volunteers.
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		The Windows installer was written by <a
		href="http://www.serpentine.com/blog">Bryan O'Sullivan</a>.
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
av6 copyright: update to 2019...	r41534	Mercurial is Copyright 2005-2019 Matt Mackall and others. See
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	the <tt>Contributors.txt</tt> file for a list of contributors.
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		Mercurial is free software; you can redistribute it and/or
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288	modify it under the terms of the <a
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">GNU
Matt Mackall Update license to GPLv2+	r10263	General Public License version 2</a> or any later version.
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288
Martin Geisler contrib/win32: indent and word wrap consistently	r8438	<p>
		Mercurial is distributed in the hope that it will be useful, but
		<b>without any warranty</b>; without even the implied warranty
		of <b>merchantability</b> or <b>fitness for a particular
		purpose</b>. See the GNU General Public License for more
		details.
		</p>
Bryan O'Sullivan Turn the win32 README into a HTML file for now.	r1288	</body>
		</html>