1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY mercurial-download-http "https://www.mercurial-scm.org/release/mercurial-&mercurial-version;.tar.gz">
|
---|
8 | <!ENTITY mercurial-download-ftp " ">
|
---|
9 | <!ENTITY mercurial-md5sum "2bbab188eaa482c6ad3db296b9e53773">
|
---|
10 | <!ENTITY mercurial-size "7.7 MB">
|
---|
11 | <!ENTITY mercurial-buildsize "76 MB (with docs, add 1.9 GB for tests)">
|
---|
12 | <!ENTITY mercurial-time "0.3 SBU (with docs, add 17 SBU for tests using -j4)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="mercurial" xreflabel="Mercurial-&mercurial-version;">
|
---|
16 | <?dbhtml filename="mercurial.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <date>$Date$</date>
|
---|
20 | </sect1info>
|
---|
21 |
|
---|
22 | <title>Mercurial-&mercurial-version;</title>
|
---|
23 |
|
---|
24 | <indexterm zone="mercurial">
|
---|
25 | <primary sortas="a-mercurial">mercurial</primary>
|
---|
26 | </indexterm>
|
---|
27 |
|
---|
28 | <sect2 role="package">
|
---|
29 | <title>Introduction to Mercurial</title>
|
---|
30 |
|
---|
31 | <para>
|
---|
32 | <application>Mercurial</application> is a distributed source control
|
---|
33 | management tool similar to <application>Git</application> and
|
---|
34 | <application>Bazaar</application>. <application>Mercurial</application>
|
---|
35 | is written in <application>Python</application> and is used by projects
|
---|
36 | such as Mozilla for Firefox and Thunderbird.
|
---|
37 | </para>
|
---|
38 |
|
---|
39 | &lfs111_checked;
|
---|
40 |
|
---|
41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
42 | <itemizedlist spacing="compact">
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (HTTP): <ulink url="&mercurial-download-http;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download (FTP): <ulink url="&mercurial-download-ftp;"/>
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download MD5 sum: &mercurial-md5sum;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Download size: &mercurial-size;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated disk space required: &mercurial-buildsize;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | <listitem>
|
---|
69 | <para>
|
---|
70 | Estimated build time: &mercurial-time;
|
---|
71 | </para>
|
---|
72 | </listitem>
|
---|
73 | </itemizedlist>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect3">Mercurial Dependencies</bridgehead>
|
---|
76 |
|
---|
77 | <!--
|
---|
78 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
79 | <para role="required">
|
---|
80 | <xref linkend="python2"/>
|
---|
81 | </para>
|
---|
82 | -->
|
---|
83 |
|
---|
84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
85 | <para role="optional">
|
---|
86 | <xref linkend="docutils"/>
|
---|
87 | (required to build the documentation),
|
---|
88 | <xref linkend="git"/>,
|
---|
89 | <xref linkend="gpgme"/> (with Python bindings),
|
---|
90 | <xref role="runtime" linkend="openssh"/>
|
---|
91 | (runtime, to access ssh://... repositories),
|
---|
92 | <xref linkend="pygments"/>,
|
---|
93 | <xref linkend="rust"/> (see <filename>rust/README.rst</filename> and <filename>rust/rhg/README.md</filename>),
|
---|
94 | <xref linkend="subversion"/> (with Python bindings),
|
---|
95 | <ulink url="https://launchpad.net/bzr">Bazaar</ulink>,
|
---|
96 | <ulink url="http://www.nongnu.org/cvs/">CVS</ulink>,
|
---|
97 | <ulink url="https://pypi.python.org/pypi/pyflakes">pyflakes</ulink>,
|
---|
98 | <ulink url="https://www.pyopenssl.org/en/stable/">pyOpenSSL</ulink>, and
|
---|
99 | <ulink url="https://github.com/google/re2/">re2</ulink>
|
---|
100 |
|
---|
101 | </para>
|
---|
102 |
|
---|
103 | <para condition="html" role="usernotes">User Notes:
|
---|
104 | <ulink url="&blfs-wiki;/mercurial"/></para>
|
---|
105 |
|
---|
106 | </sect2>
|
---|
107 |
|
---|
108 | <sect2 role="installation">
|
---|
109 | <title>Installation of Mercurial</title>
|
---|
110 | <!-- Rust port is now part of the standard tests -->
|
---|
111 |
|
---|
112 | <para>
|
---|
113 | Build <application>Mercurial</application> by issuing the following
|
---|
114 | command:
|
---|
115 | </para>
|
---|
116 |
|
---|
117 | <screen><userinput>make build</userinput></screen>
|
---|
118 |
|
---|
119 | <para>
|
---|
120 | To build the documentation (requires <xref linkend="docutils"/>), issue:
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | <screen remap="doc"><userinput>make doc</userinput></screen>
|
---|
124 |
|
---|
125 | <para>
|
---|
126 | To run the test suite, issue (8 tests are known to fail):
|
---|
127 | </para>
|
---|
128 | <screen remap="test"><userinput>TESTFLAGS="-j<replaceable><N></replaceable> --tmpdir tmp --blacklist blacklists/fsmonitor --blacklist blacklists/linux-vfat" make check</userinput></screen>
|
---|
129 | <!-- The blacklists have to be checked every release of Mercurial, do a listing
|
---|
130 | of tests/blacklists, but do not include the README. -->
|
---|
131 |
|
---|
132 | <para>
|
---|
133 | where <replaceable><N></replaceable> is an integer between one
|
---|
134 | and the number of ( processor X threads ), inclusive. In order to
|
---|
135 | investigate any apparently failing tests, you may use the
|
---|
136 | <command>run-tests.py</command> script. To see the almost forty switches,
|
---|
137 | some of them very useful, issue <command>tests/run-tests.py
|
---|
138 | --help</command>. Running the following commands, you will execute only
|
---|
139 | the tests that failed before:
|
---|
140 | </para>
|
---|
141 |
|
---|
142 | <screen remap="test"><userinput>pushd tests &&
|
---|
143 | rm -rf tmp &&
|
---|
144 | ./run-tests.py --tmpdir tmp test-gpg.t
|
---|
145 | popd</userinput></screen>
|
---|
146 |
|
---|
147 | <para>
|
---|
148 | Normally, the previous failures will be reproducible. However, if
|
---|
149 | you add the switch <option>--debug</option> before
|
---|
150 | <option>--tmpdir</option>, and run the tests again, some failures may
|
---|
151 | disappear, which is a problem with the test suite. If this happens,
|
---|
152 | there will be no more of these failures even if you do not pass the
|
---|
153 | --debug switch again.
|
---|
154 | </para>
|
---|
155 |
|
---|
156 | <para>
|
---|
157 | An interesting switch is <option>--time</option>, which will generate a
|
---|
158 | table of all the executed tests and their respective start, end, user,
|
---|
159 | system and real times once the tests are complete. Note that these
|
---|
160 | switches may be used with <command>make check</command> by including
|
---|
161 | them in the <envar>TESTFLAGS</envar> environment variable.
|
---|
162 | </para>
|
---|
163 |
|
---|
164 | <para>
|
---|
165 | Install <application>Mercurial</application> by running the following
|
---|
166 | command (as <systemitem class="username">root</systemitem>):
|
---|
167 | </para>
|
---|
168 |
|
---|
169 | <screen role="root"><userinput>make PREFIX=/usr install-bin</userinput></screen>
|
---|
170 |
|
---|
171 | <para>
|
---|
172 | If you built the documentation, install it by running the following
|
---|
173 | command (as <systemitem class="username">root</systemitem>):
|
---|
174 | </para>
|
---|
175 |
|
---|
176 | <screen role="root"
|
---|
177 | remap="doc"><userinput>make PREFIX=/usr install-doc</userinput></screen>
|
---|
178 |
|
---|
179 | <para>
|
---|
180 | After installation, two very quick and simple tests should run
|
---|
181 | correctly. The first one needs some configuration:
|
---|
182 | </para>
|
---|
183 |
|
---|
184 | <screen><userinput>cat >> ~/.hgrc << "EOF"
|
---|
185 | <literal>[ui]
|
---|
186 | username = <replaceable><user_name> <user@mail></replaceable></literal>
|
---|
187 | EOF</userinput></screen>
|
---|
188 |
|
---|
189 | <para>
|
---|
190 | where you must replace <user_name> and <your@mail> (mail
|
---|
191 | is optional and can be omitted). With the user identity defined, run
|
---|
192 | <command>hg debuginstall</command> and several lines will be displayed,
|
---|
193 | the last one reading "no problems detected". Another quick and simple
|
---|
194 | test is just <command>hg</command>, which should output basic commands
|
---|
195 | that can be used with <command>hg</command>.
|
---|
196 | </para>
|
---|
197 |
|
---|
198 | </sect2>
|
---|
199 |
|
---|
200 | <!--
|
---|
201 | <sect2 role="commands">
|
---|
202 | <title>Command Explanations</title>
|
---|
203 |
|
---|
204 | <para>
|
---|
205 | <command>2to3 -w doc/hgmanpage.py</command>: Since <application>
|
---|
206 | Python 3</application> is used with docutils, one file needs to be
|
---|
207 | converted in order to be compatible.
|
---|
208 | </para>
|
---|
209 |
|
---|
210 | </sect2>
|
---|
211 | -->
|
---|
212 |
|
---|
213 | <sect2 role="configuration">
|
---|
214 | <title>Configuring Mercurial</title>
|
---|
215 |
|
---|
216 | <sect3 id="mercurial-config">
|
---|
217 | <title>Config Files</title>
|
---|
218 |
|
---|
219 | <para>
|
---|
220 | <filename>/etc/mercurial/hgrc</filename> and
|
---|
221 | <filename>~/.hgrc</filename>
|
---|
222 | </para>
|
---|
223 |
|
---|
224 | <indexterm zone="mercurial mercurial-config">
|
---|
225 | <primary sortas="e-etc-mercurial-hgrc">/etc/mercurial/hgrc</primary>
|
---|
226 | </indexterm>
|
---|
227 |
|
---|
228 | <indexterm zone="mercurial mercurial-config">
|
---|
229 | <primary sortas="e-AA.hgrc">~/.hgrc</primary>
|
---|
230 | </indexterm>
|
---|
231 |
|
---|
232 | <para>
|
---|
233 | The great majority of extensions are disabled by default. Run
|
---|
234 | <command>hg help extensions</command> if you need to enable any, e.g.
|
---|
235 | when investigating test failures. This will output a list of enabled
|
---|
236 | and disabled extensions, as well as more information such as how to
|
---|
237 | enable or disable extensions using configuration files.
|
---|
238 | </para>
|
---|
239 |
|
---|
240 | <para>
|
---|
241 | If you have installed <xref linkend="make-ca"/> and want
|
---|
242 | <application>Mercurial</application> to use the certificates,
|
---|
243 | as the <systemitem class="username">root</systemitem> user, issue:
|
---|
244 | </para>
|
---|
245 |
|
---|
246 | <screen role="root"><userinput>install -v -d -m755 /etc/mercurial &&
|
---|
247 | cat > /etc/mercurial/hgrc << "EOF"
|
---|
248 | <literal>[web]
|
---|
249 | cacerts = /etc/pki/tls/certs/ca-bundle.crt</literal>
|
---|
250 | EOF</userinput></screen>
|
---|
251 |
|
---|
252 | </sect3>
|
---|
253 |
|
---|
254 | </sect2>
|
---|
255 |
|
---|
256 | <sect2 role="content">
|
---|
257 | <title>Contents</title>
|
---|
258 |
|
---|
259 | <segmentedlist>
|
---|
260 | <segtitle>Installed Programs</segtitle>
|
---|
261 | <segtitle>Installed Libraries</segtitle>
|
---|
262 | <segtitle>Installed Directories</segtitle>
|
---|
263 |
|
---|
264 | <seglistitem>
|
---|
265 | <seg>
|
---|
266 | hg
|
---|
267 | </seg>
|
---|
268 | <seg>
|
---|
269 | several internal modules under
|
---|
270 | /usr/lib/python&python3-majorver;/site-packages/mercurial
|
---|
271 | </seg>
|
---|
272 | <seg>
|
---|
273 | /etc/mercurial and
|
---|
274 | /usr/lib/python&python3-majorver;/site-packages/{hgdemandimport,hgext,hgext3rd,mercurial}
|
---|
275 | </seg>
|
---|
276 | </seglistitem>
|
---|
277 | </segmentedlist>
|
---|
278 |
|
---|
279 | <variablelist>
|
---|
280 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
281 | <?dbfo list-presentation="list"?>
|
---|
282 | <?dbhtml list-presentation="table"?>
|
---|
283 |
|
---|
284 | <varlistentry id="hg">
|
---|
285 | <term><command>hg</command></term>
|
---|
286 | <listitem>
|
---|
287 | <para>
|
---|
288 | is the mercurial version control system
|
---|
289 | </para>
|
---|
290 | <indexterm zone="mercurial hg">
|
---|
291 | <primary sortas="b-hg">hg</primary>
|
---|
292 | </indexterm>
|
---|
293 | </listitem>
|
---|
294 | </varlistentry>
|
---|
295 |
|
---|
296 | </variablelist>
|
---|
297 |
|
---|
298 | </sect2>
|
---|
299 |
|
---|
300 | </sect1>
|
---|