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

configitems: declare items in a TOML file...

configitems: declare items in a TOML file Mercurial ships with Rust code that also needs to read from the config. Having a way of presenting `configitems` to both Python and Rust is needed to prevent duplication, drift, and have the appropriate devel warnings. Abstracting away from Python means choosing a config format. No single format is perfect, and I have yet to come across a developer that doesn't hate all of them in some way. Since we have a strict no-dependencies policy for Mercurial, we either need to use whatever comes with Python, vendor a library, or implement a custom format ourselves. Python stdlib means using JSON, which doesn't support comments and isn't great for humans, or `configparser` which is an obscure, untyped format that nobody uses and doesn't have a commonplace Rust parser. Implementing a custom format is error-prone, tedious and subject to the same issues as picking an existing format. Vendoring opens us to the vast array of common config formats. The ones being picked for most modern software are YAML and TOML. YAML is older and common in the Python community, but TOML is much simpler and less error-prone. I would much rather be responsible for the <1000 lines of `tomli`, on top of TOML being the choice of the Rust community, with robust crates for reading it. The structure of `configitems.toml` is explained inline.

Matt Harbison - - Load All Authors

File last commit:

r50725:bc59c1e5 stable


                r51655:c51b178b

default

Download file

             ReadMe.html
        
                    161 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>

        Matt Harbison
    
copyright: update to 2023

              r50725
            
            Mercurial is Copyright 2005-2023 Olivia Mackall and others.

        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 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>
Matt Harbison copyright: update to 2023	r50725	Mercurial is Copyright 2005-2023 Olivia Mackall and others.
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 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>