source: general/prog/mercurial.xml@ d1c51434

10.0 10.1 11.0 7.10 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since d1c51434 was d1c51434, checked in by Fernando de Oliveira <fernando@…>, 6 years ago
  • Update to x264-snapshot-20150908-2245.
  • Update to mplayer-SVN-r37520.
  • Remove "CVS-1.11.23" and "Running a CVS Server".
  • Update to joe-4.1.

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

  • Property mode set to 100644
File size: 7.8 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 "http://mercurial.selenic.com/release/mercurial-&mercurial-version;.tar.gz">
8 <!ENTITY mercurial-download-ftp " ">
9 <!ENTITY mercurial-md5sum "796a778075ec6358235e9258f9a54224">
10 <!ENTITY mercurial-size "4.3 MB">
11 <!ENTITY mercurial-buildsize "51 MB (with documentation, additional 290 MB for tests)">
12 <!ENTITY mercurial-time "0.1 SBU (with documentation, additional 3 SBU for tests, with -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 &lfs77_checked; &gcc5_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. If there are failures, e.g.
102 test-parse-date.t, those tests can be disabled. To test the results in the
103 subdiretory <filename class="directory">tests/tmp</filename>, skipping
104 failing tests, issue:</para>
105
106<screen><userinput>cat &gt; tests/blacklists/failed-tests &lt;&lt; "EOF"
107<literal># Test Failures
108 test-hgweb-commands.t
109 test-convert-svn-source.t
110 test-subrepo-svn.t
111 test-convert-hg-svn.t
112 test-mq-subrepo-svn.t
113 test-gpg.t</literal>
114EOF
115rm -rf tests/tmp &amp;&amp;
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 threads, inclusive. In order to investigate a
121 particular apparently failing test, e.g <quote>test-parse-date.t</quote>,
122 issue the following commands (notice that omitting <option>--debug</option>
123 sometimes modifies the result):</para>
124
125<screen><userinput>pushd tests &amp;&amp;
126rm -rf tmp &amp;&amp;
127./run-tests.py --debug --tmpdir tmp test-parse-date.t &amp;&amp;
128popd</userinput></screen>
129
130 <para>Install <application>Mercurial</application> by running the following
131 command (as <systemitem class="username">root</systemitem>):</para>
132
133<screen role="root"><userinput>make PREFIX=/usr install-bin</userinput></screen>
134
135 <para>If you built the documentation, install it by running the following
136 command (as <systemitem class="username">root</systemitem>):</para>
137
138<screen role="root"><userinput>make PREFIX=/usr install-doc</userinput></screen>
139
140 <para>After installed, two very quick and simple tests should run correctly.
141 First one needs some configuration:</para>
142
143<screen><userinput>cat &gt;&gt; ~/.hgrc &lt;&lt; "EOF"
144<literal>[ui]
145username = &lt;user_name&gt; &lt;your@mail&gt;</literal>
146EOF</userinput></screen>
147
148 <para>where you must replace &lt;user_name&gt; and &lt;your@mail&gt; (mail
149 is optional and can be omitted). With the user identity defined, run
150 <command>hg debuginstall</command> and several lines will be displayed,
151 the last one reading "no problems detected". Another quick and simple test
152 is just <command>hg</command>, which should output basic commands that can
153 be used with <command>hg</command>.</para>
154
155 </sect2>
156
157 <sect2 role="configuration">
158 <title>Configuring Mercurial</title>
159
160 <sect3 id="mercurial-config">
161 <title>Config Files</title>
162
163 <para>
164 <filename>/etc/mercurial/hgrc</filename>
165 </para>
166
167 <indexterm zone="mercurial mercurial-config">
168 <primary sortas="e-etc-mercurial-hgrc">/etc/mercurial/hgrc</primary>
169 </indexterm>
170
171 <para>
172 If you have installed the <xref linkend="cacerts"/> and you want
173 <application>Mercurial</application> to use them, as the
174 <systemitem class="username">root</systemitem> user:
175 </para>
176
177<screen role="root"><userinput>install -v -d -m755 /etc/mercurial &amp;&amp;
178cat &gt; /etc/mercurial/hgrc &lt;&lt; "EOF"
179<literal>[web]
180cacerts = /etc/ssl/ca-bundle.crt</literal>
181EOF</userinput></screen>
182
183 </sect3>
184
185 </sect2>
186
187 <sect2 role="content">
188 <title>Contents</title>
189
190 <segmentedlist>
191 <segtitle>Installed Programs</segtitle>
192 <segtitle>Installed Libraries</segtitle>
193 <segtitle>Installed Directories</segtitle>
194
195 <seglistitem>
196 <seg>
197 hg
198 </seg>
199 <seg>
200 several internal modules under
201 /usr/lib/python&python2-majorver;/site-packages/mercurial
202 </seg>
203 <seg>
204 /etc/mercurial and
205 /usr/lib/python&python2-majorver;/site-packages/{hgext,mercurial}
206 </seg>
207 </seglistitem>
208 </segmentedlist>
209
210 <variablelist>
211 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
212 <?dbfo list-presentation="list"?>
213 <?dbhtml list-presentation="table"?>
214
215 <varlistentry id="hg">
216 <term><command>hg</command></term>
217 <listitem>
218 <para>is the program file for mercurial.</para>
219 <indexterm zone="mercurial hg">
220 <primary sortas="b-hg">hg</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 </variablelist>
226
227 </sect2>
228
229</sect1>
Note: See TracBrowser for help on using the repository browser.