source: general/prog/mercurial.xml@ 99caf0d

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 99caf0d was 99caf0d, checked in by Bruce Dubbs <bdubbs@…>, 17 months ago

Update to mercurial-5.4.1.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23257 af4574ff-66df-0310-9fd7-8a98e5e911e0

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