##// END OF EJS Templates
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.

File last commit:

r50725:bc59c1e5 stable
r51655:c51b178b default
Show More
ReadMe.html
161 lines | 4.6 KiB | text/html | HtmlLexer
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Mercurial for Windows</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
<style type="text/css">
<!--
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;
}
-->
</style>
</head>
<body>
<h1>Mercurial for Windows</h1>
<p>Welcome to Mercurial for Windows!</p>
<p>
Mercurial is a command-line application. You must run it from
the Windows command prompt (or if you're hard core, a <a
href="http://www.mingw.org/">MinGW</a> shell).
</p>
<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>
<p>
For documentation, please visit the <a
href="https://mercurial-scm.org/">Mercurial web site</a>.
You can also download a free book, <a
href="https://book.mercurial-scm.org/">Mercurial: The Definitive
Guide</a>.
</p>
<p>
By default, Mercurial installs to <tt>C:\Program
Files\Mercurial</tt>. The Mercurial command is called
<tt>hg.exe</tt>.
</p>
<h1>Testing Mercurial after you've installed it</h1>
<p>
The easiest way to check that Mercurial is installed properly is
to just type the following at the command prompt:
</p>
<pre>
hg
</pre>
<p>
This command should print a useful help message. If it does,
other Mercurial commands should work fine for you.
</p>
<h1>Configuration notes</h1>
<h4>Default editor</h4>
<p>
The default editor for commit messages is 'notepad'. You can set
the <tt>EDITOR</tt> (or <tt>HGEDITOR</tt>) environment variable
to specify your preference or set it in <tt>mercurial.ini</tt>:
</p>
<pre>
[ui]
editor = whatever
</pre>
<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>
<p>
By default, Mercurial will use the merge program defined by the
<tt>HGMERGE</tt> environment variable, or uses the one defined
in the <tt>mercurial.ini</tt> file. (see <a
href="https://mercurial-scm.org/wiki/MergeProgram">MergeProgram</a>
on the Mercurial Wiki for more information)
</p>
<h1>Reporting problems</h1>
<p>
Before you report any problems, please consult the <a
href="https://mercurial-scm.org/">Mercurial web site</a>
and see if your question is already in our list of <a
href="https://mercurial-scm.org/wiki/FAQ">Frequently
Answered Questions</a> (the "FAQ").
</p>
<p>
If you cannot find an answer to your question, please feel free
to send mail to the Mercurial mailing list, at <a
href="mailto:mercurial@mercurial-scm.org">mercurial@mercurial-scm.org</a>.
<b>Remember</b>, the more useful information you include in your
report, the easier it will be for us to help you!
</p>
<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>
<h1>Author and copyright information</h1>
<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>
<p>
The Windows installer was written by <a
href="http://www.serpentine.com/blog">Bryan O'Sullivan</a>.
</p>
<p>
Mercurial is Copyright 2005-2023 Olivia Mackall and others.
</p>
<p>
Mercurial is free software; you can redistribute it and/or
modify it under the terms of the <a
href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">GNU
General Public License version 2</a> or any later version.
</p>
<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>
</body>
</html>