source: general/prog/mercurial.xml@ 2beaab8

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 12.2 7.10 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gimp3 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/for-12.3 xry111/intltool xry111/llvm18 xry111/soup3 xry111/spidermonkey128 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 2beaab8 was 2beaab8, checked in by Fernando de Oliveira <fernando@…>, 9 years ago
  • mercurial-3.7: try to improve the text and minor reformats.
  • Update to nss-3.22.
  • Update to iso-codes-3.65.

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

  • Property mode set to 100644
File size: 9.2 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 "a175ce4f6660d87849589ee7d015db67">
10 <!ENTITY mercurial-size "4.5 MB">
11 <!ENTITY mercurial-buildsize "54 MB (with documentation, additional 384 MB for tests)">
12 <!ENTITY mercurial-time "less than 0.1 SBU (with documentation, additional 3.4 SBU for tests, using -j8)">
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><application>Mercurial</application> is a distributed source control
33 management tool similar to <application>Git</application> and
34 <application>Bazaar</application>. <application>Mercurial</application> is
35 written in <application>Python</application> and is used by projects such as
36 Mozilla and Vim.</para>
37
38 &lfs78_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>Download (HTTP): <ulink url="&mercurial-download-http;"/></para>
44 </listitem>
45 <listitem>
46 <para>Download (FTP): <ulink url="&mercurial-download-ftp;"/></para>
47 </listitem>
48 <listitem>
49 <para>Download MD5 sum: &mercurial-md5sum;</para>
50 </listitem>
51 <listitem>
52 <para>Download size: &mercurial-size;</para>
53 </listitem>
54 <listitem>
55 <para>Estimated disk space required: &mercurial-buildsize;</para>
56 </listitem>
57 <listitem>
58 <para>Estimated build time: &mercurial-time;</para>
59 </listitem>
60 </itemizedlist>
61
62 <bridgehead renderas="sect3">Mercurial Dependencies</bridgehead>
63
64 <bridgehead renderas="sect4">Required</bridgehead>
65 <para role="required">
66 <xref linkend="python2"/>
67 </para>
68
69 <bridgehead renderas="sect4">Optional</bridgehead>
70 <para role="optional">
71 <xref linkend="git"/>,
72 <xref linkend="gnupg2"/> (<command>gpg2</command> with Python bindings),
73 <xref linkend="subversion"/> (with Python bindings),
74 <ulink url="https://launchpad.net/bzr">Bazaar</ulink>,
75 <ulink url="http://www.nongnu.org/cvs/">CVS</ulink>,
76 <ulink url="http://docutils.sourceforge.net/">Docutils</ulink> (required to build the documentation),
77 <ulink url="http://pypi.python.org/pypi/pyflakes">pyflakes</ulink>,
78 <ulink url="http://pygments.org/">pygments</ulink>, and
79 <ulink url="https://launchpad.net/pyopenssl">pyOpenSSL</ulink>
80
81 </para>
82
83 <para condition="html" role="usernotes">User Notes:
84 <ulink url="&blfs-wiki;/mercurial"/></para>
85
86 </sect2>
87
88 <sect2 role="installation">
89 <title>Installation of Mercurial</title>
90
91 <para>Build <application>Mercurial</application> by issuing the following
92 command:</para>
93
94<screen><userinput>make build</userinput></screen>
95
96 <para>To build the documentation (requires
97 <application>Docutils</application>), issue:</para>
98
99<screen><userinput>make doc</userinput></screen>
100
101 <para>Running the test suite is optional. Tests which fail may be disabled,
102 adding each one to <filename>tests/blacklists/failed-tests</filename>. In
103 order to execute the test suite using the temporary directory <filename
104 class="directory">tests/tmp</filename> and skipping the failing tests,
105 issue:</para>
106
107<screen><userinput>cat &gt; tests/blacklists/failed-tests &lt;&lt; "EOF"
108<literal># Test Failures
109 test-convert-svn-source.t
110 test-convert-hg-svn.t
111 test-gpg.t</literal>
112EOF
113
114rm -rf tests/tmp &amp;&amp;
115
116TESTFLAGS="-j<replaceable>&lt;N&gt;</replaceable> --tmpdir tmp --blacklist blacklists/failed-tests" \
117make check</userinput></screen>
118
119 <para>where <replaceable>&lt;N&gt;</replaceable> is an integer between one
120 and the number of ( processor X threads ), inclusive. In order to
121 investigate the apparently failing tests, you may use the
122 <command>run-tests.py</command> scrypt. To see the almost forty switches,
123 some of them very useful, issue <command>tests/run-tests.py --help</command>.
124 Running the following commands, you will execute only the tests that failed
125 before:</para>
126
127<screen><userinput>pushd tests &amp;&amp;
128 rm -rf tmp &amp;&amp;
129
130 ./run-tests.py --debug --tmpdir tmp \
131 test-convert-svn-source.t \
132 test-convert-hg-svn.t \
133 test-gpg.t &amp;&amp;
134popd</userinput></screen>
135
136 <para>Normally, the previous failures will be confirmed. However, if you add
137 the switch "--debug" before "--tmpdir", and run again, some failures are
138 gone, which seems to be a problem with the test suite. If this happens,
139 normally, from now on, there will be no more such failures whether you use
140 the debug switch or not.</para>
141
142 <para>An interesting switch is "--time", which will generated at the end of
143 the test suite execution, a table with all executed tests and respective
144 start, end, user, system and real times. Notice that the switches may be
145 used with <command>make check</command>, including them in the
146 <envar>TESTFLAGS</envar> environment variable.</para>
147
148 <para>Install <application>Mercurial</application> by running the following
149 command (as <systemitem class="username">root</systemitem>):</para>
150
151<screen role="root"><userinput>make PREFIX=/usr install-bin</userinput></screen>
152
153 <para>If you built the documentation, install it by running the following
154 command (as <systemitem class="username">root</systemitem>):</para>
155
156<screen role="root"><userinput>make PREFIX=/usr install-doc</userinput></screen>
157
158 <para>After installed, two very quick and simple tests should run correctly.
159 First one needs some configuration:</para>
160
161<screen><userinput>cat &gt;&gt; ~/.hgrc &lt;&lt; "EOF"
162<literal>[ui]
163username = <replaceable>&lt;user_name&gt; &lt;user@mail&gt;</replaceable></literal>
164EOF</userinput></screen>
165
166 <para>where you must replace &lt;user_name&gt; and &lt;your@mail&gt; (mail
167 is optional and can be omitted). With the user identity defined, run
168 <command>hg debuginstall</command> and several lines will be displayed,
169 the last one reading "no problems detected". Another quick and simple test
170 is just <command>hg</command>, which should output basic commands that can
171 be used with <command>hg</command>.</para>
172
173 </sect2>
174
175 <sect2 role="configuration">
176 <title>Configuring Mercurial</title>
177
178 <sect3 id="mercurial-config">
179 <title>Config Files</title>
180
181 <para>
182 <filename>/etc/mercurial/hgrc</filename> and
183 <filename>~/.hgrc</filename>
184 </para>
185
186 <indexterm zone="mercurial mercurial-config">
187 <primary sortas="e-etc-mercurial-hgrc">/etc/mercurial/hgrc</primary>
188 </indexterm>
189
190 <indexterm zone="mercurial mercurial-config">
191 <primary sortas="e-AA.hgrc">~/.hgrc</primary>
192 </indexterm>
193
194 <para>The great majority of extensions are disabled by default. Run
195 <command>hg help extensions</command> if you need to enable any, e.g.
196 when investigating test failures. You will obtain the lists of enabled and
197 disabled extensions, and more information, such as how to enable or
198 disable them using configuration files.</para>
199
200 <para>If you have installed the <xref linkend="cacerts"/> and want
201 <application>Mercurial</application> to use them, as the <systemitem
202 class="username">root</systemitem> user, issue:</para>
203
204<screen role="root"><userinput>install -v -d -m755 /etc/mercurial &amp;&amp;
205cat &gt;&gt; /etc/mercurial/hgrc &lt;&lt; "EOF"
206<literal>[web]
207cacerts = /etc/ssl/ca-bundle.crt</literal>
208EOF</userinput></screen>
209
210 </sect3>
211
212 </sect2>
213
214 <sect2 role="content">
215 <title>Contents</title>
216
217 <segmentedlist>
218 <segtitle>Installed Programs</segtitle>
219 <segtitle>Installed Libraries</segtitle>
220 <segtitle>Installed Directories</segtitle>
221
222 <seglistitem>
223 <seg>
224 hg
225 </seg>
226 <seg>
227 several internal modules under
228 /usr/lib/python&python2-majorver;/site-packages/mercurial
229 </seg>
230 <seg>
231 /etc/mercurial and
232 /usr/lib/python&python2-majorver;/site-packages/{hgext,mercurial}
233 </seg>
234 </seglistitem>
235 </segmentedlist>
236
237 <variablelist>
238 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
239 <?dbfo list-presentation="list"?>
240 <?dbhtml list-presentation="table"?>
241
242 <varlistentry id="hg">
243 <term><command>hg</command></term>
244 <listitem>
245 <para>is the program file for mercurial.</para>
246 <indexterm zone="mercurial hg">
247 <primary sortas="b-hg">hg</primary>
248 </indexterm>
249 </listitem>
250 </varlistentry>
251
252 </variablelist>
253
254 </sect2>
255
256</sect1>
Note: See TracBrowser for help on using the repository browser.