source: general/prog/mercurial.xml@ 6e0a8a7

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 12.2 7.10 7.8 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 6e0a8a7 was 6e0a8a7, checked in by Fernando de Oliveira <fernando@…>, 9 years ago

Shall I cry or laugh?

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

  • Property mode set to 100644
File size: 7.6 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 "65783a60aefb46a11296b587e9403537">
10 <!ENTITY mercurial-size "4.1 MB">
11 <!ENTITY mercurial-buildsize "332 MB (running the test suite and building documents)">
12 <!ENTITY mercurial-time "2.7 SBU, using parallelism=8 (running the test suite and building documents)">
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="cvs"/>,
72 <xref linkend="git"/>,
73 <xref linkend="gnupg2"/> (<command>gpg2</command> with Python bindings),
74 <xref linkend="subversion"/> (with Python bindings),
75 <ulink url="https://launchpad.net/bzr">Bazaar</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-gpg.t</literal>
109EOF
110rm -rf tests/tmp &amp;&amp;
111TESTFLAGS="-j<replaceable>&lt;N&gt;</replaceable> --tmpdir tmp --blacklist blacklists/failed-tests" \
112make check</userinput></screen>
113
114 <para>where <replaceable>&lt;N&gt;</replaceable> is an integer between one
115 and the number of processor threads, inclusive. In order to investigate a
116 particular apparently failing test, e.g <quote>test-parse-date.t</quote>,
117 issue the following commands (notice that omitting <option>--debug</option>
118 sometimes modifies the result):</para>
119
120<screen><userinput>pushd tests &amp;&amp;
121rm -rf tmp &amp;&amp;
122./run-tests.py --debug --tmpdir tmp test-parse-date.t &amp;&amp;
123popd</userinput></screen>
124
125 <para>Install <application>Mercurial</application> by running the following
126 command (as <systemitem class="username">root</systemitem>):</para>
127
128<screen role="root"><userinput>make PREFIX=/usr install-bin</userinput></screen>
129
130 <para>If you built the documentation, install it by running the following
131 command (as <systemitem class="username">root</systemitem>):</para>
132
133<screen role="root"><userinput>make PREFIX=/usr install-doc</userinput></screen>
134
135 <para>After installed, two very quick and simple tests should run correctly.
136 First one needs some configuration:</para>
137
138<screen><userinput>cat &gt;&gt; ~/.hgrc &lt;&lt; "EOF"
139<literal>[ui]
140username = &lt;user_name&gt; &lt;your@mail&gt;</literal>
141EOF</userinput></screen>
142
143 <para>where you must replace &lt;user_name&gt; and &lt;your@mail&gt; (mail
144 is optional and can be omitted). With the user identity defined, run
145 <command>hg debuginstall</command> and several lines will be displayed,
146 the last one reading "no problems detected". Another quick and simple test
147 is just <command>hg</command>, which should output basic commands that can
148 be used with <command>hg</command>.</para>
149
150 </sect2>
151
152 <sect2 role="configuration">
153 <title>Configuring Mercurial</title>
154
155 <sect3 id="mercurial-config">
156 <title>Config Files</title>
157
158 <para>
159 <filename>/etc/mercurial/hgrc</filename>
160 </para>
161
162 <indexterm zone="mercurial mercurial-config">
163 <primary sortas="e-etc-mercurial-hgrc">/etc/mercurial/hgrc</primary>
164 </indexterm>
165
166 <para>
167 If you have installed the <xref linkend="cacerts"/> and you want
168 <application>Mercurial</application> to use them, as the
169 <systemitem class="username">root</systemitem> user:
170 </para>
171
172<screen role="root"><userinput>install -v -d -m755 /etc/mercurial &amp;&amp;
173cat &gt; /etc/mercurial/hgrc &lt;&lt; "EOF"
174<literal>[web]
175cacerts = /etc/ssl/ca-bundle.crt</literal>
176EOF</userinput></screen>
177
178 </sect3>
179
180 </sect2>
181
182 <sect2 role="content">
183 <title>Contents</title>
184
185 <segmentedlist>
186 <segtitle>Installed Programs</segtitle>
187 <segtitle>Installed Libraries</segtitle>
188 <segtitle>Installed Directories</segtitle>
189
190 <seglistitem>
191 <seg>
192 hg
193 </seg>
194 <seg>
195 several internal modules under
196 /usr/lib/python&python2-majorver;/site-packages/mercurial
197 </seg>
198 <seg>
199 /etc/mercurial and
200 /usr/lib/python&python2-majorver;/site-packages/{hgext,mercurial}
201 </seg>
202 </seglistitem>
203 </segmentedlist>
204
205 <variablelist>
206 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
207 <?dbfo list-presentation="list"?>
208 <?dbhtml list-presentation="table"?>
209
210 <varlistentry id="hg">
211 <term><command>hg</command></term>
212 <listitem>
213 <para>is the program file for mercurial.</para>
214 <indexterm zone="mercurial hg">
215 <primary sortas="b-hg">hg</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 </variablelist>
221
222 </sect2>
223
224</sect1>
Note: See TracBrowser for help on using the repository browser.