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 "de902a5300beb16c778bc88949832e94">
|
---|
10 | <!ENTITY mercurial-size "3.7 MB">
|
---|
11 | <!ENTITY mercurial-buildsize "43 MB (additional 1 MB for tests and 1 MB
|
---|
12 | for docs generation)
|
---|
13 | ">
|
---|
14 | <!ENTITY mercurial-time "less than 0.1 SBU (additional 7.4 SBU
|
---|
15 | for tests)">
|
---|
16 | ]>
|
---|
17 |
|
---|
18 | <sect1 id="mercurial" xreflabel="Mercurial-&mercurial-version;">
|
---|
19 | <?dbhtml filename="mercurial.html"?>
|
---|
20 |
|
---|
21 | <sect1info>
|
---|
22 | <othername>$LastChangedBy$</othername>
|
---|
23 | <date>$Date$</date>
|
---|
24 | </sect1info>
|
---|
25 |
|
---|
26 | <title>Mercurial-&mercurial-version;</title>
|
---|
27 |
|
---|
28 | <indexterm zone="mercurial">
|
---|
29 | <primary sortas="a-mercurial">mercurial</primary>
|
---|
30 | </indexterm>
|
---|
31 |
|
---|
32 | <sect2 role="package">
|
---|
33 | <title>Introduction to Mercurial</title>
|
---|
34 |
|
---|
35 | <para><application>Mercurial</application> is a distributed source control
|
---|
36 | management tool similar to <application>Git</application> and
|
---|
37 | <application>Bazaar</application>. <application>Mercurial</application> is
|
---|
38 | written in <application>Python</application> and is used by projects such as
|
---|
39 | Mozilla and Vim.</para>
|
---|
40 |
|
---|
41 | &lfs74_checked;
|
---|
42 |
|
---|
43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
44 | <itemizedlist spacing="compact">
|
---|
45 | <listitem>
|
---|
46 | <para>Download (HTTP): <ulink url="&mercurial-download-http;"/></para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>Download (FTP): <ulink url="&mercurial-download-ftp;"/></para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>Download MD5 sum: &mercurial-md5sum;</para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Download size: &mercurial-size;</para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>Estimated disk space required: &mercurial-buildsize;</para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>Estimated build time: &mercurial-time;</para>
|
---|
62 | </listitem>
|
---|
63 | </itemizedlist>
|
---|
64 |
|
---|
65 | <bridgehead renderas="sect3">Mercurial Dependencies</bridgehead>
|
---|
66 |
|
---|
67 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
68 | <para role="required">
|
---|
69 | <xref linkend="python2"/>
|
---|
70 | </para>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
73 | <para role="optional">
|
---|
74 | <ulink url="http://docutils.sourceforge.net/">Docutils</ulink> (required to build the documentation),
|
---|
75 | <xref linkend="git"/>,
|
---|
76 | <xref linkend="gnupg2"/> (<command>gpg2</command> with Python bindings),
|
---|
77 | <xref linkend="subversion"/> (with Python bindings),
|
---|
78 | <xref linkend="bazaar"/>,
|
---|
79 | <xref linkend="cvs"/>,
|
---|
80 | <ulink url="http://pypi.python.org/pypi/pyflakes">pyflakes</ulink>,
|
---|
81 | <ulink url="http://pygments.org/">pygments</ulink>, and
|
---|
82 | <ulink url="https://launchpad.net/pyopenssl">pyOpenSSL</ulink>
|
---|
83 |
|
---|
84 | </para>
|
---|
85 |
|
---|
86 | <para condition="html" role="usernotes">User Notes:
|
---|
87 | <ulink url="&blfs-wiki;/mercurial"/></para>
|
---|
88 |
|
---|
89 | </sect2>
|
---|
90 |
|
---|
91 | <sect2 role="installation">
|
---|
92 | <title>Installation of Mercurial</title>
|
---|
93 |
|
---|
94 | <para>If you wish to run the test suite, fix an error with the following
|
---|
95 | command:</para>
|
---|
96 |
|
---|
97 | <screen><userinput>sed -e 's|unzip archive.zip|unzip archive.zip 2>/dev/null|' \
|
---|
98 | -i tests/test-archive-symlinks.t</userinput></screen>
|
---|
99 |
|
---|
100 | <para>Build <application>Mercurial</application> by issuing the following
|
---|
101 | command:</para>
|
---|
102 |
|
---|
103 | <screen><userinput>make build</userinput></screen>
|
---|
104 |
|
---|
105 | <para>To build the documentation (requires
|
---|
106 | <application>Docutils</application>), issue:</para>
|
---|
107 |
|
---|
108 | <screen><userinput>make doc</userinput></screen>
|
---|
109 |
|
---|
110 | <para>To test the results, issue: <command>make check</command>. During the
|
---|
111 | tests, the build directory size increases above the
|
---|
112 | <quote>Estimated disk space required</quote>, even when considering the
|
---|
113 | additional values, due to temporary test files.</para>
|
---|
114 |
|
---|
115 | <para>Install <application>Mercurial</application> by running
|
---|
116 | the following command (as <systemitem class="username">root</systemitem>):</para>
|
---|
117 |
|
---|
118 | <screen role="root"><userinput>make PREFIX=/usr install-bin</userinput></screen>
|
---|
119 |
|
---|
120 | <para>If you built the documentation, install it by running
|
---|
121 | the following command (as <systemitem class="username">root</systemitem>):</para>
|
---|
122 |
|
---|
123 | <screen role="root"><userinput>make PREFIX=/usr install-doc</userinput></screen>
|
---|
124 |
|
---|
125 | <para>After installed, two very quick and simple tests should run correctly.
|
---|
126 | First one needs some configuration:</para>
|
---|
127 |
|
---|
128 | <screen><userinput>cat >> ~/.hgrc << "EOF"
|
---|
129 | <literal>[ui]
|
---|
130 | username = <user_name> <your@mail></literal>
|
---|
131 | EOF</userinput></screen>
|
---|
132 |
|
---|
133 | <para>where you must replace <user_name> and <your@mail> (mail
|
---|
134 | is optional and can be omitted). With the user identity defined, run
|
---|
135 | <command>hg debuginstall</command> and several lines will be displayed,
|
---|
136 | the last one reading "no problems detected". Another quick and simple test
|
---|
137 | is just <command>hg</command>, which should output basic commands that can
|
---|
138 | be used with <command>hg</command>.</para>
|
---|
139 |
|
---|
140 | </sect2>
|
---|
141 |
|
---|
142 | <sect2 role="configuration">
|
---|
143 | <title>Configuring Mercurial</title>
|
---|
144 |
|
---|
145 | <sect3 id="mercurial-config">
|
---|
146 | <title>Config Files</title>
|
---|
147 |
|
---|
148 | <para>
|
---|
149 | <filename>/etc/mercurial/hgrc</filename>
|
---|
150 | </para>
|
---|
151 |
|
---|
152 | <indexterm zone="mercurial mercurial-config">
|
---|
153 | <primary sortas="e-etc-mercurial-hgrc">/etc/mercurial/hgrc</primary>
|
---|
154 | </indexterm>
|
---|
155 |
|
---|
156 | <para>
|
---|
157 | If you have installed the <xref linkend="cacerts"/> and you want
|
---|
158 | <application>Mercurial</application> to use them, as the
|
---|
159 | <systemitem class="username">root</systemitem> user:
|
---|
160 | </para>
|
---|
161 |
|
---|
162 | <screen role="root"><userinput>install -v -d -m755 /etc/mercurial &&
|
---|
163 | cat > /etc/mercurial/hgrc << "EOF"
|
---|
164 | <literal>[web]
|
---|
165 | cacerts = /etc/ssl/ca-bundle.crt</literal>
|
---|
166 | EOF</userinput></screen>
|
---|
167 |
|
---|
168 | </sect3>
|
---|
169 |
|
---|
170 | </sect2>
|
---|
171 |
|
---|
172 | <sect2 role="content">
|
---|
173 | <title>Contents</title>
|
---|
174 |
|
---|
175 | <segmentedlist>
|
---|
176 | <segtitle>Installed Programs</segtitle>
|
---|
177 | <segtitle>Installed Libraries</segtitle>
|
---|
178 | <segtitle>Installed Directories</segtitle>
|
---|
179 |
|
---|
180 | <seglistitem>
|
---|
181 | <seg>hg</seg>
|
---|
182 | <seg>/usr/lib/python2.7/site-packages/hgext/inotify/linux/_inotify.so and
|
---|
183 | several under /usr/lib/python2.7/site-packages/mercurial</seg>
|
---|
184 | <seg>/etc/mercurial, /usr/lib/python2.7/site-packages/hgext and
|
---|
185 | /usr/lib/python2.7/site-packages/mercurial</seg>
|
---|
186 | </seglistitem>
|
---|
187 | </segmentedlist>
|
---|
188 |
|
---|
189 | <variablelist>
|
---|
190 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
191 | <?dbfo list-presentation="list"?>
|
---|
192 | <?dbhtml list-presentation="table"?>
|
---|
193 |
|
---|
194 | <varlistentry id="hg">
|
---|
195 | <term><command>hg</command></term>
|
---|
196 | <listitem>
|
---|
197 | <para>is the program file for mercurial.</para>
|
---|
198 | <indexterm zone="mercurial hg">
|
---|
199 | <primary sortas="b-hg">hg</primary>
|
---|
200 | </indexterm>
|
---|
201 | </listitem>
|
---|
202 | </varlistentry>
|
---|
203 |
|
---|
204 | </variablelist>
|
---|
205 |
|
---|
206 | </sect2>
|
---|
207 |
|
---|
208 | </sect1>
|
---|