Helix SwarmHelix Swarm
Loading...

hg.1.html

  • //
  • guest/
  • Doug_Napoleone/
  • mercurial/
  • doc/
  • hg.1.html #1
  • View
  • Commits
  • Open Download .zip Download (536 KB) 
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
  7. <title>hg</title>
  8. <meta name="author" content="Matt Mackall &lt;mpm&#64;selenic.com&gt;" />
  9. <meta name="organization" content="Mercurial" />
  10. <link rel="stylesheet" href="style.css" type="text/css" />
  11. </head>
  12. <body>
  13. <div class="document" id="hg">
  14. <span id="hg-1"></span>
  15. <h1 class="title">hg</h1>
  16. <h2 class="subtitle" id="mercurial-source-code-management-system">Mercurial source code management system</h2>
  17. <table class="docinfo" frame="void" rules="none">
  18. <col class="docinfo-name" />
  19. <col class="docinfo-content" />
  20. <tbody valign="top">
  21. <tr><th class="docinfo-name">Author:</th>
  22. <td>Matt Mackall &lt;<a class="reference external" href="mailto:mpm&#64;selenic.com">mpm&#64;selenic.com</a>&gt;</td></tr>
  23. <tr><th class="docinfo-name">Organization:</th>
  24. <td>Mercurial</td></tr>
  25. <tr class="field"><th class="docinfo-name">Manual section:</th><td class="field-body">1</td>
  26. </tr>
  27. <tr class="field"><th class="docinfo-name">Manual group:</th><td class="field-body">Mercurial Manual</td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. <div class="contents htmlonly topic" id="contents">
  32. <p class="topic-title first">Contents</p>
  33. <ul class="simple">
  34. <li><a class="reference internal" href="#synopsis" id="id56">Synopsis</a></li>
  35. <li><a class="reference internal" href="#description" id="id57">Description</a></li>
  36. <li><a class="reference internal" href="#command-elements" id="id58">Command Elements</a></li>
  37. <li><a class="reference internal" href="#options" id="id59">Options</a></li>
  38. <li><a class="reference internal" href="#commands" id="id60">Commands</a></li>
  39. <li><a class="reference internal" href="#date-formats" id="id61">Date Formats</a></li>
  40. <li><a class="reference internal" href="#diff-formats" id="id62">Diff Formats</a></li>
  41. <li><a class="reference internal" href="#environment-variables" id="id63">Environment Variables</a></li>
  42. <li><a class="reference internal" href="#using-additional-features" id="id64">Using Additional Features</a></li>
  43. <li><a class="reference internal" href="#specifying-file-sets" id="id65">Specifying File Sets</a></li>
  44. <li><a class="reference internal" href="#id1" id="id66">Glossary</a></li>
  45. <li><a class="reference internal" href="#syntax-for-mercurial-ignore-files" id="id67">Syntax for Mercurial Ignore Files</a></li>
  46. <li><a class="reference internal" href="#configuring-hgweb" id="id68">Configuring hgweb</a></li>
  47. <li><a class="reference internal" href="#id10" id="id69">Merge Tools</a></li>
  48. <li><a class="reference internal" href="#specifying-multiple-revisions" id="id70">Specifying Multiple Revisions</a></li>
  49. <li><a class="reference internal" href="#file-name-patterns" id="id71">File Name Patterns</a></li>
  50. <li><a class="reference internal" href="#working-with-phases" id="id72">Working with Phases</a></li>
  51. <li><a class="reference internal" href="#specifying-single-revisions" id="id73">Specifying Single Revisions</a></li>
  52. <li><a class="reference internal" href="#specifying-revision-sets" id="id74">Specifying Revision Sets</a></li>
  53. <li><a class="reference internal" href="#using-mercurial-from-scripts-and-automation" id="id75">Using Mercurial from scripts and automation</a></li>
  54. <li><a class="reference internal" href="#subrepositories" id="id76">Subrepositories</a></li>
  55. <li><a class="reference internal" href="#template-usage" id="id77">Template Usage</a></li>
  56. <li><a class="reference internal" href="#url-paths" id="id78">URL Paths</a></li>
  57. <li><a class="reference internal" href="#id12" id="id79">Extensions</a></li>
  58. <li><a class="reference internal" href="#id54" id="id80">Files</a></li>
  59. <li><a class="reference internal" href="#bugs" id="id81">Bugs</a></li>
  60. <li><a class="reference internal" href="#see-also" id="id82">See Also</a></li>
  61. <li><a class="reference internal" href="#author" id="id83">Author</a></li>
  62. <li><a class="reference internal" href="#resources" id="id84">Resources</a></li>
  63. <li><a class="reference internal" href="#copying" id="id85">Copying</a></li>
  64. </ul>
  65. </div>
  66. <div class="section" id="synopsis">
  67. <h1><a class="toc-backref" href="#contents">Synopsis</a></h1>
  68. <p><strong>hg</strong> <em>command</em> [<em>option</em>]... [<em>argument</em>]...</p>
  69. </div>
  70. <div class="section" id="description">
  71. <h1><a class="toc-backref" href="#contents">Description</a></h1>
  72. <p>The <strong>hg</strong> command provides a command line interface to the Mercurial
  73. system.</p>
  74. </div>
  75. <div class="section" id="command-elements">
  76. <h1><a class="toc-backref" href="#contents">Command Elements</a></h1>
  77. <dl class="docutils">
  78. <dt>files...</dt>
  79. <dd>indicates one or more filename or relative path filenames; see
  80. <a class="reference internal" href="#file-name-patterns">File Name Patterns</a> for information on pattern matching</dd>
  81. <dt>path</dt>
  82. <dd>indicates a path on the local machine</dd>
  83. <dt>revision</dt>
  84. <dd>indicates a changeset which can be specified as a changeset
  85. revision number, a tag, or a unique substring of the changeset
  86. hash value</dd>
  87. <dt>repository path</dt>
  88. <dd>either the pathname of a local repository or the URI of a remote
  89. repository.</dd>
  90. </dl>
  91. </div>
  92. <div class="section" id="options">
  93. <h1><a class="toc-backref" href="#contents">Options</a></h1>
  94. <table class="docutils option-list" frame="void" rules="none">
  95. <col class="option" />
  96. <col class="description" />
  97. <tbody valign="top">
  98. <tr><td class="option-group" colspan="2">
  99. <kbd><span class="option">-R</span>, <span class="option">--repository <var>&lt;REPO&gt;</var></span></kbd></td>
  100. </tr>
  101. <tr><td>&nbsp;</td><td>repository root directory or name of overlay bundle file</td></tr>
  102. <tr><td class="option-group">
  103. <kbd><span class="option">--cwd <var>&lt;DIR&gt;</var></span></kbd></td>
  104. <td>change working directory</td></tr>
  105. <tr><td class="option-group" colspan="2">
  106. <kbd><span class="option">-y</span>, <span class="option">--noninteractive</span></kbd></td>
  107. </tr>
  108. <tr><td>&nbsp;</td><td>do not prompt, automatically pick the first choice for all prompts</td></tr>
  109. <tr><td class="option-group">
  110. <kbd><span class="option">-q</span>, <span class="option">--quiet</span></kbd></td>
  111. <td>suppress output</td></tr>
  112. <tr><td class="option-group">
  113. <kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></td>
  114. <td>enable additional output</td></tr>
  115. <tr><td class="option-group" colspan="2">
  116. <kbd><span class="option">--config <var>&lt;CONFIG[+]&gt;</var></span></kbd></td>
  117. </tr>
  118. <tr><td>&nbsp;</td><td>set/override config option (use 'section.name=value')</td></tr>
  119. <tr><td class="option-group">
  120. <kbd><span class="option">--debug</span></kbd></td>
  121. <td>enable debugging output</td></tr>
  122. <tr><td class="option-group">
  123. <kbd><span class="option">--debugger</span></kbd></td>
  124. <td>start debugger</td></tr>
  125. <tr><td class="option-group" colspan="2">
  126. <kbd><span class="option">--encoding <var>&lt;ENCODE&gt;</var></span></kbd></td>
  127. </tr>
  128. <tr><td>&nbsp;</td><td>set the charset encoding (default: UTF-8)</td></tr>
  129. <tr><td class="option-group" colspan="2">
  130. <kbd><span class="option">--encodingmode <var>&lt;MODE&gt;</var></span></kbd></td>
  131. </tr>
  132. <tr><td>&nbsp;</td><td>set the charset encoding mode (default: strict)</td></tr>
  133. <tr><td class="option-group">
  134. <kbd><span class="option">--traceback</span></kbd></td>
  135. <td>always print a traceback on exception</td></tr>
  136. <tr><td class="option-group">
  137. <kbd><span class="option">--time</span></kbd></td>
  138. <td>time how long the command takes</td></tr>
  139. <tr><td class="option-group">
  140. <kbd><span class="option">--profile</span></kbd></td>
  141. <td>print command execution profile</td></tr>
  142. <tr><td class="option-group">
  143. <kbd><span class="option">--version</span></kbd></td>
  144. <td>output version information and exit</td></tr>
  145. <tr><td class="option-group">
  146. <kbd><span class="option">-h</span>, <span class="option">--help</span></kbd></td>
  147. <td>display help and exit</td></tr>
  148. <tr><td class="option-group">
  149. <kbd><span class="option">--hidden</span></kbd></td>
  150. <td>consider hidden changesets</td></tr>
  151. </tbody>
  152. </table>
  153. <p>[+] marked option can be specified multiple times</p>
  154. </div>
  155. <div class="section" id="commands">
  156. <h1><a class="toc-backref" href="#contents">Commands</a></h1>
  157. <div class="section" id="add">
  158. <h2>add</h2>
  159. <p>add the specified files on the next commit:</p>
  160. <pre class="literal-block">
  161. hg add [OPTION]... [FILE]...
  162. </pre>
  163. <p>Schedule files to be version controlled and added to the
  164. repository.</p>
  165. <p>The files will be added to the repository at the next commit. To
  166. undo an add before that, see <a class="reference external" href="hg.1.html#forget"><tt class="docutils literal">hg forget</tt></a>.</p>
  167. <p>If no names are given, add all files to the repository.</p>
  168. <div class="verbose container">
  169. <p>An example showing how new (unknown) files are added
  170. automatically by <a class="reference external" href="hg.1.html#add"><tt class="docutils literal">hg add</tt></a>:</p>
  171. <pre class="literal-block">
  172. $ ls
  173. foo.c
  174. $ hg status
  175. ? foo.c
  176. $ hg add
  177. adding foo.c
  178. $ hg status
  179. A foo.c
  180. </pre>
  181. </div>
  182. <p>Returns 0 if all files are successfully added.</p>
  183. <p>Options:</p>
  184. <table class="docutils option-list" frame="void" rules="none">
  185. <col class="option" />
  186. <col class="description" />
  187. <tbody valign="top">
  188. <tr><td class="option-group" colspan="2">
  189. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  190. </tr>
  191. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  192. <tr><td class="option-group" colspan="2">
  193. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  194. </tr>
  195. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  196. <tr><td class="option-group">
  197. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  198. <td>recurse into subrepositories</td></tr>
  199. <tr><td class="option-group">
  200. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  201. <td>do not perform actions, just print output</td></tr>
  202. </tbody>
  203. </table>
  204. <p>[+] marked option can be specified multiple times</p>
  205. </div>
  206. <div class="section" id="addremove">
  207. <h2>addremove</h2>
  208. <p>add all new files, delete all missing files:</p>
  209. <pre class="literal-block">
  210. hg addremove [OPTION]... [FILE]...
  211. </pre>
  212. <p>Add all new files and remove all missing files from the
  213. repository.</p>
  214. <p>New files are ignored if they match any of the patterns in
  215. <tt class="docutils literal">.hgignore</tt>. As with add, these changes take effect at the next
  216. commit.</p>
  217. <p>Use the -s/--similarity option to detect renamed files. This
  218. option takes a percentage between 0 (disabled) and 100 (files must
  219. be identical) as its parameter. With a parameter greater than 0,
  220. this compares every removed file with every added file and records
  221. those similar enough as renames. Detecting renamed files this way
  222. can be expensive. After using this option, <a class="reference external" href="hg.1.html#status"><tt class="docutils literal">hg status <span class="pre">-C</span></tt></a> can be
  223. used to check which files were identified as moved or renamed. If
  224. not specified, -s/--similarity defaults to 100 and only renames of
  225. identical files are detected.</p>
  226. <p>Returns 0 if all files are successfully added.</p>
  227. <p>Options:</p>
  228. <table class="docutils option-list" frame="void" rules="none">
  229. <col class="option" />
  230. <col class="description" />
  231. <tbody valign="top">
  232. <tr><td class="option-group" colspan="2">
  233. <kbd><span class="option">-s</span>, <span class="option">--similarity <var>&lt;SIMILARITY&gt;</var></span></kbd></td>
  234. </tr>
  235. <tr><td>&nbsp;</td><td>guess renamed files by similarity (0&lt;=s&lt;=100)</td></tr>
  236. <tr><td class="option-group">
  237. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  238. <td>recurse into subrepositories</td></tr>
  239. <tr><td class="option-group" colspan="2">
  240. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  241. </tr>
  242. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  243. <tr><td class="option-group" colspan="2">
  244. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  245. </tr>
  246. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  247. <tr><td class="option-group">
  248. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  249. <td>do not perform actions, just print output</td></tr>
  250. </tbody>
  251. </table>
  252. <p>[+] marked option can be specified multiple times</p>
  253. </div>
  254. <div class="section" id="annotate">
  255. <h2>annotate</h2>
  256. <p>show changeset information by line for each file:</p>
  257. <pre class="literal-block">
  258. hg annotate [-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...
  259. </pre>
  260. <p>List changes in files, showing the revision id responsible for
  261. each line</p>
  262. <p>This command is useful for discovering when a change was made and
  263. by whom.</p>
  264. <p>Without the -a/--text option, annotate will avoid processing files
  265. it detects as binary. With -a, annotate will annotate the file
  266. anyway, although the results will probably be neither useful
  267. nor desirable.</p>
  268. <p>Returns 0 on success.</p>
  269. <p>Options:</p>
  270. <table class="docutils option-list" frame="void" rules="none">
  271. <col class="option" />
  272. <col class="description" />
  273. <tbody valign="top">
  274. <tr><td class="option-group" colspan="2">
  275. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  276. </tr>
  277. <tr><td>&nbsp;</td><td>annotate the specified revision</td></tr>
  278. <tr><td class="option-group">
  279. <kbd><span class="option">--follow</span></kbd></td>
  280. <td>follow copies/renames and list the filename (DEPRECATED)</td></tr>
  281. <tr><td class="option-group">
  282. <kbd><span class="option">--no-follow</span></kbd></td>
  283. <td>don't follow copies and renames</td></tr>
  284. <tr><td class="option-group">
  285. <kbd><span class="option">-a</span>, <span class="option">--text</span></kbd></td>
  286. <td>treat all files as text</td></tr>
  287. <tr><td class="option-group">
  288. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  289. <td>list the author (long with -v)</td></tr>
  290. <tr><td class="option-group">
  291. <kbd><span class="option">-f</span>, <span class="option">--file</span></kbd></td>
  292. <td>list the filename</td></tr>
  293. <tr><td class="option-group">
  294. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  295. <td>list the date (short with -q)</td></tr>
  296. <tr><td class="option-group">
  297. <kbd><span class="option">-n</span>, <span class="option">--number</span></kbd></td>
  298. <td>list the revision number (default)</td></tr>
  299. <tr><td class="option-group" colspan="2">
  300. <kbd><span class="option">-c</span>, <span class="option">--changeset</span></kbd></td>
  301. </tr>
  302. <tr><td>&nbsp;</td><td>list the changeset</td></tr>
  303. <tr><td class="option-group" colspan="2">
  304. <kbd><span class="option">-l</span>, <span class="option">--line-number</span></kbd></td>
  305. </tr>
  306. <tr><td>&nbsp;</td><td>show line number at the first appearance</td></tr>
  307. <tr><td class="option-group" colspan="2">
  308. <kbd><span class="option">-w</span>, <span class="option">--ignore-all-space</span></kbd></td>
  309. </tr>
  310. <tr><td>&nbsp;</td><td>ignore white space when comparing lines</td></tr>
  311. <tr><td class="option-group" colspan="2">
  312. <kbd><span class="option">-b</span>, <span class="option">--ignore-space-change</span></kbd></td>
  313. </tr>
  314. <tr><td>&nbsp;</td><td>ignore changes in the amount of white space</td></tr>
  315. <tr><td class="option-group" colspan="2">
  316. <kbd><span class="option">-B</span>, <span class="option">--ignore-blank-lines</span></kbd></td>
  317. </tr>
  318. <tr><td>&nbsp;</td><td>ignore changes whose lines are all blank</td></tr>
  319. <tr><td class="option-group" colspan="2">
  320. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  321. </tr>
  322. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  323. <tr><td class="option-group" colspan="2">
  324. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  325. </tr>
  326. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  327. <tr><td class="option-group" colspan="2">
  328. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  329. </tr>
  330. <tr><td>&nbsp;</td><td>display with template (EXPERIMENTAL)</td></tr>
  331. </tbody>
  332. </table>
  333. <p>[+] marked option can be specified multiple times</p>
  334. <blockquote>
  335. aliases: blame</blockquote>
  336. </div>
  337. <div class="section" id="archive">
  338. <h2>archive</h2>
  339. <p>create an unversioned archive of a repository revision:</p>
  340. <pre class="literal-block">
  341. hg archive [OPTION]... DEST
  342. </pre>
  343. <p>By default, the revision used is the parent of the working
  344. directory; use -r/--rev to specify a different revision.</p>
  345. <p>The archive type is automatically detected based on file
  346. extension (or override using -t/--type).</p>
  347. <div class="verbose container">
  348. <p>Examples:</p>
  349. <ul>
  350. <li><p class="first">create a zip file containing the 1.0 release:</p>
  351. <pre class="literal-block">
  352. hg archive -r 1.0 project-1.0.zip
  353. </pre>
  354. </li>
  355. <li><p class="first">create a tarball excluding .hg files:</p>
  356. <pre class="literal-block">
  357. hg archive project.tar.gz -X &quot;.hg*&quot;
  358. </pre>
  359. </li>
  360. </ul>
  361. </div>
  362. <p>Valid types are:</p>
  363. <table class="docutils field-list" frame="void" rules="none">
  364. <col class="field-name" />
  365. <col class="field-body" />
  366. <tbody valign="top">
  367. <tr class="field"><th class="field-name"><tt class="docutils literal">files</tt>:</th><td class="field-body">a directory full of files (default)</td>
  368. </tr>
  369. <tr class="field"><th class="field-name"><tt class="docutils literal">tar</tt>:</th><td class="field-body">tar archive, uncompressed</td>
  370. </tr>
  371. <tr class="field"><th class="field-name"><tt class="docutils literal">tbz2</tt>:</th><td class="field-body">tar archive, compressed using bzip2</td>
  372. </tr>
  373. <tr class="field"><th class="field-name"><tt class="docutils literal">tgz</tt>:</th><td class="field-body">tar archive, compressed using gzip</td>
  374. </tr>
  375. <tr class="field"><th class="field-name"><tt class="docutils literal">uzip</tt>:</th><td class="field-body">zip archive, uncompressed</td>
  376. </tr>
  377. <tr class="field"><th class="field-name"><tt class="docutils literal">zip</tt>:</th><td class="field-body">zip archive, compressed using deflate</td>
  378. </tr>
  379. </tbody>
  380. </table>
  381. <p>The exact name of the destination archive or directory is given
  382. using a format string; see <a class="reference external" href="hg.1.html#export"><tt class="docutils literal">hg help export</tt></a> for details.</p>
  383. <p>Each member added to an archive file has a directory prefix
  384. prepended. Use -p/--prefix to specify a format string for the
  385. prefix. The default is the basename of the archive, with suffixes
  386. removed.</p>
  387. <p>Returns 0 on success.</p>
  388. <p>Options:</p>
  389. <table class="docutils option-list" frame="void" rules="none">
  390. <col class="option" />
  391. <col class="description" />
  392. <tbody valign="top">
  393. <tr><td class="option-group">
  394. <kbd><span class="option">--no-decode</span></kbd></td>
  395. <td>do not pass files through decoders</td></tr>
  396. <tr><td class="option-group" colspan="2">
  397. <kbd><span class="option">-p</span>, <span class="option">--prefix <var>&lt;PREFIX&gt;</var></span></kbd></td>
  398. </tr>
  399. <tr><td>&nbsp;</td><td>directory prefix for files in archive</td></tr>
  400. <tr><td class="option-group" colspan="2">
  401. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  402. </tr>
  403. <tr><td>&nbsp;</td><td>revision to distribute</td></tr>
  404. <tr><td class="option-group" colspan="2">
  405. <kbd><span class="option">-t</span>, <span class="option">--type <var>&lt;TYPE&gt;</var></span></kbd></td>
  406. </tr>
  407. <tr><td>&nbsp;</td><td>type of distribution to create</td></tr>
  408. <tr><td class="option-group">
  409. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  410. <td>recurse into subrepositories</td></tr>
  411. <tr><td class="option-group" colspan="2">
  412. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  413. </tr>
  414. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  415. <tr><td class="option-group" colspan="2">
  416. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  417. </tr>
  418. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  419. </tbody>
  420. </table>
  421. <p>[+] marked option can be specified multiple times</p>
  422. </div>
  423. <div class="section" id="backout">
  424. <h2>backout</h2>
  425. <p>reverse effect of earlier changeset:</p>
  426. <pre class="literal-block">
  427. hg backout [OPTION]... [-r] REV
  428. </pre>
  429. <p>Prepare a new changeset with the effect of REV undone in the
  430. current working directory.</p>
  431. <p>If REV is the parent of the working directory, then this new changeset
  432. is committed automatically. Otherwise, hg needs to merge the
  433. changes and the merged result is left uncommitted.</p>
  434. <div class="note">
  435. <p class="first admonition-title">Note</p>
  436. <p class="last">backout cannot be used to fix either an unwanted or
  437. incorrect merge.</p>
  438. </div>
  439. <div class="verbose container">
  440. <p>By default, the pending changeset will have one parent,
  441. maintaining a linear history. With --merge, the pending
  442. changeset will instead have two parents: the old parent of the
  443. working directory and a new child of REV that simply undoes REV.</p>
  444. <p>Before version 1.7, the behavior without --merge was equivalent
  445. to specifying --merge followed by <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update <span class="pre">--clean</span> .</tt></a> to
  446. cancel the merge and leave the child of REV as a head to be
  447. merged separately.</p>
  448. </div>
  449. <p>See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for a list of formats valid for -d/--date.</p>
  450. <p>Returns 0 on success, 1 if nothing to backout or there are unresolved
  451. files.</p>
  452. <p>Options:</p>
  453. <table class="docutils option-list" frame="void" rules="none">
  454. <col class="option" />
  455. <col class="description" />
  456. <tbody valign="top">
  457. <tr><td class="option-group">
  458. <kbd><span class="option">--merge</span></kbd></td>
  459. <td>merge with old dirstate parent after backout</td></tr>
  460. <tr><td class="option-group">
  461. <kbd><span class="option">--commit</span></kbd></td>
  462. <td>commit if no conflicts were encountered</td></tr>
  463. <tr><td class="option-group">
  464. <kbd><span class="option">--parent <var>&lt;REV&gt;</var></span></kbd></td>
  465. <td>parent to choose when backing out merge (DEPRECATED)</td></tr>
  466. <tr><td class="option-group" colspan="2">
  467. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  468. </tr>
  469. <tr><td>&nbsp;</td><td>revision to backout</td></tr>
  470. <tr><td class="option-group">
  471. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  472. <td>invoke editor on commit messages</td></tr>
  473. <tr><td class="option-group" colspan="2">
  474. <kbd><span class="option">-t</span>, <span class="option">--tool <var>&lt;VALUE&gt;</var></span></kbd></td>
  475. </tr>
  476. <tr><td>&nbsp;</td><td>specify merge tool</td></tr>
  477. <tr><td class="option-group" colspan="2">
  478. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  479. </tr>
  480. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  481. <tr><td class="option-group" colspan="2">
  482. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  483. </tr>
  484. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  485. <tr><td class="option-group" colspan="2">
  486. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  487. </tr>
  488. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  489. <tr><td class="option-group" colspan="2">
  490. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  491. </tr>
  492. <tr><td>&nbsp;</td><td>read commit message from file</td></tr>
  493. <tr><td class="option-group" colspan="2">
  494. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  495. </tr>
  496. <tr><td>&nbsp;</td><td>record the specified date as commit date</td></tr>
  497. <tr><td class="option-group" colspan="2">
  498. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  499. </tr>
  500. <tr><td>&nbsp;</td><td>record the specified user as committer</td></tr>
  501. </tbody>
  502. </table>
  503. <p>[+] marked option can be specified multiple times</p>
  504. </div>
  505. <div class="section" id="bisect">
  506. <h2>bisect</h2>
  507. <p>subdivision search of changesets:</p>
  508. <pre class="literal-block">
  509. hg bisect [-gbsr] [-U] [-c CMD] [REV]
  510. </pre>
  511. <p>This command helps to find changesets which introduce problems. To
  512. use, mark the earliest changeset you know exhibits the problem as
  513. bad, then mark the latest changeset which is free from the problem
  514. as good. Bisect will update your working directory to a revision
  515. for testing (unless the -U/--noupdate option is specified). Once
  516. you have performed tests, mark the working directory as good or
  517. bad, and bisect will either update to another candidate changeset
  518. or announce that it has found the bad revision.</p>
  519. <p>As a shortcut, you can also use the revision argument to mark a
  520. revision as good or bad without checking it out first.</p>
  521. <p>If you supply a command, it will be used for automatic bisection.
  522. The environment variable HG_NODE will contain the ID of the
  523. changeset being tested. The exit status of the command will be
  524. used to mark revisions as good or bad: status 0 means good, 125
  525. means to skip the revision, 127 (command not found) will abort the
  526. bisection, and any other non-zero exit status means the revision
  527. is bad.</p>
  528. <div class="verbose container">
  529. <p>Some examples:</p>
  530. <ul>
  531. <li><p class="first">start a bisection with known bad revision 34, and good revision 12:</p>
  532. <pre class="literal-block">
  533. hg bisect --bad 34
  534. hg bisect --good 12
  535. </pre>
  536. </li>
  537. <li><p class="first">advance the current bisection by marking current revision as good or
  538. bad:</p>
  539. <pre class="literal-block">
  540. hg bisect --good
  541. hg bisect --bad
  542. </pre>
  543. </li>
  544. <li><p class="first">mark the current revision, or a known revision, to be skipped (e.g. if
  545. that revision is not usable because of another issue):</p>
  546. <pre class="literal-block">
  547. hg bisect --skip
  548. hg bisect --skip 23
  549. </pre>
  550. </li>
  551. <li><p class="first">skip all revisions that do not touch directories <tt class="docutils literal">foo</tt> or <tt class="docutils literal">bar</tt>:</p>
  552. <pre class="literal-block">
  553. hg bisect --skip &quot;!( file('path:foo') &amp; file('path:bar') )&quot;
  554. </pre>
  555. </li>
  556. <li><p class="first">forget the current bisection:</p>
  557. <pre class="literal-block">
  558. hg bisect --reset
  559. </pre>
  560. </li>
  561. <li><p class="first">use 'make &amp;&amp; make tests' to automatically find the first broken
  562. revision:</p>
  563. <pre class="literal-block">
  564. hg bisect --reset
  565. hg bisect --bad 34
  566. hg bisect --good 12
  567. hg bisect --command &quot;make &amp;&amp; make tests&quot;
  568. </pre>
  569. </li>
  570. <li><p class="first">see all changesets whose states are already known in the current
  571. bisection:</p>
  572. <pre class="literal-block">
  573. hg log -r &quot;bisect(pruned)&quot;
  574. </pre>
  575. </li>
  576. <li><p class="first">see the changeset currently being bisected (especially useful
  577. if running with -U/--noupdate):</p>
  578. <pre class="literal-block">
  579. hg log -r &quot;bisect(current)&quot;
  580. </pre>
  581. </li>
  582. <li><p class="first">see all changesets that took part in the current bisection:</p>
  583. <pre class="literal-block">
  584. hg log -r &quot;bisect(range)&quot;
  585. </pre>
  586. </li>
  587. <li><p class="first">you can even get a nice graph:</p>
  588. <pre class="literal-block">
  589. hg log --graph -r &quot;bisect(range)&quot;
  590. </pre>
  591. </li>
  592. </ul>
  593. <p>See <a class="reference external" href="hg.1.html#revsets"><tt class="docutils literal">hg help revsets</tt></a> for more about the <cite>bisect()</cite> keyword.</p>
  594. </div>
  595. <p>Returns 0 on success.</p>
  596. <p>Options:</p>
  597. <table class="docutils option-list" frame="void" rules="none">
  598. <col class="option" />
  599. <col class="description" />
  600. <tbody valign="top">
  601. <tr><td class="option-group">
  602. <kbd><span class="option">-r</span>, <span class="option">--reset</span></kbd></td>
  603. <td>reset bisect state</td></tr>
  604. <tr><td class="option-group">
  605. <kbd><span class="option">-g</span>, <span class="option">--good</span></kbd></td>
  606. <td>mark changeset good</td></tr>
  607. <tr><td class="option-group">
  608. <kbd><span class="option">-b</span>, <span class="option">--bad</span></kbd></td>
  609. <td>mark changeset bad</td></tr>
  610. <tr><td class="option-group">
  611. <kbd><span class="option">-s</span>, <span class="option">--skip</span></kbd></td>
  612. <td>skip testing changeset</td></tr>
  613. <tr><td class="option-group">
  614. <kbd><span class="option">-e</span>, <span class="option">--extend</span></kbd></td>
  615. <td>extend the bisect range</td></tr>
  616. <tr><td class="option-group" colspan="2">
  617. <kbd><span class="option">-c</span>, <span class="option">--command <var>&lt;CMD&gt;</var></span></kbd></td>
  618. </tr>
  619. <tr><td>&nbsp;</td><td>use command to check changeset state</td></tr>
  620. <tr><td class="option-group">
  621. <kbd><span class="option">-U</span>, <span class="option">--noupdate</span></kbd></td>
  622. <td>do not update to target</td></tr>
  623. </tbody>
  624. </table>
  625. </div>
  626. <div class="section" id="bookmarks">
  627. <h2>bookmarks</h2>
  628. <p>create a new bookmark or list existing bookmarks:</p>
  629. <pre class="literal-block">
  630. hg bookmarks [OPTIONS]... [NAME]...
  631. </pre>
  632. <p>Bookmarks are labels on changesets to help track lines of development.
  633. Bookmarks are unversioned and can be moved, renamed and deleted.
  634. Deleting or moving a bookmark has no effect on the associated changesets.</p>
  635. <p>Creating or updating to a bookmark causes it to be marked as 'active'.
  636. The active bookmark is indicated with a '*'.
  637. When a commit is made, the active bookmark will advance to the new commit.
  638. A plain <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a> will also advance an active bookmark, if possible.
  639. Updating away from a bookmark will cause it to be deactivated.</p>
  640. <p>Bookmarks can be pushed and pulled between repositories (see
  641. <a class="reference external" href="hg.1.html#push"><tt class="docutils literal">hg help push</tt></a> and <a class="reference external" href="hg.1.html#pull"><tt class="docutils literal">hg help pull</tt></a>). If a shared bookmark has
  642. diverged, a new 'divergent bookmark' of the form <a class="reference external" href="mailto:'name&#64;path">'name&#64;path</a>' will
  643. be created. Using <a class="reference external" href="hg.1.html#merge"><tt class="docutils literal">hg merge</tt></a> will resolve the divergence.</p>
  644. <p>A bookmark named '&#64;' has the special property that <a class="reference external" href="hg.1.html#clone"><tt class="docutils literal">hg clone</tt></a> will
  645. check it out by default if it exists.</p>
  646. <div class="verbose container">
  647. <p>Examples:</p>
  648. <ul>
  649. <li><p class="first">create an active bookmark for a new line of development:</p>
  650. <pre class="literal-block">
  651. hg book new-feature
  652. </pre>
  653. </li>
  654. <li><p class="first">create an inactive bookmark as a place marker:</p>
  655. <pre class="literal-block">
  656. hg book -i reviewed
  657. </pre>
  658. </li>
  659. <li><p class="first">create an inactive bookmark on another changeset:</p>
  660. <pre class="literal-block">
  661. hg book -r .^ tested
  662. </pre>
  663. </li>
  664. <li><p class="first">move the '&#64;' bookmark from another branch:</p>
  665. <pre class="literal-block">
  666. hg book -f &#64;
  667. </pre>
  668. </li>
  669. </ul>
  670. </div>
  671. <p>Options:</p>
  672. <table class="docutils option-list" frame="void" rules="none">
  673. <col class="option" />
  674. <col class="description" />
  675. <tbody valign="top">
  676. <tr><td class="option-group">
  677. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  678. <td>force</td></tr>
  679. <tr><td class="option-group" colspan="2">
  680. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  681. </tr>
  682. <tr><td>&nbsp;</td><td>revision</td></tr>
  683. <tr><td class="option-group">
  684. <kbd><span class="option">-d</span>, <span class="option">--delete</span></kbd></td>
  685. <td>delete a given bookmark</td></tr>
  686. <tr><td class="option-group" colspan="2">
  687. <kbd><span class="option">-m</span>, <span class="option">--rename <var>&lt;NAME&gt;</var></span></kbd></td>
  688. </tr>
  689. <tr><td>&nbsp;</td><td>rename a given bookmark</td></tr>
  690. <tr><td class="option-group">
  691. <kbd><span class="option">-i</span>, <span class="option">--inactive</span></kbd></td>
  692. <td>mark a bookmark inactive</td></tr>
  693. <tr><td class="option-group" colspan="2">
  694. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  695. </tr>
  696. <tr><td>&nbsp;</td><td><p class="first">display with template (EXPERIMENTAL)</p>
  697. <p class="last">aliases: bookmark</p>
  698. </td></tr>
  699. </tbody>
  700. </table>
  701. </div>
  702. <div class="section" id="branch">
  703. <h2>branch</h2>
  704. <p>set or show the current branch name:</p>
  705. <pre class="literal-block">
  706. hg branch [-fC] [NAME]
  707. </pre>
  708. <div class="note">
  709. <p class="first admonition-title">Note</p>
  710. <p class="last">Branch names are permanent and global. Use <a class="reference external" href="hg.1.html#bookmark"><tt class="docutils literal">hg bookmark</tt></a> to create a
  711. light-weight bookmark instead. See <a class="reference external" href="hg.1.html#glossary"><tt class="docutils literal">hg help glossary</tt></a> for more
  712. information about named branches and bookmarks.</p>
  713. </div>
  714. <p>With no argument, show the current branch name. With one argument,
  715. set the working directory branch name (the branch will not exist
  716. in the repository until the next commit). Standard practice
  717. recommends that primary development take place on the 'default'
  718. branch.</p>
  719. <p>Unless -f/--force is specified, branch will not let you set a
  720. branch name that already exists.</p>
  721. <p>Use -C/--clean to reset the working directory branch to that of
  722. the parent of the working directory, negating a previous branch
  723. change.</p>
  724. <p>Use the command <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a> to switch to an existing branch. Use
  725. <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit <span class="pre">--close-branch</span></tt></a> to mark this branch head as closed.
  726. When all heads of the branch are closed, the branch will be
  727. considered closed.</p>
  728. <p>Returns 0 on success.</p>
  729. <p>Options:</p>
  730. <table class="docutils option-list" frame="void" rules="none">
  731. <col class="option" />
  732. <col class="description" />
  733. <tbody valign="top">
  734. <tr><td class="option-group">
  735. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  736. <td>set branch name even if it shadows an existing branch</td></tr>
  737. <tr><td class="option-group">
  738. <kbd><span class="option">-C</span>, <span class="option">--clean</span></kbd></td>
  739. <td>reset branch name to parent branch name</td></tr>
  740. </tbody>
  741. </table>
  742. </div>
  743. <div class="section" id="branches">
  744. <h2>branches</h2>
  745. <p>list repository named branches:</p>
  746. <pre class="literal-block">
  747. hg branches [-ac]
  748. </pre>
  749. <p>List the repository's named branches, indicating which ones are
  750. inactive. If -c/--closed is specified, also list branches which have
  751. been marked closed (see <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit <span class="pre">--close-branch</span></tt></a>).</p>
  752. <p>Use the command <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a> to switch to an existing branch.</p>
  753. <p>Returns 0.</p>
  754. <p>Options:</p>
  755. <table class="docutils option-list" frame="void" rules="none">
  756. <col class="option" />
  757. <col class="description" />
  758. <tbody valign="top">
  759. <tr><td class="option-group">
  760. <kbd><span class="option">-a</span>, <span class="option">--active</span></kbd></td>
  761. <td>show only branches that have unmerged heads (DEPRECATED)</td></tr>
  762. <tr><td class="option-group">
  763. <kbd><span class="option">-c</span>, <span class="option">--closed</span></kbd></td>
  764. <td>show normal and closed branches</td></tr>
  765. <tr><td class="option-group" colspan="2">
  766. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  767. </tr>
  768. <tr><td>&nbsp;</td><td>display with template (EXPERIMENTAL)</td></tr>
  769. </tbody>
  770. </table>
  771. </div>
  772. <div class="section" id="bundle">
  773. <h2>bundle</h2>
  774. <p>create a changegroup file:</p>
  775. <pre class="literal-block">
  776. hg bundle [-f] [-t TYPE] [-a] [-r REV]... [--base REV]... FILE [DEST]
  777. </pre>
  778. <p>Generate a compressed changegroup file collecting changesets not
  779. known to be in another repository.</p>
  780. <p>If you omit the destination repository, then hg assumes the
  781. destination will have all the nodes you specify with --base
  782. parameters. To create a bundle containing all changesets, use
  783. -a/--all (or --base null).</p>
  784. <p>You can change compression method with the -t/--type option.
  785. The available compression methods are: none, bzip2, and
  786. gzip (by default, bundles are compressed using bzip2).</p>
  787. <p>The bundle file can then be transferred using conventional means
  788. and applied to another repository with the unbundle or pull
  789. command. This is useful when direct push and pull are not
  790. available or when exporting an entire repository is undesirable.</p>
  791. <p>Applying bundles preserves all changeset contents including
  792. permissions, copy/rename information, and revision history.</p>
  793. <p>Returns 0 on success, 1 if no changes found.</p>
  794. <p>Options:</p>
  795. <table class="docutils option-list" frame="void" rules="none">
  796. <col class="option" />
  797. <col class="description" />
  798. <tbody valign="top">
  799. <tr><td class="option-group">
  800. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  801. <td>run even when the destination is unrelated</td></tr>
  802. <tr><td class="option-group" colspan="2">
  803. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  804. </tr>
  805. <tr><td>&nbsp;</td><td>a changeset intended to be added to the destination</td></tr>
  806. <tr><td class="option-group" colspan="2">
  807. <kbd><span class="option">-b</span>, <span class="option">--branch <var>&lt;BRANCH[+]&gt;</var></span></kbd></td>
  808. </tr>
  809. <tr><td>&nbsp;</td><td>a specific branch you would like to bundle</td></tr>
  810. <tr><td class="option-group" colspan="2">
  811. <kbd><span class="option">--base <var>&lt;REV[+]&gt;</var></span></kbd></td>
  812. </tr>
  813. <tr><td>&nbsp;</td><td>a base changeset assumed to be available at the destination</td></tr>
  814. <tr><td class="option-group">
  815. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  816. <td>bundle all changesets in the repository</td></tr>
  817. <tr><td class="option-group" colspan="2">
  818. <kbd><span class="option">-t</span>, <span class="option">--type <var>&lt;TYPE&gt;</var></span></kbd></td>
  819. </tr>
  820. <tr><td>&nbsp;</td><td>bundle compression type to use (default: bzip2)</td></tr>
  821. <tr><td class="option-group" colspan="2">
  822. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  823. </tr>
  824. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  825. <tr><td class="option-group" colspan="2">
  826. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  827. </tr>
  828. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  829. <tr><td class="option-group">
  830. <kbd><span class="option">--insecure</span></kbd></td>
  831. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  832. </tbody>
  833. </table>
  834. <p>[+] marked option can be specified multiple times</p>
  835. </div>
  836. <div class="section" id="cat">
  837. <h2>cat</h2>
  838. <p>output the current or given revision of files:</p>
  839. <pre class="literal-block">
  840. hg cat [OPTION]... FILE...
  841. </pre>
  842. <p>Print the specified files as they were at the given revision. If
  843. no revision is given, the parent of the working directory is used.</p>
  844. <p>Output may be to a file, in which case the name of the file is
  845. given using a format string. The formatting rules as follows:</p>
  846. <table class="docutils field-list" frame="void" rules="none">
  847. <col class="field-name" />
  848. <col class="field-body" />
  849. <tbody valign="top">
  850. <tr class="field"><th class="field-name"><tt class="docutils literal">%%</tt>:</th><td class="field-body">literal &quot;%&quot; character</td>
  851. </tr>
  852. <tr class="field"><th class="field-name"><tt class="docutils literal">%s</tt>:</th><td class="field-body">basename of file being printed</td>
  853. </tr>
  854. <tr class="field"><th class="field-name"><tt class="docutils literal">%d</tt>:</th><td class="field-body">dirname of file being printed, or '.' if in repository root</td>
  855. </tr>
  856. <tr class="field"><th class="field-name"><tt class="docutils literal">%p</tt>:</th><td class="field-body">root-relative path name of file being printed</td>
  857. </tr>
  858. <tr class="field"><th class="field-name"><tt class="docutils literal">%H</tt>:</th><td class="field-body">changeset hash (40 hexadecimal digits)</td>
  859. </tr>
  860. <tr class="field"><th class="field-name"><tt class="docutils literal">%R</tt>:</th><td class="field-body">changeset revision number</td>
  861. </tr>
  862. <tr class="field"><th class="field-name"><tt class="docutils literal">%h</tt>:</th><td class="field-body">short-form changeset hash (12 hexadecimal digits)</td>
  863. </tr>
  864. <tr class="field"><th class="field-name"><tt class="docutils literal">%r</tt>:</th><td class="field-body">zero-padded changeset revision number</td>
  865. </tr>
  866. <tr class="field"><th class="field-name"><tt class="docutils literal">%b</tt>:</th><td class="field-body">basename of the exporting repository</td>
  867. </tr>
  868. </tbody>
  869. </table>
  870. <p>Returns 0 on success.</p>
  871. <p>Options:</p>
  872. <table class="docutils option-list" frame="void" rules="none">
  873. <col class="option" />
  874. <col class="description" />
  875. <tbody valign="top">
  876. <tr><td class="option-group" colspan="2">
  877. <kbd><span class="option">-o</span>, <span class="option">--output <var>&lt;FORMAT&gt;</var></span></kbd></td>
  878. </tr>
  879. <tr><td>&nbsp;</td><td>print output to file with formatted name</td></tr>
  880. <tr><td class="option-group" colspan="2">
  881. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  882. </tr>
  883. <tr><td>&nbsp;</td><td>print the given revision</td></tr>
  884. <tr><td class="option-group">
  885. <kbd><span class="option">--decode</span></kbd></td>
  886. <td>apply any matching decode filter</td></tr>
  887. <tr><td class="option-group" colspan="2">
  888. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  889. </tr>
  890. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  891. <tr><td class="option-group" colspan="2">
  892. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  893. </tr>
  894. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  895. </tbody>
  896. </table>
  897. <p>[+] marked option can be specified multiple times</p>
  898. </div>
  899. <div class="section" id="clone">
  900. <h2>clone</h2>
  901. <p>make a copy of an existing repository:</p>
  902. <pre class="literal-block">
  903. hg clone [OPTION]... SOURCE [DEST]
  904. </pre>
  905. <p>Create a copy of an existing repository in a new directory.</p>
  906. <p>If no destination directory name is specified, it defaults to the
  907. basename of the source.</p>
  908. <p>The location of the source is added to the new repository's
  909. <tt class="docutils literal">.hg/hgrc</tt> file, as the default to be used for future pulls.</p>
  910. <p>Only local paths and <tt class="docutils literal"><span class="pre">ssh://</span></tt> URLs are supported as
  911. destinations. For <tt class="docutils literal"><span class="pre">ssh://</span></tt> destinations, no working directory or
  912. <tt class="docutils literal">.hg/hgrc</tt> will be created on the remote side.</p>
  913. <p>To pull only a subset of changesets, specify one or more revisions
  914. identifiers with -r/--rev or branches with -b/--branch. The
  915. resulting clone will contain only the specified changesets and
  916. their ancestors. These options (or 'clone src#rev dest') imply
  917. --pull, even for local source repositories. Note that specifying a
  918. tag will include the tagged changeset but not the changeset
  919. containing the tag.</p>
  920. <p>If the source repository has a bookmark called '&#64;' set, that
  921. revision will be checked out in the new repository by default.</p>
  922. <p>To check out a particular version, use -u/--update, or
  923. -U/--noupdate to create a clone with no working directory.</p>
  924. <div class="verbose container">
  925. <p>For efficiency, hardlinks are used for cloning whenever the
  926. source and destination are on the same filesystem (note this
  927. applies only to the repository data, not to the working
  928. directory). Some filesystems, such as AFS, implement hardlinking
  929. incorrectly, but do not report errors. In these cases, use the
  930. --pull option to avoid hardlinking.</p>
  931. <p>In some cases, you can clone repositories and the working
  932. directory using full hardlinks with</p>
  933. <pre class="literal-block">
  934. $ cp -al REPO REPOCLONE
  935. </pre>
  936. <p>This is the fastest way to clone, but it is not always safe. The
  937. operation is not atomic (making sure REPO is not modified during
  938. the operation is up to you) and you have to make sure your
  939. editor breaks hardlinks (Emacs and most Linux Kernel tools do
  940. so). Also, this is not compatible with certain extensions that
  941. place their metadata under the .hg directory, such as mq.</p>
  942. <p>Mercurial will update the working directory to the first applicable
  943. revision from this list:</p>
  944. <ol class="loweralpha simple">
  945. <li>null if -U or the source repository has no changesets</li>
  946. <li>if -u . and the source repository is local, the first parent of
  947. the source repository's working directory</li>
  948. <li>the changeset specified with -u (if a branch name, this means the
  949. latest head of that branch)</li>
  950. <li>the changeset specified with -r</li>
  951. <li>the tipmost head specified with -b</li>
  952. <li>the tipmost head specified with the url#branch source syntax</li>
  953. <li>the revision marked with the '&#64;' bookmark, if present</li>
  954. <li>the tipmost head of the default branch</li>
  955. <li>tip</li>
  956. </ol>
  957. <p>Examples:</p>
  958. <ul>
  959. <li><p class="first">clone a remote repository to a new directory named hg/:</p>
  960. <pre class="literal-block">
  961. hg clone http://selenic.com/hg
  962. </pre>
  963. </li>
  964. <li><p class="first">create a lightweight local clone:</p>
  965. <pre class="literal-block">
  966. hg clone project/ project-feature/
  967. </pre>
  968. </li>
  969. <li><p class="first">clone from an absolute path on an ssh server (note double-slash):</p>
  970. <pre class="literal-block">
  971. hg clone ssh://user&#64;server//home/projects/alpha/
  972. </pre>
  973. </li>
  974. <li><p class="first">do a high-speed clone over a LAN while checking out a
  975. specified version:</p>
  976. <pre class="literal-block">
  977. hg clone --uncompressed http://server/repo -u 1.5
  978. </pre>
  979. </li>
  980. <li><p class="first">create a repository without changesets after a particular revision:</p>
  981. <pre class="literal-block">
  982. hg clone -r 04e544 experimental/ good/
  983. </pre>
  984. </li>
  985. <li><p class="first">clone (and track) a particular named branch:</p>
  986. <pre class="literal-block">
  987. hg clone http://selenic.com/hg#stable
  988. </pre>
  989. </li>
  990. </ul>
  991. </div>
  992. <p>See <a class="reference external" href="hg.1.html#urls"><tt class="docutils literal">hg help urls</tt></a> for details on specifying URLs.</p>
  993. <p>Returns 0 on success.</p>
  994. <p>Options:</p>
  995. <table class="docutils option-list" frame="void" rules="none">
  996. <col class="option" />
  997. <col class="description" />
  998. <tbody valign="top">
  999. <tr><td class="option-group">
  1000. <kbd><span class="option">-U</span>, <span class="option">--noupdate</span></kbd></td>
  1001. <td>the clone will include an empty working directory (only a repository)</td></tr>
  1002. <tr><td class="option-group" colspan="2">
  1003. <kbd><span class="option">-u</span>, <span class="option">--updaterev <var>&lt;REV&gt;</var></span></kbd></td>
  1004. </tr>
  1005. <tr><td>&nbsp;</td><td>revision, tag or branch to check out</td></tr>
  1006. <tr><td class="option-group" colspan="2">
  1007. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  1008. </tr>
  1009. <tr><td>&nbsp;</td><td>include the specified changeset</td></tr>
  1010. <tr><td class="option-group" colspan="2">
  1011. <kbd><span class="option">-b</span>, <span class="option">--branch <var>&lt;BRANCH[+]&gt;</var></span></kbd></td>
  1012. </tr>
  1013. <tr><td>&nbsp;</td><td>clone only the specified branch</td></tr>
  1014. <tr><td class="option-group">
  1015. <kbd><span class="option">--pull</span></kbd></td>
  1016. <td>use pull protocol to copy metadata</td></tr>
  1017. <tr><td class="option-group">
  1018. <kbd><span class="option">--uncompressed</span></kbd></td>
  1019. <td>use uncompressed transfer (fast over LAN)</td></tr>
  1020. <tr><td class="option-group" colspan="2">
  1021. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  1022. </tr>
  1023. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  1024. <tr><td class="option-group" colspan="2">
  1025. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  1026. </tr>
  1027. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  1028. <tr><td class="option-group">
  1029. <kbd><span class="option">--insecure</span></kbd></td>
  1030. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  1031. </tbody>
  1032. </table>
  1033. <p>[+] marked option can be specified multiple times</p>
  1034. </div>
  1035. <div class="section" id="commit">
  1036. <h2>commit</h2>
  1037. <p>commit the specified files or all outstanding changes:</p>
  1038. <pre class="literal-block">
  1039. hg commit [OPTION]... [FILE]...
  1040. </pre>
  1041. <p>Commit changes to the given files into the repository. Unlike a
  1042. centralized SCM, this operation is a local operation. See
  1043. <a class="reference external" href="hg.1.html#push"><tt class="docutils literal">hg push</tt></a> for a way to actively distribute your changes.</p>
  1044. <p>If a list of files is omitted, all changes reported by <a class="reference external" href="hg.1.html#status"><tt class="docutils literal">hg status</tt></a>
  1045. will be committed.</p>
  1046. <p>If you are committing the result of a merge, do not provide any
  1047. filenames or -I/-X filters.</p>
  1048. <p>If no commit message is specified, Mercurial starts your
  1049. configured editor where you can enter a message. In case your
  1050. commit fails, you will find a backup of your message in
  1051. <tt class="docutils literal"><span class="pre">.hg/last-message.txt</span></tt>.</p>
  1052. <p>The --close-branch flag can be used to mark the current branch
  1053. head closed. When all heads of a branch are closed, the branch
  1054. will be considered closed and no longer listed.</p>
  1055. <p>The --amend flag can be used to amend the parent of the
  1056. working directory with a new commit that contains the changes
  1057. in the parent in addition to those currently reported by <a class="reference external" href="hg.1.html#status"><tt class="docutils literal">hg status</tt></a>,
  1058. if there are any. The old commit is stored in a backup bundle in
  1059. <tt class="docutils literal"><span class="pre">.hg/strip-backup</span></tt> (see <a class="reference external" href="hg.1.html#bundle"><tt class="docutils literal">hg help bundle</tt></a> and <a class="reference external" href="hg.1.html#unbundle"><tt class="docutils literal">hg help unbundle</tt></a>
  1060. on how to restore it).</p>
  1061. <p>Message, user and date are taken from the amended commit unless
  1062. specified. When a message isn't specified on the command line,
  1063. the editor will open with the message of the amended commit.</p>
  1064. <p>It is not possible to amend public changesets (see <a class="reference external" href="hg.1.html#phases"><tt class="docutils literal">hg help phases</tt></a>)
  1065. or changesets that have children.</p>
  1066. <p>See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for a list of formats valid for -d/--date.</p>
  1067. <p>Returns 0 on success, 1 if nothing changed.</p>
  1068. <p>Options:</p>
  1069. <table class="docutils option-list" frame="void" rules="none">
  1070. <col class="option" />
  1071. <col class="description" />
  1072. <tbody valign="top">
  1073. <tr><td class="option-group" colspan="2">
  1074. <kbd><span class="option">-A</span>, <span class="option">--addremove</span></kbd></td>
  1075. </tr>
  1076. <tr><td>&nbsp;</td><td>mark new/missing files as added/removed before committing</td></tr>
  1077. <tr><td class="option-group">
  1078. <kbd><span class="option">--close-branch</span></kbd></td>
  1079. <td>mark a branch head as closed</td></tr>
  1080. <tr><td class="option-group">
  1081. <kbd><span class="option">--amend</span></kbd></td>
  1082. <td>amend the parent of the working directory</td></tr>
  1083. <tr><td class="option-group">
  1084. <kbd><span class="option">-s</span>, <span class="option">--secret</span></kbd></td>
  1085. <td>use the secret phase for committing</td></tr>
  1086. <tr><td class="option-group">
  1087. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  1088. <td>invoke editor on commit messages</td></tr>
  1089. <tr><td class="option-group" colspan="2">
  1090. <kbd><span class="option">-i</span>, <span class="option">--interactive</span></kbd></td>
  1091. </tr>
  1092. <tr><td>&nbsp;</td><td>use interactive mode</td></tr>
  1093. <tr><td class="option-group" colspan="2">
  1094. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1095. </tr>
  1096. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  1097. <tr><td class="option-group" colspan="2">
  1098. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1099. </tr>
  1100. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  1101. <tr><td class="option-group" colspan="2">
  1102. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  1103. </tr>
  1104. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  1105. <tr><td class="option-group" colspan="2">
  1106. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  1107. </tr>
  1108. <tr><td>&nbsp;</td><td>read commit message from file</td></tr>
  1109. <tr><td class="option-group" colspan="2">
  1110. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  1111. </tr>
  1112. <tr><td>&nbsp;</td><td>record the specified date as commit date</td></tr>
  1113. <tr><td class="option-group" colspan="2">
  1114. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  1115. </tr>
  1116. <tr><td>&nbsp;</td><td>record the specified user as committer</td></tr>
  1117. <tr><td class="option-group">
  1118. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  1119. <td>recurse into subrepositories</td></tr>
  1120. </tbody>
  1121. </table>
  1122. <p>[+] marked option can be specified multiple times</p>
  1123. <blockquote>
  1124. aliases: ci</blockquote>
  1125. </div>
  1126. <div class="section" id="config">
  1127. <h2>config</h2>
  1128. <p>show combined config settings from all hgrc files:</p>
  1129. <pre class="literal-block">
  1130. hg config [-u] [NAME]...
  1131. </pre>
  1132. <p>With no arguments, print names and values of all config items.</p>
  1133. <p>With one argument of the form section.name, print just the value
  1134. of that config item.</p>
  1135. <p>With multiple arguments, print names and values of all config
  1136. items with matching section names.</p>
  1137. <p>With --edit, start an editor on the user-level config file. With
  1138. --global, edit the system-wide config file. With --local, edit the
  1139. repository-level config file.</p>
  1140. <p>With --debug, the source (filename and line number) is printed
  1141. for each config item.</p>
  1142. <p>See <a class="reference external" href="hg.1.html#config"><tt class="docutils literal">hg help config</tt></a> for more information about config files.</p>
  1143. <p>Returns 0 on success, 1 if NAME does not exist.</p>
  1144. <p>Options:</p>
  1145. <table class="docutils option-list" frame="void" rules="none">
  1146. <col class="option" />
  1147. <col class="description" />
  1148. <tbody valign="top">
  1149. <tr><td class="option-group" colspan="2">
  1150. <kbd><span class="option">-u</span>, <span class="option">--untrusted</span></kbd></td>
  1151. </tr>
  1152. <tr><td>&nbsp;</td><td>show untrusted configuration options</td></tr>
  1153. <tr><td class="option-group">
  1154. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  1155. <td>edit user config</td></tr>
  1156. <tr><td class="option-group">
  1157. <kbd><span class="option">-l</span>, <span class="option">--local</span></kbd></td>
  1158. <td>edit repository config</td></tr>
  1159. <tr><td class="option-group">
  1160. <kbd><span class="option">-g</span>, <span class="option">--global</span></kbd></td>
  1161. <td><p class="first">edit global config</p>
  1162. <p class="last">aliases: showconfig debugconfig</p>
  1163. </td></tr>
  1164. </tbody>
  1165. </table>
  1166. </div>
  1167. <div class="section" id="copy">
  1168. <h2>copy</h2>
  1169. <p>mark files as copied for the next commit:</p>
  1170. <pre class="literal-block">
  1171. hg copy [OPTION]... [SOURCE]... DEST
  1172. </pre>
  1173. <p>Mark dest as having copies of source files. If dest is a
  1174. directory, copies are put in that directory. If dest is a file,
  1175. the source must be a single file.</p>
  1176. <p>By default, this command copies the contents of files as they
  1177. exist in the working directory. If invoked with -A/--after, the
  1178. operation is recorded, but no copying is performed.</p>
  1179. <p>This command takes effect with the next commit. To undo a copy
  1180. before that, see <a class="reference external" href="hg.1.html#revert"><tt class="docutils literal">hg revert</tt></a>.</p>
  1181. <p>Returns 0 on success, 1 if errors are encountered.</p>
  1182. <p>Options:</p>
  1183. <table class="docutils option-list" frame="void" rules="none">
  1184. <col class="option" />
  1185. <col class="description" />
  1186. <tbody valign="top">
  1187. <tr><td class="option-group">
  1188. <kbd><span class="option">-A</span>, <span class="option">--after</span></kbd></td>
  1189. <td>record a copy that has already occurred</td></tr>
  1190. <tr><td class="option-group">
  1191. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  1192. <td>forcibly copy over an existing managed file</td></tr>
  1193. <tr><td class="option-group" colspan="2">
  1194. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1195. </tr>
  1196. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  1197. <tr><td class="option-group" colspan="2">
  1198. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1199. </tr>
  1200. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  1201. <tr><td class="option-group">
  1202. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  1203. <td>do not perform actions, just print output</td></tr>
  1204. </tbody>
  1205. </table>
  1206. <p>[+] marked option can be specified multiple times</p>
  1207. <blockquote>
  1208. aliases: cp</blockquote>
  1209. </div>
  1210. <div class="section" id="diff">
  1211. <h2>diff</h2>
  1212. <p>diff repository (or selected files):</p>
  1213. <pre class="literal-block">
  1214. hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
  1215. </pre>
  1216. <p>Show differences between revisions for the specified files.</p>
  1217. <p>Differences between files are shown using the unified diff format.</p>
  1218. <div class="note">
  1219. <p class="first admonition-title">Note</p>
  1220. <p class="last">diff may generate unexpected results for merges, as it will
  1221. default to comparing against the working directory's first
  1222. parent changeset if no revisions are specified.</p>
  1223. </div>
  1224. <p>When two revision arguments are given, then changes are shown
  1225. between those revisions. If only one revision is specified then
  1226. that revision is compared to the working directory, and, when no
  1227. revisions are specified, the working directory files are compared
  1228. to its parent.</p>
  1229. <p>Alternatively you can specify -c/--change with a revision to see
  1230. the changes in that changeset relative to its first parent.</p>
  1231. <p>Without the -a/--text option, diff will avoid generating diffs of
  1232. files it detects as binary. With -a, diff will generate a diff
  1233. anyway, probably with undesirable results.</p>
  1234. <p>Use the -g/--git option to generate diffs in the git extended diff
  1235. format. For more information, read <a class="reference external" href="hg.1.html#diffs"><tt class="docutils literal">hg help diffs</tt></a>.</p>
  1236. <div class="verbose container">
  1237. <p>Examples:</p>
  1238. <ul>
  1239. <li><p class="first">compare a file in the current working directory to its parent:</p>
  1240. <pre class="literal-block">
  1241. hg diff foo.c
  1242. </pre>
  1243. </li>
  1244. <li><p class="first">compare two historical versions of a directory, with rename info:</p>
  1245. <pre class="literal-block">
  1246. hg diff --git -r 1.0:1.2 lib/
  1247. </pre>
  1248. </li>
  1249. <li><p class="first">get change stats relative to the last change on some date:</p>
  1250. <pre class="literal-block">
  1251. hg diff --stat -r &quot;date('may 2')&quot;
  1252. </pre>
  1253. </li>
  1254. <li><p class="first">diff all newly-added files that contain a keyword:</p>
  1255. <pre class="literal-block">
  1256. hg diff &quot;set:added() and grep(GNU)&quot;
  1257. </pre>
  1258. </li>
  1259. <li><p class="first">compare a revision and its parents:</p>
  1260. <pre class="literal-block">
  1261. hg diff -c 9353         # compare against first parent
  1262. hg diff -r 9353^:9353   # same using revset syntax
  1263. hg diff -r 9353^2:9353  # compare against the second parent
  1264. </pre>
  1265. </li>
  1266. </ul>
  1267. </div>
  1268. <p>Returns 0 on success.</p>
  1269. <p>Options:</p>
  1270. <table class="docutils option-list" frame="void" rules="none">
  1271. <col class="option" />
  1272. <col class="description" />
  1273. <tbody valign="top">
  1274. <tr><td class="option-group" colspan="2">
  1275. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  1276. </tr>
  1277. <tr><td>&nbsp;</td><td>revision</td></tr>
  1278. <tr><td class="option-group" colspan="2">
  1279. <kbd><span class="option">-c</span>, <span class="option">--change <var>&lt;REV&gt;</var></span></kbd></td>
  1280. </tr>
  1281. <tr><td>&nbsp;</td><td>change made by revision</td></tr>
  1282. <tr><td class="option-group">
  1283. <kbd><span class="option">-a</span>, <span class="option">--text</span></kbd></td>
  1284. <td>treat all files as text</td></tr>
  1285. <tr><td class="option-group">
  1286. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  1287. <td>use git extended diff format</td></tr>
  1288. <tr><td class="option-group">
  1289. <kbd><span class="option">--nodates</span></kbd></td>
  1290. <td>omit dates from diff headers</td></tr>
  1291. <tr><td class="option-group">
  1292. <kbd><span class="option">--noprefix</span></kbd></td>
  1293. <td>omit a/ and b/ prefixes from filenames</td></tr>
  1294. <tr><td class="option-group" colspan="2">
  1295. <kbd><span class="option">-p</span>, <span class="option">--show-function</span></kbd></td>
  1296. </tr>
  1297. <tr><td>&nbsp;</td><td>show which function each change is in</td></tr>
  1298. <tr><td class="option-group">
  1299. <kbd><span class="option">--reverse</span></kbd></td>
  1300. <td>produce a diff that undoes the changes</td></tr>
  1301. <tr><td class="option-group" colspan="2">
  1302. <kbd><span class="option">-w</span>, <span class="option">--ignore-all-space</span></kbd></td>
  1303. </tr>
  1304. <tr><td>&nbsp;</td><td>ignore white space when comparing lines</td></tr>
  1305. <tr><td class="option-group" colspan="2">
  1306. <kbd><span class="option">-b</span>, <span class="option">--ignore-space-change</span></kbd></td>
  1307. </tr>
  1308. <tr><td>&nbsp;</td><td>ignore changes in the amount of white space</td></tr>
  1309. <tr><td class="option-group" colspan="2">
  1310. <kbd><span class="option">-B</span>, <span class="option">--ignore-blank-lines</span></kbd></td>
  1311. </tr>
  1312. <tr><td>&nbsp;</td><td>ignore changes whose lines are all blank</td></tr>
  1313. <tr><td class="option-group" colspan="2">
  1314. <kbd><span class="option">-U</span>, <span class="option">--unified <var>&lt;NUM&gt;</var></span></kbd></td>
  1315. </tr>
  1316. <tr><td>&nbsp;</td><td>number of lines of context to show</td></tr>
  1317. <tr><td class="option-group">
  1318. <kbd><span class="option">--stat</span></kbd></td>
  1319. <td>output diffstat-style summary of changes</td></tr>
  1320. <tr><td class="option-group">
  1321. <kbd><span class="option">--root <var>&lt;DIR&gt;</var></span></kbd></td>
  1322. <td>produce diffs relative to subdirectory</td></tr>
  1323. <tr><td class="option-group" colspan="2">
  1324. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1325. </tr>
  1326. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  1327. <tr><td class="option-group" colspan="2">
  1328. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1329. </tr>
  1330. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  1331. <tr><td class="option-group">
  1332. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  1333. <td>recurse into subrepositories</td></tr>
  1334. </tbody>
  1335. </table>
  1336. <p>[+] marked option can be specified multiple times</p>
  1337. </div>
  1338. <div class="section" id="export">
  1339. <h2>export</h2>
  1340. <p>dump the header and diffs for one or more changesets:</p>
  1341. <pre class="literal-block">
  1342. hg export [OPTION]... [-o OUTFILESPEC] [-r] [REV]...
  1343. </pre>
  1344. <p>Print the changeset header and diffs for one or more revisions.
  1345. If no revision is given, the parent of the working directory is used.</p>
  1346. <p>The information shown in the changeset header is: author, date,
  1347. branch name (if non-default), changeset hash, parent(s) and commit
  1348. comment.</p>
  1349. <div class="note">
  1350. <p class="first admonition-title">Note</p>
  1351. <p class="last">export may generate unexpected diff output for merge
  1352. changesets, as it will compare the merge changeset against its
  1353. first parent only.</p>
  1354. </div>
  1355. <p>Output may be to a file, in which case the name of the file is
  1356. given using a format string. The formatting rules are as follows:</p>
  1357. <table class="docutils field-list" frame="void" rules="none">
  1358. <col class="field-name" />
  1359. <col class="field-body" />
  1360. <tbody valign="top">
  1361. <tr class="field"><th class="field-name"><tt class="docutils literal">%%</tt>:</th><td class="field-body">literal &quot;%&quot; character</td>
  1362. </tr>
  1363. <tr class="field"><th class="field-name"><tt class="docutils literal">%H</tt>:</th><td class="field-body">changeset hash (40 hexadecimal digits)</td>
  1364. </tr>
  1365. <tr class="field"><th class="field-name"><tt class="docutils literal">%N</tt>:</th><td class="field-body">number of patches being generated</td>
  1366. </tr>
  1367. <tr class="field"><th class="field-name"><tt class="docutils literal">%R</tt>:</th><td class="field-body">changeset revision number</td>
  1368. </tr>
  1369. <tr class="field"><th class="field-name"><tt class="docutils literal">%b</tt>:</th><td class="field-body">basename of the exporting repository</td>
  1370. </tr>
  1371. <tr class="field"><th class="field-name"><tt class="docutils literal">%h</tt>:</th><td class="field-body">short-form changeset hash (12 hexadecimal digits)</td>
  1372. </tr>
  1373. <tr class="field"><th class="field-name"><tt class="docutils literal">%m</tt>:</th><td class="field-body">first line of the commit message (only alphanumeric characters)</td>
  1374. </tr>
  1375. <tr class="field"><th class="field-name"><tt class="docutils literal">%n</tt>:</th><td class="field-body">zero-padded sequence number, starting at 1</td>
  1376. </tr>
  1377. <tr class="field"><th class="field-name"><tt class="docutils literal">%r</tt>:</th><td class="field-body">zero-padded changeset revision number</td>
  1378. </tr>
  1379. </tbody>
  1380. </table>
  1381. <p>Without the -a/--text option, export will avoid generating diffs
  1382. of files it detects as binary. With -a, export will generate a
  1383. diff anyway, probably with undesirable results.</p>
  1384. <p>Use the -g/--git option to generate diffs in the git extended diff
  1385. format. See <a class="reference external" href="hg.1.html#diffs"><tt class="docutils literal">hg help diffs</tt></a> for more information.</p>
  1386. <p>With the --switch-parent option, the diff will be against the
  1387. second parent. It can be useful to review a merge.</p>
  1388. <div class="verbose container">
  1389. <p>Examples:</p>
  1390. <ul>
  1391. <li><p class="first">use export and import to transplant a bugfix to the current
  1392. branch:</p>
  1393. <pre class="literal-block">
  1394. hg export -r 9353 | hg import -
  1395. </pre>
  1396. </li>
  1397. <li><p class="first">export all the changesets between two revisions to a file with
  1398. rename information:</p>
  1399. <pre class="literal-block">
  1400. hg export --git -r 123:150 &gt; changes.txt
  1401. </pre>
  1402. </li>
  1403. <li><p class="first">split outgoing changes into a series of patches with
  1404. descriptive names:</p>
  1405. <pre class="literal-block">
  1406. hg export -r &quot;outgoing()&quot; -o &quot;%n-%m.patch&quot;
  1407. </pre>
  1408. </li>
  1409. </ul>
  1410. </div>
  1411. <p>Returns 0 on success.</p>
  1412. <p>Options:</p>
  1413. <table class="docutils option-list" frame="void" rules="none">
  1414. <col class="option" />
  1415. <col class="description" />
  1416. <tbody valign="top">
  1417. <tr><td class="option-group" colspan="2">
  1418. <kbd><span class="option">-o</span>, <span class="option">--output <var>&lt;FORMAT&gt;</var></span></kbd></td>
  1419. </tr>
  1420. <tr><td>&nbsp;</td><td>print output to file with formatted name</td></tr>
  1421. <tr><td class="option-group" colspan="2">
  1422. <kbd><span class="option">--switch-parent</span></kbd></td>
  1423. </tr>
  1424. <tr><td>&nbsp;</td><td>diff against the second parent</td></tr>
  1425. <tr><td class="option-group" colspan="2">
  1426. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  1427. </tr>
  1428. <tr><td>&nbsp;</td><td>revisions to export</td></tr>
  1429. <tr><td class="option-group">
  1430. <kbd><span class="option">-a</span>, <span class="option">--text</span></kbd></td>
  1431. <td>treat all files as text</td></tr>
  1432. <tr><td class="option-group">
  1433. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  1434. <td>use git extended diff format</td></tr>
  1435. <tr><td class="option-group">
  1436. <kbd><span class="option">--nodates</span></kbd></td>
  1437. <td>omit dates from diff headers</td></tr>
  1438. </tbody>
  1439. </table>
  1440. <p>[+] marked option can be specified multiple times</p>
  1441. </div>
  1442. <div class="section" id="files">
  1443. <h2>files</h2>
  1444. <p>list tracked files:</p>
  1445. <pre class="literal-block">
  1446. hg files [OPTION]... [PATTERN]...
  1447. </pre>
  1448. <p>Print files under Mercurial control in the working directory or
  1449. specified revision whose names match the given patterns (excluding
  1450. removed files).</p>
  1451. <p>If no patterns are given to match, this command prints the names
  1452. of all files under Mercurial control in the working directory.</p>
  1453. <div class="verbose container">
  1454. <p>Examples:</p>
  1455. <ul>
  1456. <li><p class="first">list all files under the current directory:</p>
  1457. <pre class="literal-block">
  1458. hg files .
  1459. </pre>
  1460. </li>
  1461. <li><p class="first">shows sizes and flags for current revision:</p>
  1462. <pre class="literal-block">
  1463. hg files -vr .
  1464. </pre>
  1465. </li>
  1466. <li><p class="first">list all files named README:</p>
  1467. <pre class="literal-block">
  1468. hg files -I &quot;**/README&quot;
  1469. </pre>
  1470. </li>
  1471. <li><p class="first">list all binary files:</p>
  1472. <pre class="literal-block">
  1473. hg files &quot;set:binary()&quot;
  1474. </pre>
  1475. </li>
  1476. <li><p class="first">find files containing a regular expression:</p>
  1477. <pre class="literal-block">
  1478. hg files &quot;set:grep('bob')&quot;
  1479. </pre>
  1480. </li>
  1481. <li><p class="first">search tracked file contents with xargs and grep:</p>
  1482. <pre class="literal-block">
  1483. hg files -0 | xargs -0 grep foo
  1484. </pre>
  1485. </li>
  1486. </ul>
  1487. </div>
  1488. <p>See <a class="reference external" href="hg.1.html#patterns"><tt class="docutils literal">hg help patterns</tt></a> and <a class="reference external" href="hg.1.html#filesets"><tt class="docutils literal">hg help filesets</tt></a> for more information
  1489. on specifying file patterns.</p>
  1490. <p>Returns 0 if a match is found, 1 otherwise.</p>
  1491. <p>Options:</p>
  1492. <table class="docutils option-list" frame="void" rules="none">
  1493. <col class="option" />
  1494. <col class="description" />
  1495. <tbody valign="top">
  1496. <tr><td class="option-group" colspan="2">
  1497. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  1498. </tr>
  1499. <tr><td>&nbsp;</td><td>search the repository as it is in REV</td></tr>
  1500. <tr><td class="option-group">
  1501. <kbd><span class="option">-0</span>, <span class="option">--print0</span></kbd></td>
  1502. <td>end filenames with NUL, for use with xargs</td></tr>
  1503. <tr><td class="option-group" colspan="2">
  1504. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1505. </tr>
  1506. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  1507. <tr><td class="option-group" colspan="2">
  1508. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1509. </tr>
  1510. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  1511. <tr><td class="option-group" colspan="2">
  1512. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  1513. </tr>
  1514. <tr><td>&nbsp;</td><td>display with template (EXPERIMENTAL)</td></tr>
  1515. <tr><td class="option-group">
  1516. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  1517. <td>recurse into subrepositories</td></tr>
  1518. </tbody>
  1519. </table>
  1520. <p>[+] marked option can be specified multiple times</p>
  1521. </div>
  1522. <div class="section" id="forget">
  1523. <h2>forget</h2>
  1524. <p>forget the specified files on the next commit:</p>
  1525. <pre class="literal-block">
  1526. hg forget [OPTION]... FILE...
  1527. </pre>
  1528. <p>Mark the specified files so they will no longer be tracked
  1529. after the next commit.</p>
  1530. <p>This only removes files from the current branch, not from the
  1531. entire project history, and it does not delete them from the
  1532. working directory.</p>
  1533. <p>To delete the file from the working directory, see <a class="reference external" href="hg.1.html#remove"><tt class="docutils literal">hg remove</tt></a>.</p>
  1534. <p>To undo a forget before the next commit, see <a class="reference external" href="hg.1.html#add"><tt class="docutils literal">hg add</tt></a>.</p>
  1535. <div class="verbose container">
  1536. <p>Examples:</p>
  1537. <ul>
  1538. <li><p class="first">forget newly-added binary files:</p>
  1539. <pre class="literal-block">
  1540. hg forget &quot;set:added() and binary()&quot;
  1541. </pre>
  1542. </li>
  1543. <li><p class="first">forget files that would be excluded by .hgignore:</p>
  1544. <pre class="literal-block">
  1545. hg forget &quot;set:hgignore()&quot;
  1546. </pre>
  1547. </li>
  1548. </ul>
  1549. </div>
  1550. <p>Returns 0 on success.</p>
  1551. <p>Options:</p>
  1552. <table class="docutils option-list" frame="void" rules="none">
  1553. <col class="option" />
  1554. <col class="description" />
  1555. <tbody valign="top">
  1556. <tr><td class="option-group" colspan="2">
  1557. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1558. </tr>
  1559. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  1560. <tr><td class="option-group" colspan="2">
  1561. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1562. </tr>
  1563. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  1564. </tbody>
  1565. </table>
  1566. <p>[+] marked option can be specified multiple times</p>
  1567. </div>
  1568. <div class="section" id="graft">
  1569. <h2>graft</h2>
  1570. <p>copy changes from other branches onto the current branch:</p>
  1571. <pre class="literal-block">
  1572. hg graft [OPTION]... [-r] REV...
  1573. </pre>
  1574. <p>This command uses Mercurial's merge logic to copy individual
  1575. changes from other branches without merging branches in the
  1576. history graph. This is sometimes known as 'backporting' or
  1577. 'cherry-picking'. By default, graft will copy user, date, and
  1578. description from the source changesets.</p>
  1579. <p>Changesets that are ancestors of the current revision, that have
  1580. already been grafted, or that are merges will be skipped.</p>
  1581. <p>If --log is specified, log messages will have a comment appended
  1582. of the form:</p>
  1583. <pre class="literal-block">
  1584. (grafted from CHANGESETHASH)
  1585. </pre>
  1586. <p>If --force is specified, revisions will be grafted even if they
  1587. are already ancestors of or have been grafted to the destination.
  1588. This is useful when the revisions have since been backed out.</p>
  1589. <p>If a graft merge results in conflicts, the graft process is
  1590. interrupted so that the current merge can be manually resolved.
  1591. Once all conflicts are addressed, the graft process can be
  1592. continued with the -c/--continue option.</p>
  1593. <div class="note">
  1594. <p class="first admonition-title">Note</p>
  1595. <p class="last">The -c/--continue option does not reapply earlier options, except
  1596. for --force.</p>
  1597. </div>
  1598. <div class="verbose container">
  1599. <p>Examples:</p>
  1600. <ul>
  1601. <li><p class="first">copy a single change to the stable branch and edit its description:</p>
  1602. <pre class="literal-block">
  1603. hg update stable
  1604. hg graft --edit 9393
  1605. </pre>
  1606. </li>
  1607. <li><p class="first">graft a range of changesets with one exception, updating dates:</p>
  1608. <pre class="literal-block">
  1609. hg graft -D &quot;2085::2093 and not 2091&quot;
  1610. </pre>
  1611. </li>
  1612. <li><p class="first">continue a graft after resolving conflicts:</p>
  1613. <pre class="literal-block">
  1614. hg graft -c
  1615. </pre>
  1616. </li>
  1617. <li><p class="first">show the source of a grafted changeset:</p>
  1618. <pre class="literal-block">
  1619. hg log --debug -r .
  1620. </pre>
  1621. </li>
  1622. </ul>
  1623. </div>
  1624. <p>See <a class="reference external" href="hg.1.html#revisions"><tt class="docutils literal">hg help revisions</tt></a> and <a class="reference external" href="hg.1.html#revsets"><tt class="docutils literal">hg help revsets</tt></a> for more about
  1625. specifying revisions.</p>
  1626. <p>Returns 0 on successful completion.</p>
  1627. <p>Options:</p>
  1628. <table class="docutils option-list" frame="void" rules="none">
  1629. <col class="option" />
  1630. <col class="description" />
  1631. <tbody valign="top">
  1632. <tr><td class="option-group" colspan="2">
  1633. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  1634. </tr>
  1635. <tr><td>&nbsp;</td><td>revisions to graft</td></tr>
  1636. <tr><td class="option-group">
  1637. <kbd><span class="option">-c</span>, <span class="option">--continue</span></kbd></td>
  1638. <td>resume interrupted graft</td></tr>
  1639. <tr><td class="option-group">
  1640. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  1641. <td>invoke editor on commit messages</td></tr>
  1642. <tr><td class="option-group">
  1643. <kbd><span class="option">--log</span></kbd></td>
  1644. <td>append graft info to log message</td></tr>
  1645. <tr><td class="option-group">
  1646. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  1647. <td>force graft</td></tr>
  1648. <tr><td class="option-group" colspan="2">
  1649. <kbd><span class="option">-D</span>, <span class="option">--currentdate</span></kbd></td>
  1650. </tr>
  1651. <tr><td>&nbsp;</td><td>record the current date as commit date</td></tr>
  1652. <tr><td class="option-group" colspan="2">
  1653. <kbd><span class="option">-U</span>, <span class="option">--currentuser</span></kbd></td>
  1654. </tr>
  1655. <tr><td>&nbsp;</td><td>record the current user as committer</td></tr>
  1656. <tr><td class="option-group" colspan="2">
  1657. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  1658. </tr>
  1659. <tr><td>&nbsp;</td><td>record the specified date as commit date</td></tr>
  1660. <tr><td class="option-group" colspan="2">
  1661. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  1662. </tr>
  1663. <tr><td>&nbsp;</td><td>record the specified user as committer</td></tr>
  1664. <tr><td class="option-group" colspan="2">
  1665. <kbd><span class="option">-t</span>, <span class="option">--tool <var>&lt;VALUE&gt;</var></span></kbd></td>
  1666. </tr>
  1667. <tr><td>&nbsp;</td><td>specify merge tool</td></tr>
  1668. <tr><td class="option-group">
  1669. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  1670. <td>do not perform actions, just print output</td></tr>
  1671. </tbody>
  1672. </table>
  1673. <p>[+] marked option can be specified multiple times</p>
  1674. </div>
  1675. <div class="section" id="grep">
  1676. <h2>grep</h2>
  1677. <p>search for a pattern in specified files and revisions:</p>
  1678. <pre class="literal-block">
  1679. hg grep [OPTION]... PATTERN [FILE]...
  1680. </pre>
  1681. <p>Search revisions of files for a regular expression.</p>
  1682. <p>This command behaves differently than Unix grep. It only accepts
  1683. Python/Perl regexps. It searches repository history, not the
  1684. working directory. It always prints the revision number in which a
  1685. match appears.</p>
  1686. <p>By default, grep only prints output for the first revision of a
  1687. file in which it finds a match. To get it to print every revision
  1688. that contains a change in match status (&quot;-&quot; for a match that
  1689. becomes a non-match, or &quot;+&quot; for a non-match that becomes a match),
  1690. use the --all flag.</p>
  1691. <p>Returns 0 if a match is found, 1 otherwise.</p>
  1692. <p>Options:</p>
  1693. <table class="docutils option-list" frame="void" rules="none">
  1694. <col class="option" />
  1695. <col class="description" />
  1696. <tbody valign="top">
  1697. <tr><td class="option-group">
  1698. <kbd><span class="option">-0</span>, <span class="option">--print0</span></kbd></td>
  1699. <td>end fields with NUL</td></tr>
  1700. <tr><td class="option-group">
  1701. <kbd><span class="option">--all</span></kbd></td>
  1702. <td>print all revisions that match</td></tr>
  1703. <tr><td class="option-group">
  1704. <kbd><span class="option">-a</span>, <span class="option">--text</span></kbd></td>
  1705. <td>treat all files as text</td></tr>
  1706. <tr><td class="option-group">
  1707. <kbd><span class="option">-f</span>, <span class="option">--follow</span></kbd></td>
  1708. <td>follow changeset history, or file history across copies and renames</td></tr>
  1709. <tr><td class="option-group" colspan="2">
  1710. <kbd><span class="option">-i</span>, <span class="option">--ignore-case</span></kbd></td>
  1711. </tr>
  1712. <tr><td>&nbsp;</td><td>ignore case when matching</td></tr>
  1713. <tr><td class="option-group" colspan="2">
  1714. <kbd><span class="option">-l</span>, <span class="option">--files-with-matches</span></kbd></td>
  1715. </tr>
  1716. <tr><td>&nbsp;</td><td>print only filenames and revisions that match</td></tr>
  1717. <tr><td class="option-group" colspan="2">
  1718. <kbd><span class="option">-n</span>, <span class="option">--line-number</span></kbd></td>
  1719. </tr>
  1720. <tr><td>&nbsp;</td><td>print matching line numbers</td></tr>
  1721. <tr><td class="option-group" colspan="2">
  1722. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  1723. </tr>
  1724. <tr><td>&nbsp;</td><td>only search files changed within revision range</td></tr>
  1725. <tr><td class="option-group">
  1726. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  1727. <td>list the author (long with -v)</td></tr>
  1728. <tr><td class="option-group">
  1729. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  1730. <td>list the date (short with -q)</td></tr>
  1731. <tr><td class="option-group" colspan="2">
  1732. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1733. </tr>
  1734. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  1735. <tr><td class="option-group" colspan="2">
  1736. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  1737. </tr>
  1738. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  1739. </tbody>
  1740. </table>
  1741. <p>[+] marked option can be specified multiple times</p>
  1742. </div>
  1743. <div class="section" id="heads">
  1744. <h2>heads</h2>
  1745. <p>show branch heads:</p>
  1746. <pre class="literal-block">
  1747. hg heads [-ct] [-r STARTREV] [REV]...
  1748. </pre>
  1749. <p>With no arguments, show all open branch heads in the repository.
  1750. Branch heads are changesets that have no descendants on the
  1751. same branch. They are where development generally takes place and
  1752. are the usual targets for update and merge operations.</p>
  1753. <p>If one or more REVs are given, only open branch heads on the
  1754. branches associated with the specified changesets are shown. This
  1755. means that you can use <a class="reference external" href="hg.1.html#heads"><tt class="docutils literal">hg heads .</tt></a> to see the heads on the
  1756. currently checked-out branch.</p>
  1757. <p>If -c/--closed is specified, also show branch heads marked closed
  1758. (see <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit <span class="pre">--close-branch</span></tt></a>).</p>
  1759. <p>If STARTREV is specified, only those heads that are descendants of
  1760. STARTREV will be displayed.</p>
  1761. <p>If -t/--topo is specified, named branch mechanics will be ignored and only
  1762. topological heads (changesets with no children) will be shown.</p>
  1763. <p>Returns 0 if matching heads are found, 1 if not.</p>
  1764. <p>Options:</p>
  1765. <table class="docutils option-list" frame="void" rules="none">
  1766. <col class="option" />
  1767. <col class="description" />
  1768. <tbody valign="top">
  1769. <tr><td class="option-group" colspan="2">
  1770. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;STARTREV&gt;</var></span></kbd></td>
  1771. </tr>
  1772. <tr><td>&nbsp;</td><td>show only heads which are descendants of STARTREV</td></tr>
  1773. <tr><td class="option-group">
  1774. <kbd><span class="option">-t</span>, <span class="option">--topo</span></kbd></td>
  1775. <td>show topological heads only</td></tr>
  1776. <tr><td class="option-group">
  1777. <kbd><span class="option">-a</span>, <span class="option">--active</span></kbd></td>
  1778. <td>show active branchheads only (DEPRECATED)</td></tr>
  1779. <tr><td class="option-group">
  1780. <kbd><span class="option">-c</span>, <span class="option">--closed</span></kbd></td>
  1781. <td>show normal and closed branch heads</td></tr>
  1782. <tr><td class="option-group" colspan="2">
  1783. <kbd><span class="option">--style <var>&lt;STYLE&gt;</var></span></kbd></td>
  1784. </tr>
  1785. <tr><td>&nbsp;</td><td>display using template map file (DEPRECATED)</td></tr>
  1786. <tr><td class="option-group" colspan="2">
  1787. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  1788. </tr>
  1789. <tr><td>&nbsp;</td><td>display with template</td></tr>
  1790. </tbody>
  1791. </table>
  1792. </div>
  1793. <div class="section" id="help">
  1794. <h2>help</h2>
  1795. <p>show help for a given topic or a help overview:</p>
  1796. <pre class="literal-block">
  1797. hg help [-ec] [TOPIC]
  1798. </pre>
  1799. <p>With no arguments, print a list of commands with short help messages.</p>
  1800. <p>Given a topic, extension, or command name, print help for that
  1801. topic.</p>
  1802. <p>Returns 0 if successful.</p>
  1803. <p>Options:</p>
  1804. <table class="docutils option-list" frame="void" rules="none">
  1805. <col class="option" />
  1806. <col class="description" />
  1807. <tbody valign="top">
  1808. <tr><td class="option-group" colspan="2">
  1809. <kbd><span class="option">-e</span>, <span class="option">--extension</span></kbd></td>
  1810. </tr>
  1811. <tr><td>&nbsp;</td><td>show only help for extensions</td></tr>
  1812. <tr><td class="option-group">
  1813. <kbd><span class="option">-c</span>, <span class="option">--command</span></kbd></td>
  1814. <td>show only help for commands</td></tr>
  1815. <tr><td class="option-group" colspan="2">
  1816. <kbd><span class="option">-k</span>, <span class="option">--keyword <var>&lt;VALUE&gt;</var></span></kbd></td>
  1817. </tr>
  1818. <tr><td>&nbsp;</td><td>show topics matching keyword</td></tr>
  1819. </tbody>
  1820. </table>
  1821. </div>
  1822. <div class="section" id="identify">
  1823. <h2>identify</h2>
  1824. <p>identify the working directory or specified revision:</p>
  1825. <pre class="literal-block">
  1826. hg identify [-nibtB] [-r REV] [SOURCE]
  1827. </pre>
  1828. <p>Print a summary identifying the repository state at REV using one or
  1829. two parent hash identifiers, followed by a &quot;+&quot; if the working
  1830. directory has uncommitted changes, the branch name (if not default),
  1831. a list of tags, and a list of bookmarks.</p>
  1832. <p>When REV is not given, print a summary of the current state of the
  1833. repository.</p>
  1834. <p>Specifying a path to a repository root or Mercurial bundle will
  1835. cause lookup to operate on that repository/bundle.</p>
  1836. <div class="verbose container">
  1837. <p>Examples:</p>
  1838. <ul>
  1839. <li><p class="first">generate a build identifier for the working directory:</p>
  1840. <pre class="literal-block">
  1841. hg id --id &gt; build-id.dat
  1842. </pre>
  1843. </li>
  1844. <li><p class="first">find the revision corresponding to a tag:</p>
  1845. <pre class="literal-block">
  1846. hg id -n -r 1.3
  1847. </pre>
  1848. </li>
  1849. <li><p class="first">check the most recent revision of a remote repository:</p>
  1850. <pre class="literal-block">
  1851. hg id -r tip http://selenic.com/hg/
  1852. </pre>
  1853. </li>
  1854. </ul>
  1855. </div>
  1856. <p>Returns 0 if successful.</p>
  1857. <p>Options:</p>
  1858. <table class="docutils option-list" frame="void" rules="none">
  1859. <col class="option" />
  1860. <col class="description" />
  1861. <tbody valign="top">
  1862. <tr><td class="option-group" colspan="2">
  1863. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  1864. </tr>
  1865. <tr><td>&nbsp;</td><td>identify the specified revision</td></tr>
  1866. <tr><td class="option-group">
  1867. <kbd><span class="option">-n</span>, <span class="option">--num</span></kbd></td>
  1868. <td>show local revision number</td></tr>
  1869. <tr><td class="option-group">
  1870. <kbd><span class="option">-i</span>, <span class="option">--id</span></kbd></td>
  1871. <td>show global revision id</td></tr>
  1872. <tr><td class="option-group">
  1873. <kbd><span class="option">-b</span>, <span class="option">--branch</span></kbd></td>
  1874. <td>show branch</td></tr>
  1875. <tr><td class="option-group">
  1876. <kbd><span class="option">-t</span>, <span class="option">--tags</span></kbd></td>
  1877. <td>show tags</td></tr>
  1878. <tr><td class="option-group" colspan="2">
  1879. <kbd><span class="option">-B</span>, <span class="option">--bookmarks</span></kbd></td>
  1880. </tr>
  1881. <tr><td>&nbsp;</td><td>show bookmarks</td></tr>
  1882. <tr><td class="option-group" colspan="2">
  1883. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  1884. </tr>
  1885. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  1886. <tr><td class="option-group" colspan="2">
  1887. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  1888. </tr>
  1889. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  1890. <tr><td class="option-group">
  1891. <kbd><span class="option">--insecure</span></kbd></td>
  1892. <td><p class="first">do not verify server certificate (ignoring web.cacerts config)</p>
  1893. <p class="last">aliases: id</p>
  1894. </td></tr>
  1895. </tbody>
  1896. </table>
  1897. </div>
  1898. <div class="section" id="import">
  1899. <h2>import</h2>
  1900. <p>import an ordered set of patches:</p>
  1901. <pre class="literal-block">
  1902. hg import [OPTION]... PATCH...
  1903. </pre>
  1904. <p>Import a list of patches and commit them individually (unless
  1905. --no-commit is specified).</p>
  1906. <p>Because import first applies changes to the working directory,
  1907. import will abort if there are outstanding changes.</p>
  1908. <p>You can import a patch straight from a mail message. Even patches
  1909. as attachments work (to use the body part, it must have type
  1910. text/plain or text/x-patch). From and Subject headers of email
  1911. message are used as default committer and commit message. All
  1912. text/plain body parts before first diff are added to commit
  1913. message.</p>
  1914. <p>If the imported patch was generated by <a class="reference external" href="hg.1.html#export"><tt class="docutils literal">hg export</tt></a>, user and
  1915. description from patch override values from message headers and
  1916. body. Values given on command line with -m/--message and -u/--user
  1917. override these.</p>
  1918. <p>If --exact is specified, import will set the working directory to
  1919. the parent of each patch before applying it, and will abort if the
  1920. resulting changeset has a different ID than the one recorded in
  1921. the patch. This may happen due to character set problems or other
  1922. deficiencies in the text patch format.</p>
  1923. <p>Use --bypass to apply and commit patches directly to the
  1924. repository, not touching the working directory. Without --exact,
  1925. patches will be applied on top of the working directory parent
  1926. revision.</p>
  1927. <p>With -s/--similarity, hg will attempt to discover renames and
  1928. copies in the patch in the same way as <a class="reference external" href="hg.1.html#addremove"><tt class="docutils literal">hg addremove</tt></a>.</p>
  1929. <p>Use --partial to ensure a changeset will be created from the patch
  1930. even if some hunks fail to apply. Hunks that fail to apply will be
  1931. written to a &lt;target-file&gt;.rej file. Conflicts can then be resolved
  1932. by hand before <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit <span class="pre">--amend</span></tt></a> is run to update the created
  1933. changeset. This flag exists to let people import patches that
  1934. partially apply without losing the associated metadata (author,
  1935. date, description, ...). Note that when none of the hunk applies
  1936. cleanly, <a class="reference external" href="hg.1.html#import"><tt class="docutils literal">hg import <span class="pre">--partial</span></tt></a> will create an empty changeset,
  1937. importing only the patch metadata.</p>
  1938. <p>It is possible to use external patch programs to perform the patch
  1939. by setting the <tt class="docutils literal">ui.patch</tt> configuration option. For the default
  1940. internal tool, the fuzz can also be configured via <tt class="docutils literal">patch.fuzz</tt>.
  1941. See <a class="reference external" href="hg.1.html#config"><tt class="docutils literal">hg help config</tt></a> for more information about configuration
  1942. files and how to use these options.</p>
  1943. <p>To read a patch from standard input, use &quot;-&quot; as the patch name. If
  1944. a URL is specified, the patch will be downloaded from it.
  1945. See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for a list of formats valid for -d/--date.</p>
  1946. <div class="verbose container">
  1947. <p>Examples:</p>
  1948. <ul>
  1949. <li><p class="first">import a traditional patch from a website and detect renames:</p>
  1950. <pre class="literal-block">
  1951. hg import -s 80 http://example.com/bugfix.patch
  1952. </pre>
  1953. </li>
  1954. <li><p class="first">import a changeset from an hgweb server:</p>
  1955. <pre class="literal-block">
  1956. hg import http://www.selenic.com/hg/rev/5ca8c111e9aa
  1957. </pre>
  1958. </li>
  1959. <li><p class="first">import all the patches in an Unix-style mbox:</p>
  1960. <pre class="literal-block">
  1961. hg import incoming-patches.mbox
  1962. </pre>
  1963. </li>
  1964. <li><p class="first">attempt to exactly restore an exported changeset (not always
  1965. possible):</p>
  1966. <pre class="literal-block">
  1967. hg import --exact proposed-fix.patch
  1968. </pre>
  1969. </li>
  1970. <li><p class="first">use an external tool to apply a patch which is too fuzzy for
  1971. the default internal tool.</p>
  1972. <blockquote>
  1973. <p>hg import --config ui.patch=&quot;patch --merge&quot; fuzzy.patch</p>
  1974. </blockquote>
  1975. </li>
  1976. <li><p class="first">change the default fuzzing from 2 to a less strict 7</p>
  1977. <blockquote>
  1978. <p>hg import --config ui.fuzz=7 fuzz.patch</p>
  1979. </blockquote>
  1980. </li>
  1981. </ul>
  1982. </div>
  1983. <p>Returns 0 on success, 1 on partial success (see --partial).</p>
  1984. <p>Options:</p>
  1985. <table class="docutils option-list" frame="void" rules="none">
  1986. <col class="option" />
  1987. <col class="description" />
  1988. <tbody valign="top">
  1989. <tr><td class="option-group" colspan="2">
  1990. <kbd><span class="option">-p</span>, <span class="option">--strip <var>&lt;NUM&gt;</var></span></kbd></td>
  1991. </tr>
  1992. <tr><td>&nbsp;</td><td>directory strip option for patch. This has the same meaning as the corresponding patch option (default: 1)</td></tr>
  1993. <tr><td class="option-group" colspan="2">
  1994. <kbd><span class="option">-b</span>, <span class="option">--base <var>&lt;PATH&gt;</var></span></kbd></td>
  1995. </tr>
  1996. <tr><td>&nbsp;</td><td>base path (DEPRECATED)</td></tr>
  1997. <tr><td class="option-group">
  1998. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  1999. <td>invoke editor on commit messages</td></tr>
  2000. <tr><td class="option-group">
  2001. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  2002. <td>skip check for outstanding uncommitted changes (DEPRECATED)</td></tr>
  2003. <tr><td class="option-group">
  2004. <kbd><span class="option">--no-commit</span></kbd></td>
  2005. <td>don't commit, just update the working directory</td></tr>
  2006. <tr><td class="option-group">
  2007. <kbd><span class="option">--bypass</span></kbd></td>
  2008. <td>apply patch without touching the working directory</td></tr>
  2009. <tr><td class="option-group">
  2010. <kbd><span class="option">--partial</span></kbd></td>
  2011. <td>commit even if some hunks fail</td></tr>
  2012. <tr><td class="option-group">
  2013. <kbd><span class="option">--exact</span></kbd></td>
  2014. <td>apply patch to the nodes from which it was generated</td></tr>
  2015. <tr><td class="option-group">
  2016. <kbd><span class="option">--prefix <var>&lt;DIR&gt;</var></span></kbd></td>
  2017. <td>apply patch to subdirectory</td></tr>
  2018. <tr><td class="option-group" colspan="2">
  2019. <kbd><span class="option">--import-branch</span></kbd></td>
  2020. </tr>
  2021. <tr><td>&nbsp;</td><td>use any branch information in patch (implied by --exact)</td></tr>
  2022. <tr><td class="option-group" colspan="2">
  2023. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  2024. </tr>
  2025. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  2026. <tr><td class="option-group" colspan="2">
  2027. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  2028. </tr>
  2029. <tr><td>&nbsp;</td><td>read commit message from file</td></tr>
  2030. <tr><td class="option-group" colspan="2">
  2031. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  2032. </tr>
  2033. <tr><td>&nbsp;</td><td>record the specified date as commit date</td></tr>
  2034. <tr><td class="option-group" colspan="2">
  2035. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  2036. </tr>
  2037. <tr><td>&nbsp;</td><td>record the specified user as committer</td></tr>
  2038. <tr><td class="option-group" colspan="2">
  2039. <kbd><span class="option">-s</span>, <span class="option">--similarity <var>&lt;SIMILARITY&gt;</var></span></kbd></td>
  2040. </tr>
  2041. <tr><td>&nbsp;</td><td><p class="first">guess renamed files by similarity (0&lt;=s&lt;=100)</p>
  2042. <p class="last">aliases: patch</p>
  2043. </td></tr>
  2044. </tbody>
  2045. </table>
  2046. </div>
  2047. <div class="section" id="incoming">
  2048. <h2>incoming</h2>
  2049. <p>show new changesets found in source:</p>
  2050. <pre class="literal-block">
  2051. hg incoming [-p] [-n] [-M] [-f] [-r REV]... [--bundle FILENAME] [SOURCE]
  2052. </pre>
  2053. <p>Show new changesets found in the specified path/URL or the default
  2054. pull location. These are the changesets that would have been pulled
  2055. if a pull at the time you issued this command.</p>
  2056. <p>See pull for valid source format details.</p>
  2057. <div class="verbose container">
  2058. <p>With -B/--bookmarks, the result of bookmark comparison between
  2059. local and remote repositories is displayed. With -v/--verbose,
  2060. status is also displayed for each bookmark like below:</p>
  2061. <pre class="literal-block">
  2062. BM1               01234567890a added
  2063. BM2               1234567890ab advanced
  2064. BM3               234567890abc diverged
  2065. BM4               34567890abcd changed
  2066. </pre>
  2067. <p>The action taken locally when pulling depends on the
  2068. status of each bookmark:</p>
  2069. <table class="docutils field-list" frame="void" rules="none">
  2070. <col class="field-name" />
  2071. <col class="field-body" />
  2072. <tbody valign="top">
  2073. <tr class="field"><th class="field-name"><tt class="docutils literal">added</tt>:</th><td class="field-body">pull will create it</td>
  2074. </tr>
  2075. <tr class="field"><th class="field-name"><tt class="docutils literal">advanced</tt>:</th><td class="field-body">pull will update it</td>
  2076. </tr>
  2077. <tr class="field"><th class="field-name"><tt class="docutils literal">diverged</tt>:</th><td class="field-body">pull will create a divergent bookmark</td>
  2078. </tr>
  2079. <tr class="field"><th class="field-name"><tt class="docutils literal">changed</tt>:</th><td class="field-body">result depends on remote changesets</td>
  2080. </tr>
  2081. </tbody>
  2082. </table>
  2083. <p>From the point of view of pulling behavior, bookmark
  2084. existing only in the remote repository are treated as <tt class="docutils literal">added</tt>,
  2085. even if it is in fact locally deleted.</p>
  2086. </div>
  2087. <div class="verbose container">
  2088. <p>For remote repository, using --bundle avoids downloading the
  2089. changesets twice if the incoming is followed by a pull.</p>
  2090. <p>Examples:</p>
  2091. <ul>
  2092. <li><p class="first">show incoming changes with patches and full description:</p>
  2093. <pre class="literal-block">
  2094. hg incoming -vp
  2095. </pre>
  2096. </li>
  2097. <li><p class="first">show incoming changes excluding merges, store a bundle:</p>
  2098. <pre class="literal-block">
  2099. hg in -vpM --bundle incoming.hg
  2100. hg pull incoming.hg
  2101. </pre>
  2102. </li>
  2103. <li><p class="first">briefly list changes inside a bundle:</p>
  2104. <pre class="literal-block">
  2105. hg in changes.hg -T &quot;{desc|firstline}\n&quot;
  2106. </pre>
  2107. </li>
  2108. </ul>
  2109. </div>
  2110. <p>Returns 0 if there are incoming changes, 1 otherwise.</p>
  2111. <p>Options:</p>
  2112. <table class="docutils option-list" frame="void" rules="none">
  2113. <col class="option" />
  2114. <col class="description" />
  2115. <tbody valign="top">
  2116. <tr><td class="option-group">
  2117. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  2118. <td>run even if remote repository is unrelated</td></tr>
  2119. <tr><td class="option-group" colspan="2">
  2120. <kbd><span class="option">-n</span>, <span class="option">--newest-first</span></kbd></td>
  2121. </tr>
  2122. <tr><td>&nbsp;</td><td>show newest record first</td></tr>
  2123. <tr><td class="option-group" colspan="2">
  2124. <kbd><span class="option">--bundle <var>&lt;FILE&gt;</var></span></kbd></td>
  2125. </tr>
  2126. <tr><td>&nbsp;</td><td>file to store the bundles into</td></tr>
  2127. <tr><td class="option-group" colspan="2">
  2128. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  2129. </tr>
  2130. <tr><td>&nbsp;</td><td>a remote changeset intended to be added</td></tr>
  2131. <tr><td class="option-group" colspan="2">
  2132. <kbd><span class="option">-B</span>, <span class="option">--bookmarks</span></kbd></td>
  2133. </tr>
  2134. <tr><td>&nbsp;</td><td>compare bookmarks</td></tr>
  2135. <tr><td class="option-group" colspan="2">
  2136. <kbd><span class="option">-b</span>, <span class="option">--branch <var>&lt;BRANCH[+]&gt;</var></span></kbd></td>
  2137. </tr>
  2138. <tr><td>&nbsp;</td><td>a specific branch you would like to pull</td></tr>
  2139. <tr><td class="option-group">
  2140. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  2141. <td>show patch</td></tr>
  2142. <tr><td class="option-group">
  2143. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  2144. <td>use git extended diff format</td></tr>
  2145. <tr><td class="option-group" colspan="2">
  2146. <kbd><span class="option">-l</span>, <span class="option">--limit <var>&lt;NUM&gt;</var></span></kbd></td>
  2147. </tr>
  2148. <tr><td>&nbsp;</td><td>limit number of changes displayed</td></tr>
  2149. <tr><td class="option-group" colspan="2">
  2150. <kbd><span class="option">-M</span>, <span class="option">--no-merges</span></kbd></td>
  2151. </tr>
  2152. <tr><td>&nbsp;</td><td>do not show merges</td></tr>
  2153. <tr><td class="option-group">
  2154. <kbd><span class="option">--stat</span></kbd></td>
  2155. <td>output diffstat-style summary of changes</td></tr>
  2156. <tr><td class="option-group">
  2157. <kbd><span class="option">-G</span>, <span class="option">--graph</span></kbd></td>
  2158. <td>show the revision DAG</td></tr>
  2159. <tr><td class="option-group" colspan="2">
  2160. <kbd><span class="option">--style <var>&lt;STYLE&gt;</var></span></kbd></td>
  2161. </tr>
  2162. <tr><td>&nbsp;</td><td>display using template map file (DEPRECATED)</td></tr>
  2163. <tr><td class="option-group" colspan="2">
  2164. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  2165. </tr>
  2166. <tr><td>&nbsp;</td><td>display with template</td></tr>
  2167. <tr><td class="option-group" colspan="2">
  2168. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  2169. </tr>
  2170. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  2171. <tr><td class="option-group" colspan="2">
  2172. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  2173. </tr>
  2174. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  2175. <tr><td class="option-group">
  2176. <kbd><span class="option">--insecure</span></kbd></td>
  2177. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  2178. <tr><td class="option-group">
  2179. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  2180. <td>recurse into subrepositories</td></tr>
  2181. </tbody>
  2182. </table>
  2183. <p>[+] marked option can be specified multiple times</p>
  2184. <blockquote>
  2185. aliases: in</blockquote>
  2186. </div>
  2187. <div class="section" id="init">
  2188. <h2>init</h2>
  2189. <p>create a new repository in the given directory:</p>
  2190. <pre class="literal-block">
  2191. hg init [-e CMD] [--remotecmd CMD] [DEST]
  2192. </pre>
  2193. <p>Initialize a new repository in the given directory. If the given
  2194. directory does not exist, it will be created.</p>
  2195. <p>If no directory is given, the current directory is used.</p>
  2196. <p>It is possible to specify an <tt class="docutils literal"><span class="pre">ssh://</span></tt> URL as the destination.
  2197. See <a class="reference external" href="hg.1.html#urls"><tt class="docutils literal">hg help urls</tt></a> for more information.</p>
  2198. <p>Returns 0 on success.</p>
  2199. <p>Options:</p>
  2200. <table class="docutils option-list" frame="void" rules="none">
  2201. <col class="option" />
  2202. <col class="description" />
  2203. <tbody valign="top">
  2204. <tr><td class="option-group" colspan="2">
  2205. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  2206. </tr>
  2207. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  2208. <tr><td class="option-group" colspan="2">
  2209. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  2210. </tr>
  2211. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  2212. <tr><td class="option-group">
  2213. <kbd><span class="option">--insecure</span></kbd></td>
  2214. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  2215. </tbody>
  2216. </table>
  2217. </div>
  2218. <div class="section" id="locate">
  2219. <h2>locate</h2>
  2220. <p>locate files matching specific patterns (DEPRECATED):</p>
  2221. <pre class="literal-block">
  2222. hg locate [OPTION]... [PATTERN]...
  2223. </pre>
  2224. <p>Print files under Mercurial control in the working directory whose
  2225. names match the given patterns.</p>
  2226. <p>By default, this command searches all directories in the working
  2227. directory. To search just the current directory and its
  2228. subdirectories, use &quot;--include .&quot;.</p>
  2229. <p>If no patterns are given to match, this command prints the names
  2230. of all files under Mercurial control in the working directory.</p>
  2231. <p>If you want to feed the output of this command into the &quot;xargs&quot;
  2232. command, use the -0 option to both this command and &quot;xargs&quot;. This
  2233. will avoid the problem of &quot;xargs&quot; treating single filenames that
  2234. contain whitespace as multiple filenames.</p>
  2235. <p>See <a class="reference external" href="hg.1.html#files"><tt class="docutils literal">hg help files</tt></a> for a more versatile command.</p>
  2236. <p>Returns 0 if a match is found, 1 otherwise.</p>
  2237. <p>Options:</p>
  2238. <table class="docutils option-list" frame="void" rules="none">
  2239. <col class="option" />
  2240. <col class="description" />
  2241. <tbody valign="top">
  2242. <tr><td class="option-group" colspan="2">
  2243. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  2244. </tr>
  2245. <tr><td>&nbsp;</td><td>search the repository as it is in REV</td></tr>
  2246. <tr><td class="option-group">
  2247. <kbd><span class="option">-0</span>, <span class="option">--print0</span></kbd></td>
  2248. <td>end filenames with NUL, for use with xargs</td></tr>
  2249. <tr><td class="option-group">
  2250. <kbd><span class="option">-f</span>, <span class="option">--fullpath</span></kbd></td>
  2251. <td>print complete paths from the filesystem root</td></tr>
  2252. <tr><td class="option-group" colspan="2">
  2253. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  2254. </tr>
  2255. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  2256. <tr><td class="option-group" colspan="2">
  2257. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  2258. </tr>
  2259. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  2260. </tbody>
  2261. </table>
  2262. <p>[+] marked option can be specified multiple times</p>
  2263. </div>
  2264. <div class="section" id="log">
  2265. <h2>log</h2>
  2266. <p>show revision history of entire repository or files:</p>
  2267. <pre class="literal-block">
  2268. hg log [OPTION]... [FILE]
  2269. </pre>
  2270. <p>Print the revision history of the specified files or the entire
  2271. project.</p>
  2272. <p>If no revision range is specified, the default is <tt class="docutils literal">tip:0</tt> unless
  2273. --follow is set, in which case the working directory parent is
  2274. used as the starting revision.</p>
  2275. <p>File history is shown without following rename or copy history of
  2276. files. Use -f/--follow with a filename to follow history across
  2277. renames and copies. --follow without a filename will only show
  2278. ancestors or descendants of the starting revision.</p>
  2279. <p>By default this command prints revision number and changeset id,
  2280. tags, non-trivial parents, user, date and time, and a summary for
  2281. each commit. When the -v/--verbose switch is used, the list of
  2282. changed files and full commit message are shown.</p>
  2283. <p>With --graph the revisions are shown as an ASCII art DAG with the most
  2284. recent changeset at the top.
  2285. 'o' is a changeset, '&#64;' is a working directory parent, 'x' is obsolete,
  2286. and '+' represents a fork where the changeset from the lines below is a
  2287. parent of the 'o' merge on the same line.</p>
  2288. <div class="note">
  2289. <p class="first admonition-title">Note</p>
  2290. <p class="last">log -p/--patch may generate unexpected diff output for merge
  2291. changesets, as it will only compare the merge changeset against
  2292. its first parent. Also, only files different from BOTH parents
  2293. will appear in files:.</p>
  2294. </div>
  2295. <div class="note">
  2296. <p class="first admonition-title">Note</p>
  2297. <p class="last">for performance reasons, log FILE may omit duplicate changes
  2298. made on branches and will not show removals or mode changes. To
  2299. see all such changes, use the --removed switch.</p>
  2300. </div>
  2301. <div class="verbose container">
  2302. <p>Some examples:</p>
  2303. <ul>
  2304. <li><p class="first">changesets with full descriptions and file lists:</p>
  2305. <pre class="literal-block">
  2306. hg log -v
  2307. </pre>
  2308. </li>
  2309. <li><p class="first">changesets ancestral to the working directory:</p>
  2310. <pre class="literal-block">
  2311. hg log -f
  2312. </pre>
  2313. </li>
  2314. <li><p class="first">last 10 commits on the current branch:</p>
  2315. <pre class="literal-block">
  2316. hg log -l 10 -b .
  2317. </pre>
  2318. </li>
  2319. <li><p class="first">changesets showing all modifications of a file, including removals:</p>
  2320. <pre class="literal-block">
  2321. hg log --removed file.c
  2322. </pre>
  2323. </li>
  2324. <li><p class="first">all changesets that touch a directory, with diffs, excluding merges:</p>
  2325. <pre class="literal-block">
  2326. hg log -Mp lib/
  2327. </pre>
  2328. </li>
  2329. <li><p class="first">all revision numbers that match a keyword:</p>
  2330. <pre class="literal-block">
  2331. hg log -k bug --template &quot;{rev}\n&quot;
  2332. </pre>
  2333. </li>
  2334. <li><p class="first">list available log templates:</p>
  2335. <pre class="literal-block">
  2336. hg log -T list
  2337. </pre>
  2338. </li>
  2339. <li><p class="first">check if a given changeset is included in a tagged release:</p>
  2340. <pre class="literal-block">
  2341. hg log -r &quot;a21ccf and ancestor(1.9)&quot;
  2342. </pre>
  2343. </li>
  2344. <li><p class="first">find all changesets by some user in a date range:</p>
  2345. <pre class="literal-block">
  2346. hg log -k alice -d &quot;may 2008 to jul 2008&quot;
  2347. </pre>
  2348. </li>
  2349. <li><p class="first">summary of all changesets after the last tag:</p>
  2350. <pre class="literal-block">
  2351. hg log -r &quot;last(tagged())::&quot; --template &quot;{desc|firstline}\n&quot;
  2352. </pre>
  2353. </li>
  2354. </ul>
  2355. </div>
  2356. <p>See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for a list of formats valid for -d/--date.</p>
  2357. <p>See <a class="reference external" href="hg.1.html#revisions"><tt class="docutils literal">hg help revisions</tt></a> and <a class="reference external" href="hg.1.html#revsets"><tt class="docutils literal">hg help revsets</tt></a> for more about
  2358. specifying revisions.</p>
  2359. <p>See <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a> for more about pre-packaged styles and
  2360. specifying custom templates.</p>
  2361. <p>Returns 0 on success.</p>
  2362. <p>Options:</p>
  2363. <table class="docutils option-list" frame="void" rules="none">
  2364. <col class="option" />
  2365. <col class="description" />
  2366. <tbody valign="top">
  2367. <tr><td class="option-group">
  2368. <kbd><span class="option">-f</span>, <span class="option">--follow</span></kbd></td>
  2369. <td>follow changeset history, or file history across copies and renames</td></tr>
  2370. <tr><td class="option-group">
  2371. <kbd><span class="option">--follow-first</span></kbd></td>
  2372. <td>only follow the first parent of merge changesets (DEPRECATED)</td></tr>
  2373. <tr><td class="option-group" colspan="2">
  2374. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  2375. </tr>
  2376. <tr><td>&nbsp;</td><td>show revisions matching date spec</td></tr>
  2377. <tr><td class="option-group">
  2378. <kbd><span class="option">-C</span>, <span class="option">--copies</span></kbd></td>
  2379. <td>show copied files</td></tr>
  2380. <tr><td class="option-group" colspan="2">
  2381. <kbd><span class="option">-k</span>, <span class="option">--keyword <var>&lt;TEXT[+]&gt;</var></span></kbd></td>
  2382. </tr>
  2383. <tr><td>&nbsp;</td><td>do case-insensitive search for a given text</td></tr>
  2384. <tr><td class="option-group" colspan="2">
  2385. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  2386. </tr>
  2387. <tr><td>&nbsp;</td><td>show the specified revision or revset</td></tr>
  2388. <tr><td class="option-group">
  2389. <kbd><span class="option">--removed</span></kbd></td>
  2390. <td>include revisions where files were removed</td></tr>
  2391. <tr><td class="option-group" colspan="2">
  2392. <kbd><span class="option">-m</span>, <span class="option">--only-merges</span></kbd></td>
  2393. </tr>
  2394. <tr><td>&nbsp;</td><td>show only merges (DEPRECATED)</td></tr>
  2395. <tr><td class="option-group" colspan="2">
  2396. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER[+]&gt;</var></span></kbd></td>
  2397. </tr>
  2398. <tr><td>&nbsp;</td><td>revisions committed by user</td></tr>
  2399. <tr><td class="option-group" colspan="2">
  2400. <kbd><span class="option">--only-branch <var>&lt;BRANCH[+]&gt;</var></span></kbd></td>
  2401. </tr>
  2402. <tr><td>&nbsp;</td><td>show only changesets within the given named branch (DEPRECATED)</td></tr>
  2403. <tr><td class="option-group" colspan="2">
  2404. <kbd><span class="option">-b</span>, <span class="option">--branch <var>&lt;BRANCH[+]&gt;</var></span></kbd></td>
  2405. </tr>
  2406. <tr><td>&nbsp;</td><td>show changesets within the given named branch</td></tr>
  2407. <tr><td class="option-group" colspan="2">
  2408. <kbd><span class="option">-P</span>, <span class="option">--prune <var>&lt;REV[+]&gt;</var></span></kbd></td>
  2409. </tr>
  2410. <tr><td>&nbsp;</td><td>do not display revision or any of its ancestors</td></tr>
  2411. <tr><td class="option-group">
  2412. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  2413. <td>show patch</td></tr>
  2414. <tr><td class="option-group">
  2415. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  2416. <td>use git extended diff format</td></tr>
  2417. <tr><td class="option-group" colspan="2">
  2418. <kbd><span class="option">-l</span>, <span class="option">--limit <var>&lt;NUM&gt;</var></span></kbd></td>
  2419. </tr>
  2420. <tr><td>&nbsp;</td><td>limit number of changes displayed</td></tr>
  2421. <tr><td class="option-group" colspan="2">
  2422. <kbd><span class="option">-M</span>, <span class="option">--no-merges</span></kbd></td>
  2423. </tr>
  2424. <tr><td>&nbsp;</td><td>do not show merges</td></tr>
  2425. <tr><td class="option-group">
  2426. <kbd><span class="option">--stat</span></kbd></td>
  2427. <td>output diffstat-style summary of changes</td></tr>
  2428. <tr><td class="option-group">
  2429. <kbd><span class="option">-G</span>, <span class="option">--graph</span></kbd></td>
  2430. <td>show the revision DAG</td></tr>
  2431. <tr><td class="option-group" colspan="2">
  2432. <kbd><span class="option">--style <var>&lt;STYLE&gt;</var></span></kbd></td>
  2433. </tr>
  2434. <tr><td>&nbsp;</td><td>display using template map file (DEPRECATED)</td></tr>
  2435. <tr><td class="option-group" colspan="2">
  2436. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  2437. </tr>
  2438. <tr><td>&nbsp;</td><td>display with template</td></tr>
  2439. <tr><td class="option-group" colspan="2">
  2440. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  2441. </tr>
  2442. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  2443. <tr><td class="option-group" colspan="2">
  2444. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  2445. </tr>
  2446. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  2447. </tbody>
  2448. </table>
  2449. <p>[+] marked option can be specified multiple times</p>
  2450. <blockquote>
  2451. aliases: history</blockquote>
  2452. </div>
  2453. <div class="section" id="manifest">
  2454. <h2>manifest</h2>
  2455. <p>output the current or given revision of the project manifest:</p>
  2456. <pre class="literal-block">
  2457. hg manifest [-r REV]
  2458. </pre>
  2459. <p>Print a list of version controlled files for the given revision.
  2460. If no revision is given, the first parent of the working directory
  2461. is used, or the null revision if no revision is checked out.</p>
  2462. <p>With -v, print file permissions, symlink and executable bits.
  2463. With --debug, print file revision hashes.</p>
  2464. <p>If option --all is specified, the list of all files from all revisions
  2465. is printed. This includes deleted and renamed files.</p>
  2466. <p>Returns 0 on success.</p>
  2467. <p>Options:</p>
  2468. <table class="docutils option-list" frame="void" rules="none">
  2469. <col class="option" />
  2470. <col class="description" />
  2471. <tbody valign="top">
  2472. <tr><td class="option-group" colspan="2">
  2473. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  2474. </tr>
  2475. <tr><td>&nbsp;</td><td>revision to display</td></tr>
  2476. <tr><td class="option-group">
  2477. <kbd><span class="option">--all</span></kbd></td>
  2478. <td>list files from all revisions</td></tr>
  2479. <tr><td class="option-group" colspan="2">
  2480. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  2481. </tr>
  2482. <tr><td>&nbsp;</td><td>display with template (EXPERIMENTAL)</td></tr>
  2483. </tbody>
  2484. </table>
  2485. </div>
  2486. <div class="section" id="merge">
  2487. <h2>merge</h2>
  2488. <p>merge another revision into working directory:</p>
  2489. <pre class="literal-block">
  2490. hg merge [-P] [-f] [[-r] REV]
  2491. </pre>
  2492. <p>The current working directory is updated with all changes made in
  2493. the requested revision since the last common predecessor revision.</p>
  2494. <p>Files that changed between either parent are marked as changed for
  2495. the next commit and a commit must be performed before any further
  2496. updates to the repository are allowed. The next commit will have
  2497. two parents.</p>
  2498. <p><tt class="docutils literal"><span class="pre">--tool</span></tt> can be used to specify the merge tool used for file
  2499. merges. It overrides the HGMERGE environment variable and your
  2500. configuration files. See <a class="reference external" href="hg.1.html#merge-tools"><tt class="docutils literal">hg help <span class="pre">merge-tools</span></tt></a> for options.</p>
  2501. <p>If no revision is specified, the working directory's parent is a
  2502. head revision, and the current branch contains exactly one other
  2503. head, the other head is merged with by default. Otherwise, an
  2504. explicit revision with which to merge with must be provided.</p>
  2505. <p><a class="reference external" href="hg.1.html#resolve"><tt class="docutils literal">hg resolve</tt></a> must be used to resolve unresolved files.</p>
  2506. <p>To undo an uncommitted merge, use <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update <span class="pre">--clean</span> .</tt></a> which
  2507. will check out a clean copy of the original merge parent, losing
  2508. all changes.</p>
  2509. <p>Returns 0 on success, 1 if there are unresolved files.</p>
  2510. <p>Options:</p>
  2511. <table class="docutils option-list" frame="void" rules="none">
  2512. <col class="option" />
  2513. <col class="description" />
  2514. <tbody valign="top">
  2515. <tr><td class="option-group">
  2516. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  2517. <td>force a merge including outstanding changes (DEPRECATED)</td></tr>
  2518. <tr><td class="option-group" colspan="2">
  2519. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  2520. </tr>
  2521. <tr><td>&nbsp;</td><td>revision to merge</td></tr>
  2522. <tr><td class="option-group">
  2523. <kbd><span class="option">-P</span>, <span class="option">--preview</span></kbd></td>
  2524. <td>review revisions to merge (no merge is performed)</td></tr>
  2525. <tr><td class="option-group" colspan="2">
  2526. <kbd><span class="option">-t</span>, <span class="option">--tool <var>&lt;VALUE&gt;</var></span></kbd></td>
  2527. </tr>
  2528. <tr><td>&nbsp;</td><td>specify merge tool</td></tr>
  2529. </tbody>
  2530. </table>
  2531. </div>
  2532. <div class="section" id="outgoing">
  2533. <h2>outgoing</h2>
  2534. <p>show changesets not found in the destination:</p>
  2535. <pre class="literal-block">
  2536. hg outgoing [-M] [-p] [-n] [-f] [-r REV]... [DEST]
  2537. </pre>
  2538. <p>Show changesets not found in the specified destination repository
  2539. or the default push location. These are the changesets that would
  2540. be pushed if a push was requested.</p>
  2541. <p>See pull for details of valid destination formats.</p>
  2542. <div class="verbose container">
  2543. <p>With -B/--bookmarks, the result of bookmark comparison between
  2544. local and remote repositories is displayed. With -v/--verbose,
  2545. status is also displayed for each bookmark like below:</p>
  2546. <pre class="literal-block">
  2547. BM1               01234567890a added
  2548. BM2                            deleted
  2549. BM3               234567890abc advanced
  2550. BM4               34567890abcd diverged
  2551. BM5               4567890abcde changed
  2552. </pre>
  2553. <p>The action taken when pushing depends on the
  2554. status of each bookmark:</p>
  2555. <table class="docutils field-list" frame="void" rules="none">
  2556. <col class="field-name" />
  2557. <col class="field-body" />
  2558. <tbody valign="top">
  2559. <tr class="field"><th class="field-name"><tt class="docutils literal">added</tt>:</th><td class="field-body">push with <tt class="docutils literal"><span class="pre">-B</span></tt> will create it</td>
  2560. </tr>
  2561. <tr class="field"><th class="field-name"><tt class="docutils literal">deleted</tt>:</th><td class="field-body">push with <tt class="docutils literal"><span class="pre">-B</span></tt> will delete it</td>
  2562. </tr>
  2563. <tr class="field"><th class="field-name"><tt class="docutils literal">advanced</tt>:</th><td class="field-body">push will update it</td>
  2564. </tr>
  2565. <tr class="field"><th class="field-name"><tt class="docutils literal">diverged</tt>:</th><td class="field-body">push with <tt class="docutils literal"><span class="pre">-B</span></tt> will update it</td>
  2566. </tr>
  2567. <tr class="field"><th class="field-name"><tt class="docutils literal">changed</tt>:</th><td class="field-body">push with <tt class="docutils literal"><span class="pre">-B</span></tt> will update it</td>
  2568. </tr>
  2569. </tbody>
  2570. </table>
  2571. <p>From the point of view of pushing behavior, bookmarks
  2572. existing only in the remote repository are treated as
  2573. <tt class="docutils literal">deleted</tt>, even if it is in fact added remotely.</p>
  2574. </div>
  2575. <p>Returns 0 if there are outgoing changes, 1 otherwise.</p>
  2576. <p>Options:</p>
  2577. <table class="docutils option-list" frame="void" rules="none">
  2578. <col class="option" />
  2579. <col class="description" />
  2580. <tbody valign="top">
  2581. <tr><td class="option-group">
  2582. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  2583. <td>run even when the destination is unrelated</td></tr>
  2584. <tr><td class="option-group" colspan="2">
  2585. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  2586. </tr>
  2587. <tr><td>&nbsp;</td><td>a changeset intended to be included in the destination</td></tr>
  2588. <tr><td class="option-group" colspan="2">
  2589. <kbd><span class="option">-n</span>, <span class="option">--newest-first</span></kbd></td>
  2590. </tr>
  2591. <tr><td>&nbsp;</td><td>show newest record first</td></tr>
  2592. <tr><td class="option-group" colspan="2">
  2593. <kbd><span class="option">-B</span>, <span class="option">--bookmarks</span></kbd></td>
  2594. </tr>
  2595. <tr><td>&nbsp;</td><td>compare bookmarks</td></tr>
  2596. <tr><td class="option-group" colspan="2">
  2597. <kbd><span class="option">-b</span>, <span class="option">--branch <var>&lt;BRANCH[+]&gt;</var></span></kbd></td>
  2598. </tr>
  2599. <tr><td>&nbsp;</td><td>a specific branch you would like to push</td></tr>
  2600. <tr><td class="option-group">
  2601. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  2602. <td>show patch</td></tr>
  2603. <tr><td class="option-group">
  2604. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  2605. <td>use git extended diff format</td></tr>
  2606. <tr><td class="option-group" colspan="2">
  2607. <kbd><span class="option">-l</span>, <span class="option">--limit <var>&lt;NUM&gt;</var></span></kbd></td>
  2608. </tr>
  2609. <tr><td>&nbsp;</td><td>limit number of changes displayed</td></tr>
  2610. <tr><td class="option-group" colspan="2">
  2611. <kbd><span class="option">-M</span>, <span class="option">--no-merges</span></kbd></td>
  2612. </tr>
  2613. <tr><td>&nbsp;</td><td>do not show merges</td></tr>
  2614. <tr><td class="option-group">
  2615. <kbd><span class="option">--stat</span></kbd></td>
  2616. <td>output diffstat-style summary of changes</td></tr>
  2617. <tr><td class="option-group">
  2618. <kbd><span class="option">-G</span>, <span class="option">--graph</span></kbd></td>
  2619. <td>show the revision DAG</td></tr>
  2620. <tr><td class="option-group" colspan="2">
  2621. <kbd><span class="option">--style <var>&lt;STYLE&gt;</var></span></kbd></td>
  2622. </tr>
  2623. <tr><td>&nbsp;</td><td>display using template map file (DEPRECATED)</td></tr>
  2624. <tr><td class="option-group" colspan="2">
  2625. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  2626. </tr>
  2627. <tr><td>&nbsp;</td><td>display with template</td></tr>
  2628. <tr><td class="option-group" colspan="2">
  2629. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  2630. </tr>
  2631. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  2632. <tr><td class="option-group" colspan="2">
  2633. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  2634. </tr>
  2635. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  2636. <tr><td class="option-group">
  2637. <kbd><span class="option">--insecure</span></kbd></td>
  2638. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  2639. <tr><td class="option-group">
  2640. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  2641. <td>recurse into subrepositories</td></tr>
  2642. </tbody>
  2643. </table>
  2644. <p>[+] marked option can be specified multiple times</p>
  2645. <blockquote>
  2646. aliases: out</blockquote>
  2647. </div>
  2648. <div class="section" id="parents">
  2649. <h2>parents</h2>
  2650. <p>show the parents of the working directory or revision (DEPRECATED):</p>
  2651. <pre class="literal-block">
  2652. hg parents [-r REV] [FILE]
  2653. </pre>
  2654. <p>Print the working directory's parent revisions. If a revision is
  2655. given via -r/--rev, the parent of that revision will be printed.
  2656. If a file argument is given, the revision in which the file was
  2657. last changed (before the working directory revision or the
  2658. argument to --rev if given) is printed.</p>
  2659. <p>See <a class="reference external" href="hg.1.html#summary"><tt class="docutils literal">hg summary</tt></a> and <a class="reference external" href="hg.1.html#revsets"><tt class="docutils literal">hg help revsets</tt></a> for related information.</p>
  2660. <p>Returns 0 on success.</p>
  2661. <p>Options:</p>
  2662. <table class="docutils option-list" frame="void" rules="none">
  2663. <col class="option" />
  2664. <col class="description" />
  2665. <tbody valign="top">
  2666. <tr><td class="option-group" colspan="2">
  2667. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  2668. </tr>
  2669. <tr><td>&nbsp;</td><td>show parents of the specified revision</td></tr>
  2670. <tr><td class="option-group" colspan="2">
  2671. <kbd><span class="option">--style <var>&lt;STYLE&gt;</var></span></kbd></td>
  2672. </tr>
  2673. <tr><td>&nbsp;</td><td>display using template map file (DEPRECATED)</td></tr>
  2674. <tr><td class="option-group" colspan="2">
  2675. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  2676. </tr>
  2677. <tr><td>&nbsp;</td><td>display with template</td></tr>
  2678. </tbody>
  2679. </table>
  2680. </div>
  2681. <div class="section" id="paths">
  2682. <h2>paths</h2>
  2683. <p>show aliases for remote repositories:</p>
  2684. <pre class="literal-block">
  2685. hg paths [NAME]
  2686. </pre>
  2687. <p>Show definition of symbolic path name NAME. If no name is given,
  2688. show definition of all available names.</p>
  2689. <p>Option -q/--quiet suppresses all output when searching for NAME
  2690. and shows only the path names when listing all definitions.</p>
  2691. <p>Path names are defined in the [paths] section of your
  2692. configuration file and in <tt class="docutils literal">/etc/mercurial/hgrc</tt>. If run inside a
  2693. repository, <tt class="docutils literal">.hg/hgrc</tt> is used, too.</p>
  2694. <p>The path names <tt class="docutils literal">default</tt> and <tt class="docutils literal"><span class="pre">default-push</span></tt> have a special
  2695. meaning.  When performing a push or pull operation, they are used
  2696. as fallbacks if no location is specified on the command-line.
  2697. When <tt class="docutils literal"><span class="pre">default-push</span></tt> is set, it will be used for push and
  2698. <tt class="docutils literal">default</tt> will be used for pull; otherwise <tt class="docutils literal">default</tt> is used
  2699. as the fallback for both.  When cloning a repository, the clone
  2700. source is written as <tt class="docutils literal">default</tt> in <tt class="docutils literal">.hg/hgrc</tt>.  Note that
  2701. <tt class="docutils literal">default</tt> and <tt class="docutils literal"><span class="pre">default-push</span></tt> apply to all inbound (e.g.
  2702. <a class="reference external" href="hg.1.html#incoming"><tt class="docutils literal">hg incoming</tt></a>) and outbound (e.g. <a class="reference external" href="hg.1.html#outgoing"><tt class="docutils literal">hg outgoing</tt></a>, <a class="reference external" href="hg.1.html#email"><tt class="docutils literal">hg email</tt></a> and
  2703. <a class="reference external" href="hg.1.html#bundle"><tt class="docutils literal">hg bundle</tt></a>) operations.</p>
  2704. <p>See <a class="reference external" href="hg.1.html#urls"><tt class="docutils literal">hg help urls</tt></a> for more information.</p>
  2705. <p>Returns 0 on success.</p>
  2706. </div>
  2707. <div class="section" id="phase">
  2708. <h2>phase</h2>
  2709. <p>set or show the current phase name:</p>
  2710. <pre class="literal-block">
  2711. hg phase [-p|-d|-s] [-f] [-r] [REV...]
  2712. </pre>
  2713. <p>With no argument, show the phase name of the current revision(s).</p>
  2714. <p>With one of -p/--public, -d/--draft or -s/--secret, change the
  2715. phase value of the specified revisions.</p>
  2716. <p>Unless -f/--force is specified, <a class="reference external" href="hg.1.html#phase"><tt class="docutils literal">hg phase</tt></a> won't move changeset from a
  2717. lower phase to an higher phase. Phases are ordered as follows:</p>
  2718. <pre class="literal-block">
  2719. public &lt; draft &lt; secret
  2720. </pre>
  2721. <p>Returns 0 on success, 1 if no phases were changed or some could not
  2722. be changed.</p>
  2723. <p>(For more information about the phases concept, see <a class="reference external" href="hg.1.html#phases"><tt class="docutils literal">hg help phases</tt></a>.)</p>
  2724. <p>Options:</p>
  2725. <table class="docutils option-list" frame="void" rules="none">
  2726. <col class="option" />
  2727. <col class="description" />
  2728. <tbody valign="top">
  2729. <tr><td class="option-group">
  2730. <kbd><span class="option">-p</span>, <span class="option">--public</span></kbd></td>
  2731. <td>set changeset phase to public</td></tr>
  2732. <tr><td class="option-group">
  2733. <kbd><span class="option">-d</span>, <span class="option">--draft</span></kbd></td>
  2734. <td>set changeset phase to draft</td></tr>
  2735. <tr><td class="option-group">
  2736. <kbd><span class="option">-s</span>, <span class="option">--secret</span></kbd></td>
  2737. <td>set changeset phase to secret</td></tr>
  2738. <tr><td class="option-group">
  2739. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  2740. <td>allow to move boundary backward</td></tr>
  2741. <tr><td class="option-group" colspan="2">
  2742. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  2743. </tr>
  2744. <tr><td>&nbsp;</td><td>target revision</td></tr>
  2745. </tbody>
  2746. </table>
  2747. <p>[+] marked option can be specified multiple times</p>
  2748. </div>
  2749. <div class="section" id="pull">
  2750. <h2>pull</h2>
  2751. <p>pull changes from the specified source:</p>
  2752. <pre class="literal-block">
  2753. hg pull [-u] [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [SOURCE]
  2754. </pre>
  2755. <p>Pull changes from a remote repository to a local one.</p>
  2756. <p>This finds all changes from the repository at the specified path
  2757. or URL and adds them to a local repository (the current one unless
  2758. -R is specified). By default, this does not update the copy of the
  2759. project in the working directory.</p>
  2760. <p>Use <a class="reference external" href="hg.1.html#incoming"><tt class="docutils literal">hg incoming</tt></a> if you want to see what would have been added
  2761. by a pull at the time you issued this command. If you then decide
  2762. to add those changes to the repository, you should use <a class="reference external" href="hg.1.html#pull"><tt class="docutils literal">hg pull
  2763. <span class="pre">-r</span> X</tt></a> where <tt class="docutils literal">X</tt> is the last changeset listed by <a class="reference external" href="hg.1.html#incoming"><tt class="docutils literal">hg incoming</tt></a>.</p>
  2764. <p>If SOURCE is omitted, the 'default' path will be used.
  2765. See <a class="reference external" href="hg.1.html#urls"><tt class="docutils literal">hg help urls</tt></a> for more information.</p>
  2766. <p>Returns 0 on success, 1 if an update had unresolved files.</p>
  2767. <p>Options:</p>
  2768. <table class="docutils option-list" frame="void" rules="none">
  2769. <col class="option" />
  2770. <col class="description" />
  2771. <tbody valign="top">
  2772. <tr><td class="option-group">
  2773. <kbd><span class="option">-u</span>, <span class="option">--update</span></kbd></td>
  2774. <td>update to new branch head if changesets were pulled</td></tr>
  2775. <tr><td class="option-group">
  2776. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  2777. <td>run even when remote repository is unrelated</td></tr>
  2778. <tr><td class="option-group" colspan="2">
  2779. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  2780. </tr>
  2781. <tr><td>&nbsp;</td><td>a remote changeset intended to be added</td></tr>
  2782. <tr><td class="option-group" colspan="2">
  2783. <kbd><span class="option">-B</span>, <span class="option">--bookmark <var>&lt;BOOKMARK[+]&gt;</var></span></kbd></td>
  2784. </tr>
  2785. <tr><td>&nbsp;</td><td>bookmark to pull</td></tr>
  2786. <tr><td class="option-group" colspan="2">
  2787. <kbd><span class="option">-b</span>, <span class="option">--branch <var>&lt;BRANCH[+]&gt;</var></span></kbd></td>
  2788. </tr>
  2789. <tr><td>&nbsp;</td><td>a specific branch you would like to pull</td></tr>
  2790. <tr><td class="option-group" colspan="2">
  2791. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  2792. </tr>
  2793. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  2794. <tr><td class="option-group" colspan="2">
  2795. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  2796. </tr>
  2797. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  2798. <tr><td class="option-group">
  2799. <kbd><span class="option">--insecure</span></kbd></td>
  2800. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  2801. </tbody>
  2802. </table>
  2803. <p>[+] marked option can be specified multiple times</p>
  2804. </div>
  2805. <div class="section" id="push">
  2806. <h2>push</h2>
  2807. <p>push changes to the specified destination:</p>
  2808. <pre class="literal-block">
  2809. hg push [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [DEST]
  2810. </pre>
  2811. <p>Push changesets from the local repository to the specified
  2812. destination.</p>
  2813. <p>This operation is symmetrical to pull: it is identical to a pull
  2814. in the destination repository from the current one.</p>
  2815. <p>By default, push will not allow creation of new heads at the
  2816. destination, since multiple heads would make it unclear which head
  2817. to use. In this situation, it is recommended to pull and merge
  2818. before pushing.</p>
  2819. <p>Use --new-branch if you want to allow push to create a new named
  2820. branch that is not present at the destination. This allows you to
  2821. only create a new branch without forcing other changes.</p>
  2822. <div class="note">
  2823. <p class="first admonition-title">Note</p>
  2824. <p class="last">Extra care should be taken with the -f/--force option,
  2825. which will push all new heads on all branches, an action which will
  2826. almost always cause confusion for collaborators.</p>
  2827. </div>
  2828. <p>If -r/--rev is used, the specified revision and all its ancestors
  2829. will be pushed to the remote repository.</p>
  2830. <p>If -B/--bookmark is used, the specified bookmarked revision, its
  2831. ancestors, and the bookmark will be pushed to the remote
  2832. repository.</p>
  2833. <p>Please see <a class="reference external" href="hg.1.html#urls"><tt class="docutils literal">hg help urls</tt></a> for important details about <tt class="docutils literal"><span class="pre">ssh://</span></tt>
  2834. URLs. If DESTINATION is omitted, a default path will be used.</p>
  2835. <p>Returns 0 if push was successful, 1 if nothing to push.</p>
  2836. <p>Options:</p>
  2837. <table class="docutils option-list" frame="void" rules="none">
  2838. <col class="option" />
  2839. <col class="description" />
  2840. <tbody valign="top">
  2841. <tr><td class="option-group">
  2842. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  2843. <td>force push</td></tr>
  2844. <tr><td class="option-group" colspan="2">
  2845. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  2846. </tr>
  2847. <tr><td>&nbsp;</td><td>a changeset intended to be included in the destination</td></tr>
  2848. <tr><td class="option-group" colspan="2">
  2849. <kbd><span class="option">-B</span>, <span class="option">--bookmark <var>&lt;BOOKMARK[+]&gt;</var></span></kbd></td>
  2850. </tr>
  2851. <tr><td>&nbsp;</td><td>bookmark to push</td></tr>
  2852. <tr><td class="option-group" colspan="2">
  2853. <kbd><span class="option">-b</span>, <span class="option">--branch <var>&lt;BRANCH[+]&gt;</var></span></kbd></td>
  2854. </tr>
  2855. <tr><td>&nbsp;</td><td>a specific branch you would like to push</td></tr>
  2856. <tr><td class="option-group">
  2857. <kbd><span class="option">--new-branch</span></kbd></td>
  2858. <td>allow pushing a new branch</td></tr>
  2859. <tr><td class="option-group" colspan="2">
  2860. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  2861. </tr>
  2862. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  2863. <tr><td class="option-group" colspan="2">
  2864. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  2865. </tr>
  2866. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  2867. <tr><td class="option-group">
  2868. <kbd><span class="option">--insecure</span></kbd></td>
  2869. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  2870. </tbody>
  2871. </table>
  2872. <p>[+] marked option can be specified multiple times</p>
  2873. </div>
  2874. <div class="section" id="recover">
  2875. <h2>recover</h2>
  2876. <p>roll back an interrupted transaction:</p>
  2877. <pre class="literal-block">
  2878. hg recover
  2879. </pre>
  2880. <p>Recover from an interrupted commit or pull.</p>
  2881. <p>This command tries to fix the repository status after an
  2882. interrupted operation. It should only be necessary when Mercurial
  2883. suggests it.</p>
  2884. <p>Returns 0 if successful, 1 if nothing to recover or verify fails.</p>
  2885. </div>
  2886. <div class="section" id="remove">
  2887. <h2>remove</h2>
  2888. <p>remove the specified files on the next commit:</p>
  2889. <pre class="literal-block">
  2890. hg remove [OPTION]... FILE...
  2891. </pre>
  2892. <p>Schedule the indicated files for removal from the current branch.</p>
  2893. <p>This command schedules the files to be removed at the next commit.
  2894. To undo a remove before that, see <a class="reference external" href="hg.1.html#revert"><tt class="docutils literal">hg revert</tt></a>. To undo added
  2895. files, see <a class="reference external" href="hg.1.html#forget"><tt class="docutils literal">hg forget</tt></a>.</p>
  2896. <div class="verbose container">
  2897. <p>-A/--after can be used to remove only files that have already
  2898. been deleted, -f/--force can be used to force deletion, and -Af
  2899. can be used to remove files from the next revision without
  2900. deleting them from the working directory.</p>
  2901. <p>The following table details the behavior of remove for different
  2902. file states (columns) and option combinations (rows). The file
  2903. states are Added [A], Clean [C], Modified [M] and Missing [!]
  2904. (as reported by <a class="reference external" href="hg.1.html#status"><tt class="docutils literal">hg status</tt></a>). The actions are Warn, Remove
  2905. (from branch) and Delete (from disk):</p>
  2906. <table border="1" class="docutils">
  2907. <colgroup>
  2908. <col width="53%" />
  2909. <col width="12%" />
  2910. <col width="12%" />
  2911. <col width="12%" />
  2912. <col width="12%" />
  2913. </colgroup>
  2914. <thead valign="bottom">
  2915. <tr><th class="head">opt/state</th>
  2916. <th class="head">A</th>
  2917. <th class="head">C</th>
  2918. <th class="head">M</th>
  2919. <th class="head">!</th>
  2920. </tr>
  2921. </thead>
  2922. <tbody valign="top">
  2923. <tr><td>none</td>
  2924. <td>W</td>
  2925. <td>RD</td>
  2926. <td>W</td>
  2927. <td>R</td>
  2928. </tr>
  2929. <tr><td>-f</td>
  2930. <td>R</td>
  2931. <td>RD</td>
  2932. <td>RD</td>
  2933. <td>R</td>
  2934. </tr>
  2935. <tr><td>-A</td>
  2936. <td>W</td>
  2937. <td>W</td>
  2938. <td>W</td>
  2939. <td>R</td>
  2940. </tr>
  2941. <tr><td>-Af</td>
  2942. <td>R</td>
  2943. <td>R</td>
  2944. <td>R</td>
  2945. <td>R</td>
  2946. </tr>
  2947. </tbody>
  2948. </table>
  2949. <p>Note that remove never deletes files in Added [A] state from the
  2950. working directory, not even if option --force is specified.</p>
  2951. </div>
  2952. <p>Returns 0 on success, 1 if any warnings encountered.</p>
  2953. <p>Options:</p>
  2954. <table class="docutils option-list" frame="void" rules="none">
  2955. <col class="option" />
  2956. <col class="description" />
  2957. <tbody valign="top">
  2958. <tr><td class="option-group">
  2959. <kbd><span class="option">-A</span>, <span class="option">--after</span></kbd></td>
  2960. <td>record delete for missing files</td></tr>
  2961. <tr><td class="option-group">
  2962. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  2963. <td>remove (and delete) file even if added or modified</td></tr>
  2964. <tr><td class="option-group">
  2965. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  2966. <td>recurse into subrepositories</td></tr>
  2967. <tr><td class="option-group" colspan="2">
  2968. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  2969. </tr>
  2970. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  2971. <tr><td class="option-group" colspan="2">
  2972. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  2973. </tr>
  2974. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  2975. </tbody>
  2976. </table>
  2977. <p>[+] marked option can be specified multiple times</p>
  2978. <blockquote>
  2979. aliases: rm</blockquote>
  2980. </div>
  2981. <div class="section" id="rename">
  2982. <h2>rename</h2>
  2983. <p>rename files; equivalent of copy + remove:</p>
  2984. <pre class="literal-block">
  2985. hg rename [OPTION]... SOURCE... DEST
  2986. </pre>
  2987. <p>Mark dest as copies of sources; mark sources for deletion. If dest
  2988. is a directory, copies are put in that directory. If dest is a
  2989. file, there can only be one source.</p>
  2990. <p>By default, this command copies the contents of files as they
  2991. exist in the working directory. If invoked with -A/--after, the
  2992. operation is recorded, but no copying is performed.</p>
  2993. <p>This command takes effect at the next commit. To undo a rename
  2994. before that, see <a class="reference external" href="hg.1.html#revert"><tt class="docutils literal">hg revert</tt></a>.</p>
  2995. <p>Returns 0 on success, 1 if errors are encountered.</p>
  2996. <p>Options:</p>
  2997. <table class="docutils option-list" frame="void" rules="none">
  2998. <col class="option" />
  2999. <col class="description" />
  3000. <tbody valign="top">
  3001. <tr><td class="option-group">
  3002. <kbd><span class="option">-A</span>, <span class="option">--after</span></kbd></td>
  3003. <td>record a rename that has already occurred</td></tr>
  3004. <tr><td class="option-group">
  3005. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  3006. <td>forcibly copy over an existing managed file</td></tr>
  3007. <tr><td class="option-group" colspan="2">
  3008. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  3009. </tr>
  3010. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  3011. <tr><td class="option-group" colspan="2">
  3012. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  3013. </tr>
  3014. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  3015. <tr><td class="option-group">
  3016. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  3017. <td>do not perform actions, just print output</td></tr>
  3018. </tbody>
  3019. </table>
  3020. <p>[+] marked option can be specified multiple times</p>
  3021. <blockquote>
  3022. aliases: move mv</blockquote>
  3023. </div>
  3024. <div class="section" id="resolve">
  3025. <h2>resolve</h2>
  3026. <p>redo merges or set/view the merge status of files:</p>
  3027. <pre class="literal-block">
  3028. hg resolve [OPTION]... [FILE]...
  3029. </pre>
  3030. <p>Merges with unresolved conflicts are often the result of
  3031. non-interactive merging using the <tt class="docutils literal">internal:merge</tt> configuration
  3032. setting, or a command-line merge tool like <tt class="docutils literal">diff3</tt>. The resolve
  3033. command is used to manage the files involved in a merge, after
  3034. <a class="reference external" href="hg.1.html#merge"><tt class="docutils literal">hg merge</tt></a> has been run, and before <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit</tt></a> is run (i.e. the
  3035. working directory must have two parents). See <a class="reference external" href="hg.1.html#merge-tools"><tt class="docutils literal">hg help
  3036. <span class="pre">merge-tools</span></tt></a> for information on configuring merge tools.</p>
  3037. <p>The resolve command can be used in the following ways:</p>
  3038. <ul class="simple">
  3039. <li><a class="reference external" href="hg.1.html#resolve"><tt class="docutils literal">hg resolve <span class="pre">[--tool</span> TOOL] <span class="pre">FILE...</span></tt></a>: attempt to re-merge the specified
  3040. files, discarding any previous merge attempts. Re-merging is not
  3041. performed for files already marked as resolved. Use <tt class="docutils literal"><span class="pre">--all/-a</span></tt>
  3042. to select all unresolved files. <tt class="docutils literal"><span class="pre">--tool</span></tt> can be used to specify
  3043. the merge tool used for the given files. It overrides the HGMERGE
  3044. environment variable and your configuration files.  Previous file
  3045. contents are saved with a <tt class="docutils literal">.orig</tt> suffix.</li>
  3046. <li><a class="reference external" href="hg.1.html#resolve"><tt class="docutils literal">hg resolve <span class="pre">-m</span> [FILE]</tt></a>: mark a file as having been resolved
  3047. (e.g. after having manually fixed-up the files). The default is
  3048. to mark all unresolved files.</li>
  3049. <li><a class="reference external" href="hg.1.html#resolve"><tt class="docutils literal">hg resolve <span class="pre">-u</span> <span class="pre">[FILE]...</span></tt></a>: mark a file as unresolved. The
  3050. default is to mark all resolved files.</li>
  3051. <li><a class="reference external" href="hg.1.html#resolve"><tt class="docutils literal">hg resolve <span class="pre">-l</span></tt></a>: list files which had or still have conflicts.
  3052. In the printed list, <tt class="docutils literal">U</tt> = unresolved and <tt class="docutils literal">R</tt> = resolved.</li>
  3053. </ul>
  3054. <p>Note that Mercurial will not let you commit files with unresolved
  3055. merge conflicts. You must use <a class="reference external" href="hg.1.html#resolve"><tt class="docutils literal">hg resolve <span class="pre">-m</span> ...</tt></a> before you can
  3056. commit after a conflicting merge.</p>
  3057. <p>Returns 0 on success, 1 if any files fail a resolve attempt.</p>
  3058. <p>Options:</p>
  3059. <table class="docutils option-list" frame="void" rules="none">
  3060. <col class="option" />
  3061. <col class="description" />
  3062. <tbody valign="top">
  3063. <tr><td class="option-group">
  3064. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  3065. <td>select all unresolved files</td></tr>
  3066. <tr><td class="option-group">
  3067. <kbd><span class="option">-l</span>, <span class="option">--list</span></kbd></td>
  3068. <td>list state of files needing merge</td></tr>
  3069. <tr><td class="option-group">
  3070. <kbd><span class="option">-m</span>, <span class="option">--mark</span></kbd></td>
  3071. <td>mark files as resolved</td></tr>
  3072. <tr><td class="option-group">
  3073. <kbd><span class="option">-u</span>, <span class="option">--unmark</span></kbd></td>
  3074. <td>mark files as unresolved</td></tr>
  3075. <tr><td class="option-group" colspan="2">
  3076. <kbd><span class="option">-n</span>, <span class="option">--no-status</span></kbd></td>
  3077. </tr>
  3078. <tr><td>&nbsp;</td><td>hide status prefix</td></tr>
  3079. <tr><td class="option-group" colspan="2">
  3080. <kbd><span class="option">-t</span>, <span class="option">--tool <var>&lt;VALUE&gt;</var></span></kbd></td>
  3081. </tr>
  3082. <tr><td>&nbsp;</td><td>specify merge tool</td></tr>
  3083. <tr><td class="option-group" colspan="2">
  3084. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  3085. </tr>
  3086. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  3087. <tr><td class="option-group" colspan="2">
  3088. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  3089. </tr>
  3090. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  3091. <tr><td class="option-group" colspan="2">
  3092. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  3093. </tr>
  3094. <tr><td>&nbsp;</td><td>display with template (EXPERIMENTAL)</td></tr>
  3095. </tbody>
  3096. </table>
  3097. <p>[+] marked option can be specified multiple times</p>
  3098. </div>
  3099. <div class="section" id="revert">
  3100. <h2>revert</h2>
  3101. <p>restore files to their checkout state:</p>
  3102. <pre class="literal-block">
  3103. hg revert [OPTION]... [-r REV] [NAME]...
  3104. </pre>
  3105. <div class="note">
  3106. <p class="first admonition-title">Note</p>
  3107. <p class="last">To check out earlier revisions, you should use <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update REV</tt></a>.
  3108. To cancel an uncommitted merge (and lose your changes),
  3109. use <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update <span class="pre">--clean</span> .</tt></a>.</p>
  3110. </div>
  3111. <p>With no revision specified, revert the specified files or directories
  3112. to the contents they had in the parent of the working directory.
  3113. This restores the contents of files to an unmodified
  3114. state and unschedules adds, removes, copies, and renames. If the
  3115. working directory has two parents, you must explicitly specify a
  3116. revision.</p>
  3117. <p>Using the -r/--rev or -d/--date options, revert the given files or
  3118. directories to their states as of a specific revision. Because
  3119. revert does not change the working directory parents, this will
  3120. cause these files to appear modified. This can be helpful to &quot;back
  3121. out&quot; some or all of an earlier change. See <a class="reference external" href="hg.1.html#backout"><tt class="docutils literal">hg backout</tt></a> for a
  3122. related method.</p>
  3123. <p>Modified files are saved with a .orig suffix before reverting.
  3124. To disable these backups, use --no-backup.</p>
  3125. <p>See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for a list of formats valid for -d/--date.</p>
  3126. <p>Returns 0 on success.</p>
  3127. <p>Options:</p>
  3128. <table class="docutils option-list" frame="void" rules="none">
  3129. <col class="option" />
  3130. <col class="description" />
  3131. <tbody valign="top">
  3132. <tr><td class="option-group">
  3133. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  3134. <td>revert all changes when no arguments given</td></tr>
  3135. <tr><td class="option-group" colspan="2">
  3136. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  3137. </tr>
  3138. <tr><td>&nbsp;</td><td>tipmost revision matching date</td></tr>
  3139. <tr><td class="option-group" colspan="2">
  3140. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  3141. </tr>
  3142. <tr><td>&nbsp;</td><td>revert to the specified revision</td></tr>
  3143. <tr><td class="option-group" colspan="2">
  3144. <kbd><span class="option">-C</span>, <span class="option">--no-backup</span></kbd></td>
  3145. </tr>
  3146. <tr><td>&nbsp;</td><td>do not save backup copies of files</td></tr>
  3147. <tr><td class="option-group" colspan="2">
  3148. <kbd><span class="option">-i</span>, <span class="option">--interactive</span></kbd></td>
  3149. </tr>
  3150. <tr><td>&nbsp;</td><td>interactively select the changes (EXPERIMENTAL)</td></tr>
  3151. <tr><td class="option-group" colspan="2">
  3152. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  3153. </tr>
  3154. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  3155. <tr><td class="option-group" colspan="2">
  3156. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  3157. </tr>
  3158. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  3159. <tr><td class="option-group">
  3160. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  3161. <td>do not perform actions, just print output</td></tr>
  3162. </tbody>
  3163. </table>
  3164. <p>[+] marked option can be specified multiple times</p>
  3165. </div>
  3166. <div class="section" id="rollback">
  3167. <h2>rollback</h2>
  3168. <p>roll back the last transaction (DANGEROUS) (DEPRECATED):</p>
  3169. <pre class="literal-block">
  3170. hg rollback
  3171. </pre>
  3172. <p>Please use <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit <span class="pre">--amend</span></tt></a> instead of rollback to correct
  3173. mistakes in the last commit.</p>
  3174. <p>This command should be used with care. There is only one level of
  3175. rollback, and there is no way to undo a rollback. It will also
  3176. restore the dirstate at the time of the last transaction, losing
  3177. any dirstate changes since that time. This command does not alter
  3178. the working directory.</p>
  3179. <p>Transactions are used to encapsulate the effects of all commands
  3180. that create new changesets or propagate existing changesets into a
  3181. repository.</p>
  3182. <div class="verbose container">
  3183. <p>For example, the following commands are transactional, and their
  3184. effects can be rolled back:</p>
  3185. <ul class="simple">
  3186. <li>commit</li>
  3187. <li>import</li>
  3188. <li>pull</li>
  3189. <li>push (with this repository as the destination)</li>
  3190. <li>unbundle</li>
  3191. </ul>
  3192. <p>To avoid permanent data loss, rollback will refuse to rollback a
  3193. commit transaction if it isn't checked out. Use --force to
  3194. override this protection.</p>
  3195. </div>
  3196. <p>This command is not intended for use on public repositories. Once
  3197. changes are visible for pull by other users, rolling a transaction
  3198. back locally is ineffective (someone else may already have pulled
  3199. the changes). Furthermore, a race is possible with readers of the
  3200. repository; for example an in-progress pull from the repository
  3201. may fail if a rollback is performed.</p>
  3202. <p>Returns 0 on success, 1 if no rollback data is available.</p>
  3203. <p>Options:</p>
  3204. <table class="docutils option-list" frame="void" rules="none">
  3205. <col class="option" />
  3206. <col class="description" />
  3207. <tbody valign="top">
  3208. <tr><td class="option-group">
  3209. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  3210. <td>do not perform actions, just print output</td></tr>
  3211. <tr><td class="option-group">
  3212. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  3213. <td>ignore safety measures</td></tr>
  3214. </tbody>
  3215. </table>
  3216. </div>
  3217. <div class="section" id="root">
  3218. <h2>root</h2>
  3219. <p>print the root (top) of the current working directory:</p>
  3220. <pre class="literal-block">
  3221. hg root
  3222. </pre>
  3223. <p>Print the root directory of the current repository.</p>
  3224. <p>Returns 0 on success.</p>
  3225. </div>
  3226. <div class="section" id="serve">
  3227. <h2>serve</h2>
  3228. <p>start stand-alone webserver:</p>
  3229. <pre class="literal-block">
  3230. hg serve [OPTION]...
  3231. </pre>
  3232. <p>Start a local HTTP repository browser and pull server. You can use
  3233. this for ad-hoc sharing and browsing of repositories. It is
  3234. recommended to use a real web server to serve a repository for
  3235. longer periods of time.</p>
  3236. <p>Please note that the server does not implement access control.
  3237. This means that, by default, anybody can read from the server and
  3238. nobody can write to it by default. Set the <tt class="docutils literal">web.allow_push</tt>
  3239. option to <tt class="docutils literal">*</tt> to allow everybody to push to the server. You
  3240. should use a real web server if you need to authenticate users.</p>
  3241. <p>By default, the server logs accesses to stdout and errors to
  3242. stderr. Use the -A/--accesslog and -E/--errorlog options to log to
  3243. files.</p>
  3244. <p>To have the server choose a free port number to listen on, specify
  3245. a port number of 0; in this case, the server will print the port
  3246. number it uses.</p>
  3247. <p>Returns 0 on success.</p>
  3248. <p>Options:</p>
  3249. <table class="docutils option-list" frame="void" rules="none">
  3250. <col class="option" />
  3251. <col class="description" />
  3252. <tbody valign="top">
  3253. <tr><td class="option-group" colspan="2">
  3254. <kbd><span class="option">-A</span>, <span class="option">--accesslog <var>&lt;FILE&gt;</var></span></kbd></td>
  3255. </tr>
  3256. <tr><td>&nbsp;</td><td>name of access log file to write to</td></tr>
  3257. <tr><td class="option-group">
  3258. <kbd><span class="option">-d</span>, <span class="option">--daemon</span></kbd></td>
  3259. <td>run server in background</td></tr>
  3260. <tr><td class="option-group" colspan="2">
  3261. <kbd><span class="option">--daemon-pipefds <var>&lt;FILE&gt;</var></span></kbd></td>
  3262. </tr>
  3263. <tr><td>&nbsp;</td><td>used internally by daemon mode</td></tr>
  3264. <tr><td class="option-group" colspan="2">
  3265. <kbd><span class="option">-E</span>, <span class="option">--errorlog <var>&lt;FILE&gt;</var></span></kbd></td>
  3266. </tr>
  3267. <tr><td>&nbsp;</td><td>name of error log file to write to</td></tr>
  3268. <tr><td class="option-group" colspan="2">
  3269. <kbd><span class="option">-p</span>, <span class="option">--port <var>&lt;PORT&gt;</var></span></kbd></td>
  3270. </tr>
  3271. <tr><td>&nbsp;</td><td>port to listen on (default: 8000)</td></tr>
  3272. <tr><td class="option-group" colspan="2">
  3273. <kbd><span class="option">-a</span>, <span class="option">--address <var>&lt;ADDR&gt;</var></span></kbd></td>
  3274. </tr>
  3275. <tr><td>&nbsp;</td><td>address to listen on (default: all interfaces)</td></tr>
  3276. <tr><td class="option-group" colspan="2">
  3277. <kbd><span class="option">--prefix <var>&lt;PREFIX&gt;</var></span></kbd></td>
  3278. </tr>
  3279. <tr><td>&nbsp;</td><td>prefix path to serve from (default: server root)</td></tr>
  3280. <tr><td class="option-group" colspan="2">
  3281. <kbd><span class="option">-n</span>, <span class="option">--name <var>&lt;NAME&gt;</var></span></kbd></td>
  3282. </tr>
  3283. <tr><td>&nbsp;</td><td>name to show in web pages (default: working directory)</td></tr>
  3284. <tr><td class="option-group" colspan="2">
  3285. <kbd><span class="option">--web-conf <var>&lt;FILE&gt;</var></span></kbd></td>
  3286. </tr>
  3287. <tr><td>&nbsp;</td><td>name of the hgweb config file (see &quot;hg help hgweb&quot;)</td></tr>
  3288. <tr><td class="option-group" colspan="2">
  3289. <kbd><span class="option">--webdir-conf <var>&lt;FILE&gt;</var></span></kbd></td>
  3290. </tr>
  3291. <tr><td>&nbsp;</td><td>name of the hgweb config file (DEPRECATED)</td></tr>
  3292. <tr><td class="option-group" colspan="2">
  3293. <kbd><span class="option">--pid-file <var>&lt;FILE&gt;</var></span></kbd></td>
  3294. </tr>
  3295. <tr><td>&nbsp;</td><td>name of file to write process ID to</td></tr>
  3296. <tr><td class="option-group">
  3297. <kbd><span class="option">--stdio</span></kbd></td>
  3298. <td>for remote clients</td></tr>
  3299. <tr><td class="option-group" colspan="2">
  3300. <kbd><span class="option">--cmdserver <var>&lt;MODE&gt;</var></span></kbd></td>
  3301. </tr>
  3302. <tr><td>&nbsp;</td><td>for remote clients</td></tr>
  3303. <tr><td class="option-group" colspan="2">
  3304. <kbd><span class="option">-t</span>, <span class="option">--templates <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  3305. </tr>
  3306. <tr><td>&nbsp;</td><td>web templates to use</td></tr>
  3307. <tr><td class="option-group" colspan="2">
  3308. <kbd><span class="option">--style <var>&lt;STYLE&gt;</var></span></kbd></td>
  3309. </tr>
  3310. <tr><td>&nbsp;</td><td>template style to use</td></tr>
  3311. <tr><td class="option-group">
  3312. <kbd><span class="option">-6</span>, <span class="option">--ipv6</span></kbd></td>
  3313. <td>use IPv6 in addition to IPv4</td></tr>
  3314. <tr><td class="option-group" colspan="2">
  3315. <kbd><span class="option">--certificate <var>&lt;FILE&gt;</var></span></kbd></td>
  3316. </tr>
  3317. <tr><td>&nbsp;</td><td>SSL certificate file</td></tr>
  3318. </tbody>
  3319. </table>
  3320. </div>
  3321. <div class="section" id="status">
  3322. <h2>status</h2>
  3323. <p>show changed files in the working directory:</p>
  3324. <pre class="literal-block">
  3325. hg status [OPTION]... [FILE]...
  3326. </pre>
  3327. <p>Show status of files in the repository. If names are given, only
  3328. files that match are shown. Files that are clean or ignored or
  3329. the source of a copy/move operation, are not listed unless
  3330. -c/--clean, -i/--ignored, -C/--copies or -A/--all are given.
  3331. Unless options described with &quot;show only ...&quot; are given, the
  3332. options -mardu are used.</p>
  3333. <p>Option -q/--quiet hides untracked (unknown and ignored) files
  3334. unless explicitly requested with -u/--unknown or -i/--ignored.</p>
  3335. <div class="note">
  3336. <p class="first admonition-title">Note</p>
  3337. <p class="last">status may appear to disagree with diff if permissions have
  3338. changed or a merge has occurred. The standard diff format does
  3339. not report permission changes and diff only reports changes
  3340. relative to one merge parent.</p>
  3341. </div>
  3342. <p>If one revision is given, it is used as the base revision.
  3343. If two revisions are given, the differences between them are
  3344. shown. The --change option can also be used as a shortcut to list
  3345. the changed files of a revision from its first parent.</p>
  3346. <p>The codes used to show the status of files are:</p>
  3347. <pre class="literal-block">
  3348. M = modified
  3349. A = added
  3350. R = removed
  3351. C = clean
  3352. ! = missing (deleted by non-hg command, but still tracked)
  3353. ? = not tracked
  3354. I = ignored
  3355.   = origin of the previous file (with --copies)
  3356. </pre>
  3357. <div class="verbose container">
  3358. <p>Examples:</p>
  3359. <ul>
  3360. <li><p class="first">show changes in the working directory relative to a
  3361. changeset:</p>
  3362. <pre class="literal-block">
  3363. hg status --rev 9353
  3364. </pre>
  3365. </li>
  3366. <li><p class="first">show changes in the working directory relative to the
  3367. current directory (see <a class="reference external" href="hg.1.html#patterns"><tt class="docutils literal">hg help patterns</tt></a> for more information):</p>
  3368. <pre class="literal-block">
  3369. hg status re:
  3370. </pre>
  3371. </li>
  3372. <li><p class="first">show all changes including copies in an existing changeset:</p>
  3373. <pre class="literal-block">
  3374. hg status --copies --change 9353
  3375. </pre>
  3376. </li>
  3377. <li><p class="first">get a NUL separated list of added files, suitable for xargs:</p>
  3378. <pre class="literal-block">
  3379. hg status -an0
  3380. </pre>
  3381. </li>
  3382. </ul>
  3383. </div>
  3384. <p>Returns 0 on success.</p>
  3385. <p>Options:</p>
  3386. <table class="docutils option-list" frame="void" rules="none">
  3387. <col class="option" />
  3388. <col class="description" />
  3389. <tbody valign="top">
  3390. <tr><td class="option-group">
  3391. <kbd><span class="option">-A</span>, <span class="option">--all</span></kbd></td>
  3392. <td>show status of all files</td></tr>
  3393. <tr><td class="option-group">
  3394. <kbd><span class="option">-m</span>, <span class="option">--modified</span></kbd></td>
  3395. <td>show only modified files</td></tr>
  3396. <tr><td class="option-group">
  3397. <kbd><span class="option">-a</span>, <span class="option">--added</span></kbd></td>
  3398. <td>show only added files</td></tr>
  3399. <tr><td class="option-group">
  3400. <kbd><span class="option">-r</span>, <span class="option">--removed</span></kbd></td>
  3401. <td>show only removed files</td></tr>
  3402. <tr><td class="option-group">
  3403. <kbd><span class="option">-d</span>, <span class="option">--deleted</span></kbd></td>
  3404. <td>show only deleted (but tracked) files</td></tr>
  3405. <tr><td class="option-group">
  3406. <kbd><span class="option">-c</span>, <span class="option">--clean</span></kbd></td>
  3407. <td>show only files without changes</td></tr>
  3408. <tr><td class="option-group">
  3409. <kbd><span class="option">-u</span>, <span class="option">--unknown</span></kbd></td>
  3410. <td>show only unknown (not tracked) files</td></tr>
  3411. <tr><td class="option-group">
  3412. <kbd><span class="option">-i</span>, <span class="option">--ignored</span></kbd></td>
  3413. <td>show only ignored files</td></tr>
  3414. <tr><td class="option-group" colspan="2">
  3415. <kbd><span class="option">-n</span>, <span class="option">--no-status</span></kbd></td>
  3416. </tr>
  3417. <tr><td>&nbsp;</td><td>hide status prefix</td></tr>
  3418. <tr><td class="option-group">
  3419. <kbd><span class="option">-C</span>, <span class="option">--copies</span></kbd></td>
  3420. <td>show source of copied files</td></tr>
  3421. <tr><td class="option-group">
  3422. <kbd><span class="option">-0</span>, <span class="option">--print0</span></kbd></td>
  3423. <td>end filenames with NUL, for use with xargs</td></tr>
  3424. <tr><td class="option-group">
  3425. <kbd><span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  3426. <td>show difference from revision</td></tr>
  3427. <tr><td class="option-group">
  3428. <kbd><span class="option">--change <var>&lt;REV&gt;</var></span></kbd></td>
  3429. <td>list the changed files of a revision</td></tr>
  3430. <tr><td class="option-group" colspan="2">
  3431. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  3432. </tr>
  3433. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  3434. <tr><td class="option-group" colspan="2">
  3435. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  3436. </tr>
  3437. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  3438. <tr><td class="option-group">
  3439. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  3440. <td>recurse into subrepositories</td></tr>
  3441. <tr><td class="option-group" colspan="2">
  3442. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  3443. </tr>
  3444. <tr><td>&nbsp;</td><td>display with template (EXPERIMENTAL)</td></tr>
  3445. </tbody>
  3446. </table>
  3447. <p>[+] marked option can be specified multiple times</p>
  3448. <blockquote>
  3449. aliases: st</blockquote>
  3450. </div>
  3451. <div class="section" id="summary">
  3452. <h2>summary</h2>
  3453. <p>summarize working directory state:</p>
  3454. <pre class="literal-block">
  3455. hg summary [--remote]
  3456. </pre>
  3457. <p>This generates a brief summary of the working directory state,
  3458. including parents, branch, commit status, phase and available updates.</p>
  3459. <p>With the --remote option, this will check the default paths for
  3460. incoming and outgoing changes. This can be time-consuming.</p>
  3461. <p>Returns 0 on success.</p>
  3462. <p>Options:</p>
  3463. <table class="docutils option-list" frame="void" rules="none">
  3464. <col class="option" />
  3465. <col class="description" />
  3466. <tbody valign="top">
  3467. <tr><td class="option-group">
  3468. <kbd><span class="option">--remote</span></kbd></td>
  3469. <td><p class="first">check for push and pull</p>
  3470. <p class="last">aliases: sum</p>
  3471. </td></tr>
  3472. </tbody>
  3473. </table>
  3474. </div>
  3475. <div class="section" id="tag">
  3476. <h2>tag</h2>
  3477. <p>add one or more tags for the current or given revision:</p>
  3478. <pre class="literal-block">
  3479. hg tag [-f] [-l] [-m TEXT] [-d DATE] [-u USER] [-r REV] NAME...
  3480. </pre>
  3481. <p>Name a particular revision using &lt;name&gt;.</p>
  3482. <p>Tags are used to name particular revisions of the repository and are
  3483. very useful to compare different revisions, to go back to significant
  3484. earlier versions or to mark branch points as releases, etc. Changing
  3485. an existing tag is normally disallowed; use -f/--force to override.</p>
  3486. <p>If no revision is given, the parent of the working directory is
  3487. used.</p>
  3488. <p>To facilitate version control, distribution, and merging of tags,
  3489. they are stored as a file named &quot;.hgtags&quot; which is managed similarly
  3490. to other project files and can be hand-edited if necessary. This
  3491. also means that tagging creates a new commit. The file
  3492. &quot;.hg/localtags&quot; is used for local tags (not shared among
  3493. repositories).</p>
  3494. <p>Tag commits are usually made at the head of a branch. If the parent
  3495. of the working directory is not a branch head, <a class="reference external" href="hg.1.html#tag"><tt class="docutils literal">hg tag</tt></a> aborts; use
  3496. -f/--force to force the tag commit to be based on a non-head
  3497. changeset.</p>
  3498. <p>See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for a list of formats valid for -d/--date.</p>
  3499. <p>Since tag names have priority over branch names during revision
  3500. lookup, using an existing branch name as a tag name is discouraged.</p>
  3501. <p>Returns 0 on success.</p>
  3502. <p>Options:</p>
  3503. <table class="docutils option-list" frame="void" rules="none">
  3504. <col class="option" />
  3505. <col class="description" />
  3506. <tbody valign="top">
  3507. <tr><td class="option-group">
  3508. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  3509. <td>force tag</td></tr>
  3510. <tr><td class="option-group">
  3511. <kbd><span class="option">-l</span>, <span class="option">--local</span></kbd></td>
  3512. <td>make the tag local</td></tr>
  3513. <tr><td class="option-group" colspan="2">
  3514. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  3515. </tr>
  3516. <tr><td>&nbsp;</td><td>revision to tag</td></tr>
  3517. <tr><td class="option-group">
  3518. <kbd><span class="option">--remove</span></kbd></td>
  3519. <td>remove a tag</td></tr>
  3520. <tr><td class="option-group">
  3521. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  3522. <td>invoke editor on commit messages</td></tr>
  3523. <tr><td class="option-group" colspan="2">
  3524. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  3525. </tr>
  3526. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  3527. <tr><td class="option-group" colspan="2">
  3528. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  3529. </tr>
  3530. <tr><td>&nbsp;</td><td>record the specified date as commit date</td></tr>
  3531. <tr><td class="option-group" colspan="2">
  3532. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  3533. </tr>
  3534. <tr><td>&nbsp;</td><td>record the specified user as committer</td></tr>
  3535. </tbody>
  3536. </table>
  3537. </div>
  3538. <div class="section" id="tags">
  3539. <h2>tags</h2>
  3540. <p>list repository tags:</p>
  3541. <pre class="literal-block">
  3542. hg tags
  3543. </pre>
  3544. <p>This lists both regular and local tags. When the -v/--verbose
  3545. switch is used, a third column &quot;local&quot; is printed for local tags.</p>
  3546. <p>Returns 0 on success.</p>
  3547. <p>Options:</p>
  3548. <table class="docutils option-list" frame="void" rules="none">
  3549. <col class="option" />
  3550. <col class="description" />
  3551. <tbody valign="top">
  3552. <tr><td class="option-group" colspan="2">
  3553. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  3554. </tr>
  3555. <tr><td>&nbsp;</td><td>display with template (EXPERIMENTAL)</td></tr>
  3556. </tbody>
  3557. </table>
  3558. </div>
  3559. <div class="section" id="tip">
  3560. <h2>tip</h2>
  3561. <p>show the tip revision (DEPRECATED):</p>
  3562. <pre class="literal-block">
  3563. hg tip [-p] [-g]
  3564. </pre>
  3565. <p>The tip revision (usually just called the tip) is the changeset
  3566. most recently added to the repository (and therefore the most
  3567. recently changed head).</p>
  3568. <p>If you have just made a commit, that commit will be the tip. If
  3569. you have just pulled changes from another repository, the tip of
  3570. that repository becomes the current tip. The &quot;tip&quot; tag is special
  3571. and cannot be renamed or assigned to a different changeset.</p>
  3572. <p>This command is deprecated, please use <a class="reference external" href="hg.1.html#heads"><tt class="docutils literal">hg heads</tt></a> instead.</p>
  3573. <p>Returns 0 on success.</p>
  3574. <p>Options:</p>
  3575. <table class="docutils option-list" frame="void" rules="none">
  3576. <col class="option" />
  3577. <col class="description" />
  3578. <tbody valign="top">
  3579. <tr><td class="option-group">
  3580. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  3581. <td>show patch</td></tr>
  3582. <tr><td class="option-group">
  3583. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  3584. <td>use git extended diff format</td></tr>
  3585. <tr><td class="option-group" colspan="2">
  3586. <kbd><span class="option">--style <var>&lt;STYLE&gt;</var></span></kbd></td>
  3587. </tr>
  3588. <tr><td>&nbsp;</td><td>display using template map file (DEPRECATED)</td></tr>
  3589. <tr><td class="option-group" colspan="2">
  3590. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  3591. </tr>
  3592. <tr><td>&nbsp;</td><td>display with template</td></tr>
  3593. </tbody>
  3594. </table>
  3595. </div>
  3596. <div class="section" id="unbundle">
  3597. <h2>unbundle</h2>
  3598. <p>apply one or more changegroup files:</p>
  3599. <pre class="literal-block">
  3600. hg unbundle [-u] FILE...
  3601. </pre>
  3602. <p>Apply one or more compressed changegroup files generated by the
  3603. bundle command.</p>
  3604. <p>Returns 0 on success, 1 if an update has unresolved files.</p>
  3605. <p>Options:</p>
  3606. <table class="docutils option-list" frame="void" rules="none">
  3607. <col class="option" />
  3608. <col class="description" />
  3609. <tbody valign="top">
  3610. <tr><td class="option-group">
  3611. <kbd><span class="option">-u</span>, <span class="option">--update</span></kbd></td>
  3612. <td>update to new branch head if changesets were unbundled</td></tr>
  3613. </tbody>
  3614. </table>
  3615. </div>
  3616. <div class="section" id="update">
  3617. <h2>update</h2>
  3618. <p>update working directory (or switch revisions):</p>
  3619. <pre class="literal-block">
  3620. hg update [-c] [-C] [-d DATE] [[-r] REV]
  3621. </pre>
  3622. <p>Update the repository's working directory to the specified
  3623. changeset. If no changeset is specified, update to the tip of the
  3624. current named branch and move the active bookmark (see <a class="reference external" href="hg.1.html#bookmarks"><tt class="docutils literal">hg help
  3625. bookmarks</tt></a>).</p>
  3626. <p>Update sets the working directory's parent revision to the specified
  3627. changeset (see <a class="reference external" href="hg.1.html#parents"><tt class="docutils literal">hg help parents</tt></a>).</p>
  3628. <p>If the changeset is not a descendant or ancestor of the working
  3629. directory's parent, the update is aborted. With the -c/--check
  3630. option, the working directory is checked for uncommitted changes; if
  3631. none are found, the working directory is updated to the specified
  3632. changeset.</p>
  3633. <div class="verbose container">
  3634. <p>The following rules apply when the working directory contains
  3635. uncommitted changes:</p>
  3636. <ol class="arabic simple">
  3637. <li>If neither -c/--check nor -C/--clean is specified, and if
  3638. the requested changeset is an ancestor or descendant of
  3639. the working directory's parent, the uncommitted changes
  3640. are merged into the requested changeset and the merged
  3641. result is left uncommitted. If the requested changeset is
  3642. not an ancestor or descendant (that is, it is on another
  3643. branch), the update is aborted and the uncommitted changes
  3644. are preserved.</li>
  3645. <li>With the -c/--check option, the update is aborted and the
  3646. uncommitted changes are preserved.</li>
  3647. <li>With the -C/--clean option, uncommitted changes are discarded and
  3648. the working directory is updated to the requested changeset.</li>
  3649. </ol>
  3650. </div>
  3651. <p>To cancel an uncommitted merge (and lose your changes), use
  3652. <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update <span class="pre">--clean</span> .</tt></a>.</p>
  3653. <p>Use null as the changeset to remove the working directory (like
  3654. <a class="reference external" href="hg.1.html#clone"><tt class="docutils literal">hg clone <span class="pre">-U</span></tt></a>).</p>
  3655. <p>If you want to revert just one file to an older revision, use
  3656. <a class="reference external" href="hg.1.html#revert"><tt class="docutils literal">hg revert <span class="pre">[-r</span> REV] NAME</tt></a>.</p>
  3657. <p>See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for a list of formats valid for -d/--date.</p>
  3658. <p>Returns 0 on success, 1 if there are unresolved files.</p>
  3659. <p>Options:</p>
  3660. <table class="docutils option-list" frame="void" rules="none">
  3661. <col class="option" />
  3662. <col class="description" />
  3663. <tbody valign="top">
  3664. <tr><td class="option-group">
  3665. <kbd><span class="option">-C</span>, <span class="option">--clean</span></kbd></td>
  3666. <td>discard uncommitted changes (no backup)</td></tr>
  3667. <tr><td class="option-group">
  3668. <kbd><span class="option">-c</span>, <span class="option">--check</span></kbd></td>
  3669. <td>update across branches if no uncommitted changes</td></tr>
  3670. <tr><td class="option-group" colspan="2">
  3671. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  3672. </tr>
  3673. <tr><td>&nbsp;</td><td>tipmost revision matching date</td></tr>
  3674. <tr><td class="option-group" colspan="2">
  3675. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  3676. </tr>
  3677. <tr><td>&nbsp;</td><td>revision</td></tr>
  3678. <tr><td class="option-group" colspan="2">
  3679. <kbd><span class="option">-t</span>, <span class="option">--tool <var>&lt;VALUE&gt;</var></span></kbd></td>
  3680. </tr>
  3681. <tr><td>&nbsp;</td><td><p class="first">specify merge tool</p>
  3682. <p class="last">aliases: up checkout co</p>
  3683. </td></tr>
  3684. </tbody>
  3685. </table>
  3686. </div>
  3687. <div class="section" id="verify">
  3688. <h2>verify</h2>
  3689. <p>verify the integrity of the repository:</p>
  3690. <pre class="literal-block">
  3691. hg verify
  3692. </pre>
  3693. <p>Verify the integrity of the current repository.</p>
  3694. <p>This will perform an extensive check of the repository's
  3695. integrity, validating the hashes and checksums of each entry in
  3696. the changelog, manifest, and tracked files, as well as the
  3697. integrity of their crosslinks and indices.</p>
  3698. <p>Please see <a class="reference external" href="http://mercurial.selenic.com/wiki/RepositoryCorruption">http://mercurial.selenic.com/wiki/RepositoryCorruption</a>
  3699. for more information about recovery from corruption of the
  3700. repository.</p>
  3701. <p>Returns 0 on success, 1 if errors are encountered.</p>
  3702. </div>
  3703. <div class="section" id="version">
  3704. <h2>version</h2>
  3705. <p>output version and copyright information:</p>
  3706. <pre class="literal-block">
  3707. hg version
  3708. </pre>
  3709. <p>output version and copyright information</p>
  3710. </div>
  3711. </div>
  3712. <div class="section" id="date-formats">
  3713. <span id="dates"></span><h1><a class="toc-backref" href="#contents">Date Formats</a></h1>
  3714. <p>Some commands allow the user to specify a date, e.g.:</p>
  3715. <ul class="simple">
  3716. <li>backout, commit, import, tag: Specify the commit date.</li>
  3717. <li>log, revert, update: Select revision(s) by date.</li>
  3718. </ul>
  3719. <p>Many date formats are valid. Here are some examples:</p>
  3720. <ul class="simple">
  3721. <li><tt class="docutils literal">Wed Dec 6 13:18:29 2006</tt> (local timezone assumed)</li>
  3722. <li><tt class="docutils literal">Dec 6 13:18 <span class="pre">-0600</span></tt> (year assumed, time offset provided)</li>
  3723. <li><tt class="docutils literal">Dec 6 13:18 UTC</tt> (UTC and GMT are aliases for +0000)</li>
  3724. <li><tt class="docutils literal">Dec 6</tt> (midnight)</li>
  3725. <li><tt class="docutils literal">13:18</tt> (today assumed)</li>
  3726. <li><tt class="docutils literal">3:39</tt> (3:39AM assumed)</li>
  3727. <li><tt class="docutils literal">3:39pm</tt> (15:39)</li>
  3728. <li><tt class="docutils literal"><span class="pre">2006-12-06</span> 13:18:29</tt> (ISO 8601 format)</li>
  3729. <li><tt class="docutils literal"><span class="pre">2006-12-6</span> 13:18</tt></li>
  3730. <li><tt class="docutils literal"><span class="pre">2006-12-6</span></tt></li>
  3731. <li><tt class="docutils literal"><span class="pre">12-6</span></tt></li>
  3732. <li><tt class="docutils literal">12/6</tt></li>
  3733. <li><tt class="docutils literal">12/6/6</tt> (Dec 6 2006)</li>
  3734. <li><tt class="docutils literal">today</tt> (midnight)</li>
  3735. <li><tt class="docutils literal">yesterday</tt> (midnight)</li>
  3736. <li><tt class="docutils literal">now</tt> - right now</li>
  3737. </ul>
  3738. <p>Lastly, there is Mercurial's internal format:</p>
  3739. <ul class="simple">
  3740. <li><tt class="docutils literal">1165411109 0</tt> (Wed Dec 6 13:18:29 2006 UTC)</li>
  3741. </ul>
  3742. <p>This is the internal representation format for dates. The first number
  3743. is the number of seconds since the epoch (1970-01-01 00:00 UTC). The
  3744. second is the offset of the local timezone, in seconds west of UTC
  3745. (negative if the timezone is east of UTC).</p>
  3746. <p>The log command also accepts date ranges:</p>
  3747. <ul class="simple">
  3748. <li><tt class="docutils literal">&lt;DATE</tt> - at or before a given date/time</li>
  3749. <li><tt class="docutils literal">&gt;DATE</tt> - on or after a given date/time</li>
  3750. <li><tt class="docutils literal">DATE to DATE</tt> - a date range, inclusive</li>
  3751. <li><tt class="docutils literal"><span class="pre">-DAYS</span></tt> - within a given number of days of today</li>
  3752. </ul>
  3753. </div>
  3754. <div class="section" id="diff-formats">
  3755. <span id="diffs"></span><h1><a class="toc-backref" href="#contents">Diff Formats</a></h1>
  3756. <p>Mercurial's default format for showing changes between two versions of
  3757. a file is compatible with the unified format of GNU diff, which can be
  3758. used by GNU patch and many other standard tools.</p>
  3759. <p>While this standard format is often enough, it does not encode the
  3760. following information:</p>
  3761. <ul class="simple">
  3762. <li>executable status and other permission bits</li>
  3763. <li>copy or rename information</li>
  3764. <li>changes in binary files</li>
  3765. <li>creation or deletion of empty files</li>
  3766. </ul>
  3767. <p>Mercurial also supports the extended diff format from the git VCS
  3768. which addresses these limitations. The git diff format is not produced
  3769. by default because a few widespread tools still do not understand this
  3770. format.</p>
  3771. <p>This means that when generating diffs from a Mercurial repository
  3772. (e.g. with <a class="reference external" href="hg.1.html#export"><tt class="docutils literal">hg export</tt></a>), you should be careful about things like file
  3773. copies and renames or other things mentioned above, because when
  3774. applying a standard diff to a different repository, this extra
  3775. information is lost. Mercurial's internal operations (like push and
  3776. pull) are not affected by this, because they use an internal binary
  3777. format for communicating changes.</p>
  3778. <p>To make Mercurial produce the git extended diff format, use the --git
  3779. option available for many commands, or set 'git = True' in the [diff]
  3780. section of your configuration file. You do not need to set this option
  3781. when importing diffs in this format or using them in the mq extension.</p>
  3782. </div>
  3783. <div class="section" id="environment-variables">
  3784. <span id="env"></span><span id="environment"></span><h1><a class="toc-backref" href="#contents">Environment Variables</a></h1>
  3785. <dl class="docutils">
  3786. <dt>HG</dt>
  3787. <dd>Path to the 'hg' executable, automatically passed when running
  3788. hooks, extensions or external tools. If unset or empty, this is
  3789. the hg executable's name if it's frozen, or an executable named
  3790. 'hg' (with %PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on
  3791. Windows) is searched.</dd>
  3792. <dt>HGEDITOR</dt>
  3793. <dd><p class="first">This is the name of the editor to run when committing. See EDITOR.</p>
  3794. <p class="last">(deprecated, use configuration file)</p>
  3795. </dd>
  3796. <dt>HGENCODING</dt>
  3797. <dd>This overrides the default locale setting detected by Mercurial.
  3798. This setting is used to convert data including usernames,
  3799. changeset descriptions, tag names, and branches. This setting can
  3800. be overridden with the --encoding command-line option.</dd>
  3801. <dt>HGENCODINGMODE</dt>
  3802. <dd>This sets Mercurial's behavior for handling unknown characters
  3803. while transcoding user input. The default is &quot;strict&quot;, which
  3804. causes Mercurial to abort if it can't map a character. Other
  3805. settings include &quot;replace&quot;, which replaces unknown characters, and
  3806. &quot;ignore&quot;, which drops them. This setting can be overridden with
  3807. the --encodingmode command-line option.</dd>
  3808. <dt>HGENCODINGAMBIGUOUS</dt>
  3809. <dd>This sets Mercurial's behavior for handling characters with
  3810. &quot;ambiguous&quot; widths like accented Latin characters with East Asian
  3811. fonts. By default, Mercurial assumes ambiguous characters are
  3812. narrow, set this variable to &quot;wide&quot; if such characters cause
  3813. formatting problems.</dd>
  3814. <dt>HGMERGE</dt>
  3815. <dd><p class="first">An executable to use for resolving merge conflicts. The program
  3816. will be executed with three arguments: local file, remote file,
  3817. ancestor file.</p>
  3818. <p class="last">(deprecated, use configuration file)</p>
  3819. </dd>
  3820. <dt>HGRCPATH</dt>
  3821. <dd><p class="first">A list of files or directories to search for configuration
  3822. files. Item separator is &quot;:&quot; on Unix, &quot;;&quot; on Windows. If HGRCPATH
  3823. is not set, platform default search path is used. If empty, only
  3824. the .hg/hgrc from the current repository is read.</p>
  3825. <p>For each element in HGRCPATH:</p>
  3826. <ul class="last simple">
  3827. <li>if it's a directory, all files ending with .rc are added</li>
  3828. <li>otherwise, the file itself will be added</li>
  3829. </ul>
  3830. </dd>
  3831. <dt>HGPLAIN</dt>
  3832. <dd><p class="first">When set, this disables any configuration settings that might
  3833. change Mercurial's default output. This includes encoding,
  3834. defaults, verbose mode, debug mode, quiet mode, tracebacks, and
  3835. localization. This can be useful when scripting against Mercurial
  3836. in the face of existing user configuration.</p>
  3837. <p class="last">Equivalent options set via command line flags or environment
  3838. variables are not overridden.</p>
  3839. </dd>
  3840. <dt>HGPLAINEXCEPT</dt>
  3841. <dd><p class="first">This is a comma-separated list of features to preserve when
  3842. HGPLAIN is enabled. Currently the only value supported is &quot;i18n&quot;,
  3843. which preserves internationalization in plain mode.</p>
  3844. <p class="last">Setting HGPLAINEXCEPT to anything (even an empty string) will
  3845. enable plain mode.</p>
  3846. </dd>
  3847. <dt>HGUSER</dt>
  3848. <dd><p class="first">This is the string used as the author of a commit. If not set,
  3849. available values will be considered in this order:</p>
  3850. <ul class="simple">
  3851. <li>HGUSER (deprecated)</li>
  3852. <li>configuration files from the HGRCPATH</li>
  3853. <li>EMAIL</li>
  3854. <li>interactive prompt</li>
  3855. <li>LOGNAME (with <tt class="docutils literal">&#64;hostname</tt> appended)</li>
  3856. </ul>
  3857. <p class="last">(deprecated, use configuration file)</p>
  3858. </dd>
  3859. <dt>EMAIL</dt>
  3860. <dd>May be used as the author of a commit; see HGUSER.</dd>
  3861. <dt>LOGNAME</dt>
  3862. <dd>May be used as the author of a commit; see HGUSER.</dd>
  3863. <dt>VISUAL</dt>
  3864. <dd>This is the name of the editor to use when committing. See EDITOR.</dd>
  3865. <dt>EDITOR</dt>
  3866. <dd>Sometimes Mercurial needs to open a text file in an editor for a
  3867. user to modify, for example when writing commit messages. The
  3868. editor it uses is determined by looking at the environment
  3869. variables HGEDITOR, VISUAL and EDITOR, in that order. The first
  3870. non-empty one is chosen. If all of them are empty, the editor
  3871. defaults to 'vi'.</dd>
  3872. <dt>PYTHONPATH</dt>
  3873. <dd>This is used by Python to find imported modules and may need to be
  3874. set appropriately if this Mercurial is not installed system-wide.</dd>
  3875. </dl>
  3876. </div>
  3877. <div class="section" id="using-additional-features">
  3878. <span id="extensions"></span><h1><a class="toc-backref" href="#contents">Using Additional Features</a></h1>
  3879. <p>Mercurial has the ability to add new features through the use of
  3880. extensions. Extensions may add new commands, add options to
  3881. existing commands, change the default behavior of commands, or
  3882. implement hooks.</p>
  3883. <p>To enable the &quot;foo&quot; extension, either shipped with Mercurial or in the
  3884. Python search path, create an entry for it in your configuration file,
  3885. like this:</p>
  3886. <pre class="literal-block">
  3887. [extensions]
  3888. foo =
  3889. </pre>
  3890. <p>You may also specify the full path to an extension:</p>
  3891. <pre class="literal-block">
  3892. [extensions]
  3893. myfeature = ~/.hgext/myfeature.py
  3894. </pre>
  3895. <p>See <a class="reference external" href="hg.1.html#config"><tt class="docutils literal">hg help config</tt></a> for more information on configuration files.</p>
  3896. <p>Extensions are not loaded by default for a variety of reasons:
  3897. they can increase startup overhead; they may be meant for advanced
  3898. usage only; they may provide potentially dangerous abilities (such
  3899. as letting you destroy or modify history); they might not be ready
  3900. for prime time; or they may alter some usual behaviors of stock
  3901. Mercurial. It is thus up to the user to activate extensions as
  3902. needed.</p>
  3903. <p>To explicitly disable an extension enabled in a configuration file of
  3904. broader scope, prepend its path with !:</p>
  3905. <pre class="literal-block">
  3906. [extensions]
  3907. # disabling extension bar residing in /path/to/extension/bar.py
  3908. bar = !/path/to/extension/bar.py
  3909. # ditto, but no path was supplied for extension baz
  3910. baz = !
  3911. </pre>
  3912. <p>disabled extensions:</p>
  3913. <blockquote>
  3914. <table class="docutils field-list" frame="void" rules="none">
  3915. <col class="field-name" />
  3916. <col class="field-body" />
  3917. <tbody valign="top">
  3918. <tr class="field"><th class="field-name">acl:</th><td class="field-body">hooks for controlling repository access</td>
  3919. </tr>
  3920. <tr class="field"><th class="field-name">blackbox:</th><td class="field-body">log repository events to a blackbox for debugging</td>
  3921. </tr>
  3922. <tr class="field"><th class="field-name">bugzilla:</th><td class="field-body">hooks for integrating with the Bugzilla bug tracker</td>
  3923. </tr>
  3924. <tr class="field"><th class="field-name">censor:</th><td class="field-body">erase file content at a given revision</td>
  3925. </tr>
  3926. <tr class="field"><th class="field-name">churn:</th><td class="field-body">command to display statistics about repository history</td>
  3927. </tr>
  3928. <tr class="field"><th class="field-name">color:</th><td class="field-body">colorize output from some commands</td>
  3929. </tr>
  3930. <tr class="field"><th class="field-name">convert:</th><td class="field-body">import revisions from foreign VCS repositories into Mercurial</td>
  3931. </tr>
  3932. <tr class="field"><th class="field-name">eol:</th><td class="field-body">automatically manage newlines in repository files</td>
  3933. </tr>
  3934. <tr class="field"><th class="field-name">extdiff:</th><td class="field-body">command to allow external programs to compare revisions</td>
  3935. </tr>
  3936. <tr class="field"><th class="field-name">factotum:</th><td class="field-body">http authentication with factotum</td>
  3937. </tr>
  3938. <tr class="field"><th class="field-name">gpg:</th><td class="field-body">commands to sign and verify changesets</td>
  3939. </tr>
  3940. <tr class="field"><th class="field-name">hgcia:</th><td class="field-body">hooks for integrating with the CIA.vc notification service</td>
  3941. </tr>
  3942. <tr class="field"><th class="field-name">hgk:</th><td class="field-body">browse the repository in a graphical way</td>
  3943. </tr>
  3944. <tr class="field"><th class="field-name">highlight:</th><td class="field-body">syntax highlighting for hgweb (requires Pygments)</td>
  3945. </tr>
  3946. <tr class="field"><th class="field-name">histedit:</th><td class="field-body">interactive history editing</td>
  3947. </tr>
  3948. <tr class="field"><th class="field-name">keyword:</th><td class="field-body">expand keywords in tracked files</td>
  3949. </tr>
  3950. <tr class="field"><th class="field-name">largefiles:</th><td class="field-body">track large binary files</td>
  3951. </tr>
  3952. <tr class="field"><th class="field-name">mq:</th><td class="field-body">manage a stack of patches</td>
  3953. </tr>
  3954. <tr class="field"><th class="field-name">notify:</th><td class="field-body">hooks for sending email push notifications</td>
  3955. </tr>
  3956. <tr class="field"><th class="field-name">pager:</th><td class="field-body">browse command output with an external pager</td>
  3957. </tr>
  3958. <tr class="field"><th class="field-name">patchbomb:</th><td class="field-body">command to send changesets as (a series of) patch emails</td>
  3959. </tr>
  3960. <tr class="field"><th class="field-name">purge:</th><td class="field-body">command to delete untracked files from the working directory</td>
  3961. </tr>
  3962. <tr class="field"><th class="field-name">rebase:</th><td class="field-body">command to move sets of revisions to a different ancestor</td>
  3963. </tr>
  3964. <tr class="field"><th class="field-name">record:</th><td class="field-body">commands to interactively select changes for commit/qrefresh</td>
  3965. </tr>
  3966. <tr class="field"><th class="field-name">relink:</th><td class="field-body">recreates hardlinks between repository clones</td>
  3967. </tr>
  3968. <tr class="field"><th class="field-name">schemes:</th><td class="field-body">extend schemes with shortcuts to repository swarms</td>
  3969. </tr>
  3970. <tr class="field"><th class="field-name">share:</th><td class="field-body">share a common history between several working directories</td>
  3971. </tr>
  3972. <tr class="field"><th class="field-name">shelve:</th><td class="field-body">save and restore changes to the working directory</td>
  3973. </tr>
  3974. <tr class="field"><th class="field-name">strip:</th><td class="field-body">strip changesets and their descendants from history</td>
  3975. </tr>
  3976. <tr class="field"><th class="field-name">transplant:</th><td class="field-body">command to transplant changesets from another branch</td>
  3977. </tr>
  3978. <tr class="field"><th class="field-name">win32mbcs:</th><td class="field-body">allow the use of MBCS paths with problematic encodings</td>
  3979. </tr>
  3980. <tr class="field"><th class="field-name">zeroconf:</th><td class="field-body">discover and advertise repositories on the local network</td>
  3981. </tr>
  3982. </tbody>
  3983. </table>
  3984. </blockquote>
  3985. </div>
  3986. <div class="section" id="specifying-file-sets">
  3987. <span id="fileset"></span><span id="filesets"></span><h1><a class="toc-backref" href="#contents">Specifying File Sets</a></h1>
  3988. <p>Mercurial supports a functional language for selecting a set of
  3989. files.</p>
  3990. <p>Like other file patterns, this pattern type is indicated by a prefix,
  3991. 'set:'. The language supports a number of predicates which are joined
  3992. by infix operators. Parenthesis can be used for grouping.</p>
  3993. <p>Identifiers such as filenames or patterns must be quoted with single
  3994. or double quotes if they contain characters outside of
  3995. <tt class="docutils literal"><span class="pre">[.*{}[]?/\_a-zA-Z0-9\x80-\xff]</span></tt> or if they match one of the
  3996. predefined predicates. This generally applies to file patterns other
  3997. than globs and arguments for predicates.</p>
  3998. <p>Special characters can be used in quoted identifiers by escaping them,
  3999. e.g., <tt class="docutils literal">\n</tt> is interpreted as a newline. To prevent them from being
  4000. interpreted, strings can be prefixed with <tt class="docutils literal">r</tt>, e.g. <tt class="docutils literal"><span class="pre">r'...'</span></tt>.</p>
  4001. <p>There is a single prefix operator:</p>
  4002. <dl class="docutils">
  4003. <dt><tt class="docutils literal">not x</tt></dt>
  4004. <dd>Files not in x. Short form is <tt class="docutils literal">! x</tt>.</dd>
  4005. </dl>
  4006. <p>These are the supported infix operators:</p>
  4007. <dl class="docutils">
  4008. <dt><tt class="docutils literal">x and y</tt></dt>
  4009. <dd>The intersection of files in x and y. Short form is <tt class="docutils literal">x &amp; y</tt>.</dd>
  4010. <dt><tt class="docutils literal">x or y</tt></dt>
  4011. <dd>The union of files in x and y. There are two alternative short
  4012. forms: <tt class="docutils literal">x | y</tt> and <tt class="docutils literal">x + y</tt>.</dd>
  4013. <dt><tt class="docutils literal">x - y</tt></dt>
  4014. <dd>Files in x but not in y.</dd>
  4015. </dl>
  4016. <p>The following predicates are supported:</p>
  4017. <dl class="docutils">
  4018. <dt><tt class="docutils literal">added()</tt></dt>
  4019. <dd>File that is added according to status.</dd>
  4020. <dt><tt class="docutils literal">binary()</tt></dt>
  4021. <dd>File that appears to be binary (contains NUL bytes).</dd>
  4022. <dt><tt class="docutils literal">clean()</tt></dt>
  4023. <dd>File that is clean according to status.</dd>
  4024. <dt><tt class="docutils literal">copied()</tt></dt>
  4025. <dd>File that is recorded as being copied.</dd>
  4026. <dt><tt class="docutils literal">deleted()</tt></dt>
  4027. <dd>File that is deleted according to status.</dd>
  4028. <dt><tt class="docutils literal">encoding(name)</tt></dt>
  4029. <dd>File can be successfully decoded with the given character
  4030. encoding. May not be useful for encodings other than ASCII and
  4031. UTF-8.</dd>
  4032. <dt><tt class="docutils literal">eol(style)</tt></dt>
  4033. <dd>File contains newlines of the given style (dos, unix, mac). Binary
  4034. files are excluded, files with mixed line endings match multiple
  4035. styles.</dd>
  4036. <dt><tt class="docutils literal">exec()</tt></dt>
  4037. <dd>File that is marked as executable.</dd>
  4038. <dt><tt class="docutils literal">grep(regex)</tt></dt>
  4039. <dd>File contains the given regular expression.</dd>
  4040. <dt><tt class="docutils literal">hgignore()</tt></dt>
  4041. <dd>File that matches the active .hgignore pattern.</dd>
  4042. <dt><tt class="docutils literal">ignored()</tt></dt>
  4043. <dd>File that is ignored according to status. These files will only be
  4044. considered if this predicate is used.</dd>
  4045. <dt><tt class="docutils literal">modified()</tt></dt>
  4046. <dd>File that is modified according to status.</dd>
  4047. <dt><tt class="docutils literal">portable()</tt></dt>
  4048. <dd>File that has a portable name. (This doesn't include filenames with case
  4049. collisions.)</dd>
  4050. <dt><tt class="docutils literal">removed()</tt></dt>
  4051. <dd>File that is removed according to status.</dd>
  4052. <dt><tt class="docutils literal">resolved()</tt></dt>
  4053. <dd>File that is marked resolved according to the resolve state.</dd>
  4054. <dt><tt class="docutils literal">size(expression)</tt></dt>
  4055. <dd><p class="first">File size matches the given expression. Examples:</p>
  4056. <ul class="last simple">
  4057. <li>1k (files from 1024 to 2047 bytes)</li>
  4058. <li>&lt; 20k (files less than 20480 bytes)</li>
  4059. <li>&gt;= .5MB (files at least 524288 bytes)</li>
  4060. <li>4k - 1MB (files from 4096 bytes to 1048576 bytes)</li>
  4061. </ul>
  4062. </dd>
  4063. <dt><tt class="docutils literal"><span class="pre">subrepo([pattern])</span></tt></dt>
  4064. <dd>Subrepositories whose paths match the given pattern.</dd>
  4065. <dt><tt class="docutils literal">symlink()</tt></dt>
  4066. <dd>File that is marked as a symlink.</dd>
  4067. <dt><tt class="docutils literal">unknown()</tt></dt>
  4068. <dd>File that is unknown according to status. These files will only be
  4069. considered if this predicate is used.</dd>
  4070. <dt><tt class="docutils literal">unresolved()</tt></dt>
  4071. <dd>File that is marked unresolved according to the resolve state.</dd>
  4072. </dl>
  4073. <p>Some sample queries:</p>
  4074. <ul>
  4075. <li><p class="first">Show status of files that appear to be binary in the working directory:</p>
  4076. <pre class="literal-block">
  4077. hg status -A &quot;set:binary()&quot;
  4078. </pre>
  4079. </li>
  4080. <li><p class="first">Forget files that are in .hgignore but are already tracked:</p>
  4081. <pre class="literal-block">
  4082. hg forget &quot;set:hgignore() and not ignored()&quot;
  4083. </pre>
  4084. </li>
  4085. <li><p class="first">Find text files that contain a string:</p>
  4086. <pre class="literal-block">
  4087. hg files &quot;set:grep(magic) and not binary()&quot;
  4088. </pre>
  4089. </li>
  4090. <li><p class="first">Find C files in a non-standard encoding:</p>
  4091. <pre class="literal-block">
  4092. hg files &quot;set:**.c and not encoding('UTF-8')&quot;
  4093. </pre>
  4094. </li>
  4095. <li><p class="first">Revert copies of large binary files:</p>
  4096. <pre class="literal-block">
  4097. hg revert &quot;set:copied() and binary() and size('&gt;1M')&quot;
  4098. </pre>
  4099. </li>
  4100. <li><p class="first">Remove files listed in foo.lst that contain the letter a or b:</p>
  4101. <pre class="literal-block">
  4102. hg remove &quot;set: 'listfile:foo.lst' and (**a* or **b*)&quot;
  4103. </pre>
  4104. </li>
  4105. </ul>
  4106. <p>See also <a class="reference external" href="hg.1.html#patterns"><tt class="docutils literal">hg help patterns</tt></a>.</p>
  4107. </div>
  4108. <div class="section" id="id1">
  4109. <span id="glossary"></span><h1><a class="toc-backref" href="#contents">Glossary</a></h1>
  4110. <dl class="docutils">
  4111. <dt>Ancestor</dt>
  4112. <dd>Any changeset that can be reached by an unbroken chain of parent
  4113. changesets from a given changeset. More precisely, the ancestors
  4114. of a changeset can be defined by two properties: a parent of a
  4115. changeset is an ancestor, and a parent of an ancestor is an
  4116. ancestor. See also: 'Descendant'.</dd>
  4117. <dt>Bookmark</dt>
  4118. <dd><p class="first">Bookmarks are pointers to certain commits that move when
  4119. committing. They are similar to tags in that it is possible to use
  4120. bookmark names in all places where Mercurial expects a changeset
  4121. ID, e.g., with <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a>. Unlike tags, bookmarks move along
  4122. when you make a commit.</p>
  4123. <p class="last">Bookmarks can be renamed, copied and deleted. Bookmarks are local,
  4124. unless they are explicitly pushed or pulled between repositories.
  4125. Pushing and pulling bookmarks allow you to collaborate with others
  4126. on a branch without creating a named branch.</p>
  4127. </dd>
  4128. <dt>Branch</dt>
  4129. <dd><p class="first">(Noun) A child changeset that has been created from a parent that
  4130. is not a head. These are known as topological branches, see
  4131. 'Branch, topological'. If a topological branch is named, it becomes
  4132. a named branch. If a topological branch is not named, it becomes
  4133. an anonymous branch. See 'Branch, anonymous' and 'Branch, named'.</p>
  4134. <p>Branches may be created when changes are pulled from or pushed to
  4135. a remote repository, since new heads may be created by these
  4136. operations. Note that the term branch can also be used informally
  4137. to describe a development process in which certain development is
  4138. done independently of other development. This is sometimes done
  4139. explicitly with a named branch, but it can also be done locally,
  4140. using bookmarks or clones and anonymous branches.</p>
  4141. <p>Example: &quot;The experimental branch&quot;.</p>
  4142. <p>(Verb) The action of creating a child changeset which results in
  4143. its parent having more than one child.</p>
  4144. <p class="last">Example: &quot;I'm going to branch at X&quot;.</p>
  4145. </dd>
  4146. <dt>Branch, anonymous</dt>
  4147. <dd>Every time a new child changeset is created from a parent that is not
  4148. a head and the name of the branch is not changed, a new anonymous
  4149. branch is created.</dd>
  4150. <dt>Branch, closed</dt>
  4151. <dd>A named branch whose branch heads have all been closed.</dd>
  4152. <dt>Branch, default</dt>
  4153. <dd>The branch assigned to a changeset when no name has previously been
  4154. assigned.</dd>
  4155. <dt>Branch head</dt>
  4156. <dd>See 'Head, branch'.</dd>
  4157. <dt>Branch, inactive</dt>
  4158. <dd><p class="first">If a named branch has no topological heads, it is considered to be
  4159. inactive. As an example, a feature branch becomes inactive when it
  4160. is merged into the default branch. The <a class="reference external" href="hg.1.html#branches"><tt class="docutils literal">hg branches</tt></a> command
  4161. shows inactive branches by default, though they can be hidden with
  4162. <a class="reference external" href="hg.1.html#branches"><tt class="docutils literal">hg branches <span class="pre">--active</span></tt></a>.</p>
  4163. <p class="last">NOTE: this concept is deprecated because it is too implicit.
  4164. Branches should now be explicitly closed using <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit
  4165. <span class="pre">--close-branch</span></tt></a> when they are no longer needed.</p>
  4166. </dd>
  4167. <dt>Branch, named</dt>
  4168. <dd><p class="first">A collection of changesets which have the same branch name. By
  4169. default, children of a changeset in a named branch belong to the
  4170. same named branch. A child can be explicitly assigned to a
  4171. different branch. See <a class="reference external" href="hg.1.html#branch"><tt class="docutils literal">hg help branch</tt></a>, <a class="reference external" href="hg.1.html#branches"><tt class="docutils literal">hg help branches</tt></a> and
  4172. <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit <span class="pre">--close-branch</span></tt></a> for more information on managing
  4173. branches.</p>
  4174. <p class="last">Named branches can be thought of as a kind of namespace, dividing
  4175. the collection of changesets that comprise the repository into a
  4176. collection of disjoint subsets. A named branch is not necessarily
  4177. a topological branch. If a new named branch is created from the
  4178. head of another named branch, or the default branch, but no
  4179. further changesets are added to that previous branch, then that
  4180. previous branch will be a branch in name only.</p>
  4181. </dd>
  4182. <dt>Branch tip</dt>
  4183. <dd>See 'Tip, branch'.</dd>
  4184. <dt>Branch, topological</dt>
  4185. <dd>Every time a new child changeset is created from a parent that is
  4186. not a head, a new topological branch is created. If a topological
  4187. branch is named, it becomes a named branch. If a topological
  4188. branch is not named, it becomes an anonymous branch of the
  4189. current, possibly default, branch.</dd>
  4190. <dt>Changelog</dt>
  4191. <dd>A record of the changesets in the order in which they were added
  4192. to the repository. This includes details such as changeset id,
  4193. author, commit message, date, and list of changed files.</dd>
  4194. <dt>Changeset</dt>
  4195. <dd>A snapshot of the state of the repository used to record a change.</dd>
  4196. <dt>Changeset, child</dt>
  4197. <dd>The converse of parent changeset: if P is a parent of C, then C is
  4198. a child of P. There is no limit to the number of children that a
  4199. changeset may have.</dd>
  4200. <dt>Changeset id</dt>
  4201. <dd>A SHA-1 hash that uniquely identifies a changeset. It may be
  4202. represented as either a &quot;long&quot; 40 hexadecimal digit string, or a
  4203. &quot;short&quot; 12 hexadecimal digit string.</dd>
  4204. <dt>Changeset, merge</dt>
  4205. <dd>A changeset with two parents. This occurs when a merge is
  4206. committed.</dd>
  4207. <dt>Changeset, parent</dt>
  4208. <dd>A revision upon which a child changeset is based. Specifically, a
  4209. parent changeset of a changeset C is a changeset whose node
  4210. immediately precedes C in the DAG. Changesets have at most two
  4211. parents.</dd>
  4212. <dt>Checkout</dt>
  4213. <dd><p class="first">(Noun) The working directory being updated to a specific
  4214. revision. This use should probably be avoided where possible, as
  4215. changeset is much more appropriate than checkout in this context.</p>
  4216. <p>Example: &quot;I'm using checkout X.&quot;</p>
  4217. <p>(Verb) Updating the working directory to a specific changeset. See
  4218. <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg help update</tt></a>.</p>
  4219. <p class="last">Example: &quot;I'm going to check out changeset X.&quot;</p>
  4220. </dd>
  4221. <dt>Child changeset</dt>
  4222. <dd>See 'Changeset, child'.</dd>
  4223. <dt>Close changeset</dt>
  4224. <dd>See 'Head, closed branch'</dd>
  4225. <dt>Closed branch</dt>
  4226. <dd>See 'Branch, closed'.</dd>
  4227. <dt>Clone</dt>
  4228. <dd><p class="first">(Noun) An entire or partial copy of a repository. The partial
  4229. clone must be in the form of a revision and its ancestors.</p>
  4230. <p>Example: &quot;Is your clone up to date?&quot;.</p>
  4231. <p>(Verb) The process of creating a clone, using <a class="reference external" href="hg.1.html#clone"><tt class="docutils literal">hg clone</tt></a>.</p>
  4232. <p class="last">Example: &quot;I'm going to clone the repository&quot;.</p>
  4233. </dd>
  4234. <dt>Closed branch head</dt>
  4235. <dd>See 'Head, closed branch'.</dd>
  4236. <dt>Commit</dt>
  4237. <dd><p class="first">(Noun) A synonym for changeset.</p>
  4238. <p>Example: &quot;Is the bug fixed in your recent commit?&quot;</p>
  4239. <p>(Verb) The act of recording changes to a repository. When files
  4240. are committed in a working directory, Mercurial finds the
  4241. differences between the committed files and their parent
  4242. changeset, creating a new changeset in the repository.</p>
  4243. <p class="last">Example: &quot;You should commit those changes now.&quot;</p>
  4244. </dd>
  4245. <dt>Cset</dt>
  4246. <dd>A common abbreviation of the term changeset.</dd>
  4247. <dt>DAG</dt>
  4248. <dd>The repository of changesets of a distributed version control
  4249. system (DVCS) can be described as a directed acyclic graph (DAG),
  4250. consisting of nodes and edges, where nodes correspond to
  4251. changesets and edges imply a parent -&gt; child relation. This graph
  4252. can be visualized by graphical tools such as <a class="reference external" href="hg.1.html#log"><tt class="docutils literal">hg log <span class="pre">--graph</span></tt></a>. In
  4253. Mercurial, the DAG is limited by the requirement for children to
  4254. have at most two parents.</dd>
  4255. <dt>Deprecated</dt>
  4256. <dd>Feature removed from documentation, but not scheduled for removal.</dd>
  4257. <dt>Default branch</dt>
  4258. <dd>See 'Branch, default'.</dd>
  4259. <dt>Descendant</dt>
  4260. <dd>Any changeset that can be reached by a chain of child changesets
  4261. from a given changeset. More precisely, the descendants of a
  4262. changeset can be defined by two properties: the child of a
  4263. changeset is a descendant, and the child of a descendant is a
  4264. descendant. See also: 'Ancestor'.</dd>
  4265. <dt>Diff</dt>
  4266. <dd><p class="first">(Noun) The difference between the contents and attributes of files
  4267. in two changesets or a changeset and the current working
  4268. directory. The difference is usually represented in a standard
  4269. form called a &quot;diff&quot; or &quot;patch&quot;. The &quot;git diff&quot; format is used
  4270. when the changes include copies, renames, or changes to file
  4271. attributes, none of which can be represented/handled by classic
  4272. &quot;diff&quot; and &quot;patch&quot;.</p>
  4273. <p>Example: &quot;Did you see my correction in the diff?&quot;</p>
  4274. <p>(Verb) Diffing two changesets is the action of creating a diff or
  4275. patch.</p>
  4276. <p class="last">Example: &quot;If you diff with changeset X, you will see what I mean.&quot;</p>
  4277. </dd>
  4278. <dt>Directory, working</dt>
  4279. <dd>The working directory represents the state of the files tracked by
  4280. Mercurial, that will be recorded in the next commit. The working
  4281. directory initially corresponds to the snapshot at an existing
  4282. changeset, known as the parent of the working directory. See
  4283. 'Parent, working directory'. The state may be modified by changes
  4284. to the files introduced manually or by a merge. The repository
  4285. metadata exists in the .hg directory inside the working directory.</dd>
  4286. <dt>Draft</dt>
  4287. <dd>Changesets in the draft phase have not been shared with publishing
  4288. repositories and may thus be safely changed by history-modifying
  4289. extensions. See <a class="reference external" href="hg.1.html#phases"><tt class="docutils literal">hg help phases</tt></a>.</dd>
  4290. <dt>Experimental</dt>
  4291. <dd>Feature that may change or be removed at a later date.</dd>
  4292. <dt>Graph</dt>
  4293. <dd>See DAG and <a class="reference external" href="hg.1.html#log"><tt class="docutils literal">hg log <span class="pre">--graph</span></tt></a>.</dd>
  4294. <dt>Head</dt>
  4295. <dd><p class="first">The term 'head' may be used to refer to both a branch head or a
  4296. repository head, depending on the context. See 'Head, branch' and
  4297. 'Head, repository' for specific definitions.</p>
  4298. <p class="last">Heads are where development generally takes place and are the
  4299. usual targets for update and merge operations.</p>
  4300. </dd>
  4301. <dt>Head, branch</dt>
  4302. <dd>A changeset with no descendants on the same named branch.</dd>
  4303. <dt>Head, closed branch</dt>
  4304. <dd><p class="first">A changeset that marks a head as no longer interesting. The closed
  4305. head is no longer listed by <a class="reference external" href="hg.1.html#heads"><tt class="docutils literal">hg heads</tt></a>. A branch is considered
  4306. closed when all its heads are closed and consequently is not
  4307. listed by <a class="reference external" href="hg.1.html#branches"><tt class="docutils literal">hg branches</tt></a>.</p>
  4308. <p class="last">Closed heads can be re-opened by committing new changeset as the
  4309. child of the changeset that marks a head as closed.</p>
  4310. </dd>
  4311. <dt>Head, repository</dt>
  4312. <dd>A topological head which has not been closed.</dd>
  4313. <dt>Head, topological</dt>
  4314. <dd>A changeset with no children in the repository.</dd>
  4315. <dt>History, immutable</dt>
  4316. <dd>Once committed, changesets cannot be altered.  Extensions which
  4317. appear to change history actually create new changesets that
  4318. replace existing ones, and then destroy the old changesets. Doing
  4319. so in public repositories can result in old changesets being
  4320. reintroduced to the repository.</dd>
  4321. <dt>History, rewriting</dt>
  4322. <dd>The changesets in a repository are immutable. However, extensions
  4323. to Mercurial can be used to alter the repository, usually in such
  4324. a way as to preserve changeset contents.</dd>
  4325. <dt>Immutable history</dt>
  4326. <dd>See 'History, immutable'.</dd>
  4327. <dt>Merge changeset</dt>
  4328. <dd>See 'Changeset, merge'.</dd>
  4329. <dt>Manifest</dt>
  4330. <dd>Each changeset has a manifest, which is the list of files that are
  4331. tracked by the changeset.</dd>
  4332. <dt>Merge</dt>
  4333. <dd>Used to bring together divergent branches of work. When you update
  4334. to a changeset and then merge another changeset, you bring the
  4335. history of the latter changeset into your working directory. Once
  4336. conflicts are resolved (and marked), this merge may be committed
  4337. as a merge changeset, bringing two branches together in the DAG.</dd>
  4338. <dt>Named branch</dt>
  4339. <dd>See 'Branch, named'.</dd>
  4340. <dt>Null changeset</dt>
  4341. <dd>The empty changeset. It is the parent state of newly-initialized
  4342. repositories and repositories with no checked out revision. It is
  4343. thus the parent of root changesets and the effective ancestor when
  4344. merging unrelated changesets. Can be specified by the alias 'null'
  4345. or by the changeset ID '000000000000'.</dd>
  4346. <dt>Parent</dt>
  4347. <dd>See 'Changeset, parent'.</dd>
  4348. <dt>Parent changeset</dt>
  4349. <dd>See 'Changeset, parent'.</dd>
  4350. <dt>Parent, working directory</dt>
  4351. <dd>The working directory parent reflects a virtual revision which is
  4352. the child of the changeset (or two changesets with an uncommitted
  4353. merge) shown by <a class="reference external" href="hg.1.html#parents"><tt class="docutils literal">hg parents</tt></a>. This is changed with
  4354. <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a>. Other commands to see the working directory parent
  4355. are <a class="reference external" href="hg.1.html#summary"><tt class="docutils literal">hg summary</tt></a> and <a class="reference external" href="hg.1.html#id"><tt class="docutils literal">hg id</tt></a>. Can be specified by the alias &quot;.&quot;.</dd>
  4356. <dt>Patch</dt>
  4357. <dd><p class="first">(Noun) The product of a diff operation.</p>
  4358. <p>Example: &quot;I've sent you my patch.&quot;</p>
  4359. <p>(Verb) The process of using a patch file to transform one
  4360. changeset into another.</p>
  4361. <p class="last">Example: &quot;You will need to patch that revision.&quot;</p>
  4362. </dd>
  4363. <dt>Phase</dt>
  4364. <dd>A per-changeset state tracking how the changeset has been or
  4365. should be shared. See <a class="reference external" href="hg.1.html#phases"><tt class="docutils literal">hg help phases</tt></a>.</dd>
  4366. <dt>Public</dt>
  4367. <dd>Changesets in the public phase have been shared with publishing
  4368. repositories and are therefore considered immutable. See <a class="reference external" href="hg.1.html#phases"><tt class="docutils literal">hg help
  4369. phases</tt></a>.</dd>
  4370. <dt>Pull</dt>
  4371. <dd>An operation in which changesets in a remote repository which are
  4372. not in the local repository are brought into the local
  4373. repository. Note that this operation without special arguments
  4374. only updates the repository, it does not update the files in the
  4375. working directory. See <a class="reference external" href="hg.1.html#pull"><tt class="docutils literal">hg help pull</tt></a>.</dd>
  4376. <dt>Push</dt>
  4377. <dd>An operation in which changesets in a local repository which are
  4378. not in a remote repository are sent to the remote repository. Note
  4379. that this operation only adds changesets which have been committed
  4380. locally to the remote repository. Uncommitted changes are not
  4381. sent. See <a class="reference external" href="hg.1.html#push"><tt class="docutils literal">hg help push</tt></a>.</dd>
  4382. <dt>Repository</dt>
  4383. <dd>The metadata describing all recorded states of a collection of
  4384. files. Each recorded state is represented by a changeset. A
  4385. repository is usually (but not always) found in the <tt class="docutils literal">.hg</tt>
  4386. subdirectory of a working directory. Any recorded state can be
  4387. recreated by &quot;updating&quot; a working directory to a specific
  4388. changeset.</dd>
  4389. <dt>Repository head</dt>
  4390. <dd>See 'Head, repository'.</dd>
  4391. <dt>Revision</dt>
  4392. <dd>A state of the repository at some point in time. Earlier revisions
  4393. can be updated to by using <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a>.  See also 'Revision
  4394. number'; See also 'Changeset'.</dd>
  4395. <dt>Revision number</dt>
  4396. <dd>This integer uniquely identifies a changeset in a specific
  4397. repository. It represents the order in which changesets were added
  4398. to a repository, starting with revision number 0. Note that the
  4399. revision number may be different in each clone of a repository. To
  4400. identify changesets uniquely between different clones, see
  4401. 'Changeset id'.</dd>
  4402. <dt>Revlog</dt>
  4403. <dd>History storage mechanism used by Mercurial. It is a form of delta
  4404. encoding, with occasional full revision of data followed by delta
  4405. of each successive revision. It includes data and an index
  4406. pointing to the data.</dd>
  4407. <dt>Rewriting history</dt>
  4408. <dd>See 'History, rewriting'.</dd>
  4409. <dt>Root</dt>
  4410. <dd>A changeset that has only the null changeset as its parent. Most
  4411. repositories have only a single root changeset.</dd>
  4412. <dt>Secret</dt>
  4413. <dd>Changesets in the secret phase may not be shared via push, pull,
  4414. or clone. See <a class="reference external" href="hg.1.html#phases"><tt class="docutils literal">hg help phases</tt></a>.</dd>
  4415. <dt>Tag</dt>
  4416. <dd>An alternative name given to a changeset. Tags can be used in all
  4417. places where Mercurial expects a changeset ID, e.g., with
  4418. <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a>. The creation of a tag is stored in the history and
  4419. will thus automatically be shared with other using push and pull.</dd>
  4420. <dt>Tip</dt>
  4421. <dd>The changeset with the highest revision number. It is the changeset
  4422. most recently added in a repository.</dd>
  4423. <dt>Tip, branch</dt>
  4424. <dd>The head of a given branch with the highest revision number. When
  4425. a branch name is used as a revision identifier, it refers to the
  4426. branch tip. See also 'Branch, head'. Note that because revision
  4427. numbers may be different in different repository clones, the
  4428. branch tip may be different in different cloned repositories.</dd>
  4429. <dt>Update</dt>
  4430. <dd><p class="first">(Noun) Another synonym of changeset.</p>
  4431. <p>Example: &quot;I've pushed an update&quot;.</p>
  4432. <p>(Verb) This term is usually used to describe updating the state of
  4433. the working directory to that of a specific changeset. See
  4434. <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg help update</tt></a>.</p>
  4435. <p class="last">Example: &quot;You should update&quot;.</p>
  4436. </dd>
  4437. <dt>Working directory</dt>
  4438. <dd>See 'Directory, working'.</dd>
  4439. <dt>Working directory parent</dt>
  4440. <dd>See 'Parent, working directory'.</dd>
  4441. </dl>
  4442. </div>
  4443. <div class="section" id="syntax-for-mercurial-ignore-files">
  4444. <span id="ignore"></span><span id="hgignore"></span><h1><a class="toc-backref" href="#contents">Syntax for Mercurial Ignore Files</a></h1>
  4445. <div class="section" id="id2">
  4446. <h2>Synopsis</h2>
  4447. <p>The Mercurial system uses a file called <tt class="docutils literal">.hgignore</tt> in the root
  4448. directory of a repository to control its behavior when it searches
  4449. for files that it is not currently tracking.</p>
  4450. </div>
  4451. <div class="section" id="id3">
  4452. <h2>Description</h2>
  4453. <p>The working directory of a Mercurial repository will often contain
  4454. files that should not be tracked by Mercurial. These include backup
  4455. files created by editors and build products created by compilers.
  4456. These files can be ignored by listing them in a <tt class="docutils literal">.hgignore</tt> file in
  4457. the root of the working directory. The <tt class="docutils literal">.hgignore</tt> file must be
  4458. created manually. It is typically put under version control, so that
  4459. the settings will propagate to other repositories with push and pull.</p>
  4460. <p>An untracked file is ignored if its path relative to the repository
  4461. root directory, or any prefix path of that path, is matched against
  4462. any pattern in <tt class="docutils literal">.hgignore</tt>.</p>
  4463. <p>For example, say we have an untracked file, <tt class="docutils literal">file.c</tt>, at
  4464. <tt class="docutils literal">a/b/file.c</tt> inside our repository. Mercurial will ignore <tt class="docutils literal">file.c</tt>
  4465. if any pattern in <tt class="docutils literal">.hgignore</tt> matches <tt class="docutils literal">a/b/file.c</tt>, <tt class="docutils literal">a/b</tt> or <tt class="docutils literal">a</tt>.</p>
  4466. <p>In addition, a Mercurial configuration file can reference a set of
  4467. per-user or global ignore files. See the <tt class="docutils literal">ignore</tt> configuration
  4468. key on the <tt class="docutils literal">[ui]</tt> section of <a class="reference external" href="hg.1.html#config"><tt class="docutils literal">hg help config</tt></a> for details of how to
  4469. configure these files.</p>
  4470. <p>To control Mercurial's handling of files that it manages, many
  4471. commands support the <tt class="docutils literal"><span class="pre">-I</span></tt> and <tt class="docutils literal"><span class="pre">-X</span></tt> options; see
  4472. <a class="reference external" href="hg.1.html#&lt;command&gt;"><tt class="docutils literal">hg help &lt;command&gt;</tt></a> and <a class="reference external" href="hg.1.html#patterns"><tt class="docutils literal">hg help patterns</tt></a> for details.</p>
  4473. <p>Files that are already tracked are not affected by .hgignore, even
  4474. if they appear in .hgignore. An untracked file X can be explicitly
  4475. added with <a class="reference external" href="hg.1.html#add"><tt class="docutils literal">hg add X</tt></a>, even if X would be excluded by a pattern
  4476. in .hgignore.</p>
  4477. </div>
  4478. <div class="section" id="syntax">
  4479. <h2>Syntax</h2>
  4480. <p>An ignore file is a plain text file consisting of a list of patterns,
  4481. with one pattern per line. Empty lines are skipped. The <tt class="docutils literal">#</tt>
  4482. character is treated as a comment character, and the <tt class="docutils literal">\</tt> character
  4483. is treated as an escape character.</p>
  4484. <p>Mercurial supports several pattern syntaxes. The default syntax used
  4485. is Python/Perl-style regular expressions.</p>
  4486. <p>To change the syntax used, use a line of the following form:</p>
  4487. <pre class="literal-block">
  4488. syntax: NAME
  4489. </pre>
  4490. <p>where <tt class="docutils literal">NAME</tt> is one of the following:</p>
  4491. <dl class="docutils">
  4492. <dt><tt class="docutils literal">regexp</tt></dt>
  4493. <dd>Regular expression, Python/Perl syntax.</dd>
  4494. <dt><tt class="docutils literal">glob</tt></dt>
  4495. <dd>Shell-style glob.</dd>
  4496. </dl>
  4497. <p>The chosen syntax stays in effect when parsing all patterns that
  4498. follow, until another syntax is selected.</p>
  4499. <p>Neither glob nor regexp patterns are rooted. A glob-syntax pattern of
  4500. the form <tt class="docutils literal">*.c</tt> will match a file ending in <tt class="docutils literal">.c</tt> in any directory,
  4501. and a regexp pattern of the form <tt class="docutils literal">\.c$</tt> will do the same. To root a
  4502. regexp pattern, start it with <tt class="docutils literal">^</tt>.</p>
  4503. <p>Subdirectories can have their own .hgignore settings by adding
  4504. <tt class="docutils literal"><span class="pre">subinclude:path/to/subdir/.hgignore</span></tt> to the root <tt class="docutils literal">.hgignore</tt>. See
  4505. <a class="reference external" href="hg.1.html#patterns"><tt class="docutils literal">hg help patterns</tt></a> for details on <tt class="docutils literal">subinclude:</tt> and <tt class="docutils literal">include:</tt>.</p>
  4506. <div class="note">
  4507. <p class="first admonition-title">Note</p>
  4508. <p class="last">Patterns specified in other than <tt class="docutils literal">.hgignore</tt> are always rooted.
  4509. Please see <a class="reference external" href="hg.1.html#patterns"><tt class="docutils literal">hg help patterns</tt></a> for details.</p>
  4510. </div>
  4511. </div>
  4512. <div class="section" id="example">
  4513. <h2>Example</h2>
  4514. <p>Here is an example ignore file.</p>
  4515. <pre class="literal-block">
  4516. # use glob syntax.
  4517. syntax: glob
  4518.  
  4519. *.elc
  4520. *.pyc
  4521. *~
  4522.  
  4523. # switch to regexp syntax.
  4524. syntax: regexp
  4525. ^\.pc/
  4526. </pre>
  4527. </div>
  4528. </div>
  4529. <div class="section" id="configuring-hgweb">
  4530. <span id="hgweb"></span><h1><a class="toc-backref" href="#contents">Configuring hgweb</a></h1>
  4531. <p>Mercurial's internal web server, hgweb, can serve either a single
  4532. repository, or a tree of repositories. In the second case, repository
  4533. paths and global options can be defined using a dedicated
  4534. configuration file common to <a class="reference external" href="hg.1.html#serve"><tt class="docutils literal">hg serve</tt></a>, <tt class="docutils literal">hgweb.wsgi</tt>,
  4535. <tt class="docutils literal">hgweb.cgi</tt> and <tt class="docutils literal">hgweb.fcgi</tt>.</p>
  4536. <p>This file uses the same syntax as other Mercurial configuration files
  4537. but recognizes only the following sections:</p>
  4538. <blockquote>
  4539. <ul class="simple">
  4540. <li>web</li>
  4541. <li>paths</li>
  4542. <li>collections</li>
  4543. </ul>
  4544. </blockquote>
  4545. <p>The <tt class="docutils literal">web</tt> options are thoroughly described in <a class="reference external" href="hg.1.html#config"><tt class="docutils literal">hg help config</tt></a>.</p>
  4546. <p>The <tt class="docutils literal">paths</tt> section maps URL paths to paths of repositories in the
  4547. filesystem. hgweb will not expose the filesystem directly - only
  4548. Mercurial repositories can be published and only according to the
  4549. configuration.</p>
  4550. <p>The left hand side is the path in the URL. Note that hgweb reserves
  4551. subpaths like <tt class="docutils literal">rev</tt> or <tt class="docutils literal">file</tt>, try using different names for
  4552. nested repositories to avoid confusing effects.</p>
  4553. <p>The right hand side is the path in the filesystem. If the specified
  4554. path ends with <tt class="docutils literal">*</tt> or <tt class="docutils literal">**</tt> the filesystem will be searched
  4555. recursively for repositories below that point.
  4556. With <tt class="docutils literal">*</tt> it will not recurse into the repositories it finds (except for
  4557. <tt class="docutils literal">.hg/patches</tt>).
  4558. With <tt class="docutils literal">**</tt> it will also search inside repository working directories
  4559. and possibly find subrepositories.</p>
  4560. <p>In this example:</p>
  4561. <pre class="literal-block">
  4562. [paths]
  4563. /projects/a = /srv/tmprepos/a
  4564. /projects/b = c:/repos/b
  4565. / = /srv/repos/*
  4566. /user/bob = /home/bob/repos/**
  4567. </pre>
  4568. <ul class="simple">
  4569. <li>The first two entries make two repositories in different directories
  4570. appear under the same directory in the web interface</li>
  4571. <li>The third entry will publish every Mercurial repository found in
  4572. <tt class="docutils literal">/srv/repos/</tt>, for instance the repository <tt class="docutils literal">/srv/repos/quux/</tt>
  4573. will appear as <tt class="docutils literal"><span class="pre">http://server/quux/</span></tt></li>
  4574. <li>The fourth entry will publish both <tt class="docutils literal"><span class="pre">http://server/user/bob/quux/</span></tt>
  4575. and <tt class="docutils literal"><span class="pre">http://server/user/bob/quux/testsubrepo/</span></tt></li>
  4576. </ul>
  4577. <p>The <tt class="docutils literal">collections</tt> section is deprecated and has been superseded by
  4578. <tt class="docutils literal">paths</tt>.</p>
  4579. <div class="section" id="urls-and-common-arguments">
  4580. <h2>URLs and Common Arguments</h2>
  4581. <p>URLs under each repository have the form <tt class="docutils literal"><span class="pre">/{command}[/{arguments}]</span></tt>
  4582. where <tt class="docutils literal">{command}</tt> represents the name of a command or handler and
  4583. <tt class="docutils literal">{arguments}</tt> represents any number of additional URL parameters
  4584. to that command.</p>
  4585. <p>The web server has a default style associated with it. Styles map to
  4586. a collection of named templates. Each template is used to render a
  4587. specific piece of data, such as a changeset or diff.</p>
  4588. <p>The style for the current request can be overwritten two ways. First,
  4589. if <tt class="docutils literal">{command}</tt> contains a hyphen (<tt class="docutils literal">-</tt>), the text before the hyphen
  4590. defines the style. For example, <tt class="docutils literal"><span class="pre">/atom-log</span></tt> will render the <tt class="docutils literal">log</tt>
  4591. command handler with the <tt class="docutils literal">atom</tt> style. The second way to set the
  4592. style is with the <tt class="docutils literal">style</tt> query string argument. For example,
  4593. <tt class="docutils literal"><span class="pre">/log?style=atom</span></tt>. The hyphenated URL parameter is preferred.</p>
  4594. <p>Not all templates are available for all styles. Attempting to use
  4595. a style that doesn't have all templates defined may result in an error
  4596. rendering the page.</p>
  4597. <p>Many commands take a <tt class="docutils literal">{revision}</tt> URL parameter. This defines the
  4598. changeset to operate on. This is commonly specified as the short,
  4599. 12 digit hexidecimal abbreviation for the full 40 character unique
  4600. revision identifier. However, any value described by
  4601. <a class="reference external" href="hg.1.html#revisions"><tt class="docutils literal">hg help revisions</tt></a> typically works.</p>
  4602. </div>
  4603. <div class="section" id="commands-and-urls">
  4604. <h2>Commands and URLs</h2>
  4605. <p>The following web commands and their URLs are available:</p>
  4606. <div class="section" id="annotate-revision-path">
  4607. <h3>/annotate/{revision}/{path}</h3>
  4608. <p>Show changeset information for each line in a file.</p>
  4609. <p>The <tt class="docutils literal">fileannotate</tt> template is rendered.</p>
  4610. </div>
  4611. <div class="section" id="archive-revision-format-path">
  4612. <h3>/archive/{revision}.{format}[/{path}]</h3>
  4613. <p>Obtain an archive of repository content.</p>
  4614. <p>The content and type of the archive is defined by a URL path parameter.
  4615. <tt class="docutils literal">format</tt> is the file extension of the archive type to be generated. e.g.
  4616. <tt class="docutils literal">zip</tt> or <tt class="docutils literal">tar.bz2</tt>. Not all archive types may be allowed by your
  4617. server configuration.</p>
  4618. <p>The optional <tt class="docutils literal">path</tt> URL parameter controls content to include in the
  4619. archive. If omitted, every file in the specified revision is present in the
  4620. archive. If included, only the specified file or contents of the specified
  4621. directory will be included in the archive.</p>
  4622. <p>No template is used for this handler. Raw, binary content is generated.</p>
  4623. </div>
  4624. <div class="section" id="id4">
  4625. <h3>/bookmarks</h3>
  4626. <p>Show information about bookmarks.</p>
  4627. <p>No arguments are accepted.</p>
  4628. <p>The <tt class="docutils literal">bookmarks</tt> template is rendered.</p>
  4629. </div>
  4630. <div class="section" id="id5">
  4631. <h3>/branches</h3>
  4632. <p>Show information about branches.</p>
  4633. <p>All known branches are contained in the output, even closed branches.</p>
  4634. <p>No arguments are accepted.</p>
  4635. <p>The <tt class="docutils literal">branches</tt> template is rendered.</p>
  4636. </div>
  4637. <div class="section" id="changelog-revision">
  4638. <h3>/changelog[/{revision}]</h3>
  4639. <p>Show information about multiple changesets.</p>
  4640. <p>If the optional <tt class="docutils literal">revision</tt> URL argument is absent, information about
  4641. all changesets starting at <tt class="docutils literal">tip</tt> will be rendered. If the <tt class="docutils literal">revision</tt>
  4642. argument is present, changesets will be shown starting from the specified
  4643. revision.</p>
  4644. <p>If <tt class="docutils literal">revision</tt> is absent, the <tt class="docutils literal">rev</tt> query string argument may be
  4645. defined. This will perform a search for changesets.</p>
  4646. <p>The argument for <tt class="docutils literal">rev</tt> can be a single revision, a revision set,
  4647. or a literal keyword to search for in changeset data (equivalent to
  4648. <a class="reference external" href="hg.1.html#log"><tt class="docutils literal">hg log <span class="pre">-k</span></tt></a>).</p>
  4649. <p>The <tt class="docutils literal">revcount</tt> query string argument defines the maximum numbers of
  4650. changesets to render.</p>
  4651. <p>For non-searches, the <tt class="docutils literal">changelog</tt> template will be rendered.</p>
  4652. </div>
  4653. <div class="section" id="changeset-revision">
  4654. <h3>/changeset[/{revision}]</h3>
  4655. <p>Show information about a single changeset.</p>
  4656. <p>A URL path argument is the changeset identifier to show. See <tt class="docutils literal">hg help
  4657. revisions</tt> for possible values. If not defined, the <tt class="docutils literal">tip</tt> changeset
  4658. will be shown.</p>
  4659. <p>The <tt class="docutils literal">changeset</tt> template is rendered. Contents of the <tt class="docutils literal">changesettag</tt>,
  4660. <tt class="docutils literal">changesetbookmark</tt>, <tt class="docutils literal">filenodelink</tt>, <tt class="docutils literal">filenolink</tt>, and the many
  4661. templates related to diffs may all be used to produce the output.</p>
  4662. </div>
  4663. <div class="section" id="comparison-revision-path">
  4664. <h3>/comparison/{revision}/{path}</h3>
  4665. <p>Show a comparison between the old and new versions of a file from changes
  4666. made on a particular revision.</p>
  4667. <p>This is similar to the <tt class="docutils literal">diff</tt> handler. However, this form features
  4668. a split or side-by-side diff rather than a unified diff.</p>
  4669. <p>The <tt class="docutils literal">context</tt> query string argument can be used to control the lines of
  4670. context in the diff.</p>
  4671. <p>The <tt class="docutils literal">filecomparison</tt> template is rendered.</p>
  4672. </div>
  4673. <div class="section" id="diff-revision-path">
  4674. <h3>/diff/{revision}/{path}</h3>
  4675. <p>Show how a file changed in a particular commit.</p>
  4676. <p>The <tt class="docutils literal">filediff</tt> template is rendered.</p>
  4677. <p>This hander is registered under both the <tt class="docutils literal">/diff</tt> and <tt class="docutils literal">/filediff</tt>
  4678. paths. <tt class="docutils literal">/diff</tt> is used in modern code.</p>
  4679. </div>
  4680. <div class="section" id="file-revision-path">
  4681. <h3>/file/{revision}[/{path}]</h3>
  4682. <p>Show information about a directory or file in the repository.</p>
  4683. <p>Info about the <tt class="docutils literal">path</tt> given as a URL parameter will be rendered.</p>
  4684. <p>If <tt class="docutils literal">path</tt> is a directory, information about the entries in that
  4685. directory will be rendered. This form is equivalent to the <tt class="docutils literal">manifest</tt>
  4686. handler.</p>
  4687. <p>If <tt class="docutils literal">path</tt> is a file, information about that file will be shown via
  4688. the <tt class="docutils literal">filerevision</tt> template.</p>
  4689. <p>If <tt class="docutils literal">path</tt> is not defined, information about the root directory will
  4690. be rendered.</p>
  4691. </div>
  4692. <div class="section" id="id6">
  4693. <h3>/diff/{revision}/{path}</h3>
  4694. <p>Show how a file changed in a particular commit.</p>
  4695. <p>The <tt class="docutils literal">filediff</tt> template is rendered.</p>
  4696. <p>This hander is registered under both the <tt class="docutils literal">/diff</tt> and <tt class="docutils literal">/filediff</tt>
  4697. paths. <tt class="docutils literal">/diff</tt> is used in modern code.</p>
  4698. </div>
  4699. <div class="section" id="filelog-revision-path">
  4700. <h3>/filelog/{revision}/{path}</h3>
  4701. <p>Show information about the history of a file in the repository.</p>
  4702. <p>The <tt class="docutils literal">revcount</tt> query string argument can be defined to control the
  4703. maximum number of entries to show.</p>
  4704. <p>The <tt class="docutils literal">filelog</tt> template will be rendered.</p>
  4705. </div>
  4706. <div class="section" id="graph-revision">
  4707. <h3>/graph[/{revision}]</h3>
  4708. <p>Show information about the graphical topology of the repository.</p>
  4709. <p>Information rendered by this handler can be used to create visual
  4710. representations of repository topology.</p>
  4711. <p>The <tt class="docutils literal">revision</tt> URL parameter controls the starting changeset.</p>
  4712. <p>The <tt class="docutils literal">revcount</tt> query string argument can define the number of changesets
  4713. to show information for.</p>
  4714. <p>This handler will render the <tt class="docutils literal">graph</tt> template.</p>
  4715. </div>
  4716. <div class="section" id="help-topic">
  4717. <h3>/help[/{topic}]</h3>
  4718. <p>Render help documentation.</p>
  4719. <p>This web command is roughly equivalent to <a class="reference external" href="hg.1.html#help"><tt class="docutils literal">hg help</tt></a>. If a <tt class="docutils literal">topic</tt>
  4720. is defined, that help topic will be rendered. If not, an index of
  4721. available help topics will be rendered.</p>
  4722. <p>The <tt class="docutils literal">help</tt> template will be rendered when requesting help for a topic.
  4723. <tt class="docutils literal">helptopics</tt> will be rendered for the index of help topics.</p>
  4724. </div>
  4725. <div class="section" id="log-revision-path">
  4726. <h3>/log[/{revision}[/{path}]]</h3>
  4727. <p>Show repository or file history.</p>
  4728. <p>For URLs of the form <tt class="docutils literal"><span class="pre">/log/{revision}</span></tt>, a list of changesets starting at
  4729. the specified changeset identifier is shown. If <tt class="docutils literal">{revision}</tt> is not
  4730. defined, the default is <tt class="docutils literal">tip</tt>. This form is equivalent to the
  4731. <tt class="docutils literal">changelog</tt> handler.</p>
  4732. <p>For URLs of the form <tt class="docutils literal"><span class="pre">/log/{revision}/{file}</span></tt>, the history for a specific
  4733. file will be shown. This form is equivalent to the <tt class="docutils literal">filelog</tt> handler.</p>
  4734. </div>
  4735. <div class="section" id="manifest-revision-path">
  4736. <h3>/manifest[/{revision}[/{path}]]</h3>
  4737. <p>Show information about a directory.</p>
  4738. <p>If the URL path arguments are omitted, information about the root
  4739. directory for the <tt class="docutils literal">tip</tt> changeset will be shown.</p>
  4740. <p>Because this handler can only show information for directories, it
  4741. is recommended to use the <tt class="docutils literal">file</tt> handler instead, as it can handle both
  4742. directories and files.</p>
  4743. <p>The <tt class="docutils literal">manifest</tt> template will be rendered for this handler.</p>
  4744. </div>
  4745. <div class="section" id="id7">
  4746. <h3>/changeset[/{revision}]</h3>
  4747. <p>Show information about a single changeset.</p>
  4748. <p>A URL path argument is the changeset identifier to show. See <tt class="docutils literal">hg help
  4749. revisions</tt> for possible values. If not defined, the <tt class="docutils literal">tip</tt> changeset
  4750. will be shown.</p>
  4751. <p>The <tt class="docutils literal">changeset</tt> template is rendered. Contents of the <tt class="docutils literal">changesettag</tt>,
  4752. <tt class="docutils literal">changesetbookmark</tt>, <tt class="docutils literal">filenodelink</tt>, <tt class="docutils literal">filenolink</tt>, and the many
  4753. templates related to diffs may all be used to produce the output.</p>
  4754. </div>
  4755. <div class="section" id="shortlog">
  4756. <h3>/shortlog</h3>
  4757. <p>Show basic information about a set of changesets.</p>
  4758. <p>This accepts the same parameters as the <tt class="docutils literal">changelog</tt> handler. The only
  4759. difference is the <tt class="docutils literal">shortlog</tt> template will be rendered instead of the
  4760. <tt class="docutils literal">changelog</tt> template.</p>
  4761. </div>
  4762. <div class="section" id="id8">
  4763. <h3>/summary</h3>
  4764. <p>Show a summary of repository state.</p>
  4765. <p>Information about the latest changesets, bookmarks, tags, and branches
  4766. is captured by this handler.</p>
  4767. <p>The <tt class="docutils literal">summary</tt> template is rendered.</p>
  4768. </div>
  4769. <div class="section" id="id9">
  4770. <h3>/tags</h3>
  4771. <p>Show information about tags.</p>
  4772. <p>No arguments are accepted.</p>
  4773. <p>The <tt class="docutils literal">tags</tt> template is rendered.</p>
  4774. </div>
  4775. </div>
  4776. </div>
  4777. <div class="section" id="id10">
  4778. <span id="mergetools"></span><span id="merge-tools"></span><h1><a class="toc-backref" href="#contents">Merge Tools</a></h1>
  4779. <p>To merge files Mercurial uses merge tools.</p>
  4780. <p>A merge tool combines two different versions of a file into a merged
  4781. file. Merge tools are given the two files and the greatest common
  4782. ancestor of the two file versions, so they can determine the changes
  4783. made on both branches.</p>
  4784. <p>Merge tools are used both for <a class="reference external" href="hg.1.html#resolve"><tt class="docutils literal">hg resolve</tt></a>, <a class="reference external" href="hg.1.html#merge"><tt class="docutils literal">hg merge</tt></a>, <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a>,
  4785. <a class="reference external" href="hg.1.html#backout"><tt class="docutils literal">hg backout</tt></a> and in several extensions.</p>
  4786. <p>Usually, the merge tool tries to automatically reconcile the files by
  4787. combining all non-overlapping changes that occurred separately in
  4788. the two different evolutions of the same initial base file. Furthermore, some
  4789. interactive merge programs make it easier to manually resolve
  4790. conflicting merges, either in a graphical way, or by inserting some
  4791. conflict markers. Mercurial does not include any interactive merge
  4792. programs but relies on external tools for that.</p>
  4793. <div class="section" id="available-merge-tools">
  4794. <h2>Available merge tools</h2>
  4795. <p>External merge tools and their properties are configured in the
  4796. merge-tools configuration section - see hgrc(5) - but they can often just
  4797. be named by their executable.</p>
  4798. <p>A merge tool is generally usable if its executable can be found on the
  4799. system and if it can handle the merge. The executable is found if it
  4800. is an absolute or relative executable path or the name of an
  4801. application in the executable search path. The tool is assumed to be
  4802. able to handle the merge if it can handle symlinks if the file is a
  4803. symlink, if it can handle binary files if the file is binary, and if a
  4804. GUI is available if the tool requires a GUI.</p>
  4805. <p>There are some internal merge tools which can be used. The internal
  4806. merge tools are:</p>
  4807. <dl class="docutils">
  4808. <dt><tt class="docutils literal">:dump</tt></dt>
  4809. <dd>Creates three versions of the files to merge, containing the
  4810. contents of local, other and base. These files can then be used to
  4811. perform a merge manually. If the file to be merged is named
  4812. <tt class="docutils literal">a.txt</tt>, these files will accordingly be named <tt class="docutils literal">a.txt.local</tt>,
  4813. <tt class="docutils literal">a.txt.other</tt> and <tt class="docutils literal">a.txt.base</tt> and they will be placed in the
  4814. same directory as <tt class="docutils literal">a.txt</tt>.</dd>
  4815. <dt><tt class="docutils literal">:fail</tt></dt>
  4816. <dd>Rather than attempting to merge files that were modified on both
  4817. branches, it marks them as unresolved. The resolve command must be
  4818. used to resolve these conflicts.</dd>
  4819. <dt><tt class="docutils literal">:local</tt></dt>
  4820. <dd>Uses the local version of files as the merged version.</dd>
  4821. <dt><tt class="docutils literal">:merge</tt></dt>
  4822. <dd>Uses the internal non-interactive simple merge algorithm for merging
  4823. files. It will fail if there are any conflicts and leave markers in
  4824. the partially merged file. Markers will have two sections, one for each side
  4825. of merge.</dd>
  4826. <dt><tt class="docutils literal">:merge3</tt></dt>
  4827. <dd>Uses the internal non-interactive simple merge algorithm for merging
  4828. files. It will fail if there are any conflicts and leave markers in
  4829. the partially merged file. Marker will have three sections, one from each
  4830. side of the merge and one for the base content.</dd>
  4831. <dt><tt class="docutils literal">:other</tt></dt>
  4832. <dd>Uses the other version of files as the merged version.</dd>
  4833. <dt><tt class="docutils literal">:prompt</tt></dt>
  4834. <dd>Asks the user which of the local or the other version to keep as
  4835. the merged version.</dd>
  4836. <dt><tt class="docutils literal">:tagmerge</tt></dt>
  4837. <dd>Uses the internal tag merge algorithm (experimental).</dd>
  4838. </dl>
  4839. <p>Internal tools are always available and do not require a GUI but will by default
  4840. not handle symlinks or binary files.</p>
  4841. </div>
  4842. <div class="section" id="choosing-a-merge-tool">
  4843. <h2>Choosing a merge tool</h2>
  4844. <p>Mercurial uses these rules when deciding which merge tool to use:</p>
  4845. <ol class="arabic simple">
  4846. <li>If a tool has been specified with the --tool option to merge or resolve, it
  4847. is used.  If it is the name of a tool in the merge-tools configuration, its
  4848. configuration is used. Otherwise the specified tool must be executable by
  4849. the shell.</li>
  4850. <li>If the <tt class="docutils literal">HGMERGE</tt> environment variable is present, its value is used and
  4851. must be executable by the shell.</li>
  4852. <li>If the filename of the file to be merged matches any of the patterns in the
  4853. merge-patterns configuration section, the first usable merge tool
  4854. corresponding to a matching pattern is used. Here, binary capabilities of the
  4855. merge tool are not considered.</li>
  4856. <li>If ui.merge is set it will be considered next. If the value is not the name
  4857. of a configured tool, the specified value is used and must be executable by
  4858. the shell. Otherwise the named tool is used if it is usable.</li>
  4859. <li>If any usable merge tools are present in the merge-tools configuration
  4860. section, the one with the highest priority is used.</li>
  4861. <li>If a program named <tt class="docutils literal">hgmerge</tt> can be found on the system, it is used - but
  4862. it will by default not be used for symlinks and binary files.</li>
  4863. <li>If the file to be merged is not binary and is not a symlink, then
  4864. internal <tt class="docutils literal">:merge</tt> is used.</li>
  4865. <li>The merge of the file fails and must be resolved before commit.</li>
  4866. </ol>
  4867. <div class="note">
  4868. <p class="first admonition-title">Note</p>
  4869. <p class="last">After selecting a merge program, Mercurial will by default attempt
  4870. to merge the files using a simple merge algorithm first. Only if it doesn't
  4871. succeed because of conflicting changes Mercurial will actually execute the
  4872. merge program. Whether to use the simple merge algorithm first can be
  4873. controlled by the premerge setting of the merge tool. Premerge is enabled by
  4874. default unless the file is binary or a symlink.</p>
  4875. </div>
  4876. <p>See the merge-tools and ui sections of hgrc(5) for details on the
  4877. configuration of merge tools.</p>
  4878. </div>
  4879. </div>
  4880. <div class="section" id="specifying-multiple-revisions">
  4881. <span id="mrevs"></span><span id="multirevs"></span><h1><a class="toc-backref" href="#contents">Specifying Multiple Revisions</a></h1>
  4882. <p>When Mercurial accepts more than one revision, they may be specified
  4883. individually, or provided as a topologically continuous range,
  4884. separated by the &quot;:&quot; character.</p>
  4885. <p>The syntax of range notation is [BEGIN]:[END], where BEGIN and END are
  4886. revision identifiers. Both BEGIN and END are optional. If BEGIN is not
  4887. specified, it defaults to revision number 0. If END is not specified,
  4888. it defaults to the tip. The range &quot;:&quot; thus means &quot;all revisions&quot;.</p>
  4889. <p>If BEGIN is greater than END, revisions are treated in reverse order.</p>
  4890. <p>A range acts as a closed interval. This means that a range of 3:5
  4891. gives 3, 4 and 5. Similarly, a range of 9:6 gives 9, 8, 7, and 6.</p>
  4892. </div>
  4893. <div class="section" id="file-name-patterns">
  4894. <span id="patterns"></span><h1><a class="toc-backref" href="#contents">File Name Patterns</a></h1>
  4895. <p>Mercurial accepts several notations for identifying one or more files
  4896. at a time.</p>
  4897. <p>By default, Mercurial treats filenames as shell-style extended glob
  4898. patterns.</p>
  4899. <p>Alternate pattern notations must be specified explicitly.</p>
  4900. <div class="note">
  4901. <p class="first admonition-title">Note</p>
  4902. <p class="last">Patterns specified in <tt class="docutils literal">.hgignore</tt> are not rooted.
  4903. Please see <a class="reference external" href="hg.1.html#hgignore"><tt class="docutils literal">hg help hgignore</tt></a> for details.</p>
  4904. </div>
  4905. <p>To use a plain path name without any pattern matching, start it with
  4906. <tt class="docutils literal">path:</tt>. These path names must completely match starting at the
  4907. current repository root.</p>
  4908. <p>To use an extended glob, start a name with <tt class="docutils literal">glob:</tt>. Globs are rooted
  4909. at the current directory; a glob such as <tt class="docutils literal">*.c</tt> will only match files
  4910. in the current directory ending with <tt class="docutils literal">.c</tt>.</p>
  4911. <p>The supported glob syntax extensions are <tt class="docutils literal">**</tt> to match any string
  4912. across path separators and <tt class="docutils literal">{a,b}</tt> to mean &quot;a or b&quot;.</p>
  4913. <p>To use a Perl/Python regular expression, start a name with <tt class="docutils literal">re:</tt>.
  4914. Regexp pattern matching is anchored at the root of the repository.</p>
  4915. <p>To read name patterns from a file, use <tt class="docutils literal">listfile:</tt> or <tt class="docutils literal">listfile0:</tt>.
  4916. The latter expects null delimited patterns while the former expects line
  4917. feeds. Each string read from the file is itself treated as a file
  4918. pattern.</p>
  4919. <p>To read a set of patterns from a file, use <tt class="docutils literal">include:</tt> or <tt class="docutils literal">subinclude:</tt>.
  4920. <tt class="docutils literal">include:</tt> will use all the patterns from the given file and treat them as if
  4921. they had been passed in manually.  <tt class="docutils literal">subinclude:</tt> will only apply the patterns
  4922. against files that are under the subinclude file's directory. See <a class="reference external" href="hg.1.html#hgignore"><tt class="docutils literal">hg help
  4923. hgignore</tt></a> for details on the format of these files.</p>
  4924. <p>All patterns, except for <tt class="docutils literal">glob:</tt> specified in command line (not for
  4925. <tt class="docutils literal"><span class="pre">-I</span></tt> or <tt class="docutils literal"><span class="pre">-X</span></tt> options), can match also against directories: files
  4926. under matched directories are treated as matched.</p>
  4927. <p>Plain examples:</p>
  4928. <pre class="literal-block">
  4929. path:foo/bar   a name bar in a directory named foo in the root
  4930.                of the repository
  4931. path:path:name a file or directory named &quot;path:name&quot;
  4932. </pre>
  4933. <p>Glob examples:</p>
  4934. <pre class="literal-block">
  4935. glob:*.c       any name ending in &quot;.c&quot; in the current directory
  4936. *.c            any name ending in &quot;.c&quot; in the current directory
  4937. **.c           any name ending in &quot;.c&quot; in any subdirectory of the
  4938.                current directory including itself.
  4939. foo/*.c        any name ending in &quot;.c&quot; in the directory foo
  4940. foo/**.c       any name ending in &quot;.c&quot; in any subdirectory of foo
  4941.                including itself.
  4942. </pre>
  4943. <p>Regexp examples:</p>
  4944. <pre class="literal-block">
  4945. re:.*\.c$      any name ending in &quot;.c&quot;, anywhere in the repository
  4946. </pre>
  4947. <p>File examples:</p>
  4948. <pre class="literal-block">
  4949. listfile:list.txt  read list from list.txt with one file pattern per line
  4950. listfile0:list.txt read list from list.txt with null byte delimiters
  4951. </pre>
  4952. <p>See also <a class="reference external" href="hg.1.html#filesets"><tt class="docutils literal">hg help filesets</tt></a>.</p>
  4953. <p>Include examples:</p>
  4954. <pre class="literal-block">
  4955. include:path/to/mypatternfile    reads patterns to be applied to all paths
  4956. subinclude:path/to/subignorefile reads patterns specifically for paths in the
  4957.                                  subdirectory
  4958. </pre>
  4959. </div>
  4960. <div class="section" id="working-with-phases">
  4961. <span id="phases"></span><h1><a class="toc-backref" href="#contents">Working with Phases</a></h1>
  4962. <div class="section" id="what-are-phases">
  4963. <h2>What are phases?</h2>
  4964. <p>Phases are a system for tracking which changesets have been or should
  4965. be shared. This helps prevent common mistakes when modifying history
  4966. (for instance, with the mq or rebase extensions).</p>
  4967. <p>Each changeset in a repository is in one of the following phases:</p>
  4968. <blockquote>
  4969. <ul class="simple">
  4970. <li>public : changeset is visible on a public server</li>
  4971. <li>draft : changeset is not yet published</li>
  4972. <li>secret : changeset should not be pushed, pulled, or cloned</li>
  4973. </ul>
  4974. </blockquote>
  4975. <p>These phases are ordered (public &lt; draft &lt; secret) and no changeset
  4976. can be in a lower phase than its ancestors. For instance, if a
  4977. changeset is public, all its ancestors are also public. Lastly,
  4978. changeset phases should only be changed towards the public phase.</p>
  4979. </div>
  4980. <div class="section" id="how-are-phases-managed">
  4981. <h2>How are phases managed?</h2>
  4982. <p>For the most part, phases should work transparently. By default, a
  4983. changeset is created in the draft phase and is moved into the public
  4984. phase when it is pushed to another repository.</p>
  4985. <p>Once changesets become public, extensions like mq and rebase will
  4986. refuse to operate on them to prevent creating duplicate changesets.
  4987. Phases can also be manually manipulated with the <a class="reference external" href="hg.1.html#phase"><tt class="docutils literal">hg phase</tt></a> command
  4988. if needed. See <a class="reference external" href="hg.1.html#-v"><tt class="docutils literal">hg help <span class="pre">-v</span> phase</tt></a> for examples.</p>
  4989. </div>
  4990. <div class="section" id="phases-and-servers">
  4991. <h2>Phases and servers</h2>
  4992. <p>Normally, all servers are <tt class="docutils literal">publishing</tt> by default. This means:</p>
  4993. <pre class="literal-block">
  4994. - all draft changesets that are pulled or cloned appear in phase
  4995. public on the client
  4996.  
  4997. - all draft changesets that are pushed appear as public on both
  4998. client and server
  4999.  
  5000. - secret changesets are neither pushed, pulled, or cloned
  5001. </pre>
  5002. <div class="note">
  5003. <p class="first admonition-title">Note</p>
  5004. <p class="last">Pulling a draft changeset from a publishing server does not mark it
  5005. as public on the server side due to the read-only nature of pull.</p>
  5006. </div>
  5007. <p>Sometimes it may be desirable to push and pull changesets in the draft
  5008. phase to share unfinished work. This can be done by setting a
  5009. repository to disable publishing in its configuration file:</p>
  5010. <pre class="literal-block">
  5011. [phases]
  5012. publish = False
  5013. </pre>
  5014. <p>See <a class="reference external" href="hg.1.html#config"><tt class="docutils literal">hg help config</tt></a> for more information on configuration files.</p>
  5015. <div class="note">
  5016. <p class="first admonition-title">Note</p>
  5017. <p class="last">Servers running older versions of Mercurial are treated as
  5018. publishing.</p>
  5019. </div>
  5020. <div class="note">
  5021. <p class="first admonition-title">Note</p>
  5022. <p class="last">Changesets in secret phase are not exchanged with the server. This
  5023. applies to their content: file names, file contents, and changeset
  5024. metadata. For technical reasons, the identifier (e.g. d825e4025e39)
  5025. of the secret changeset may be communicated to the server.</p>
  5026. </div>
  5027. </div>
  5028. <div class="section" id="examples">
  5029. <h2>Examples</h2>
  5030. <blockquote>
  5031. <ul>
  5032. <li><p class="first">list changesets in draft or secret phase:</p>
  5033. <pre class="literal-block">
  5034. hg log -r &quot;not public()&quot;
  5035. </pre>
  5036. </li>
  5037. <li><p class="first">change all secret changesets to draft:</p>
  5038. <pre class="literal-block">
  5039. hg phase --draft &quot;secret()&quot;
  5040. </pre>
  5041. </li>
  5042. <li><p class="first">forcibly move the current changeset and descendants from public to draft:</p>
  5043. <pre class="literal-block">
  5044. hg phase --force --draft .
  5045. </pre>
  5046. </li>
  5047. <li><p class="first">show a list of changeset revision and phase:</p>
  5048. <pre class="literal-block">
  5049. hg log --template &quot;{rev} {phase}\n&quot;
  5050. </pre>
  5051. </li>
  5052. <li><p class="first">resynchronize draft changesets relative to a remote repository:</p>
  5053. <pre class="literal-block">
  5054. hg phase -fd &quot;outgoing(URL)&quot;
  5055. </pre>
  5056. </li>
  5057. </ul>
  5058. </blockquote>
  5059. <p>See <a class="reference external" href="hg.1.html#phase"><tt class="docutils literal">hg help phase</tt></a> for more information on manually manipulating phases.</p>
  5060. </div>
  5061. </div>
  5062. <div class="section" id="specifying-single-revisions">
  5063. <span id="revs"></span><span id="revisions"></span><h1><a class="toc-backref" href="#contents">Specifying Single Revisions</a></h1>
  5064. <p>Mercurial supports several ways to specify individual revisions.</p>
  5065. <p>A plain integer is treated as a revision number. Negative integers are
  5066. treated as sequential offsets from the tip, with -1 denoting the tip,
  5067. -2 denoting the revision prior to the tip, and so forth.</p>
  5068. <p>A 40-digit hexadecimal string is treated as a unique revision
  5069. identifier.</p>
  5070. <p>A hexadecimal string less than 40 characters long is treated as a
  5071. unique revision identifier and is referred to as a short-form
  5072. identifier. A short-form identifier is only valid if it is the prefix
  5073. of exactly one full-length identifier.</p>
  5074. <p>Any other string is treated as a bookmark, tag, or branch name. A
  5075. bookmark is a movable pointer to a revision. A tag is a permanent name
  5076. associated with a revision. A branch name denotes the tipmost open branch head
  5077. of that branch - or if they are all closed, the tipmost closed head of the
  5078. branch. Bookmark, tag, and branch names must not contain the &quot;:&quot; character.</p>
  5079. <p>The reserved name &quot;tip&quot; always identifies the most recent revision.</p>
  5080. <p>The reserved name &quot;null&quot; indicates the null revision. This is the
  5081. revision of an empty repository, and the parent of revision 0.</p>
  5082. <p>The reserved name &quot;.&quot; indicates the working directory parent. If no
  5083. working directory is checked out, it is equivalent to null. If an
  5084. uncommitted merge is in progress, &quot;.&quot; is the revision of the first
  5085. parent.</p>
  5086. </div>
  5087. <div class="section" id="specifying-revision-sets">
  5088. <span id="revset"></span><span id="revsets"></span><h1><a class="toc-backref" href="#contents">Specifying Revision Sets</a></h1>
  5089. <p>Mercurial supports a functional language for selecting a set of
  5090. revisions.</p>
  5091. <p>The language supports a number of predicates which are joined by infix
  5092. operators. Parenthesis can be used for grouping.</p>
  5093. <p>Identifiers such as branch names may need quoting with single or
  5094. double quotes if they contain characters like <tt class="docutils literal">-</tt> or if they match
  5095. one of the predefined predicates.</p>
  5096. <p>Special characters can be used in quoted identifiers by escaping them,
  5097. e.g., <tt class="docutils literal">\n</tt> is interpreted as a newline. To prevent them from being
  5098. interpreted, strings can be prefixed with <tt class="docutils literal">r</tt>, e.g. <tt class="docutils literal"><span class="pre">r'...'</span></tt>.</p>
  5099. <p>There is a single prefix operator:</p>
  5100. <dl class="docutils">
  5101. <dt><tt class="docutils literal">not x</tt></dt>
  5102. <dd>Changesets not in x. Short form is <tt class="docutils literal">! x</tt>.</dd>
  5103. </dl>
  5104. <p>These are the supported infix operators:</p>
  5105. <dl class="docutils">
  5106. <dt><tt class="docutils literal"><span class="pre">x::y</span></tt></dt>
  5107. <dd><p class="first">A DAG range, meaning all changesets that are descendants of x and
  5108. ancestors of y, including x and y themselves. If the first endpoint
  5109. is left out, this is equivalent to <tt class="docutils literal">ancestors(y)</tt>, if the second
  5110. is left out it is equivalent to <tt class="docutils literal">descendants(x)</tt>.</p>
  5111. <p class="last">An alternative syntax is <tt class="docutils literal"><span class="pre">x..y</span></tt>.</p>
  5112. </dd>
  5113. <dt><tt class="docutils literal">x:y</tt></dt>
  5114. <dd>All changesets with revision numbers between x and y, both
  5115. inclusive. Either endpoint can be left out, they default to 0 and
  5116. tip.</dd>
  5117. <dt><tt class="docutils literal">x and y</tt></dt>
  5118. <dd>The intersection of changesets in x and y. Short form is <tt class="docutils literal">x &amp; y</tt>.</dd>
  5119. <dt><tt class="docutils literal">x or y</tt></dt>
  5120. <dd>The union of changesets in x and y. There are two alternative short
  5121. forms: <tt class="docutils literal">x | y</tt> and <tt class="docutils literal">x + y</tt>.</dd>
  5122. <dt><tt class="docutils literal">x - y</tt></dt>
  5123. <dd>Changesets in x but not in y.</dd>
  5124. <dt><tt class="docutils literal">x^n</tt></dt>
  5125. <dd>The nth parent of x, n == 0, 1, or 2.
  5126. For n == 0, x; for n == 1, the first parent of each changeset in x;
  5127. for n == 2, the second parent of changeset in x.</dd>
  5128. <dt><tt class="docutils literal">x~n</tt></dt>
  5129. <dd>The nth first ancestor of x; <tt class="docutils literal">x~0</tt> is x; <tt class="docutils literal">x~3</tt> is <tt class="docutils literal"><span class="pre">x^^^</span></tt>.</dd>
  5130. </dl>
  5131. <p>There is a single postfix operator:</p>
  5132. <dl class="docutils">
  5133. <dt><tt class="docutils literal">x^</tt></dt>
  5134. <dd>Equivalent to <tt class="docutils literal">x^1</tt>, the first parent of each changeset in x.</dd>
  5135. </dl>
  5136. <p>The following predicates are supported:</p>
  5137. <dl class="docutils">
  5138. <dt><tt class="docutils literal">adds(pattern)</tt></dt>
  5139. <dd><p class="first">Changesets that add a file matching pattern.</p>
  5140. <p class="last">The pattern without explicit kind like <tt class="docutils literal">glob:</tt> is expected to be
  5141. relative to the current directory and match against a file or a
  5142. directory.</p>
  5143. </dd>
  5144. <dt><tt class="docutils literal">all()</tt></dt>
  5145. <dd>All changesets, the same as <tt class="docutils literal">0:tip</tt>.</dd>
  5146. <dt><tt class="docutils literal"><span class="pre">ancestor(*changeset)</span></tt></dt>
  5147. <dd><p class="first">A greatest common ancestor of the changesets.</p>
  5148. <p class="last">Accepts 0 or more changesets.
  5149. Will return empty list when passed no args.
  5150. Greatest common ancestor of a single changeset is that changeset.</p>
  5151. </dd>
  5152. <dt><tt class="docutils literal">ancestors(set)</tt></dt>
  5153. <dd>Changesets that are ancestors of a changeset in set.</dd>
  5154. <dt><tt class="docutils literal">author(string)</tt></dt>
  5155. <dd>Alias for <tt class="docutils literal">user(string)</tt>.</dd>
  5156. <dt><tt class="docutils literal">bisect(string)</tt></dt>
  5157. <dd><p class="first">Changesets marked in the specified bisect status:</p>
  5158. <ul class="last simple">
  5159. <li><tt class="docutils literal">good</tt>, <tt class="docutils literal">bad</tt>, <tt class="docutils literal">skip</tt>: csets explicitly marked as good/bad/skip</li>
  5160. <li><tt class="docutils literal">goods</tt>, <tt class="docutils literal">bads</tt>      : csets topologically good/bad</li>
  5161. <li><tt class="docutils literal">range</tt>              : csets taking part in the bisection</li>
  5162. <li><tt class="docutils literal">pruned</tt>             : csets that are goods, bads or skipped</li>
  5163. <li><tt class="docutils literal">untested</tt>           : csets whose fate is yet unknown</li>
  5164. <li><tt class="docutils literal">ignored</tt>            : csets ignored due to DAG topology</li>
  5165. <li><tt class="docutils literal">current</tt>            : the cset currently being bisected</li>
  5166. </ul>
  5167. </dd>
  5168. <dt><tt class="docutils literal"><span class="pre">bookmark([name])</span></tt></dt>
  5169. <dd><p class="first">The named bookmark or all bookmarks.</p>
  5170. <p class="last">If <cite>name</cite> starts with <cite>re:</cite>, the remainder of the name is treated as
  5171. a regular expression. To match a bookmark that actually starts with <cite>re:</cite>,
  5172. use the prefix <cite>literal:</cite>.</p>
  5173. </dd>
  5174. <dt><tt class="docutils literal">branch(string or set)</tt></dt>
  5175. <dd><p class="first">All changesets belonging to the given branch or the branches of the given
  5176. changesets.</p>
  5177. <p class="last">If <cite>string</cite> starts with <cite>re:</cite>, the remainder of the name is treated as
  5178. a regular expression. To match a branch that actually starts with <cite>re:</cite>,
  5179. use the prefix <cite>literal:</cite>.</p>
  5180. </dd>
  5181. <dt><tt class="docutils literal">branchpoint()</tt></dt>
  5182. <dd>Changesets with more than one child.</dd>
  5183. <dt><tt class="docutils literal">bumped()</tt></dt>
  5184. <dd><p class="first">Mutable changesets marked as successors of public changesets.</p>
  5185. <p class="last">Only non-public and non-obsolete changesets can be <cite>bumped</cite>.</p>
  5186. </dd>
  5187. <dt><tt class="docutils literal">bundle()</tt></dt>
  5188. <dd><p class="first">Changesets in the bundle.</p>
  5189. <p class="last">Bundle must be specified by the -R option.</p>
  5190. </dd>
  5191. <dt><tt class="docutils literal">children(set)</tt></dt>
  5192. <dd>Child changesets of changesets in set.</dd>
  5193. <dt><tt class="docutils literal">closed()</tt></dt>
  5194. <dd>Changeset is closed.</dd>
  5195. <dt><tt class="docutils literal">contains(pattern)</tt></dt>
  5196. <dd><p class="first">The revision's manifest contains a file matching pattern (but might not
  5197. modify it). See <a class="reference external" href="hg.1.html#patterns"><tt class="docutils literal">hg help patterns</tt></a> for information about file patterns.</p>
  5198. <p class="last">The pattern without explicit kind like <tt class="docutils literal">glob:</tt> is expected to be
  5199. relative to the current directory and match against a file exactly
  5200. for efficiency.</p>
  5201. </dd>
  5202. <dt><tt class="docutils literal"><span class="pre">converted([id])</span></tt></dt>
  5203. <dd>Changesets converted from the given identifier in the old repository if
  5204. present, or all converted changesets if no identifier is specified.</dd>
  5205. <dt><tt class="docutils literal">date(interval)</tt></dt>
  5206. <dd>Changesets within the interval, see <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a>.</dd>
  5207. <dt><tt class="docutils literal">desc(string)</tt></dt>
  5208. <dd>Search commit message for string. The match is case-insensitive.</dd>
  5209. <dt><tt class="docutils literal">descendants(set)</tt></dt>
  5210. <dd>Changesets which are descendants of changesets in set.</dd>
  5211. <dt><tt class="docutils literal"><span class="pre">destination([set])</span></tt></dt>
  5212. <dd>Changesets that were created by a graft, transplant or rebase operation,
  5213. with the given revisions specified as the source.  Omitting the optional set
  5214. is the same as passing all().</dd>
  5215. <dt><tt class="docutils literal">divergent()</tt></dt>
  5216. <dd>Final successors of changesets with an alternative set of final successors.</dd>
  5217. <dt><tt class="docutils literal">draft()</tt></dt>
  5218. <dd>Changeset in draft phase.</dd>
  5219. <dt><tt class="docutils literal">extinct()</tt></dt>
  5220. <dd>Obsolete changesets with obsolete descendants only.</dd>
  5221. <dt><tt class="docutils literal">extra(label, [value])</tt></dt>
  5222. <dd><p class="first">Changesets with the given label in the extra metadata, with the given
  5223. optional value.</p>
  5224. <p class="last">If <cite>value</cite> starts with <cite>re:</cite>, the remainder of the value is treated as
  5225. a regular expression. To match a value that actually starts with <cite>re:</cite>,
  5226. use the prefix <cite>literal:</cite>.</p>
  5227. </dd>
  5228. <dt><tt class="docutils literal">file(pattern)</tt></dt>
  5229. <dd><p class="first">Changesets affecting files matched by pattern.</p>
  5230. <p>For a faster but less accurate result, consider using <tt class="docutils literal">filelog()</tt>
  5231. instead.</p>
  5232. <p class="last">This predicate uses <tt class="docutils literal">glob:</tt> as the default kind of pattern.</p>
  5233. </dd>
  5234. <dt><tt class="docutils literal">filelog(pattern)</tt></dt>
  5235. <dd><p class="first">Changesets connected to the specified filelog.</p>
  5236. <p>For performance reasons, visits only revisions mentioned in the file-level
  5237. filelog, rather than filtering through all changesets (much faster, but
  5238. doesn't include deletes or duplicate changes). For a slower, more accurate
  5239. result, use <tt class="docutils literal">file()</tt>.</p>
  5240. <p>The pattern without explicit kind like <tt class="docutils literal">glob:</tt> is expected to be
  5241. relative to the current directory and match against a file exactly
  5242. for efficiency.</p>
  5243. <p class="last">If some linkrev points to revisions filtered by the current repoview, we'll
  5244. work around it to return a non-filtered value.</p>
  5245. </dd>
  5246. <dt><tt class="docutils literal">first(set, [n])</tt></dt>
  5247. <dd>An alias for limit().</dd>
  5248. <dt><tt class="docutils literal"><span class="pre">follow([file])</span></tt></dt>
  5249. <dd>An alias for <tt class="docutils literal">::.</tt> (ancestors of the working directory's first parent).
  5250. If a filename is specified, the history of the given file is followed,
  5251. including copies.</dd>
  5252. <dt><tt class="docutils literal">grep(regex)</tt></dt>
  5253. <dd>Like <tt class="docutils literal">keyword(string)</tt> but accepts a regex. Use <tt class="docutils literal"><span class="pre">grep(r'...')</span></tt>
  5254. to ensure special escape characters are handled correctly. Unlike
  5255. <tt class="docutils literal">keyword(string)</tt>, the match is case-sensitive.</dd>
  5256. <dt><tt class="docutils literal">head()</tt></dt>
  5257. <dd>Changeset is a named branch head.</dd>
  5258. <dt><tt class="docutils literal">heads(set)</tt></dt>
  5259. <dd>Members of set with no children in set.</dd>
  5260. <dt><tt class="docutils literal">hidden()</tt></dt>
  5261. <dd>Hidden changesets.</dd>
  5262. <dt><tt class="docutils literal">id(string)</tt></dt>
  5263. <dd>Revision non-ambiguously specified by the given hex string prefix.</dd>
  5264. <dt><tt class="docutils literal">keyword(string)</tt></dt>
  5265. <dd>Search commit message, user name, and names of changed files for
  5266. string. The match is case-insensitive.</dd>
  5267. <dt><tt class="docutils literal">last(set, [n])</tt></dt>
  5268. <dd>Last n members of set, defaulting to 1.</dd>
  5269. <dt><tt class="docutils literal">limit(set, [n])</tt></dt>
  5270. <dd>First n members of set, defaulting to 1.</dd>
  5271. <dt><tt class="docutils literal">matching(revision [, field])</tt></dt>
  5272. <dd><p class="first">Changesets in which a given set of fields match the set of fields in the
  5273. selected revision or set.</p>
  5274. <p>To match more than one field pass the list of fields to match separated
  5275. by spaces (e.g. <tt class="docutils literal">author description</tt>).</p>
  5276. <p>Valid fields are most regular revision fields and some special fields.</p>
  5277. <p>Regular revision fields are <tt class="docutils literal">description</tt>, <tt class="docutils literal">author</tt>, <tt class="docutils literal">branch</tt>,
  5278. <tt class="docutils literal">date</tt>, <tt class="docutils literal">files</tt>, <tt class="docutils literal">phase</tt>, <tt class="docutils literal">parents</tt>, <tt class="docutils literal">substate</tt>, <tt class="docutils literal">user</tt>
  5279. and <tt class="docutils literal">diff</tt>.
  5280. Note that <tt class="docutils literal">author</tt> and <tt class="docutils literal">user</tt> are synonyms. <tt class="docutils literal">diff</tt> refers to the
  5281. contents of the revision. Two revisions matching their <tt class="docutils literal">diff</tt> will
  5282. also match their <tt class="docutils literal">files</tt>.</p>
  5283. <p>Special fields are <tt class="docutils literal">summary</tt> and <tt class="docutils literal">metadata</tt>:
  5284. <tt class="docutils literal">summary</tt> matches the first line of the description.
  5285. <tt class="docutils literal">metadata</tt> is equivalent to matching <tt class="docutils literal">description user date</tt>
  5286. (i.e. it matches the main metadata fields).</p>
  5287. <p class="last"><tt class="docutils literal">metadata</tt> is the default field which is used when no fields are
  5288. specified. You can match more than one field at a time.</p>
  5289. </dd>
  5290. <dt><tt class="docutils literal">max(set)</tt></dt>
  5291. <dd>Changeset with highest revision number in set.</dd>
  5292. <dt><tt class="docutils literal">merge()</tt></dt>
  5293. <dd>Changeset is a merge changeset.</dd>
  5294. <dt><tt class="docutils literal">min(set)</tt></dt>
  5295. <dd>Changeset with lowest revision number in set.</dd>
  5296. <dt><tt class="docutils literal">modifies(pattern)</tt></dt>
  5297. <dd><p class="first">Changesets modifying files matched by pattern.</p>
  5298. <p class="last">The pattern without explicit kind like <tt class="docutils literal">glob:</tt> is expected to be
  5299. relative to the current directory and match against a file or a
  5300. directory.</p>
  5301. </dd>
  5302. <dt><tt class="docutils literal">named(namespace)</tt></dt>
  5303. <dd><p class="first">The changesets in a given namespace.</p>
  5304. <p class="last">If <cite>namespace</cite> starts with <cite>re:</cite>, the remainder of the string is treated as
  5305. a regular expression. To match a namespace that actually starts with <cite>re:</cite>,
  5306. use the prefix <cite>literal:</cite>.</p>
  5307. </dd>
  5308. <dt><tt class="docutils literal">obsolete()</tt></dt>
  5309. <dd>Mutable changeset with a newer version.</dd>
  5310. <dt><tt class="docutils literal">only(set, [set])</tt></dt>
  5311. <dd>Changesets that are ancestors of the first set that are not ancestors
  5312. of any other head in the repo. If a second set is specified, the result
  5313. is ancestors of the first set that are not ancestors of the second set
  5314. (i.e. ::&lt;set1&gt; - ::&lt;set2&gt;).</dd>
  5315. <dt><tt class="docutils literal"><span class="pre">origin([set])</span></tt></dt>
  5316. <dd>Changesets that were specified as a source for the grafts, transplants or
  5317. rebases that created the given revisions.  Omitting the optional set is the
  5318. same as passing all().  If a changeset created by these operations is itself
  5319. specified as a source for one of these operations, only the source changeset
  5320. for the first operation is selected.</dd>
  5321. <dt><tt class="docutils literal"><span class="pre">outgoing([path])</span></tt></dt>
  5322. <dd>Changesets not found in the specified destination repository, or the
  5323. default push location.</dd>
  5324. <dt><tt class="docutils literal"><span class="pre">p1([set])</span></tt></dt>
  5325. <dd>First parent of changesets in set, or the working directory.</dd>
  5326. <dt><tt class="docutils literal"><span class="pre">p2([set])</span></tt></dt>
  5327. <dd>Second parent of changesets in set, or the working directory.</dd>
  5328. <dt><tt class="docutils literal"><span class="pre">parents([set])</span></tt></dt>
  5329. <dd>The set of all parents for all changesets in set, or the working directory.</dd>
  5330. <dt><tt class="docutils literal">present(set)</tt></dt>
  5331. <dd><p class="first">An empty set, if any revision in set isn't found; otherwise,
  5332. all revisions in set.</p>
  5333. <p class="last">If any of specified revisions is not present in the local repository,
  5334. the query is normally aborted. But this predicate allows the query
  5335. to continue even in such cases.</p>
  5336. </dd>
  5337. <dt><tt class="docutils literal">public()</tt></dt>
  5338. <dd>Changeset in public phase.</dd>
  5339. <dt><tt class="docutils literal"><span class="pre">remote([id</span> <span class="pre">[,path]])</span></tt></dt>
  5340. <dd>Local revision that corresponds to the given identifier in a
  5341. remote repository, if present. Here, the '.' identifier is a
  5342. synonym for the current local branch.</dd>
  5343. <dt><tt class="docutils literal">removes(pattern)</tt></dt>
  5344. <dd><p class="first">Changesets which remove files matching pattern.</p>
  5345. <p class="last">The pattern without explicit kind like <tt class="docutils literal">glob:</tt> is expected to be
  5346. relative to the current directory and match against a file or a
  5347. directory.</p>
  5348. </dd>
  5349. <dt><tt class="docutils literal">rev(number)</tt></dt>
  5350. <dd>Revision with the given numeric identifier.</dd>
  5351. <dt><tt class="docutils literal">reverse(set)</tt></dt>
  5352. <dd>Reverse order of set.</dd>
  5353. <dt><tt class="docutils literal">roots(set)</tt></dt>
  5354. <dd>Changesets in set with no parent changeset in set.</dd>
  5355. <dt><tt class="docutils literal">secret()</tt></dt>
  5356. <dd>Changeset in secret phase.</dd>
  5357. <dt><tt class="docutils literal">sort(set[, <span class="pre">[-]key...])</span></tt></dt>
  5358. <dd><p class="first">Sort set by keys. The default sort order is ascending, specify a key
  5359. as <tt class="docutils literal"><span class="pre">-key</span></tt> to sort in descending order.</p>
  5360. <p>The keys can be:</p>
  5361. <ul class="last simple">
  5362. <li><tt class="docutils literal">rev</tt> for the revision number,</li>
  5363. <li><tt class="docutils literal">branch</tt> for the branch name,</li>
  5364. <li><tt class="docutils literal">desc</tt> for the commit message (description),</li>
  5365. <li><tt class="docutils literal">user</tt> for user name (<tt class="docutils literal">author</tt> can be used as an alias),</li>
  5366. <li><tt class="docutils literal">date</tt> for the commit date</li>
  5367. </ul>
  5368. </dd>
  5369. <dt><tt class="docutils literal"><span class="pre">subrepo([pattern])</span></tt></dt>
  5370. <dd>Changesets that add, modify or remove the given subrepo.  If no subrepo
  5371. pattern is named, any subrepo changes are returned.</dd>
  5372. <dt><tt class="docutils literal"><span class="pre">tag([name])</span></tt></dt>
  5373. <dd><p class="first">The specified tag by name, or all tagged revisions if no name is given.</p>
  5374. <p class="last">If <cite>name</cite> starts with <cite>re:</cite>, the remainder of the name is treated as
  5375. a regular expression. To match a tag that actually starts with <cite>re:</cite>,
  5376. use the prefix <cite>literal:</cite>.</p>
  5377. </dd>
  5378. <dt><tt class="docutils literal">unstable()</tt></dt>
  5379. <dd>Non-obsolete changesets with obsolete ancestors.</dd>
  5380. <dt><tt class="docutils literal">user(string)</tt></dt>
  5381. <dd><p class="first">User name contains string. The match is case-insensitive.</p>
  5382. <p class="last">If <cite>string</cite> starts with <cite>re:</cite>, the remainder of the string is treated as
  5383. a regular expression. To match a user that actually contains <cite>re:</cite>, use
  5384. the prefix <cite>literal:</cite>.</p>
  5385. </dd>
  5386. </dl>
  5387. <p>New predicates (known as &quot;aliases&quot;) can be defined, using any combination of
  5388. existing predicates or other aliases. An alias definition looks like:</p>
  5389. <pre class="literal-block">
  5390. &lt;alias&gt; = &lt;definition&gt;
  5391. </pre>
  5392. <p>in the <tt class="docutils literal">revsetalias</tt> section of a Mercurial configuration file. Arguments
  5393. of the form <cite>$1</cite>, <cite>$2</cite>, etc. are substituted from the alias into the
  5394. definition.</p>
  5395. <p>For example,</p>
  5396. <pre class="literal-block">
  5397. [revsetalias]
  5398. h = heads()
  5399. d($1) = sort($1, date)
  5400. rs($1, $2) = reverse(sort($1, $2))
  5401. </pre>
  5402. <p>defines three aliases, <tt class="docutils literal">h</tt>, <tt class="docutils literal">d</tt>, and <tt class="docutils literal">rs</tt>. <tt class="docutils literal">rs(0:tip, author)</tt> is
  5403. exactly equivalent to <tt class="docutils literal">reverse(sort(0:tip, author))</tt>.</p>
  5404. <p>An infix operator <tt class="docutils literal">##</tt> can concatenate strings and identifiers into
  5405. one string. For example:</p>
  5406. <pre class="literal-block">
  5407. [revsetalias]
  5408. issue($1) = grep(r'\bissue[ :]?' ## $1 ## r'\b|\bbug\(' ## $1 ## r'\)')
  5409. </pre>
  5410. <p><tt class="docutils literal">issue(1234)</tt> is equivalent to <tt class="docutils literal"><span class="pre">grep(r'\bissue[</span> <span class="pre">:]?1234\b|\bbug\(1234\)')</span></tt>
  5411. in this case. This matches against all of &quot;issue 1234&quot;, &quot;issue:1234&quot;,
  5412. &quot;issue1234&quot; and &quot;bug(1234)&quot;.</p>
  5413. <p>All other prefix, infix and postfix operators have lower priority than
  5414. <tt class="docutils literal">##</tt>. For example, <tt class="docutils literal">$1 ## $2~2</tt> is equivalent to <tt class="docutils literal">($1 ## <span class="pre">$2)~2</span></tt>.</p>
  5415. <p>Command line equivalents for <a class="reference external" href="hg.1.html#log"><tt class="docutils literal">hg log</tt></a>:</p>
  5416. <pre class="literal-block">
  5417. -f    -&gt;  ::.
  5418. -d x  -&gt;  date(x)
  5419. -k x  -&gt;  keyword(x)
  5420. -m    -&gt;  merge()
  5421. -u x  -&gt;  user(x)
  5422. -b x  -&gt;  branch(x)
  5423. -P x  -&gt;  !::x
  5424. -l x  -&gt;  limit(expr, x)
  5425. </pre>
  5426. <p>Some sample queries:</p>
  5427. <ul>
  5428. <li><p class="first">Changesets on the default branch:</p>
  5429. <pre class="literal-block">
  5430. hg log -r &quot;branch(default)&quot;
  5431. </pre>
  5432. </li>
  5433. <li><p class="first">Changesets on the default branch since tag 1.5 (excluding merges):</p>
  5434. <pre class="literal-block">
  5435. hg log -r &quot;branch(default) and 1.5:: and not merge()&quot;
  5436. </pre>
  5437. </li>
  5438. <li><p class="first">Open branch heads:</p>
  5439. <pre class="literal-block">
  5440. hg log -r &quot;head() and not closed()&quot;
  5441. </pre>
  5442. </li>
  5443. <li><p class="first">Changesets between tags 1.3 and 1.5 mentioning &quot;bug&quot; that affect
  5444. <tt class="docutils literal">hgext/*</tt>:</p>
  5445. <pre class="literal-block">
  5446. hg log -r &quot;1.3::1.5 and keyword(bug) and file('hgext/*')&quot;
  5447. </pre>
  5448. </li>
  5449. <li><p class="first">Changesets committed in May 2008, sorted by user:</p>
  5450. <pre class="literal-block">
  5451. hg log -r &quot;sort(date('May 2008'), user)&quot;
  5452. </pre>
  5453. </li>
  5454. <li><p class="first">Changesets mentioning &quot;bug&quot; or &quot;issue&quot; that are not in a tagged
  5455. release:</p>
  5456. <pre class="literal-block">
  5457. hg log -r &quot;(keyword(bug) or keyword(issue)) and not ancestors(tag())&quot;
  5458. </pre>
  5459. </li>
  5460. </ul>
  5461. </div>
  5462. <div class="section" id="using-mercurial-from-scripts-and-automation">
  5463. <span id="scripting"></span><h1><a class="toc-backref" href="#contents">Using Mercurial from scripts and automation</a></h1>
  5464. <p>It is common for machines (as opposed to humans) to consume Mercurial.
  5465. This help topic describes some of the considerations for interfacing
  5466. machines with Mercurial.</p>
  5467. <div class="section" id="choosing-an-interface">
  5468. <h2>Choosing an Interface</h2>
  5469. <p>Machines have a choice of several methods to interface with Mercurial.
  5470. These include:</p>
  5471. <ul class="simple">
  5472. <li>Executing the <tt class="docutils literal">hg</tt> process</li>
  5473. <li>Querying a HTTP server</li>
  5474. <li>Calling out to a command server</li>
  5475. </ul>
  5476. <p>Executing <tt class="docutils literal">hg</tt> processes is very similar to how humans interact with
  5477. Mercurial in the shell. It should already be familiar to you.</p>
  5478. <p><a class="reference external" href="hg.1.html#serve"><tt class="docutils literal">hg serve</tt></a> can be used to start a server. By default, this will start
  5479. a &quot;hgweb&quot; HTTP server. This HTTP server has support for machine-readable
  5480. output, such as JSON. For more, see <a class="reference external" href="hg.1.html#hgweb"><tt class="docutils literal">hg help hgweb</tt></a>.</p>
  5481. <p><a class="reference external" href="hg.1.html#serve"><tt class="docutils literal">hg serve</tt></a> can also start a &quot;command server.&quot; Clients can connect
  5482. to this server and issue Mercurial commands over a special protocol.
  5483. For more details on the command server, including links to client
  5484. libraries, see <a class="reference external" href="https://mercurial.selenic.com/wiki/CommandServer">https://mercurial.selenic.com/wiki/CommandServer</a>.</p>
  5485. <p><a class="reference external" href="hg.1.html#serve"><tt class="docutils literal">hg serve</tt></a> based interfaces (the hgweb and command servers) have the
  5486. advantage over simple <tt class="docutils literal">hg</tt> process invocations in that they are
  5487. likely more efficient. This is because there is significant overhead
  5488. to spawn new Python processes.</p>
  5489. <div class="tip">
  5490. <p class="first admonition-title">Tip</p>
  5491. <p class="last">If you need to invoke several <tt class="docutils literal">hg</tt> processes in short order and/or
  5492. performance is important to you, use of a server-based interface
  5493. is highly recommended.</p>
  5494. </div>
  5495. </div>
  5496. <div class="section" id="id11">
  5497. <h2>Environment Variables</h2>
  5498. <p>As documented in <a class="reference external" href="hg.1.html#environment"><tt class="docutils literal">hg help environment</tt></a>, various environment variables
  5499. influence the operation of Mercurial. The following are particularly
  5500. relevant for machines consuming Mercurial:</p>
  5501. <dl class="docutils">
  5502. <dt>HGPLAIN</dt>
  5503. <dd><p class="first">If not set, Mercurial's output could be influenced by configuration
  5504. settings that impact its encoding, verbose mode, localization, etc.</p>
  5505. <p class="last">It is highly recommended for machines to set this variable when
  5506. invoking <tt class="docutils literal">hg</tt> processes.</p>
  5507. </dd>
  5508. <dt>HGENCODING</dt>
  5509. <dd><p class="first">If not set, the locale used by Mercurial will be detected from the
  5510. environment. If the determined locale does not support display of
  5511. certain characters, Mercurial may render these character sequences
  5512. incorrectly (often by using &quot;?&quot; as a placeholder for invalid
  5513. characters in the current locale).</p>
  5514. <p class="last">Explicitly setting this environment variable is a good practice to
  5515. guarantee consistent results. &quot;utf-8&quot; is a good choice on UNIX-like
  5516. environments.</p>
  5517. </dd>
  5518. <dt>HGRCPATH</dt>
  5519. <dd><p class="first">If not set, Mercurial will inherit config options from config files
  5520. using the process described in <a class="reference external" href="hg.1.html#config"><tt class="docutils literal">hg help config</tt></a>. This includes
  5521. inheriting user or system-wide config files.</p>
  5522. <p class="last">When utmost control over the Mercurial configuration is desired, the
  5523. value of <tt class="docutils literal">HGRCPATH</tt> can be set to an explicit file with known good
  5524. configs. In rare cases, the value can be set to an empty file or the
  5525. null device (often <tt class="docutils literal">/dev/null</tt>) to bypass loading of any user or
  5526. system config files. Note that these approaches can have unintended
  5527. consequences, as the user and system config files often define things
  5528. like the username and extensions that may be required to interface
  5529. with a repository.</p>
  5530. </dd>
  5531. </dl>
  5532. </div>
  5533. <div class="section" id="consuming-command-output">
  5534. <h2>Consuming Command Output</h2>
  5535. <p>It is common for machines to need to parse the output of Mercurial
  5536. commands for relevant data. This section describes the various
  5537. techniques for doing so.</p>
  5538. <div class="section" id="parsing-raw-command-output">
  5539. <h3>Parsing Raw Command Output</h3>
  5540. <p>Likely the simplest and most effective solution for consuming command
  5541. output is to simply invoke <tt class="docutils literal">hg</tt> commands as you would as a user and
  5542. parse their output.</p>
  5543. <p>The output of many commands can easily be parsed with tools like
  5544. <tt class="docutils literal">grep</tt>, <tt class="docutils literal">sed</tt>, and <tt class="docutils literal">awk</tt>.</p>
  5545. <p>A potential downside with parsing command output is that the output
  5546. of commands can change when Mercurial is upgraded. While Mercurial
  5547. does generally strive for strong backwards compatibility, command
  5548. output does occasionally change. Having tests for your automated
  5549. interactions with <tt class="docutils literal">hg</tt> commands is generally recommended, but is
  5550. even more important when raw command output parsing is involved.</p>
  5551. </div>
  5552. <div class="section" id="using-templates-to-control-output">
  5553. <h3>Using Templates to Control Output</h3>
  5554. <p>Many <tt class="docutils literal">hg</tt> commands support templatized output via the
  5555. <tt class="docutils literal"><span class="pre">-T/--template</span></tt> argument. For more, see <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a>.</p>
  5556. <p>Templates are useful for explicitly controlling output so that
  5557. you get exactly the data you want formatted how you want it. For
  5558. example, <tt class="docutils literal">log <span class="pre">-T</span> <span class="pre">{node}\n</span></tt> can be used to print a newline
  5559. delimited list of changeset nodes instead of a human-tailored
  5560. output containing authors, dates, descriptions, etc.</p>
  5561. <div class="tip">
  5562. <p class="first admonition-title">Tip</p>
  5563. <p class="last">If parsing raw command output is too complicated, consider
  5564. using templates to make your life easier.</p>
  5565. </div>
  5566. <p>The <tt class="docutils literal"><span class="pre">-T/--template</span></tt> argument allows specifying pre-defined styles.
  5567. Mercurial ships with the machine-readable styles <tt class="docutils literal">json</tt> and <tt class="docutils literal">xml</tt>,
  5568. which provide JSON and XML output, respectively. These are useful for
  5569. producing output that is machine readable as-is.</p>
  5570. <div class="important">
  5571. <p class="first admonition-title">Important</p>
  5572. <p>The <tt class="docutils literal">json</tt> and <tt class="docutils literal">xml</tt> styles are considered experimental. While
  5573. they may be attractive to use for easily obtaining machine-readable
  5574. output, their behavior may change in subsequent versions.</p>
  5575. <p class="last">These styles may also exhibit unexpected results when dealing with
  5576. certain encodings. Mercurial treats things like filenames as a
  5577. series of bytes and normalizing certain byte sequences to JSON
  5578. or XML with certain encoding settings can lead to surprises.</p>
  5579. </div>
  5580. </div>
  5581. <div class="section" id="command-server-output">
  5582. <h3>Command Server Output</h3>
  5583. <p>If using the command server to interact with Mercurial, you are likely
  5584. using an existing library/API that abstracts implementation details of
  5585. the command server. If so, this interface layer may perform parsing for
  5586. you, saving you the work of implementing it yourself.</p>
  5587. </div>
  5588. <div class="section" id="output-verbosity">
  5589. <h3>Output Verbosity</h3>
  5590. <p>Commands often have varying output verbosity, even when machine
  5591. readable styles are being used (e.g. <tt class="docutils literal"><span class="pre">-T</span> json</tt>). Adding
  5592. <tt class="docutils literal"><span class="pre">-v/--verbose</span></tt> and <tt class="docutils literal"><span class="pre">--debug</span></tt> to the command's arguments can
  5593. increase the amount of data exposed by Mercurial.</p>
  5594. <p>An alternate way to get the data you need is by explicitly specifying
  5595. a template.</p>
  5596. </div>
  5597. </div>
  5598. <div class="section" id="other-topics">
  5599. <h2>Other Topics</h2>
  5600. <dl class="docutils">
  5601. <dt>revsets</dt>
  5602. <dd><p class="first">Revisions sets is a functional query language for selecting a set
  5603. of revisions. Think of it as SQL for Mercurial repositories. Revsets
  5604. are useful for querying repositories for specific data.</p>
  5605. <p class="last">See <a class="reference external" href="hg.1.html#revsets"><tt class="docutils literal">hg help revsets</tt></a> for more.</p>
  5606. </dd>
  5607. <dt>share extension</dt>
  5608. <dd><p class="first">The <tt class="docutils literal">share</tt> extension provides functionality for sharing
  5609. repository data across several working copies. It can even
  5610. automatically &quot;pool&quot; storage for logically related repositories when
  5611. cloning.</p>
  5612. <p>Configuring the <tt class="docutils literal">share</tt> extension can lead to significant resource
  5613. utilization reduction, particularly around disk space and the
  5614. network. This is especially true for continuous integration (CI)
  5615. environments.</p>
  5616. <p class="last">See <a class="reference external" href="hg.1.html#-e"><tt class="docutils literal">hg help <span class="pre">-e</span> share</tt></a> for more.</p>
  5617. </dd>
  5618. </dl>
  5619. </div>
  5620. </div>
  5621. <div class="section" id="subrepositories">
  5622. <span id="subrepo"></span><span id="subrepos"></span><h1><a class="toc-backref" href="#contents">Subrepositories</a></h1>
  5623. <p>Subrepositories let you nest external repositories or projects into a
  5624. parent Mercurial repository, and make commands operate on them as a
  5625. group.</p>
  5626. <p>Mercurial currently supports Mercurial, Git, and Subversion
  5627. subrepositories.</p>
  5628. <p>Subrepositories are made of three components:</p>
  5629. <ol class="arabic">
  5630. <li><p class="first">Nested repository checkouts. They can appear anywhere in the
  5631. parent working directory.</p>
  5632. </li>
  5633. <li><p class="first">Nested repository references. They are defined in <tt class="docutils literal">.hgsub</tt>, which
  5634. should be placed in the root of working directory, and
  5635. tell where the subrepository checkouts come from. Mercurial
  5636. subrepositories are referenced like:</p>
  5637. <pre class="literal-block">
  5638. path/to/nested = https://example.com/nested/repo/path
  5639. </pre>
  5640. <p>Git and Subversion subrepos are also supported:</p>
  5641. <pre class="literal-block">
  5642. path/to/nested = [git]git://example.com/nested/repo/path
  5643. path/to/nested = [svn]https://example.com/nested/trunk/path
  5644. </pre>
  5645. <p>where <tt class="docutils literal">path/to/nested</tt> is the checkout location relatively to the
  5646. parent Mercurial root, and <tt class="docutils literal"><span class="pre">https://example.com/nested/repo/path</span></tt>
  5647. is the source repository path. The source can also reference a
  5648. filesystem path.</p>
  5649. <p>Note that <tt class="docutils literal">.hgsub</tt> does not exist by default in Mercurial
  5650. repositories, you have to create and add it to the parent
  5651. repository before using subrepositories.</p>
  5652. </li>
  5653. <li><p class="first">Nested repository states. They are defined in <tt class="docutils literal">.hgsubstate</tt>, which
  5654. is placed in the root of working directory, and
  5655. capture whatever information is required to restore the
  5656. subrepositories to the state they were committed in a parent
  5657. repository changeset. Mercurial automatically record the nested
  5658. repositories states when committing in the parent repository.</p>
  5659. <div class="note">
  5660. <p class="first admonition-title">Note</p>
  5661. <p class="last">The <tt class="docutils literal">.hgsubstate</tt> file should not be edited manually.</p>
  5662. </div>
  5663. </li>
  5664. </ol>
  5665. <div class="section" id="adding-a-subrepository">
  5666. <h2>Adding a Subrepository</h2>
  5667. <p>If <tt class="docutils literal">.hgsub</tt> does not exist, create it and add it to the parent
  5668. repository. Clone or checkout the external projects where you want it
  5669. to live in the parent repository. Edit <tt class="docutils literal">.hgsub</tt> and add the
  5670. subrepository entry as described above. At this point, the
  5671. subrepository is tracked and the next commit will record its state in
  5672. <tt class="docutils literal">.hgsubstate</tt> and bind it to the committed changeset.</p>
  5673. </div>
  5674. <div class="section" id="synchronizing-a-subrepository">
  5675. <h2>Synchronizing a Subrepository</h2>
  5676. <p>Subrepos do not automatically track the latest changeset of their
  5677. sources. Instead, they are updated to the changeset that corresponds
  5678. with the changeset checked out in the top-level changeset. This is so
  5679. developers always get a consistent set of compatible code and
  5680. libraries when they update.</p>
  5681. <p>Thus, updating subrepos is a manual process. Simply check out target
  5682. subrepo at the desired revision, test in the top-level repo, then
  5683. commit in the parent repository to record the new combination.</p>
  5684. </div>
  5685. <div class="section" id="deleting-a-subrepository">
  5686. <h2>Deleting a Subrepository</h2>
  5687. <p>To remove a subrepository from the parent repository, delete its
  5688. reference from <tt class="docutils literal">.hgsub</tt>, then remove its files.</p>
  5689. </div>
  5690. <div class="section" id="interaction-with-mercurial-commands">
  5691. <h2>Interaction with Mercurial Commands</h2>
  5692. <table class="docutils field-list" frame="void" rules="none">
  5693. <col class="field-name" />
  5694. <col class="field-body" />
  5695. <tbody valign="top">
  5696. <tr class="field"><th class="field-name">add:</th><td class="field-body">add does not recurse in subrepos unless -S/--subrepos is
  5697. specified.  However, if you specify the full path of a file in a
  5698. subrepo, it will be added even without -S/--subrepos specified.
  5699. Subversion subrepositories are currently silently
  5700. ignored.</td>
  5701. </tr>
  5702. <tr class="field"><th class="field-name">addremove:</th><td class="field-body">addremove does not recurse into subrepos unless
  5703. -S/--subrepos is specified.  However, if you specify the full
  5704. path of a directory in a subrepo, addremove will be performed on
  5705. it even without -S/--subrepos being specified.  Git and
  5706. Subversion subrepositories will print a warning and continue.</td>
  5707. </tr>
  5708. <tr class="field"><th class="field-name">archive:</th><td class="field-body">archive does not recurse in subrepositories unless
  5709. -S/--subrepos is specified.</td>
  5710. </tr>
  5711. <tr class="field"><th class="field-name">cat:</th><td class="field-body">cat currently only handles exact file matches in subrepos.
  5712. Subversion subrepositories are currently ignored.</td>
  5713. </tr>
  5714. <tr class="field"><th class="field-name">commit:</th><td class="field-body">commit creates a consistent snapshot of the state of the
  5715. entire project and its subrepositories. If any subrepositories
  5716. have been modified, Mercurial will abort.  Mercurial can be made
  5717. to instead commit all modified subrepositories by specifying
  5718. -S/--subrepos, or setting &quot;ui.commitsubrepos=True&quot; in a
  5719. configuration file (see <a class="reference external" href="hg.1.html#config"><tt class="docutils literal">hg help config</tt></a>).  After there are no
  5720. longer any modified subrepositories, it records their state and
  5721. finally commits it in the parent repository.  The --addremove
  5722. option also honors the -S/--subrepos option.  However, Git and
  5723. Subversion subrepositories will print a warning and abort.</td>
  5724. </tr>
  5725. <tr class="field"><th class="field-name">diff:</th><td class="field-body">diff does not recurse in subrepos unless -S/--subrepos is
  5726. specified. Changes are displayed as usual, on the subrepositories
  5727. elements. Subversion subrepositories are currently silently ignored.</td>
  5728. </tr>
  5729. <tr class="field"><th class="field-name">files:</th><td class="field-body">files does not recurse into subrepos unless -S/--subrepos is
  5730. specified.  However, if you specify the full path of a file or
  5731. directory in a subrepo, it will be displayed even without
  5732. -S/--subrepos being specified.  Git and Subversion subrepositories
  5733. are currently silently ignored.</td>
  5734. </tr>
  5735. <tr class="field"><th class="field-name">forget:</th><td class="field-body">forget currently only handles exact file matches in subrepos.
  5736. Git and Subversion subrepositories are currently silently ignored.</td>
  5737. </tr>
  5738. <tr class="field"><th class="field-name">incoming:</th><td class="field-body">incoming does not recurse in subrepos unless -S/--subrepos
  5739. is specified. Git and Subversion subrepositories are currently
  5740. silently ignored.</td>
  5741. </tr>
  5742. <tr class="field"><th class="field-name">outgoing:</th><td class="field-body">outgoing does not recurse in subrepos unless -S/--subrepos
  5743. is specified. Git and Subversion subrepositories are currently
  5744. silently ignored.</td>
  5745. </tr>
  5746. <tr class="field"><th class="field-name">pull:</th><td class="field-body">pull is not recursive since it is not clear what to pull prior
  5747. to running <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a>. Listing and retrieving all
  5748. subrepositories changes referenced by the parent repository pulled
  5749. changesets is expensive at best, impossible in the Subversion
  5750. case.</td>
  5751. </tr>
  5752. <tr class="field"><th class="field-name">push:</th><td class="field-body">Mercurial will automatically push all subrepositories first
  5753. when the parent repository is being pushed. This ensures new
  5754. subrepository changes are available when referenced by top-level
  5755. repositories.  Push is a no-op for Subversion subrepositories.</td>
  5756. </tr>
  5757. <tr class="field"><th class="field-name">status:</th><td class="field-body">status does not recurse into subrepositories unless
  5758. -S/--subrepos is specified. Subrepository changes are displayed as
  5759. regular Mercurial changes on the subrepository
  5760. elements. Subversion subrepositories are currently silently
  5761. ignored.</td>
  5762. </tr>
  5763. <tr class="field"><th class="field-name">remove:</th><td class="field-body">remove does not recurse into subrepositories unless
  5764. -S/--subrepos is specified.  However, if you specify a file or
  5765. directory path in a subrepo, it will be removed even without
  5766. -S/--subrepos.  Git and Subversion subrepositories are currently
  5767. silently ignored.</td>
  5768. </tr>
  5769. <tr class="field"><th class="field-name">update:</th><td class="field-body">update restores the subrepos in the state they were
  5770. originally committed in target changeset. If the recorded
  5771. changeset is not available in the current subrepository, Mercurial
  5772. will pull it in first before updating.  This means that updating
  5773. can require network access when using subrepositories.</td>
  5774. </tr>
  5775. </tbody>
  5776. </table>
  5777. </div>
  5778. <div class="section" id="remapping-subrepositories-sources">
  5779. <h2>Remapping Subrepositories Sources</h2>
  5780. <p>A subrepository source location may change during a project life,
  5781. invalidating references stored in the parent repository history. To
  5782. fix this, rewriting rules can be defined in parent repository <tt class="docutils literal">hgrc</tt>
  5783. file or in Mercurial configuration. See the <tt class="docutils literal">[subpaths]</tt> section in
  5784. hgrc(5) for more details.</p>
  5785. </div>
  5786. </div>
  5787. <div class="section" id="template-usage">
  5788. <span id="style"></span><span id="template"></span><span id="templates"></span><span id="templating"></span><h1><a class="toc-backref" href="#contents">Template Usage</a></h1>
  5789. <p>Mercurial allows you to customize output of commands through
  5790. templates. You can either pass in a template or select an existing
  5791. template-style from the command line, via the --template option.</p>
  5792. <p>You can customize output for any &quot;log-like&quot; command: log,
  5793. outgoing, incoming, tip, parents, and heads.</p>
  5794. <p>Some built-in styles are packaged with Mercurial. These can be listed
  5795. with <a class="reference external" href="hg.1.html#log"><tt class="docutils literal">hg log <span class="pre">--template</span> list</tt></a>. Example usage:</p>
  5796. <pre class="literal-block">
  5797. $ hg log -r1.0::1.1 --template changelog
  5798. </pre>
  5799. <p>A template is a piece of text, with markup to invoke variable
  5800. expansion:</p>
  5801. <pre class="literal-block">
  5802. $ hg log -r1 --template &quot;{node}\n&quot;
  5803. b56ce7b07c52de7d5fd79fb89701ea538af65746
  5804. </pre>
  5805. <p>Strings in curly braces are called keywords. The availability of
  5806. keywords depends on the exact context of the templater. These
  5807. keywords are usually available for templating a log-like command:</p>
  5808. <table class="docutils field-list" frame="void" rules="none">
  5809. <col class="field-name" />
  5810. <col class="field-body" />
  5811. <tbody valign="top">
  5812. <tr class="field"><th class="field-name">activebookmark:</th><td class="field-body">String. The active bookmark, if it is
  5813. associated with the changeset</td>
  5814. </tr>
  5815. <tr class="field"><th class="field-name">author:</th><td class="field-body">String. The unmodified author of the changeset.</td>
  5816. </tr>
  5817. <tr class="field"><th class="field-name">bisect:</th><td class="field-body">String. The changeset bisection status.</td>
  5818. </tr>
  5819. <tr class="field"><th class="field-name">bookmarks:</th><td class="field-body">List of strings. Any bookmarks associated with the
  5820. changeset. Also sets 'active', the name of the active bookmark.</td>
  5821. </tr>
  5822. <tr class="field"><th class="field-name">branch:</th><td class="field-body">String. The name of the branch on which the changeset was
  5823. committed.</td>
  5824. </tr>
  5825. <tr class="field"><th class="field-name" colspan="2">changessincelatesttag:</th></tr>
  5826. <tr class="field"><td>&nbsp;</td><td class="field-body">Integer. All ancestors not in the latest tag.</td>
  5827. </tr>
  5828. <tr class="field"><th class="field-name">children:</th><td class="field-body">List of strings. The children of the changeset.</td>
  5829. </tr>
  5830. <tr class="field"><th class="field-name" colspan="2">currentbookmark:</th></tr>
  5831. <tr class="field"><td>&nbsp;</td><td class="field-body">String. The active bookmark, if it is
  5832. associated with the changeset (DEPRECATED)</td>
  5833. </tr>
  5834. <tr class="field"><th class="field-name">date:</th><td class="field-body">Date information. The date when the changeset was committed.</td>
  5835. </tr>
  5836. <tr class="field"><th class="field-name">desc:</th><td class="field-body">String. The text of the changeset description.</td>
  5837. </tr>
  5838. <tr class="field"><th class="field-name">diffstat:</th><td class="field-body">String. Statistics of changes with the following format:
  5839. &quot;modified files: +added/-removed lines&quot;</td>
  5840. </tr>
  5841. <tr class="field"><th class="field-name">extras:</th><td class="field-body">List of dicts with key, value entries of the 'extras'
  5842. field of this changeset.</td>
  5843. </tr>
  5844. <tr class="field"><th class="field-name">file_adds:</th><td class="field-body">List of strings. Files added by this changeset.</td>
  5845. </tr>
  5846. <tr class="field"><th class="field-name">file_copies:</th><td class="field-body">List of strings. Files copied in this changeset with
  5847. their sources.</td>
  5848. </tr>
  5849. <tr class="field"><th class="field-name" colspan="2">file_copies_switch:</th></tr>
  5850. <tr class="field"><td>&nbsp;</td><td class="field-body">List of strings. Like &quot;file_copies&quot; but displayed
  5851. only if the --copied switch is set.</td>
  5852. </tr>
  5853. <tr class="field"><th class="field-name">file_dels:</th><td class="field-body">List of strings. Files removed by this changeset.</td>
  5854. </tr>
  5855. <tr class="field"><th class="field-name">file_mods:</th><td class="field-body">List of strings. Files modified by this changeset.</td>
  5856. </tr>
  5857. <tr class="field"><th class="field-name">files:</th><td class="field-body">List of strings. All files modified, added, or removed by this
  5858. changeset.</td>
  5859. </tr>
  5860. <tr class="field"><th class="field-name">latesttag:</th><td class="field-body">List of strings. The global tags on the most recent globally
  5861. tagged ancestor of this changeset.</td>
  5862. </tr>
  5863. <tr class="field"><th class="field-name" colspan="2">latesttagdistance:</th></tr>
  5864. <tr class="field"><td>&nbsp;</td><td class="field-body">Integer. Longest path to the latest tag.</td>
  5865. </tr>
  5866. <tr class="field"><th class="field-name">node:</th><td class="field-body">String. The changeset identification hash, as a 40 hexadecimal
  5867. digit string.</td>
  5868. </tr>
  5869. <tr class="field"><th class="field-name">p1node:</th><td class="field-body">String. The identification hash of the changeset's first parent,
  5870. as a 40 digit hexadecimal string. If the changeset has no parents, all
  5871. digits are 0.</td>
  5872. </tr>
  5873. <tr class="field"><th class="field-name">p1rev:</th><td class="field-body">Integer. The repository-local revision number of the changeset's
  5874. first parent, or -1 if the changeset has no parents.</td>
  5875. </tr>
  5876. <tr class="field"><th class="field-name">p2node:</th><td class="field-body">String. The identification hash of the changeset's second
  5877. parent, as a 40 digit hexadecimal string. If the changeset has no second
  5878. parent, all digits are 0.</td>
  5879. </tr>
  5880. <tr class="field"><th class="field-name">p2rev:</th><td class="field-body">Integer. The repository-local revision number of the changeset's
  5881. second parent, or -1 if the changeset has no second parent.</td>
  5882. </tr>
  5883. <tr class="field"><th class="field-name">parents:</th><td class="field-body">List of strings. The parents of the changeset in &quot;rev:node&quot;
  5884. format. If the changeset has only one &quot;natural&quot; parent (the predecessor
  5885. revision) nothing is shown.</td>
  5886. </tr>
  5887. <tr class="field"><th class="field-name">phase:</th><td class="field-body">String. The changeset phase name.</td>
  5888. </tr>
  5889. <tr class="field"><th class="field-name">phaseidx:</th><td class="field-body">Integer. The changeset phase index.</td>
  5890. </tr>
  5891. <tr class="field"><th class="field-name">rev:</th><td class="field-body">Integer. The repository-local changeset revision number.</td>
  5892. </tr>
  5893. <tr class="field"><th class="field-name">subrepos:</th><td class="field-body">List of strings. Updated subrepositories in the changeset.</td>
  5894. </tr>
  5895. <tr class="field"><th class="field-name">tags:</th><td class="field-body">List of strings. Any tags associated with the changeset.</td>
  5896. </tr>
  5897. </tbody>
  5898. </table>
  5899. <p>The &quot;date&quot; keyword does not produce human-readable output. If you
  5900. want to use a date in your output, you can use a filter to process
  5901. it. Filters are functions which return a string based on the input
  5902. variable. Be sure to use the stringify filter first when you're
  5903. applying a string-input filter to a list-like input variable.
  5904. You can also use a chain of filters to get the desired output:</p>
  5905. <pre class="literal-block">
  5906. $ hg tip --template &quot;{date|isodate}\n&quot;
  5907. 2008-08-21 18:22 +0000
  5908. </pre>
  5909. <p>List of filters:</p>
  5910. <table class="docutils field-list" frame="void" rules="none">
  5911. <col class="field-name" />
  5912. <col class="field-body" />
  5913. <tbody valign="top">
  5914. <tr class="field"><th class="field-name">addbreaks:</th><td class="field-body">Any text. Add an XHTML &quot;&lt;br /&gt;&quot; tag before the end of
  5915. every line except the last.</td>
  5916. </tr>
  5917. <tr class="field"><th class="field-name">age:</th><td class="field-body">Date. Returns a human-readable date/time difference between the
  5918. given date/time and the current date/time.</td>
  5919. </tr>
  5920. <tr class="field"><th class="field-name">basename:</th><td class="field-body">Any text. Treats the text as a path, and returns the last
  5921. component of the path after splitting by the path separator
  5922. (ignoring trailing separators). For example, &quot;foo/bar/baz&quot; becomes
  5923. &quot;baz&quot; and &quot;foo/bar//&quot; becomes &quot;bar&quot;.</td>
  5924. </tr>
  5925. <tr class="field"><th class="field-name">count:</th><td class="field-body">List or text. Returns the length as an integer.</td>
  5926. </tr>
  5927. <tr class="field"><th class="field-name">date:</th><td class="field-body">Date. Returns a date in a Unix date format, including the
  5928. timezone: &quot;Mon Sep 04 15:13:13 2006 0700&quot;.</td>
  5929. </tr>
  5930. <tr class="field"><th class="field-name">domain:</th><td class="field-body">Any text. Finds the first string that looks like an email
  5931. address, and extracts just the domain component. Example: <tt class="docutils literal">User
  5932. &lt;user&#64;example.com&gt;</tt> becomes <tt class="docutils literal">example.com</tt>.</td>
  5933. </tr>
  5934. <tr class="field"><th class="field-name">email:</th><td class="field-body">Any text. Extracts the first string that looks like an email
  5935. address. Example: <tt class="docutils literal">User &lt;user&#64;example.com&gt;</tt> becomes
  5936. <tt class="docutils literal">user&#64;example.com</tt>.</td>
  5937. </tr>
  5938. <tr class="field"><th class="field-name">emailuser:</th><td class="field-body">Any text. Returns the user portion of an email address.</td>
  5939. </tr>
  5940. <tr class="field"><th class="field-name">escape:</th><td class="field-body">Any text. Replaces the special XML/XHTML characters &quot;&amp;&quot;, &quot;&lt;&quot;
  5941. and &quot;&gt;&quot; with XML entities, and filters out NUL characters.</td>
  5942. </tr>
  5943. <tr class="field"><th class="field-name">fill68:</th><td class="field-body">Any text. Wraps the text to fit in 68 columns.</td>
  5944. </tr>
  5945. <tr class="field"><th class="field-name">fill76:</th><td class="field-body">Any text. Wraps the text to fit in 76 columns.</td>
  5946. </tr>
  5947. <tr class="field"><th class="field-name">firstline:</th><td class="field-body">Any text. Returns the first line of text.</td>
  5948. </tr>
  5949. <tr class="field"><th class="field-name">hex:</th><td class="field-body">Any text. Convert a binary Mercurial node identifier into
  5950. its long hexadecimal representation.</td>
  5951. </tr>
  5952. <tr class="field"><th class="field-name">hgdate:</th><td class="field-body">Date. Returns the date as a pair of numbers: &quot;1157407993
  5953. 25200&quot; (Unix timestamp, timezone offset).</td>
  5954. </tr>
  5955. <tr class="field"><th class="field-name">isodate:</th><td class="field-body">Date. Returns the date in ISO 8601 format: &quot;2009-08-18 13:00
  5956. +0200&quot;.</td>
  5957. </tr>
  5958. <tr class="field"><th class="field-name">isodatesec:</th><td class="field-body">Date. Returns the date in ISO 8601 format, including
  5959. seconds: &quot;2009-08-18 13:00:13 +0200&quot;. See also the rfc3339date
  5960. filter.</td>
  5961. </tr>
  5962. <tr class="field"><th class="field-name">localdate:</th><td class="field-body">Date. Converts a date to local date.</td>
  5963. </tr>
  5964. <tr class="field"><th class="field-name">lower:</th><td class="field-body">Any text. Converts the text to lowercase.</td>
  5965. </tr>
  5966. <tr class="field"><th class="field-name">nonempty:</th><td class="field-body">Any text. Returns '(none)' if the string is empty.</td>
  5967. </tr>
  5968. <tr class="field"><th class="field-name">obfuscate:</th><td class="field-body">Any text. Returns the input text rendered as a sequence of
  5969. XML entities.</td>
  5970. </tr>
  5971. <tr class="field"><th class="field-name">person:</th><td class="field-body">Any text. Returns the name before an email address,
  5972. interpreting it as per RFC 5322.</td>
  5973. </tr>
  5974. <tr class="field"><th class="field-name">revescape:</th><td class="field-body">Any text. Escapes all &quot;special&quot; characters, except &#64;.
  5975. Forward slashes are escaped twice to prevent web servers from prematurely
  5976. unescaping them. For example, &quot;&#64;foo bar/baz&quot; becomes &quot;&#64;foo%20bar%252Fbaz&quot;.</td>
  5977. </tr>
  5978. <tr class="field"><th class="field-name">rfc3339date:</th><td class="field-body">Date. Returns a date using the Internet date format
  5979. specified in RFC 3339: &quot;2009-08-18T13:00:13+02:00&quot;.</td>
  5980. </tr>
  5981. <tr class="field"><th class="field-name">rfc822date:</th><td class="field-body">Date. Returns a date using the same format used in email
  5982. headers: &quot;Tue, 18 Aug 2009 13:00:13 +0200&quot;.</td>
  5983. </tr>
  5984. <tr class="field"><th class="field-name">short:</th><td class="field-body">Changeset hash. Returns the short form of a changeset hash,
  5985. i.e. a 12 hexadecimal digit string.</td>
  5986. </tr>
  5987. <tr class="field"><th class="field-name">shortbisect:</th><td class="field-body">Any text. Treats <cite>text</cite> as a bisection status, and
  5988. returns a single-character representing the status (G: good, B: bad,
  5989. S: skipped, U: untested, I: ignored). Returns single space if <cite>text</cite>
  5990. is not a valid bisection status.</td>
  5991. </tr>
  5992. <tr class="field"><th class="field-name">shortdate:</th><td class="field-body">Date. Returns a date like &quot;2006-09-18&quot;.</td>
  5993. </tr>
  5994. <tr class="field"><th class="field-name">splitlines:</th><td class="field-body">Any text. Split text into a list of lines.</td>
  5995. </tr>
  5996. <tr class="field"><th class="field-name">stringify:</th><td class="field-body">Any type. Turns the value into text by converting values into
  5997. text and concatenating them.</td>
  5998. </tr>
  5999. <tr class="field"><th class="field-name">strip:</th><td class="field-body">Any text. Strips all leading and trailing whitespace.</td>
  6000. </tr>
  6001. <tr class="field"><th class="field-name">stripdir:</th><td class="field-body">Treat the text as path and strip a directory level, if
  6002. possible. For example, &quot;foo&quot; and &quot;foo/bar&quot; becomes &quot;foo&quot;.</td>
  6003. </tr>
  6004. <tr class="field"><th class="field-name">tabindent:</th><td class="field-body">Any text. Returns the text, with every non-empty line
  6005. except the first starting with a tab character.</td>
  6006. </tr>
  6007. <tr class="field"><th class="field-name">upper:</th><td class="field-body">Any text. Converts the text to uppercase.</td>
  6008. </tr>
  6009. <tr class="field"><th class="field-name">urlescape:</th><td class="field-body">Any text. Escapes all &quot;special&quot; characters. For example,
  6010. &quot;foo bar&quot; becomes &quot;foo%20bar&quot;.</td>
  6011. </tr>
  6012. <tr class="field"><th class="field-name">user:</th><td class="field-body">Any text. Returns a short representation of a user name or email
  6013. address.</td>
  6014. </tr>
  6015. </tbody>
  6016. </table>
  6017. <p>Note that a filter is nothing more than a function call, i.e.
  6018. <tt class="docutils literal">expr|filter</tt> is equivalent to <tt class="docutils literal">filter(expr)</tt>.</p>
  6019. <p>In addition to filters, there are some basic built-in functions:</p>
  6020. <table class="docutils field-list" frame="void" rules="none">
  6021. <col class="field-name" />
  6022. <col class="field-body" />
  6023. <tbody valign="top">
  6024. <tr class="field"><th class="field-name" colspan="2">date(date[, fmt]):</th></tr>
  6025. <tr class="field"><td>&nbsp;</td><td class="field-body">Format a date. See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for formatting
  6026. strings.</td>
  6027. </tr>
  6028. <tr class="field"><th class="field-name" colspan="2">diff([includepattern [, excludepattern]]):</th></tr>
  6029. <tr class="field"><td>&nbsp;</td><td class="field-body">Show a diff, optionally
  6030. specifying files to include or exclude.</td>
  6031. </tr>
  6032. <tr class="field"><th class="field-name" colspan="2">fill(text[, width[, initialident[, hangindent]]]):</th></tr>
  6033. <tr class="field"><td>&nbsp;</td><td class="field-body">Fill many
  6034. paragraphs with optional indentation. See the &quot;fill&quot; filter.</td>
  6035. </tr>
  6036. <tr class="field"><th class="field-name">get(dict, key):</th><td class="field-body">Get an attribute/key from an object. Some keywords
  6037. are complex types. This function allows you to obtain the value of an
  6038. attribute on these type.</td>
  6039. </tr>
  6040. <tr class="field"><th class="field-name" colspan="2">if(expr, then[, else]):</th></tr>
  6041. <tr class="field"><td>&nbsp;</td><td class="field-body">Conditionally execute based on the result of
  6042. an expression.</td>
  6043. </tr>
  6044. <tr class="field"><th class="field-name" colspan="2">ifcontains(search, thing, then[, else]):</th></tr>
  6045. <tr class="field"><td>&nbsp;</td><td class="field-body">Conditionally execute based
  6046. on whether the item &quot;search&quot; is in &quot;thing&quot;.</td>
  6047. </tr>
  6048. <tr class="field"><th class="field-name" colspan="2">ifeq(expr1, expr2, then[, else]):</th></tr>
  6049. <tr class="field"><td>&nbsp;</td><td class="field-body">Conditionally execute based on
  6050. whether 2 items are equivalent.</td>
  6051. </tr>
  6052. <tr class="field"><th class="field-name" colspan="2">indent(text, indentchars[, firstline]):</th></tr>
  6053. <tr class="field"><td>&nbsp;</td><td class="field-body">Indents all non-empty lines
  6054. with the characters given in the indentchars string. An optional
  6055. third parameter will override the indent for the first line only
  6056. if present.</td>
  6057. </tr>
  6058. <tr class="field"><th class="field-name" colspan="2">join(list, sep):</th></tr>
  6059. <tr class="field"><td>&nbsp;</td><td class="field-body">Join items in a list with a delimiter.</td>
  6060. </tr>
  6061. <tr class="field"><th class="field-name" colspan="2">label(label, expr):</th></tr>
  6062. <tr class="field"><td>&nbsp;</td><td class="field-body">Apply a label to generated content. Content with
  6063. a label applied can result in additional post-processing, such as
  6064. automatic colorization.</td>
  6065. </tr>
  6066. <tr class="field"><th class="field-name" colspan="2">pad(text, width[, fillchar=' '[, right=False]]):</th></tr>
  6067. <tr class="field"><td>&nbsp;</td><td class="field-body">Pad text with a
  6068. fill character.</td>
  6069. </tr>
  6070. <tr class="field"><th class="field-name" colspan="2">revset(query[, formatargs...]):</th></tr>
  6071. <tr class="field"><td>&nbsp;</td><td class="field-body">Execute a revision set query. See
  6072. <a class="reference external" href="hg.1.html#revset"><tt class="docutils literal">hg help revset</tt></a>.</td>
  6073. </tr>
  6074. <tr class="field"><th class="field-name" colspan="2">rstdoc(text, style):</th></tr>
  6075. <tr class="field"><td>&nbsp;</td><td class="field-body">Format ReStructuredText.</td>
  6076. </tr>
  6077. <tr class="field"><th class="field-name" colspan="2">shortest(node, minlength=4):</th></tr>
  6078. <tr class="field"><td>&nbsp;</td><td class="field-body">Obtain the shortest representation of
  6079. a node.</td>
  6080. </tr>
  6081. <tr class="field"><th class="field-name" colspan="2">startswith(pattern, text):</th></tr>
  6082. <tr class="field"><td>&nbsp;</td><td class="field-body">Returns the value from the &quot;text&quot; argument
  6083. if it begins with the content from the &quot;pattern&quot; argument.</td>
  6084. </tr>
  6085. <tr class="field"><th class="field-name" colspan="2">strip(text[, chars]):</th></tr>
  6086. <tr class="field"><td>&nbsp;</td><td class="field-body">Strip characters from a string.</td>
  6087. </tr>
  6088. <tr class="field"><th class="field-name" colspan="2">sub(pattern, replacement, expression):</th></tr>
  6089. <tr class="field"><td>&nbsp;</td><td class="field-body">Perform text substitution
  6090. using regular expressions.</td>
  6091. </tr>
  6092. <tr class="field"><th class="field-name" colspan="2">word(number, text[, separator]):</th></tr>
  6093. <tr class="field"><td>&nbsp;</td><td class="field-body">Return the nth word from a string.</td>
  6094. </tr>
  6095. </tbody>
  6096. </table>
  6097. <p>Also, for any expression that returns a list, there is a list operator:</p>
  6098. <ul class="simple">
  6099. <li>expr % &quot;{template}&quot;</li>
  6100. </ul>
  6101. <p>As seen in the above example, &quot;{template}&quot; is interpreted as a template.
  6102. To prevent it from being interpreted, you can use an escape character &quot;{&quot;
  6103. or a raw string prefix, &quot;r'...'&quot;.</p>
  6104. <p>Some sample command line templates:</p>
  6105. <ul>
  6106. <li><p class="first">Format lists, e.g. files:</p>
  6107. <pre class="literal-block">
  6108. $ hg log -r 0 --template &quot;files:\n{files % '  {file}\n'}&quot;
  6109. </pre>
  6110. </li>
  6111. <li><p class="first">Join the list of files with a &quot;, &quot;:</p>
  6112. <pre class="literal-block">
  6113. $ hg log -r 0 --template &quot;files: {join(files, ', ')}\n&quot;
  6114. </pre>
  6115. </li>
  6116. <li><p class="first">Modify each line of a commit description:</p>
  6117. <pre class="literal-block">
  6118. $ hg log --template &quot;{splitlines(desc) % '**** {line}\n'}&quot;
  6119. </pre>
  6120. </li>
  6121. <li><p class="first">Format date:</p>
  6122. <pre class="literal-block">
  6123. $ hg log -r 0 --template &quot;{date(date, '%Y')}\n&quot;
  6124. </pre>
  6125. </li>
  6126. <li><p class="first">Output the description set to a fill-width of 30:</p>
  6127. <pre class="literal-block">
  6128. $ hg log -r 0 --template &quot;{fill(desc, 30)}&quot;
  6129. </pre>
  6130. </li>
  6131. <li><p class="first">Use a conditional to test for the default branch:</p>
  6132. <pre class="literal-block">
  6133. $ hg log -r 0 --template &quot;{ifeq(branch, 'default', 'on the main branch',
  6134. 'on branch {branch}')}\n&quot;
  6135. </pre>
  6136. </li>
  6137. <li><p class="first">Append a newline if not empty:</p>
  6138. <pre class="literal-block">
  6139. $ hg tip --template &quot;{if(author, '{author}\n')}&quot;
  6140. </pre>
  6141. </li>
  6142. <li><p class="first">Label the output for use with the color extension:</p>
  6143. <pre class="literal-block">
  6144. $ hg log -r 0 --template &quot;{label('changeset.{phase}', node|short)}\n&quot;
  6145. </pre>
  6146. </li>
  6147. <li><p class="first">Invert the firstline filter, i.e. everything but the first line:</p>
  6148. <pre class="literal-block">
  6149. $ hg log -r 0 --template &quot;{sub(r'^.*\n?\n?', '', desc)}\n&quot;
  6150. </pre>
  6151. </li>
  6152. <li><p class="first">Display the contents of the 'extra' field, one per line:</p>
  6153. <pre class="literal-block">
  6154. $ hg log -r 0 --template &quot;{join(extras, '\n')}\n&quot;
  6155. </pre>
  6156. </li>
  6157. <li><p class="first">Mark the active bookmark with '*':</p>
  6158. <pre class="literal-block">
  6159. $ hg log --template &quot;{bookmarks % '{bookmark}{ifeq(bookmark, active, '*')} '}\n&quot;
  6160. </pre>
  6161. </li>
  6162. <li><p class="first">Mark the working copy parent with '&#64;':</p>
  6163. <pre class="literal-block">
  6164. $ hg log --template &quot;{ifcontains(rev, revset('.'), '&#64;')}\n&quot;
  6165. </pre>
  6166. </li>
  6167. <li><p class="first">Show only commit descriptions that start with &quot;template&quot;:</p>
  6168. <pre class="literal-block">
  6169. $ hg log --template &quot;{startswith('template', firstline(desc))}\n&quot;
  6170. </pre>
  6171. </li>
  6172. <li><p class="first">Print the first word of each line of a commit message:</p>
  6173. <pre class="literal-block">
  6174. $ hg log --template &quot;{word(0, desc)}\n&quot;
  6175. </pre>
  6176. </li>
  6177. </ul>
  6178. </div>
  6179. <div class="section" id="url-paths">
  6180. <span id="urls"></span><h1><a class="toc-backref" href="#contents">URL Paths</a></h1>
  6181. <p>Valid URLs are of the form:</p>
  6182. <pre class="literal-block">
  6183. local/filesystem/path[#revision]
  6184. file://local/filesystem/path[#revision]
  6185. http://[user[:pass]&#64;]host[:port]/[path][#revision]
  6186. https://[user[:pass]&#64;]host[:port]/[path][#revision]
  6187. ssh://[user&#64;]host[:port]/[path][#revision]
  6188. </pre>
  6189. <p>Paths in the local filesystem can either point to Mercurial
  6190. repositories or to bundle files (as created by <a class="reference external" href="hg.1.html#bundle"><tt class="docutils literal">hg bundle</tt></a> or
  6191. <a class="reference external" href="hg.1.html#incoming"><tt class="docutils literal">hg incoming <span class="pre">--bundle</span></tt></a>). See also <a class="reference external" href="hg.1.html#paths"><tt class="docutils literal">hg help paths</tt></a>.</p>
  6192. <p>An optional identifier after # indicates a particular branch, tag, or
  6193. changeset to use from the remote repository. See also <a class="reference external" href="hg.1.html#revisions"><tt class="docutils literal">hg help
  6194. revisions</tt></a>.</p>
  6195. <p>Some features, such as pushing to <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> URLs are only
  6196. possible if the feature is explicitly enabled on the remote Mercurial
  6197. server.</p>
  6198. <p>Note that the security of HTTPS URLs depends on proper configuration of
  6199. web.cacerts.</p>
  6200. <p>Some notes about using SSH with Mercurial:</p>
  6201. <ul>
  6202. <li><p class="first">SSH requires an accessible shell account on the destination machine
  6203. and a copy of hg in the remote path or specified with as remotecmd.</p>
  6204. </li>
  6205. <li><p class="first">path is relative to the remote user's home directory by default. Use
  6206. an extra slash at the start of a path to specify an absolute path:</p>
  6207. <pre class="literal-block">
  6208. ssh://example.com//tmp/repository
  6209. </pre>
  6210. </li>
  6211. <li><p class="first">Mercurial doesn't use its own compression via SSH; the right thing
  6212. to do is to configure it in your ~/.ssh/config, e.g.:</p>
  6213. <pre class="literal-block">
  6214. Host *.mylocalnetwork.example.com
  6215.   Compression no
  6216. Host *
  6217.   Compression yes
  6218. </pre>
  6219. <p>Alternatively specify &quot;ssh -C&quot; as your ssh command in your
  6220. configuration file or with the --ssh command line option.</p>
  6221. </li>
  6222. </ul>
  6223. <p>These URLs can all be stored in your configuration file with path
  6224. aliases under the [paths] section like so:</p>
  6225. <pre class="literal-block">
  6226. [paths]
  6227. alias1 = URL1
  6228. alias2 = URL2
  6229. ...
  6230. </pre>
  6231. <p>You can then use the alias for any command that uses a URL (for
  6232. example <a class="reference external" href="hg.1.html#pull"><tt class="docutils literal">hg pull alias1</tt></a> will be treated as <a class="reference external" href="hg.1.html#pull"><tt class="docutils literal">hg pull URL1</tt></a>).</p>
  6233. <p>Two path aliases are special because they are used as defaults when
  6234. you do not provide the URL to a command:</p>
  6235. <dl class="docutils">
  6236. <dt>default:</dt>
  6237. <dd>When you create a repository with hg clone, the clone command saves
  6238. the location of the source repository as the new repository's
  6239. 'default' path. This is then used when you omit path from push- and
  6240. pull-like commands (including incoming and outgoing).</dd>
  6241. <dt>default-push:</dt>
  6242. <dd>The push command will look for a path named 'default-push', and
  6243. prefer it over 'default' if both are defined.</dd>
  6244. </dl>
  6245. </div>
  6246. <div class="section" id="id12">
  6247. <h1><a class="toc-backref" href="#contents">Extensions</a></h1>
  6248. <p>This section contains help for extensions that are distributed together with Mercurial. Help for other extensions is available in the help system.</p>
  6249. <div class="contents htmlonly local topic" id="id13">
  6250. <ul class="simple">
  6251. <li><a class="reference internal" href="#acl" id="id86">acl</a></li>
  6252. <li><a class="reference internal" href="#blackbox" id="id87">blackbox</a></li>
  6253. <li><a class="reference internal" href="#bugzilla" id="id88">bugzilla</a></li>
  6254. <li><a class="reference internal" href="#censor" id="id89">censor</a></li>
  6255. <li><a class="reference internal" href="#children" id="id90">children</a></li>
  6256. <li><a class="reference internal" href="#churn" id="id91">churn</a></li>
  6257. <li><a class="reference internal" href="#color" id="id92">color</a></li>
  6258. <li><a class="reference internal" href="#convert" id="id93">convert</a></li>
  6259. <li><a class="reference internal" href="#eol" id="id94">eol</a></li>
  6260. <li><a class="reference internal" href="#extdiff" id="id95">extdiff</a></li>
  6261. <li><a class="reference internal" href="#factotum" id="id96">factotum</a></li>
  6262. <li><a class="reference internal" href="#fetch" id="id97">fetch</a></li>
  6263. <li><a class="reference internal" href="#gpg" id="id98">gpg</a></li>
  6264. <li><a class="reference internal" href="#graphlog" id="id99">graphlog</a></li>
  6265. <li><a class="reference internal" href="#hgcia" id="id100">hgcia</a></li>
  6266. <li><a class="reference internal" href="#hgk" id="id101">hgk</a></li>
  6267. <li><a class="reference internal" href="#highlight" id="id102">highlight</a></li>
  6268. <li><a class="reference internal" href="#histedit" id="id103">histedit</a></li>
  6269. <li><a class="reference internal" href="#keyword" id="id104">keyword</a></li>
  6270. <li><a class="reference internal" href="#largefiles" id="id105">largefiles</a></li>
  6271. <li><a class="reference internal" href="#mq" id="id106">mq</a></li>
  6272. <li><a class="reference internal" href="#notify" id="id107">notify</a></li>
  6273. <li><a class="reference internal" href="#pager" id="id108">pager</a></li>
  6274. <li><a class="reference internal" href="#patchbomb" id="id109">patchbomb</a></li>
  6275. <li><a class="reference internal" href="#progress" id="id110">progress</a></li>
  6276. <li><a class="reference internal" href="#purge" id="id111">purge</a></li>
  6277. <li><a class="reference internal" href="#rebase" id="id112">rebase</a></li>
  6278. <li><a class="reference internal" href="#record" id="id113">record</a></li>
  6279. <li><a class="reference internal" href="#relink" id="id114">relink</a></li>
  6280. <li><a class="reference internal" href="#schemes" id="id115">schemes</a></li>
  6281. <li><a class="reference internal" href="#share" id="id116">share</a></li>
  6282. <li><a class="reference internal" href="#shelve" id="id117">shelve</a></li>
  6283. <li><a class="reference internal" href="#strip" id="id118">strip</a></li>
  6284. <li><a class="reference internal" href="#transplant" id="id119">transplant</a></li>
  6285. <li><a class="reference internal" href="#win32mbcs" id="id120">win32mbcs</a></li>
  6286. <li><a class="reference internal" href="#win32text" id="id121">win32text</a></li>
  6287. <li><a class="reference internal" href="#zeroconf" id="id122">zeroconf</a></li>
  6288. </ul>
  6289. </div>
  6290. <div class="section" id="acl">
  6291. <h2><a class="toc-backref" href="#id86">acl</a></h2>
  6292. <p>hooks for controlling repository access</p>
  6293. <p>This hook makes it possible to allow or deny write access to given
  6294. branches and paths of a repository when receiving incoming changesets
  6295. via pretxnchangegroup and pretxncommit.</p>
  6296. <p>The authorization is matched based on the local user name on the
  6297. system where the hook runs, and not the committer of the original
  6298. changeset (since the latter is merely informative).</p>
  6299. <p>The acl hook is best used along with a restricted shell like hgsh,
  6300. preventing authenticating users from doing anything other than pushing
  6301. or pulling. The hook is not safe to use if users have interactive
  6302. shell access, as they can then disable the hook. Nor is it safe if
  6303. remote users share an account, because then there is no way to
  6304. distinguish them.</p>
  6305. <p>The order in which access checks are performed is:</p>
  6306. <ol class="arabic simple">
  6307. <li>Deny  list for branches (section <tt class="docutils literal">acl.deny.branches</tt>)</li>
  6308. <li>Allow list for branches (section <tt class="docutils literal">acl.allow.branches</tt>)</li>
  6309. <li>Deny  list for paths    (section <tt class="docutils literal">acl.deny</tt>)</li>
  6310. <li>Allow list for paths    (section <tt class="docutils literal">acl.allow</tt>)</li>
  6311. </ol>
  6312. <p>The allow and deny sections take key-value pairs.</p>
  6313. <div class="section" id="branch-based-access-control">
  6314. <h3>Branch-based Access Control</h3>
  6315. <p>Use the <tt class="docutils literal">acl.deny.branches</tt> and <tt class="docutils literal">acl.allow.branches</tt> sections to
  6316. have branch-based access control. Keys in these sections can be
  6317. either:</p>
  6318. <ul class="simple">
  6319. <li>a branch name, or</li>
  6320. <li>an asterisk, to match any branch;</li>
  6321. </ul>
  6322. <p>The corresponding values can be either:</p>
  6323. <ul class="simple">
  6324. <li>a comma-separated list containing users and groups, or</li>
  6325. <li>an asterisk, to match anyone;</li>
  6326. </ul>
  6327. <p>You can add the &quot;!&quot; prefix to a user or group name to invert the sense
  6328. of the match.</p>
  6329. </div>
  6330. <div class="section" id="path-based-access-control">
  6331. <h3>Path-based Access Control</h3>
  6332. <p>Use the <tt class="docutils literal">acl.deny</tt> and <tt class="docutils literal">acl.allow</tt> sections to have path-based
  6333. access control. Keys in these sections accept a subtree pattern (with
  6334. a glob syntax by default). The corresponding values follow the same
  6335. syntax as the other sections above.</p>
  6336. </div>
  6337. <div class="section" id="groups">
  6338. <h3>Groups</h3>
  6339. <p>Group names must be prefixed with an <tt class="docutils literal">&#64;</tt> symbol. Specifying a group
  6340. name has the same effect as specifying all the users in that group.</p>
  6341. <p>You can define group members in the <tt class="docutils literal">acl.groups</tt> section.
  6342. If a group name is not defined there, and Mercurial is running under
  6343. a Unix-like system, the list of users will be taken from the OS.
  6344. Otherwise, an exception will be raised.</p>
  6345. </div>
  6346. <div class="section" id="example-configuration">
  6347. <h3>Example Configuration</h3>
  6348. <pre class="literal-block">
  6349. [hooks]
  6350.  
  6351. # Use this if you want to check access restrictions at commit time
  6352. pretxncommit.acl = python:hgext.acl.hook
  6353.  
  6354. # Use this if you want to check access restrictions for pull, push,
  6355. # bundle and serve.
  6356. pretxnchangegroup.acl = python:hgext.acl.hook
  6357.  
  6358. [acl]
  6359. # Allow or deny access for incoming changes only if their source is
  6360. # listed here, let them pass otherwise. Source is &quot;serve&quot; for all
  6361. # remote access (http or ssh), &quot;push&quot;, &quot;pull&quot; or &quot;bundle&quot; when the
  6362. # related commands are run locally.
  6363. # Default: serve
  6364. sources = serve
  6365.  
  6366. [acl.deny.branches]
  6367.  
  6368. # Everyone is denied to the frozen branch:
  6369. frozen-branch = *
  6370.  
  6371. # A bad user is denied on all branches:
  6372. * = bad-user
  6373.  
  6374. [acl.allow.branches]
  6375.  
  6376. # A few users are allowed on branch-a:
  6377. branch-a = user-1, user-2, user-3
  6378.  
  6379. # Only one user is allowed on branch-b:
  6380. branch-b = user-1
  6381.  
  6382. # The super user is allowed on any branch:
  6383. * = super-user
  6384.  
  6385. # Everyone is allowed on branch-for-tests:
  6386. branch-for-tests = *
  6387.  
  6388. [acl.deny]
  6389. # This list is checked first. If a match is found, acl.allow is not
  6390. # checked. All users are granted access if acl.deny is not present.
  6391. # Format for both lists: glob pattern = user, ..., &#64;group, ...
  6392.  
  6393. # To match everyone, use an asterisk for the user:
  6394. # my/glob/pattern = *
  6395.  
  6396. # user6 will not have write access to any file:
  6397. ** = user6
  6398.  
  6399. # Group &quot;hg-denied&quot; will not have write access to any file:
  6400. ** = &#64;hg-denied
  6401.  
  6402. # Nobody will be able to change &quot;DONT-TOUCH-THIS.txt&quot;, despite
  6403. # everyone being able to change all other files. See below.
  6404. src/main/resources/DONT-TOUCH-THIS.txt = *
  6405.  
  6406. [acl.allow]
  6407. # if acl.allow is not present, all users are allowed by default
  6408. # empty acl.allow = no users allowed
  6409.  
  6410. # User &quot;doc_writer&quot; has write access to any file under the &quot;docs&quot;
  6411. # folder:
  6412. docs/** = doc_writer
  6413.  
  6414. # User &quot;jack&quot; and group &quot;designers&quot; have write access to any file
  6415. # under the &quot;images&quot; folder:
  6416. images/** = jack, &#64;designers
  6417.  
  6418. # Everyone (except for &quot;user6&quot; and &quot;&#64;hg-denied&quot; - see acl.deny above)
  6419. # will have write access to any file under the &quot;resources&quot; folder
  6420. # (except for 1 file. See acl.deny):
  6421. src/main/resources/** = *
  6422.  
  6423. .hgtags = release_engineer
  6424. </pre>
  6425. <div class="section" id="examples-using-the-prefix">
  6426. <h4>Examples using the &quot;!&quot; prefix</h4>
  6427. <p>Suppose there's a branch that only a given user (or group) should be able to
  6428. push to, and you don't want to restrict access to any other branch that may
  6429. be created.</p>
  6430. <p>The &quot;!&quot; prefix allows you to prevent anyone except a given user or group to
  6431. push changesets in a given branch or path.</p>
  6432. <p>In the examples below, we will:
  6433. 1) Deny access to branch &quot;ring&quot; to anyone but user &quot;gollum&quot;
  6434. 2) Deny access to branch &quot;lake&quot; to anyone but members of the group &quot;hobbit&quot;
  6435. 3) Deny access to a file to anyone but user &quot;gollum&quot;</p>
  6436. <pre class="literal-block">
  6437. [acl.allow.branches]
  6438. # Empty
  6439.  
  6440. [acl.deny.branches]
  6441.  
  6442. # 1) only 'gollum' can commit to branch 'ring';
  6443. # 'gollum' and anyone else can still commit to any other branch.
  6444. ring = !gollum
  6445.  
  6446. # 2) only members of the group 'hobbit' can commit to branch 'lake';
  6447. # 'hobbit' members and anyone else can still commit to any other branch.
  6448. lake = !&#64;hobbit
  6449.  
  6450. # You can also deny access based on file paths:
  6451.  
  6452. [acl.allow]
  6453. # Empty
  6454.  
  6455. [acl.deny]
  6456. # 3) only 'gollum' can change the file below;
  6457. # 'gollum' and anyone else can still change any other file.
  6458. /misty/mountains/cave/ring = !gollum
  6459. </pre>
  6460. </div>
  6461. </div>
  6462. </div>
  6463. <div class="section" id="blackbox">
  6464. <h2><a class="toc-backref" href="#id87">blackbox</a></h2>
  6465. <p>log repository events to a blackbox for debugging</p>
  6466. <p>Logs event information to .hg/blackbox.log to help debug and diagnose problems.
  6467. The events that get logged can be configured via the blackbox.track config key.
  6468. Examples:</p>
  6469. <pre class="literal-block">
  6470. [blackbox]
  6471. track = *
  6472.  
  6473. [blackbox]
  6474. track = command, commandfinish, commandexception, exthook, pythonhook
  6475.  
  6476. [blackbox]
  6477. track = incoming
  6478.  
  6479. [blackbox]
  6480. # limit the size of a log file
  6481. maxsize = 1.5 MB
  6482. # rotate up to N log files when the current one gets too big
  6483. maxfiles = 3
  6484. </pre>
  6485. <div class="section" id="id14">
  6486. <h3>Commands</h3>
  6487. <div class="section" id="id15">
  6488. <h4>blackbox</h4>
  6489. <p>view the recent repository events:</p>
  6490. <pre class="literal-block">
  6491. hg blackbox [OPTION]...
  6492. </pre>
  6493. <p>view the recent repository events</p>
  6494. <p>Options:</p>
  6495. <table class="docutils option-list" frame="void" rules="none">
  6496. <col class="option" />
  6497. <col class="description" />
  6498. <tbody valign="top">
  6499. <tr><td class="option-group" colspan="2">
  6500. <kbd><span class="option">-l</span>, <span class="option">--limit <var>&lt;VALUE&gt;</var></span></kbd></td>
  6501. </tr>
  6502. <tr><td>&nbsp;</td><td>the number of events to show (default: 10)</td></tr>
  6503. </tbody>
  6504. </table>
  6505. </div>
  6506. </div>
  6507. </div>
  6508. <div class="section" id="bugzilla">
  6509. <h2><a class="toc-backref" href="#id88">bugzilla</a></h2>
  6510. <p>hooks for integrating with the Bugzilla bug tracker</p>
  6511. <p>This hook extension adds comments on bugs in Bugzilla when changesets
  6512. that refer to bugs by Bugzilla ID are seen. The comment is formatted using
  6513. the Mercurial template mechanism.</p>
  6514. <p>The bug references can optionally include an update for Bugzilla of the
  6515. hours spent working on the bug. Bugs can also be marked fixed.</p>
  6516. <p>Three basic modes of access to Bugzilla are provided:</p>
  6517. <ol class="arabic simple">
  6518. <li>Access via the Bugzilla XMLRPC interface. Requires Bugzilla 3.4 or later.</li>
  6519. <li>Check data via the Bugzilla XMLRPC interface and submit bug change
  6520. via email to Bugzilla email interface. Requires Bugzilla 3.4 or later.</li>
  6521. <li>Writing directly to the Bugzilla database. Only Bugzilla installations
  6522. using MySQL are supported. Requires Python MySQLdb.</li>
  6523. </ol>
  6524. <p>Writing directly to the database is susceptible to schema changes, and
  6525. relies on a Bugzilla contrib script to send out bug change
  6526. notification emails. This script runs as the user running Mercurial,
  6527. must be run on the host with the Bugzilla install, and requires
  6528. permission to read Bugzilla configuration details and the necessary
  6529. MySQL user and password to have full access rights to the Bugzilla
  6530. database. For these reasons this access mode is now considered
  6531. deprecated, and will not be updated for new Bugzilla versions going
  6532. forward. Only adding comments is supported in this access mode.</p>
  6533. <p>Access via XMLRPC needs a Bugzilla username and password to be specified
  6534. in the configuration. Comments are added under that username. Since the
  6535. configuration must be readable by all Mercurial users, it is recommended
  6536. that the rights of that user are restricted in Bugzilla to the minimum
  6537. necessary to add comments. Marking bugs fixed requires Bugzilla 4.0 and later.</p>
  6538. <p>Access via XMLRPC/email uses XMLRPC to query Bugzilla, but sends
  6539. email to the Bugzilla email interface to submit comments to bugs.
  6540. The From: address in the email is set to the email address of the Mercurial
  6541. user, so the comment appears to come from the Mercurial user. In the event
  6542. that the Mercurial user email is not recognized by Bugzilla as a Bugzilla
  6543. user, the email associated with the Bugzilla username used to log into
  6544. Bugzilla is used instead as the source of the comment. Marking bugs fixed
  6545. works on all supported Bugzilla versions.</p>
  6546. <p>Configuration items common to all access modes:</p>
  6547. <dl class="docutils">
  6548. <dt>bugzilla.version</dt>
  6549. <dd><p class="first">The access type to use. Values recognized are:</p>
  6550. <table class="last docutils field-list" frame="void" rules="none">
  6551. <col class="field-name" />
  6552. <col class="field-body" />
  6553. <tbody valign="top">
  6554. <tr class="field"><th class="field-name"><tt class="docutils literal">xmlrpc</tt>:</th><td class="field-body">Bugzilla XMLRPC interface.</td>
  6555. </tr>
  6556. <tr class="field"><th class="field-name"><tt class="docutils literal">xmlrpc+email</tt>:</th><td class="field-body">Bugzilla XMLRPC and email interfaces.</td>
  6557. </tr>
  6558. <tr class="field"><th class="field-name"><tt class="docutils literal">3.0</tt>:</th><td class="field-body">MySQL access, Bugzilla 3.0 and later.</td>
  6559. </tr>
  6560. <tr class="field"><th class="field-name"><tt class="docutils literal">2.18</tt>:</th><td class="field-body">MySQL access, Bugzilla 2.18 and up to but not
  6561. including 3.0.</td>
  6562. </tr>
  6563. <tr class="field"><th class="field-name"><tt class="docutils literal">2.16</tt>:</th><td class="field-body">MySQL access, Bugzilla 2.16 and up to but not
  6564. including 2.18.</td>
  6565. </tr>
  6566. </tbody>
  6567. </table>
  6568. </dd>
  6569. <dt>bugzilla.regexp</dt>
  6570. <dd>Regular expression to match bug IDs for update in changeset commit message.
  6571. It must contain one &quot;()&quot; named group <tt class="docutils literal">&lt;ids&gt;</tt> containing the bug
  6572. IDs separated by non-digit characters. It may also contain
  6573. a named group <tt class="docutils literal">&lt;hours&gt;</tt> with a floating-point number giving the
  6574. hours worked on the bug. If no named groups are present, the first
  6575. &quot;()&quot; group is assumed to contain the bug IDs, and work time is not
  6576. updated. The default expression matches <tt class="docutils literal">Bug 1234</tt>, <tt class="docutils literal">Bug no. 1234</tt>,
  6577. <tt class="docutils literal">Bug number 1234</tt>, <tt class="docutils literal">Bugs 1234,5678</tt>, <tt class="docutils literal">Bug 1234 and 5678</tt> and
  6578. variations thereof, followed by an hours number prefixed by <tt class="docutils literal">h</tt> or
  6579. <tt class="docutils literal">hours</tt>, e.g. <tt class="docutils literal">hours 1.5</tt>. Matching is case insensitive.</dd>
  6580. <dt>bugzilla.fixregexp</dt>
  6581. <dd>Regular expression to match bug IDs for marking fixed in changeset
  6582. commit message. This must contain a &quot;()&quot; named group <tt class="docutils literal">&lt;ids&gt;` containing
  6583. the bug IDs separated by <span class="pre">non-digit</span> characters. It may also contain
  6584. a named group <span class="pre">``&lt;hours&gt;</span></tt> with a floating-point number giving the
  6585. hours worked on the bug. If no named groups are present, the first
  6586. &quot;()&quot; group is assumed to contain the bug IDs, and work time is not
  6587. updated. The default expression matches <tt class="docutils literal">Fixes 1234</tt>, <tt class="docutils literal">Fixes bug 1234</tt>,
  6588. <tt class="docutils literal">Fixes bugs 1234,5678</tt>, <tt class="docutils literal">Fixes 1234 and 5678</tt> and
  6589. variations thereof, followed by an hours number prefixed by <tt class="docutils literal">h</tt> or
  6590. <tt class="docutils literal">hours</tt>, e.g. <tt class="docutils literal">hours 1.5</tt>. Matching is case insensitive.</dd>
  6591. <dt>bugzilla.fixstatus</dt>
  6592. <dd>The status to set a bug to when marking fixed. Default <tt class="docutils literal">RESOLVED</tt>.</dd>
  6593. <dt>bugzilla.fixresolution</dt>
  6594. <dd>The resolution to set a bug to when marking fixed. Default <tt class="docutils literal">FIXED</tt>.</dd>
  6595. <dt>bugzilla.style</dt>
  6596. <dd>The style file to use when formatting comments.</dd>
  6597. <dt>bugzilla.template</dt>
  6598. <dd><p class="first">Template to use when formatting comments. Overrides style if
  6599. specified. In addition to the usual Mercurial keywords, the
  6600. extension specifies:</p>
  6601. <table class="docutils field-list" frame="void" rules="none">
  6602. <col class="field-name" />
  6603. <col class="field-body" />
  6604. <tbody valign="top">
  6605. <tr class="field"><th class="field-name"><tt class="docutils literal">{bug}</tt>:</th><td class="field-body">The Bugzilla bug ID.</td>
  6606. </tr>
  6607. <tr class="field"><th class="field-name"><tt class="docutils literal">{root}</tt>:</th><td class="field-body">The full pathname of the Mercurial repository.</td>
  6608. </tr>
  6609. <tr class="field"><th class="field-name"><tt class="docutils literal">{webroot}</tt>:</th><td class="field-body">Stripped pathname of the Mercurial repository.</td>
  6610. </tr>
  6611. <tr class="field"><th class="field-name"><tt class="docutils literal">{hgweb}</tt>:</th><td class="field-body">Base URL for browsing Mercurial repositories.</td>
  6612. </tr>
  6613. </tbody>
  6614. </table>
  6615. <p class="last">Default <tt class="docutils literal">changeset {node|short} in repo {root} refers to bug
  6616. <span class="pre">{bug}.\ndetails:\n\t{desc|tabindent}</span></tt></p>
  6617. </dd>
  6618. <dt>bugzilla.strip</dt>
  6619. <dd>The number of path separator characters to strip from the front of
  6620. the Mercurial repository path (<tt class="docutils literal">{root}</tt> in templates) to produce
  6621. <tt class="docutils literal">{webroot}</tt>. For example, a repository with <tt class="docutils literal">{root}</tt>
  6622. <tt class="docutils literal"><span class="pre">/var/local/my-project</span></tt> with a strip of 2 gives a value for
  6623. <tt class="docutils literal">{webroot}</tt> of <tt class="docutils literal"><span class="pre">my-project</span></tt>. Default 0.</dd>
  6624. <dt>web.baseurl</dt>
  6625. <dd>Base URL for browsing Mercurial repositories. Referenced from
  6626. templates as <tt class="docutils literal">{hgweb}</tt>.</dd>
  6627. </dl>
  6628. <p>Configuration items common to XMLRPC+email and MySQL access modes:</p>
  6629. <dl class="docutils">
  6630. <dt>bugzilla.usermap</dt>
  6631. <dd><p class="first">Path of file containing Mercurial committer email to Bugzilla user email
  6632. mappings. If specified, the file should contain one mapping per
  6633. line:</p>
  6634. <pre class="literal-block">
  6635. committer = Bugzilla user
  6636. </pre>
  6637. <p class="last">See also the <tt class="docutils literal">[usermap]</tt> section.</p>
  6638. </dd>
  6639. </dl>
  6640. <p>The <tt class="docutils literal">[usermap]</tt> section is used to specify mappings of Mercurial
  6641. committer email to Bugzilla user email. See also <tt class="docutils literal">bugzilla.usermap</tt>.
  6642. Contains entries of the form <tt class="docutils literal">committer = Bugzilla user</tt>.</p>
  6643. <p>XMLRPC access mode configuration:</p>
  6644. <dl class="docutils">
  6645. <dt>bugzilla.bzurl</dt>
  6646. <dd>The base URL for the Bugzilla installation.
  6647. Default <tt class="docutils literal"><span class="pre">http://localhost/bugzilla</span></tt>.</dd>
  6648. <dt>bugzilla.user</dt>
  6649. <dd>The username to use to log into Bugzilla via XMLRPC. Default
  6650. <tt class="docutils literal">bugs</tt>.</dd>
  6651. <dt>bugzilla.password</dt>
  6652. <dd>The password for Bugzilla login.</dd>
  6653. </dl>
  6654. <p>XMLRPC+email access mode uses the XMLRPC access mode configuration items,
  6655. and also:</p>
  6656. <dl class="docutils">
  6657. <dt>bugzilla.bzemail</dt>
  6658. <dd>The Bugzilla email address.</dd>
  6659. </dl>
  6660. <p>In addition, the Mercurial email settings must be configured. See the
  6661. documentation in hgrc(5), sections <tt class="docutils literal">[email]</tt> and <tt class="docutils literal">[smtp]</tt>.</p>
  6662. <p>MySQL access mode configuration:</p>
  6663. <dl class="docutils">
  6664. <dt>bugzilla.host</dt>
  6665. <dd>Hostname of the MySQL server holding the Bugzilla database.
  6666. Default <tt class="docutils literal">localhost</tt>.</dd>
  6667. <dt>bugzilla.db</dt>
  6668. <dd>Name of the Bugzilla database in MySQL. Default <tt class="docutils literal">bugs</tt>.</dd>
  6669. <dt>bugzilla.user</dt>
  6670. <dd>Username to use to access MySQL server. Default <tt class="docutils literal">bugs</tt>.</dd>
  6671. <dt>bugzilla.password</dt>
  6672. <dd>Password to use to access MySQL server.</dd>
  6673. <dt>bugzilla.timeout</dt>
  6674. <dd>Database connection timeout (seconds). Default 5.</dd>
  6675. <dt>bugzilla.bzuser</dt>
  6676. <dd>Fallback Bugzilla user name to record comments with, if changeset
  6677. committer cannot be found as a Bugzilla user.</dd>
  6678. <dt>bugzilla.bzdir</dt>
  6679. <dd>Bugzilla install directory. Used by default notify. Default
  6680. <tt class="docutils literal">/var/www/html/bugzilla</tt>.</dd>
  6681. <dt>bugzilla.notify</dt>
  6682. <dd>The command to run to get Bugzilla to send bug change notification
  6683. emails. Substitutes from a map with 3 keys, <tt class="docutils literal">bzdir</tt>, <tt class="docutils literal">id</tt> (bug
  6684. id) and <tt class="docutils literal">user</tt> (committer bugzilla email). Default depends on
  6685. version; from 2.18 it is &quot;cd %(bzdir)s &amp;&amp; perl -T
  6686. contrib/sendbugmail.pl %(id)s %(user)s&quot;.</dd>
  6687. </dl>
  6688. <p>Activating the extension:</p>
  6689. <pre class="literal-block">
  6690. [extensions]
  6691. bugzilla =
  6692.  
  6693. [hooks]
  6694. # run bugzilla hook on every change pulled or pushed in here
  6695. incoming.bugzilla = python:hgext.bugzilla.hook
  6696. </pre>
  6697. <p>Example configurations:</p>
  6698. <p>XMLRPC example configuration. This uses the Bugzilla at
  6699. <tt class="docutils literal"><span class="pre">http://my-project.org/bugzilla</span></tt>, logging in as user
  6700. <tt class="docutils literal"><span class="pre">bugmail&#64;my-project.org</span></tt> with password <tt class="docutils literal">plugh</tt>. It is used with a
  6701. collection of Mercurial repositories in <tt class="docutils literal">/var/local/hg/repos/</tt>,
  6702. with a web interface at <tt class="docutils literal"><span class="pre">http://my-project.org/hg</span></tt>.</p>
  6703. <pre class="literal-block">
  6704. [bugzilla]
  6705. bzurl=http://my-project.org/bugzilla
  6706. user=bugmail&#64;my-project.org
  6707. password=plugh
  6708. version=xmlrpc
  6709. template=Changeset {node|short} in {root|basename}.
  6710.          {hgweb}/{webroot}/rev/{node|short}\n
  6711.          {desc}\n
  6712. strip=5
  6713.  
  6714. [web]
  6715. baseurl=http://my-project.org/hg
  6716. </pre>
  6717. <p>XMLRPC+email example configuration. This uses the Bugzilla at
  6718. <tt class="docutils literal"><span class="pre">http://my-project.org/bugzilla</span></tt>, logging in as user
  6719. <tt class="docutils literal"><span class="pre">bugmail&#64;my-project.org</span></tt> with password <tt class="docutils literal">plugh</tt>. It is used with a
  6720. collection of Mercurial repositories in <tt class="docutils literal">/var/local/hg/repos/</tt>,
  6721. with a web interface at <tt class="docutils literal"><span class="pre">http://my-project.org/hg</span></tt>. Bug comments
  6722. are sent to the Bugzilla email address
  6723. <tt class="docutils literal"><span class="pre">bugzilla&#64;my-project.org</span></tt>.</p>
  6724. <pre class="literal-block">
  6725. [bugzilla]
  6726. bzurl=http://my-project.org/bugzilla
  6727. user=bugmail&#64;my-project.org
  6728. password=plugh
  6729. version=xmlrpc+email
  6730. bzemail=bugzilla&#64;my-project.org
  6731. template=Changeset {node|short} in {root|basename}.
  6732.          {hgweb}/{webroot}/rev/{node|short}\n
  6733.          {desc}\n
  6734. strip=5
  6735.  
  6736. [web]
  6737. baseurl=http://my-project.org/hg
  6738.  
  6739. [usermap]
  6740. user&#64;emaildomain.com=user.name&#64;bugzilladomain.com
  6741. </pre>
  6742. <p>MySQL example configuration. This has a local Bugzilla 3.2 installation
  6743. in <tt class="docutils literal"><span class="pre">/opt/bugzilla-3.2</span></tt>. The MySQL database is on <tt class="docutils literal">localhost</tt>,
  6744. the Bugzilla database name is <tt class="docutils literal">bugs</tt> and MySQL is
  6745. accessed with MySQL username <tt class="docutils literal">bugs</tt> password <tt class="docutils literal">XYZZY</tt>. It is used
  6746. with a collection of Mercurial repositories in <tt class="docutils literal">/var/local/hg/repos/</tt>,
  6747. with a web interface at <tt class="docutils literal"><span class="pre">http://my-project.org/hg</span></tt>.</p>
  6748. <pre class="literal-block">
  6749. [bugzilla]
  6750. host=localhost
  6751. password=XYZZY
  6752. version=3.0
  6753. bzuser=unknown&#64;domain.com
  6754. bzdir=/opt/bugzilla-3.2
  6755. template=Changeset {node|short} in {root|basename}.
  6756.          {hgweb}/{webroot}/rev/{node|short}\n
  6757.          {desc}\n
  6758. strip=5
  6759.  
  6760. [web]
  6761. baseurl=http://my-project.org/hg
  6762.  
  6763. [usermap]
  6764. user&#64;emaildomain.com=user.name&#64;bugzilladomain.com
  6765. </pre>
  6766. <p>All the above add a comment to the Bugzilla bug record of the form:</p>
  6767. <pre class="literal-block">
  6768. Changeset 3b16791d6642 in repository-name.
  6769. http://my-project.org/hg/repository-name/rev/3b16791d6642
  6770.  
  6771. Changeset commit comment. Bug 1234.
  6772. </pre>
  6773. </div>
  6774. <div class="section" id="censor">
  6775. <h2><a class="toc-backref" href="#id89">censor</a></h2>
  6776. <p>erase file content at a given revision</p>
  6777. <p>The censor command instructs Mercurial to erase all content of a file at a given
  6778. revision <em>without updating the changeset hash.</em> This allows existing history to
  6779. remain valid while preventing future clones/pulls from receiving the erased
  6780. data.</p>
  6781. <p>Typical uses for censor are due to security or legal requirements, including:</p>
  6782. <pre class="literal-block">
  6783. * Passwords, private keys, crytographic material
  6784. * Licensed data/code/libraries for which the license has expired
  6785. * Personally Identifiable Information or other private data
  6786. </pre>
  6787. <p>Censored nodes can interrupt mercurial's typical operation whenever the excised
  6788. data needs to be materialized. Some commands, like <tt class="docutils literal">hg cat</tt>/<tt class="docutils literal">hg revert</tt>,
  6789. simply fail when asked to produce censored data. Others, like <tt class="docutils literal">hg verify</tt> and
  6790. <tt class="docutils literal">hg update</tt>, must be capable of tolerating censored data to continue to
  6791. function in a meaningful way. Such commands only tolerate censored file
  6792. revisions if they are allowed by the &quot;censor.policy=ignore&quot; config option.</p>
  6793. <div class="section" id="id16">
  6794. <h3>Commands</h3>
  6795. <div class="section" id="id17">
  6796. <h4>censor</h4>
  6797. <pre class="literal-block">
  6798. hg censor -r REV [-t TEXT] [FILE]
  6799. </pre>
  6800. <p>Options:</p>
  6801. <table class="docutils option-list" frame="void" rules="none">
  6802. <col class="option" />
  6803. <col class="description" />
  6804. <tbody valign="top">
  6805. <tr><td class="option-group" colspan="2">
  6806. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  6807. </tr>
  6808. <tr><td>&nbsp;</td><td>censor file from specified revision</td></tr>
  6809. <tr><td class="option-group" colspan="2">
  6810. <kbd><span class="option">-t</span>, <span class="option">--tombstone <var>&lt;TEXT&gt;</var></span></kbd></td>
  6811. </tr>
  6812. <tr><td>&nbsp;</td><td>replacement tombstone data</td></tr>
  6813. </tbody>
  6814. </table>
  6815. </div>
  6816. </div>
  6817. </div>
  6818. <div class="section" id="children">
  6819. <h2><a class="toc-backref" href="#id90">children</a></h2>
  6820. <p>command to display child changesets (DEPRECATED)</p>
  6821. <p>This extension is deprecated. You should use <a class="reference external" href="hg.1.html#log"><tt class="docutils literal">hg log <span class="pre">-r</span>
  6822. &quot;children(REV)&quot;</tt></a> instead.</p>
  6823. <div class="section" id="id18">
  6824. <h3>Commands</h3>
  6825. <div class="section" id="id19">
  6826. <h4>children</h4>
  6827. <p>show the children of the given or working directory revision:</p>
  6828. <pre class="literal-block">
  6829. hg children [-r REV] [FILE]
  6830. </pre>
  6831. <p>Print the children of the working directory's revisions. If a
  6832. revision is given via -r/--rev, the children of that revision will
  6833. be printed. If a file argument is given, revision in which the
  6834. file was last changed (after the working directory revision or the
  6835. argument to --rev if given) is printed.</p>
  6836. <p>Options:</p>
  6837. <table class="docutils option-list" frame="void" rules="none">
  6838. <col class="option" />
  6839. <col class="description" />
  6840. <tbody valign="top">
  6841. <tr><td class="option-group" colspan="2">
  6842. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
  6843. </tr>
  6844. <tr><td>&nbsp;</td><td>show children of the specified revision</td></tr>
  6845. <tr><td class="option-group" colspan="2">
  6846. <kbd><span class="option">--style <var>&lt;STYLE&gt;</var></span></kbd></td>
  6847. </tr>
  6848. <tr><td>&nbsp;</td><td>display using template map file (DEPRECATED)</td></tr>
  6849. <tr><td class="option-group" colspan="2">
  6850. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  6851. </tr>
  6852. <tr><td>&nbsp;</td><td>display with template</td></tr>
  6853. </tbody>
  6854. </table>
  6855. </div>
  6856. </div>
  6857. </div>
  6858. <div class="section" id="churn">
  6859. <h2><a class="toc-backref" href="#id91">churn</a></h2>
  6860. <p>command to display statistics about repository history</p>
  6861. <div class="section" id="id20">
  6862. <h3>Commands</h3>
  6863. <div class="section" id="id21">
  6864. <h4>churn</h4>
  6865. <p>histogram of changes to the repository:</p>
  6866. <pre class="literal-block">
  6867. hg churn [-d DATE] [-r REV] [--aliases FILE] [FILE]
  6868. </pre>
  6869. <p>This command will display a histogram representing the number
  6870. of changed lines or revisions, grouped according to the given
  6871. template. The default template will group changes by author.
  6872. The --dateformat option may be used to group the results by
  6873. date instead.</p>
  6874. <p>Statistics are based on the number of changed lines, or
  6875. alternatively the number of matching revisions if the
  6876. --changesets option is specified.</p>
  6877. <p>Examples:</p>
  6878. <pre class="literal-block">
  6879. # display count of changed lines for every committer
  6880. hg churn -t &quot;{author|email}&quot;
  6881.  
  6882. # display daily activity graph
  6883. hg churn -f &quot;%H&quot; -s -c
  6884.  
  6885. # display activity of developers by month
  6886. hg churn -f &quot;%Y-%m&quot; -s -c
  6887.  
  6888. # display count of lines changed in every year
  6889. hg churn -f &quot;%Y&quot; -s
  6890. </pre>
  6891. <p>It is possible to map alternate email addresses to a main address
  6892. by providing a file using the following format:</p>
  6893. <pre class="literal-block">
  6894. &lt;alias email&gt; = &lt;actual email&gt;
  6895. </pre>
  6896. <p>Such a file may be specified with the --aliases option, otherwise
  6897. a .hgchurn file will be looked for in the working directory root.
  6898. Aliases will be split from the rightmost &quot;=&quot;.</p>
  6899. <p>Options:</p>
  6900. <table class="docutils option-list" frame="void" rules="none">
  6901. <col class="option" />
  6902. <col class="description" />
  6903. <tbody valign="top">
  6904. <tr><td class="option-group" colspan="2">
  6905. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  6906. </tr>
  6907. <tr><td>&nbsp;</td><td>count rate for the specified revision or revset</td></tr>
  6908. <tr><td class="option-group" colspan="2">
  6909. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  6910. </tr>
  6911. <tr><td>&nbsp;</td><td>count rate for revisions matching date spec</td></tr>
  6912. <tr><td class="option-group" colspan="2">
  6913. <kbd><span class="option">-t</span>, <span class="option">--oldtemplate <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  6914. </tr>
  6915. <tr><td>&nbsp;</td><td>template to group changesets (DEPRECATED)</td></tr>
  6916. <tr><td class="option-group" colspan="2">
  6917. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  6918. </tr>
  6919. <tr><td>&nbsp;</td><td>template to group changesets (default: {author|email})</td></tr>
  6920. <tr><td class="option-group" colspan="2">
  6921. <kbd><span class="option">-f</span>, <span class="option">--dateformat <var>&lt;FORMAT&gt;</var></span></kbd></td>
  6922. </tr>
  6923. <tr><td>&nbsp;</td><td>strftime-compatible format for grouping by date</td></tr>
  6924. <tr><td class="option-group" colspan="2">
  6925. <kbd><span class="option">-c</span>, <span class="option">--changesets</span></kbd></td>
  6926. </tr>
  6927. <tr><td>&nbsp;</td><td>count rate by number of changesets</td></tr>
  6928. <tr><td class="option-group">
  6929. <kbd><span class="option">-s</span>, <span class="option">--sort</span></kbd></td>
  6930. <td>sort by key (default: sort by count)</td></tr>
  6931. <tr><td class="option-group">
  6932. <kbd><span class="option">--diffstat</span></kbd></td>
  6933. <td>display added/removed lines separately</td></tr>
  6934. <tr><td class="option-group" colspan="2">
  6935. <kbd><span class="option">--aliases <var>&lt;FILE&gt;</var></span></kbd></td>
  6936. </tr>
  6937. <tr><td>&nbsp;</td><td>file with email aliases</td></tr>
  6938. <tr><td class="option-group" colspan="2">
  6939. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  6940. </tr>
  6941. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  6942. <tr><td class="option-group" colspan="2">
  6943. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  6944. </tr>
  6945. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  6946. </tbody>
  6947. </table>
  6948. <p>[+] marked option can be specified multiple times</p>
  6949. </div>
  6950. </div>
  6951. </div>
  6952. <div class="section" id="color">
  6953. <h2><a class="toc-backref" href="#id92">color</a></h2>
  6954. <p>colorize output from some commands</p>
  6955. <p>The color extension colorizes output from several Mercurial commands.
  6956. For example, the diff command shows additions in green and deletions
  6957. in red, while the status command shows modified files in magenta. Many
  6958. other commands have analogous colors. It is possible to customize
  6959. these colors.</p>
  6960. <div class="section" id="effects">
  6961. <h3>Effects</h3>
  6962. <p>Other effects in addition to color, like bold and underlined text, are
  6963. also available. By default, the terminfo database is used to find the
  6964. terminal codes used to change color and effect.  If terminfo is not
  6965. available, then effects are rendered with the ECMA-48 SGR control
  6966. function (aka ANSI escape codes).</p>
  6967. <p>The available effects in terminfo mode are 'blink', 'bold', 'dim',
  6968. 'inverse', 'invisible', 'italic', 'standout', and 'underline'; in
  6969. ECMA-48 mode, the options are 'bold', 'inverse', 'italic', and
  6970. 'underline'.  How each is rendered depends on the terminal emulator.
  6971. Some may not be available for a given terminal type, and will be
  6972. silently ignored.</p>
  6973. </div>
  6974. <div class="section" id="labels">
  6975. <h3>Labels</h3>
  6976. <p>Text receives color effects depending on the labels that it has. Many
  6977. default Mercurial commands emit labelled text. You can also define
  6978. your own labels in templates using the label function, see <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help
  6979. templates</tt></a>. A single portion of text may have more than one label. In
  6980. that case, effects given to the last label will override any other
  6981. effects. This includes the special &quot;none&quot; effect, which nullifies
  6982. other effects.</p>
  6983. <p>Labels are normally invisible. In order to see these labels and their
  6984. position in the text, use the global --color=debug option. The same
  6985. anchor text may be associated to multiple labels, e.g.</p>
  6986. <blockquote>
  6987. [log.changeset changeset.secret|changeset:   22611:6f0a53c8f587]</blockquote>
  6988. <p>The following are the default effects for some default labels. Default
  6989. effects may be overridden from your configuration file:</p>
  6990. <pre class="literal-block">
  6991. [color]
  6992. status.modified = blue bold underline red_background
  6993. status.added = green bold
  6994. status.removed = red bold blue_background
  6995. status.deleted = cyan bold underline
  6996. status.unknown = magenta bold underline
  6997. status.ignored = black bold
  6998.  
  6999. # 'none' turns off all effects
  7000. status.clean = none
  7001. status.copied = none
  7002.  
  7003. qseries.applied = blue bold underline
  7004. qseries.unapplied = black bold
  7005. qseries.missing = red bold
  7006.  
  7007. diff.diffline = bold
  7008. diff.extended = cyan bold
  7009. diff.file_a = red bold
  7010. diff.file_b = green bold
  7011. diff.hunk = magenta
  7012. diff.deleted = red
  7013. diff.inserted = green
  7014. diff.changed = white
  7015. diff.tab =
  7016. diff.trailingwhitespace = bold red_background
  7017.  
  7018. # Blank so it inherits the style of the surrounding label
  7019. changeset.public =
  7020. changeset.draft =
  7021. changeset.secret =
  7022.  
  7023. resolve.unresolved = red bold
  7024. resolve.resolved = green bold
  7025.  
  7026. bookmarks.active = green
  7027.  
  7028. branches.active = none
  7029. branches.closed = black bold
  7030. branches.current = green
  7031. branches.inactive = none
  7032.  
  7033. tags.normal = green
  7034. tags.local = black bold
  7035.  
  7036. rebase.rebased = blue
  7037. rebase.remaining = red bold
  7038.  
  7039. shelve.age = cyan
  7040. shelve.newest = green bold
  7041. shelve.name = blue bold
  7042.  
  7043. histedit.remaining = red bold
  7044. </pre>
  7045. </div>
  7046. <div class="section" id="custom-colors">
  7047. <h3>Custom colors</h3>
  7048. <p>Because there are only eight standard colors, this module allows you
  7049. to define color names for other color slots which might be available
  7050. for your terminal type, assuming terminfo mode.  For instance:</p>
  7051. <pre class="literal-block">
  7052. color.brightblue = 12
  7053. color.pink = 207
  7054. color.orange = 202
  7055. </pre>
  7056. <p>to set 'brightblue' to color slot 12 (useful for 16 color terminals
  7057. that have brighter colors defined in the upper eight) and, 'pink' and
  7058. 'orange' to colors in 256-color xterm's default color cube.  These
  7059. defined colors may then be used as any of the pre-defined eight,
  7060. including appending '_background' to set the background to that color.</p>
  7061. </div>
  7062. <div class="section" id="modes">
  7063. <h3>Modes</h3>
  7064. <p>By default, the color extension will use ANSI mode (or win32 mode on
  7065. Windows) if it detects a terminal. To override auto mode (to enable
  7066. terminfo mode, for example), set the following configuration option:</p>
  7067. <pre class="literal-block">
  7068. [color]
  7069. mode = terminfo
  7070. </pre>
  7071. <p>Any value other than 'ansi', 'win32', 'terminfo', or 'auto' will
  7072. disable color.</p>
  7073. <p>Note that on some systems, terminfo mode may cause problems when using
  7074. color with the pager extension and less -R. less with the -R option
  7075. will only display ECMA-48 color codes, and terminfo mode may sometimes
  7076. emit codes that less doesn't understand. You can work around this by
  7077. either using ansi mode (or auto mode), or by using less -r (which will
  7078. pass through all terminal control codes, not just color control
  7079. codes).</p>
  7080. <p>On some systems (such as MSYS in Windows), the terminal may support
  7081. a different color mode than the pager (activated via the &quot;pager&quot;
  7082. extension). It is possible to define separate modes depending on whether
  7083. the pager is active:</p>
  7084. <pre class="literal-block">
  7085. [color]
  7086. mode = auto
  7087. pagermode = ansi
  7088. </pre>
  7089. <p>If <tt class="docutils literal">pagermode</tt> is not defined, the <tt class="docutils literal">mode</tt> will be used.</p>
  7090. </div>
  7091. <div class="section" id="id22">
  7092. <h3>Commands</h3>
  7093. </div>
  7094. </div>
  7095. <div class="section" id="convert">
  7096. <h2><a class="toc-backref" href="#id93">convert</a></h2>
  7097. <p>import revisions from foreign VCS repositories into Mercurial</p>
  7098. <div class="section" id="id23">
  7099. <h3>Commands</h3>
  7100. <div class="section" id="id24">
  7101. <h4>convert</h4>
  7102. <p>convert a foreign SCM repository to a Mercurial one.:</p>
  7103. <pre class="literal-block">
  7104. hg convert [OPTION]... SOURCE [DEST [REVMAP]]
  7105. </pre>
  7106. <p>Accepted source formats [identifiers]:</p>
  7107. <ul class="simple">
  7108. <li>Mercurial [hg]</li>
  7109. <li>CVS [cvs]</li>
  7110. <li>Darcs [darcs]</li>
  7111. <li>git [git]</li>
  7112. <li>Subversion [svn]</li>
  7113. <li>Monotone [mtn]</li>
  7114. <li>GNU Arch [gnuarch]</li>
  7115. <li>Bazaar [bzr]</li>
  7116. <li>Perforce [p4]</li>
  7117. </ul>
  7118. <p>Accepted destination formats [identifiers]:</p>
  7119. <ul class="simple">
  7120. <li>Mercurial [hg]</li>
  7121. <li>Subversion [svn] (history on branches is not preserved)</li>
  7122. </ul>
  7123. <p>If no revision is given, all revisions will be converted.
  7124. Otherwise, convert will only import up to the named revision
  7125. (given in a format understood by the source).</p>
  7126. <p>If no destination directory name is specified, it defaults to the
  7127. basename of the source with <tt class="docutils literal"><span class="pre">-hg</span></tt> appended. If the destination
  7128. repository doesn't exist, it will be created.</p>
  7129. <p>By default, all sources except Mercurial will use --branchsort.
  7130. Mercurial uses --sourcesort to preserve original revision numbers
  7131. order. Sort modes have the following effects:</p>
  7132. <table class="docutils option-list" frame="void" rules="none">
  7133. <col class="option" />
  7134. <col class="description" />
  7135. <tbody valign="top">
  7136. <tr><td class="option-group">
  7137. <kbd><span class="option">--branchsort</span></kbd></td>
  7138. <td>convert from parent to child revision when possible,
  7139. which means branches are usually converted one after
  7140. the other. It generates more compact repositories.</td></tr>
  7141. <tr><td class="option-group">
  7142. <kbd><span class="option">--datesort</span></kbd></td>
  7143. <td>sort revisions by date. Converted repositories have
  7144. good-looking changelogs but are often an order of
  7145. magnitude larger than the same ones generated by
  7146. --branchsort.</td></tr>
  7147. <tr><td class="option-group">
  7148. <kbd><span class="option">--sourcesort</span></kbd></td>
  7149. <td>try to preserve source revisions order, only
  7150. supported by Mercurial sources.</td></tr>
  7151. <tr><td class="option-group">
  7152. <kbd><span class="option">--closesort</span></kbd></td>
  7153. <td>try to move closed revisions as close as possible
  7154. to parent branches, only supported by Mercurial
  7155. sources.</td></tr>
  7156. </tbody>
  7157. </table>
  7158. <p>If <tt class="docutils literal">REVMAP</tt> isn't given, it will be put in a default location
  7159. (<tt class="docutils literal"><span class="pre">&lt;dest&gt;/.hg/shamap</span></tt> by default). The <tt class="docutils literal">REVMAP</tt> is a simple
  7160. text file that maps each source commit ID to the destination ID
  7161. for that revision, like so:</p>
  7162. <pre class="literal-block">
  7163. &lt;source ID&gt; &lt;destination ID&gt;
  7164. </pre>
  7165. <p>If the file doesn't exist, it's automatically created. It's
  7166. updated on each commit copied, so <a class="reference external" href="hg.1.html#convert"><tt class="docutils literal">hg convert</tt></a> can be interrupted
  7167. and can be run repeatedly to copy new commits.</p>
  7168. <p>The authormap is a simple text file that maps each source commit
  7169. author to a destination commit author. It is handy for source SCMs
  7170. that use unix logins to identify authors (e.g.: CVS). One line per
  7171. author mapping and the line format is:</p>
  7172. <pre class="literal-block">
  7173. source author = destination author
  7174. </pre>
  7175. <p>Empty lines and lines starting with a <tt class="docutils literal">#</tt> are ignored.</p>
  7176. <p>The filemap is a file that allows filtering and remapping of files
  7177. and directories. Each line can contain one of the following
  7178. directives:</p>
  7179. <pre class="literal-block">
  7180. include path/to/file-or-dir
  7181.  
  7182. exclude path/to/file-or-dir
  7183.  
  7184. rename path/to/source path/to/destination
  7185. </pre>
  7186. <p>Comment lines start with <tt class="docutils literal">#</tt>. A specified path matches if it
  7187. equals the full relative name of a file or one of its parent
  7188. directories. The <tt class="docutils literal">include</tt> or <tt class="docutils literal">exclude</tt> directive with the
  7189. longest matching path applies, so line order does not matter.</p>
  7190. <p>The <tt class="docutils literal">include</tt> directive causes a file, or all files under a
  7191. directory, to be included in the destination repository. The default
  7192. if there are no <tt class="docutils literal">include</tt> statements is to include everything.
  7193. If there are any <tt class="docutils literal">include</tt> statements, nothing else is included.
  7194. The <tt class="docutils literal">exclude</tt> directive causes files or directories to
  7195. be omitted. The <tt class="docutils literal">rename</tt> directive renames a file or directory if
  7196. it is converted. To rename from a subdirectory into the root of
  7197. the repository, use <tt class="docutils literal">.</tt> as the path to rename to.</p>
  7198. <p><tt class="docutils literal"><span class="pre">--full</span></tt> will make sure the converted changesets contain exactly
  7199. the right files with the right content. It will make a full
  7200. conversion of all files, not just the ones that have
  7201. changed. Files that already are correct will not be changed. This
  7202. can be used to apply filemap changes when converting
  7203. incrementally. This is currently only supported for Mercurial and
  7204. Subversion.</p>
  7205. <p>The splicemap is a file that allows insertion of synthetic
  7206. history, letting you specify the parents of a revision. This is
  7207. useful if you want to e.g. give a Subversion merge two parents, or
  7208. graft two disconnected series of history together. Each entry
  7209. contains a key, followed by a space, followed by one or two
  7210. comma-separated values:</p>
  7211. <pre class="literal-block">
  7212. key parent1, parent2
  7213. </pre>
  7214. <p>The key is the revision ID in the source
  7215. revision control system whose parents should be modified (same
  7216. format as a key in .hg/shamap). The values are the revision IDs
  7217. (in either the source or destination revision control system) that
  7218. should be used as the new parents for that node. For example, if
  7219. you have merged &quot;release-1.0&quot; into &quot;trunk&quot;, then you should
  7220. specify the revision on &quot;trunk&quot; as the first parent and the one on
  7221. the &quot;release-1.0&quot; branch as the second.</p>
  7222. <p>The branchmap is a file that allows you to rename a branch when it is
  7223. being brought in from whatever external repository. When used in
  7224. conjunction with a splicemap, it allows for a powerful combination
  7225. to help fix even the most badly mismanaged repositories and turn them
  7226. into nicely structured Mercurial repositories. The branchmap contains
  7227. lines of the form:</p>
  7228. <pre class="literal-block">
  7229. original_branch_name new_branch_name
  7230. </pre>
  7231. <p>where &quot;original_branch_name&quot; is the name of the branch in the
  7232. source repository, and &quot;new_branch_name&quot; is the name of the branch
  7233. is the destination repository. No whitespace is allowed in the
  7234. branch names. This can be used to (for instance) move code in one
  7235. repository from &quot;default&quot; to a named branch.</p>
  7236. <div class="section" id="mercurial-source">
  7237. <h5>Mercurial Source</h5>
  7238. <p>The Mercurial source recognizes the following configuration
  7239. options, which you can set on the command line with <tt class="docutils literal"><span class="pre">--config</span></tt>:</p>
  7240. <table class="docutils field-list" frame="void" rules="none">
  7241. <col class="field-name" />
  7242. <col class="field-body" />
  7243. <tbody valign="top">
  7244. <tr class="field"><th class="field-name" colspan="2">convert.hg.ignoreerrors:</th></tr>
  7245. <tr class="field"><td>&nbsp;</td><td class="field-body">ignore integrity errors when reading.
  7246. Use it to fix Mercurial repositories with missing revlogs, by
  7247. converting from and to Mercurial. Default is False.</td>
  7248. </tr>
  7249. <tr class="field"><th class="field-name" colspan="2">convert.hg.saverev:</th></tr>
  7250. <tr class="field"><td>&nbsp;</td><td class="field-body">store original revision ID in changeset
  7251. (forces target IDs to change). It takes a boolean argument and
  7252. defaults to False.</td>
  7253. </tr>
  7254. <tr class="field"><th class="field-name" colspan="2">convert.hg.startrev:</th></tr>
  7255. <tr class="field"><td>&nbsp;</td><td class="field-body">specify the initial Mercurial revision.
  7256. The default is 0.</td>
  7257. </tr>
  7258. <tr class="field"><th class="field-name" colspan="2">convert.hg.revs:</th></tr>
  7259. <tr class="field"><td>&nbsp;</td><td class="field-body">revset specifying the source revisions to convert.</td>
  7260. </tr>
  7261. </tbody>
  7262. </table>
  7263. </div>
  7264. <div class="section" id="cvs-source">
  7265. <h5>CVS Source</h5>
  7266. <p>CVS source will use a sandbox (i.e. a checked-out copy) from CVS
  7267. to indicate the starting point of what will be converted. Direct
  7268. access to the repository files is not needed, unless of course the
  7269. repository is <tt class="docutils literal">:local:</tt>. The conversion uses the top level
  7270. directory in the sandbox to find the CVS repository, and then uses
  7271. CVS rlog commands to find files to convert. This means that unless
  7272. a filemap is given, all files under the starting directory will be
  7273. converted, and that any directory reorganization in the CVS
  7274. sandbox is ignored.</p>
  7275. <p>The following options can be used with <tt class="docutils literal"><span class="pre">--config</span></tt>:</p>
  7276. <table class="docutils field-list" frame="void" rules="none">
  7277. <col class="field-name" />
  7278. <col class="field-body" />
  7279. <tbody valign="top">
  7280. <tr class="field"><th class="field-name" colspan="2">convert.cvsps.cache:</th></tr>
  7281. <tr class="field"><td>&nbsp;</td><td class="field-body">Set to False to disable remote log caching,
  7282. for testing and debugging purposes. Default is True.</td>
  7283. </tr>
  7284. <tr class="field"><th class="field-name" colspan="2">convert.cvsps.fuzz:</th></tr>
  7285. <tr class="field"><td>&nbsp;</td><td class="field-body">Specify the maximum time (in seconds) that is
  7286. allowed between commits with identical user and log message in
  7287. a single changeset. When very large files were checked in as
  7288. part of a changeset then the default may not be long enough.
  7289. The default is 60.</td>
  7290. </tr>
  7291. <tr class="field"><th class="field-name" colspan="2">convert.cvsps.mergeto:</th></tr>
  7292. <tr class="field"><td>&nbsp;</td><td class="field-body">Specify a regular expression to which
  7293. commit log messages are matched. If a match occurs, then the
  7294. conversion process will insert a dummy revision merging the
  7295. branch on which this log message occurs to the branch
  7296. indicated in the regex. Default is <tt class="docutils literal">{{mergetobranch
  7297. <span class="pre">([-\w]+)}}</span></tt></td>
  7298. </tr>
  7299. <tr class="field"><th class="field-name" colspan="2">convert.cvsps.mergefrom:</th></tr>
  7300. <tr class="field"><td>&nbsp;</td><td class="field-body">Specify a regular expression to which
  7301. commit log messages are matched. If a match occurs, then the
  7302. conversion process will add the most recent revision on the
  7303. branch indicated in the regex as the second parent of the
  7304. changeset. Default is <tt class="docutils literal">{{mergefrombranch <span class="pre">([-\w]+)}}</span></tt></td>
  7305. </tr>
  7306. <tr class="field"><th class="field-name" colspan="2">convert.localtimezone:</th></tr>
  7307. <tr class="field"><td>&nbsp;</td><td class="field-body">use local time (as determined by the TZ
  7308. environment variable) for changeset date/times. The default
  7309. is False (use UTC).</td>
  7310. </tr>
  7311. <tr class="field"><th class="field-name">hooks.cvslog:</th><td class="field-body">Specify a Python function to be called at the end of
  7312. gathering the CVS log. The function is passed a list with the
  7313. log entries, and can modify the entries in-place, or add or
  7314. delete them.</td>
  7315. </tr>
  7316. <tr class="field"><th class="field-name" colspan="2">hooks.cvschangesets:</th></tr>
  7317. <tr class="field"><td>&nbsp;</td><td class="field-body">Specify a Python function to be called after
  7318. the changesets are calculated from the CVS log. The
  7319. function is passed a list with the changeset entries, and can
  7320. modify the changesets in-place, or add or delete them.</td>
  7321. </tr>
  7322. </tbody>
  7323. </table>
  7324. <p>An additional &quot;debugcvsps&quot; Mercurial command allows the builtin
  7325. changeset merging code to be run without doing a conversion. Its
  7326. parameters and output are similar to that of cvsps 2.1. Please see
  7327. the command help for more details.</p>
  7328. </div>
  7329. <div class="section" id="subversion-source">
  7330. <h5>Subversion Source</h5>
  7331. <p>Subversion source detects classical trunk/branches/tags layouts.
  7332. By default, the supplied <tt class="docutils literal"><span class="pre">svn://repo/path/</span></tt> source URL is
  7333. converted as a single branch. If <tt class="docutils literal"><span class="pre">svn://repo/path/trunk</span></tt> exists
  7334. it replaces the default branch. If <tt class="docutils literal"><span class="pre">svn://repo/path/branches</span></tt>
  7335. exists, its subdirectories are listed as possible branches. If
  7336. <tt class="docutils literal"><span class="pre">svn://repo/path/tags</span></tt> exists, it is looked for tags referencing
  7337. converted branches. Default <tt class="docutils literal">trunk</tt>, <tt class="docutils literal">branches</tt> and <tt class="docutils literal">tags</tt>
  7338. values can be overridden with following options. Set them to paths
  7339. relative to the source URL, or leave them blank to disable auto
  7340. detection.</p>
  7341. <p>The following options can be set with <tt class="docutils literal"><span class="pre">--config</span></tt>:</p>
  7342. <table class="docutils field-list" frame="void" rules="none">
  7343. <col class="field-name" />
  7344. <col class="field-body" />
  7345. <tbody valign="top">
  7346. <tr class="field"><th class="field-name" colspan="2">convert.svn.branches:</th></tr>
  7347. <tr class="field"><td>&nbsp;</td><td class="field-body">specify the directory containing branches.
  7348. The default is <tt class="docutils literal">branches</tt>.</td>
  7349. </tr>
  7350. <tr class="field"><th class="field-name" colspan="2">convert.svn.tags:</th></tr>
  7351. <tr class="field"><td>&nbsp;</td><td class="field-body">specify the directory containing tags. The
  7352. default is <tt class="docutils literal">tags</tt>.</td>
  7353. </tr>
  7354. <tr class="field"><th class="field-name" colspan="2">convert.svn.trunk:</th></tr>
  7355. <tr class="field"><td>&nbsp;</td><td class="field-body">specify the name of the trunk branch. The
  7356. default is <tt class="docutils literal">trunk</tt>.</td>
  7357. </tr>
  7358. <tr class="field"><th class="field-name" colspan="2">convert.localtimezone:</th></tr>
  7359. <tr class="field"><td>&nbsp;</td><td class="field-body">use local time (as determined by the TZ
  7360. environment variable) for changeset date/times. The default
  7361. is False (use UTC).</td>
  7362. </tr>
  7363. </tbody>
  7364. </table>
  7365. <p>Source history can be retrieved starting at a specific revision,
  7366. instead of being integrally converted. Only single branch
  7367. conversions are supported.</p>
  7368. <table class="docutils field-list" frame="void" rules="none">
  7369. <col class="field-name" />
  7370. <col class="field-body" />
  7371. <tbody valign="top">
  7372. <tr class="field"><th class="field-name" colspan="2">convert.svn.startrev:</th></tr>
  7373. <tr class="field"><td>&nbsp;</td><td class="field-body">specify start Subversion revision number.
  7374. The default is 0.</td>
  7375. </tr>
  7376. </tbody>
  7377. </table>
  7378. </div>
  7379. <div class="section" id="git-source">
  7380. <h5>Git Source</h5>
  7381. <p>The Git importer converts commits from all reachable branches (refs
  7382. in refs/heads) and remotes (refs in refs/remotes) to Mercurial.
  7383. Branches are converted to bookmarks with the same name, with the
  7384. leading 'refs/heads' stripped. Git submodules are converted to Git
  7385. subrepos in Mercurial.</p>
  7386. <p>The following options can be set with <tt class="docutils literal"><span class="pre">--config</span></tt>:</p>
  7387. <table class="docutils field-list" frame="void" rules="none">
  7388. <col class="field-name" />
  7389. <col class="field-body" />
  7390. <tbody valign="top">
  7391. <tr class="field"><th class="field-name" colspan="2">convert.git.similarity:</th></tr>
  7392. <tr class="field"><td>&nbsp;</td><td class="field-body">specify how similar files modified in a
  7393. commit must be to be imported as renames or copies, as a
  7394. percentage between <tt class="docutils literal">0</tt> (disabled) and <tt class="docutils literal">100</tt> (files must be
  7395. identical). For example, <tt class="docutils literal">90</tt> means that a delete/add pair will
  7396. be imported as a rename if more than 90% of the file hasn't
  7397. changed. The default is <tt class="docutils literal">50</tt>.</td>
  7398. </tr>
  7399. <tr class="field"><th class="field-name" colspan="2">convert.git.findcopiesharder:</th></tr>
  7400. <tr class="field"><td>&nbsp;</td><td class="field-body">while detecting copies, look at all
  7401. files in the working copy instead of just changed ones. This
  7402. is very expensive for large projects, and is only effective when
  7403. <tt class="docutils literal">convert.git.similarity</tt> is greater than 0. The default is False.</td>
  7404. </tr>
  7405. <tr class="field"><th class="field-name" colspan="2">convert.git.remoteprefix:</th></tr>
  7406. <tr class="field"><td>&nbsp;</td><td class="field-body">remote refs are converted as bookmarks with
  7407. <tt class="docutils literal">convert.git.remoteprefix</tt> as a prefix followed by a /. The default
  7408. is 'remote'.</td>
  7409. </tr>
  7410. </tbody>
  7411. </table>
  7412. </div>
  7413. <div class="section" id="perforce-source">
  7414. <h5>Perforce Source</h5>
  7415. <p>The Perforce (P4) importer can be given a p4 depot path or a
  7416. client specification as source. It will convert all files in the
  7417. source to a flat Mercurial repository, ignoring labels, branches
  7418. and integrations. Note that when a depot path is given you then
  7419. usually should specify a target directory, because otherwise the
  7420. target may be named <tt class="docutils literal"><span class="pre">...-hg</span></tt>.</p>
  7421. <p>The following options can be set with <tt class="docutils literal"><span class="pre">--config</span></tt>:</p>
  7422. <table class="docutils field-list" frame="void" rules="none">
  7423. <col class="field-name" />
  7424. <col class="field-body" />
  7425. <tbody valign="top">
  7426. <tr class="field"><th class="field-name" colspan="2">convert.p4.encoding:</th></tr>
  7427. <tr class="field"><td>&nbsp;</td><td class="field-body">specify the encoding to use when decoding standard
  7428. output of the Perforce command line tool. The default is default system
  7429. encoding.</td>
  7430. </tr>
  7431. <tr class="field"><th class="field-name" colspan="2">convert.p4.startrev:</th></tr>
  7432. <tr class="field"><td>&nbsp;</td><td class="field-body">specify initial Perforce revision (a
  7433. Perforce changelist number).</td>
  7434. </tr>
  7435. </tbody>
  7436. </table>
  7437. </div>
  7438. <div class="section" id="mercurial-destination">
  7439. <h5>Mercurial Destination</h5>
  7440. <p>The Mercurial destination will recognize Mercurial subrepositories in the
  7441. destination directory, and update the .hgsubstate file automatically if the
  7442. destination subrepositories contain the &lt;dest&gt;/&lt;sub&gt;/.hg/shamap file.
  7443. Converting a repository with subrepositories requires converting a single
  7444. repository at a time, from the bottom up.</p>
  7445. <div class="verbose container">
  7446. <p>An example showing how to convert a repository with subrepositories:</p>
  7447. <pre class="literal-block">
  7448. # so convert knows the type when it sees a non empty destination
  7449. $ hg init converted
  7450.  
  7451. $ hg convert orig/sub1 converted/sub1
  7452. $ hg convert orig/sub2 converted/sub2
  7453. $ hg convert orig converted
  7454. </pre>
  7455. </div>
  7456. <p>The following options are supported:</p>
  7457. <table class="docutils field-list" frame="void" rules="none">
  7458. <col class="field-name" />
  7459. <col class="field-body" />
  7460. <tbody valign="top">
  7461. <tr class="field"><th class="field-name" colspan="2">convert.hg.clonebranches:</th></tr>
  7462. <tr class="field"><td>&nbsp;</td><td class="field-body">dispatch source branches in separate
  7463. clones. The default is False.</td>
  7464. </tr>
  7465. <tr class="field"><th class="field-name" colspan="2">convert.hg.tagsbranch:</th></tr>
  7466. <tr class="field"><td>&nbsp;</td><td class="field-body">branch name for tag revisions, defaults to
  7467. <tt class="docutils literal">default</tt>.</td>
  7468. </tr>
  7469. <tr class="field"><th class="field-name" colspan="2">convert.hg.usebranchnames:</th></tr>
  7470. <tr class="field"><td>&nbsp;</td><td class="field-body">preserve branch names. The default is
  7471. True.</td>
  7472. </tr>
  7473. <tr class="field"><th class="field-name" colspan="2">convert.hg.sourcename:</th></tr>
  7474. <tr class="field"><td>&nbsp;</td><td class="field-body">records the given string as a 'convert_source' extra
  7475. value on each commit made in the target repository. The default is None.</td>
  7476. </tr>
  7477. </tbody>
  7478. </table>
  7479. </div>
  7480. <div class="section" id="all-destinations">
  7481. <h5>All Destinations</h5>
  7482. <p>All destination types accept the following options:</p>
  7483. <table class="docutils field-list" frame="void" rules="none">
  7484. <col class="field-name" />
  7485. <col class="field-body" />
  7486. <tbody valign="top">
  7487. <tr class="field"><th class="field-name" colspan="2">convert.skiptags:</th></tr>
  7488. <tr class="field"><td>&nbsp;</td><td class="field-body">does not convert tags from the source repo to the target
  7489. repo. The default is False.</td>
  7490. </tr>
  7491. </tbody>
  7492. </table>
  7493. <p>Options:</p>
  7494. <table class="docutils option-list" frame="void" rules="none">
  7495. <col class="option" />
  7496. <col class="description" />
  7497. <tbody valign="top">
  7498. <tr><td class="option-group" colspan="2">
  7499. <kbd><span class="option">--authors <var>&lt;FILE&gt;</var></span></kbd></td>
  7500. </tr>
  7501. <tr><td>&nbsp;</td><td>username mapping filename (DEPRECATED, use --authormap instead)</td></tr>
  7502. <tr><td class="option-group" colspan="2">
  7503. <kbd><span class="option">-s</span>, <span class="option">--source-type <var>&lt;TYPE&gt;</var></span></kbd></td>
  7504. </tr>
  7505. <tr><td>&nbsp;</td><td>source repository type</td></tr>
  7506. <tr><td class="option-group" colspan="2">
  7507. <kbd><span class="option">-d</span>, <span class="option">--dest-type <var>&lt;TYPE&gt;</var></span></kbd></td>
  7508. </tr>
  7509. <tr><td>&nbsp;</td><td>destination repository type</td></tr>
  7510. <tr><td class="option-group" colspan="2">
  7511. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  7512. </tr>
  7513. <tr><td>&nbsp;</td><td>import up to source revision REV</td></tr>
  7514. <tr><td class="option-group" colspan="2">
  7515. <kbd><span class="option">-A</span>, <span class="option">--authormap <var>&lt;FILE&gt;</var></span></kbd></td>
  7516. </tr>
  7517. <tr><td>&nbsp;</td><td>remap usernames using this file</td></tr>
  7518. <tr><td class="option-group" colspan="2">
  7519. <kbd><span class="option">--filemap <var>&lt;FILE&gt;</var></span></kbd></td>
  7520. </tr>
  7521. <tr><td>&nbsp;</td><td>remap file names using contents of file</td></tr>
  7522. <tr><td class="option-group">
  7523. <kbd><span class="option">--full</span></kbd></td>
  7524. <td>apply filemap changes by converting all files again</td></tr>
  7525. <tr><td class="option-group" colspan="2">
  7526. <kbd><span class="option">--splicemap <var>&lt;FILE&gt;</var></span></kbd></td>
  7527. </tr>
  7528. <tr><td>&nbsp;</td><td>splice synthesized history into place</td></tr>
  7529. <tr><td class="option-group" colspan="2">
  7530. <kbd><span class="option">--branchmap <var>&lt;FILE&gt;</var></span></kbd></td>
  7531. </tr>
  7532. <tr><td>&nbsp;</td><td>change branch names while converting</td></tr>
  7533. <tr><td class="option-group">
  7534. <kbd><span class="option">--branchsort</span></kbd></td>
  7535. <td>try to sort changesets by branches</td></tr>
  7536. <tr><td class="option-group">
  7537. <kbd><span class="option">--datesort</span></kbd></td>
  7538. <td>try to sort changesets by date</td></tr>
  7539. <tr><td class="option-group">
  7540. <kbd><span class="option">--sourcesort</span></kbd></td>
  7541. <td>preserve source changesets order</td></tr>
  7542. <tr><td class="option-group">
  7543. <kbd><span class="option">--closesort</span></kbd></td>
  7544. <td>try to reorder closed revisions</td></tr>
  7545. </tbody>
  7546. </table>
  7547. <p>[+] marked option can be specified multiple times</p>
  7548. </div>
  7549. </div>
  7550. </div>
  7551. </div>
  7552. <div class="section" id="eol">
  7553. <h2><a class="toc-backref" href="#id94">eol</a></h2>
  7554. <p>automatically manage newlines in repository files</p>
  7555. <p>This extension allows you to manage the type of line endings (CRLF or
  7556. LF) that are used in the repository and in the local working
  7557. directory. That way you can get CRLF line endings on Windows and LF on
  7558. Unix/Mac, thereby letting everybody use their OS native line endings.</p>
  7559. <p>The extension reads its configuration from a versioned <tt class="docutils literal">.hgeol</tt>
  7560. configuration file found in the root of the working directory. The
  7561. <tt class="docutils literal">.hgeol</tt> file use the same syntax as all other Mercurial
  7562. configuration files. It uses two sections, <tt class="docutils literal">[patterns]</tt> and
  7563. <tt class="docutils literal">[repository]</tt>.</p>
  7564. <p>The <tt class="docutils literal">[patterns]</tt> section specifies how line endings should be
  7565. converted between the working directory and the repository. The format is
  7566. specified by a file pattern. The first match is used, so put more
  7567. specific patterns first. The available line endings are <tt class="docutils literal">LF</tt>,
  7568. <tt class="docutils literal">CRLF</tt>, and <tt class="docutils literal">BIN</tt>.</p>
  7569. <p>Files with the declared format of <tt class="docutils literal">CRLF</tt> or <tt class="docutils literal">LF</tt> are always
  7570. checked out and stored in the repository in that format and files
  7571. declared to be binary (<tt class="docutils literal">BIN</tt>) are left unchanged. Additionally,
  7572. <tt class="docutils literal">native</tt> is an alias for checking out in the platform's default line
  7573. ending: <tt class="docutils literal">LF</tt> on Unix (including Mac OS X) and <tt class="docutils literal">CRLF</tt> on
  7574. Windows. Note that <tt class="docutils literal">BIN</tt> (do nothing to line endings) is Mercurial's
  7575. default behaviour; it is only needed if you need to override a later,
  7576. more general pattern.</p>
  7577. <p>The optional <tt class="docutils literal">[repository]</tt> section specifies the line endings to
  7578. use for files stored in the repository. It has a single setting,
  7579. <tt class="docutils literal">native</tt>, which determines the storage line endings for files
  7580. declared as <tt class="docutils literal">native</tt> in the <tt class="docutils literal">[patterns]</tt> section. It can be set to
  7581. <tt class="docutils literal">LF</tt> or <tt class="docutils literal">CRLF</tt>. The default is <tt class="docutils literal">LF</tt>. For example, this means
  7582. that on Windows, files configured as <tt class="docutils literal">native</tt> (<tt class="docutils literal">CRLF</tt> by default)
  7583. will be converted to <tt class="docutils literal">LF</tt> when stored in the repository. Files
  7584. declared as <tt class="docutils literal">LF</tt>, <tt class="docutils literal">CRLF</tt>, or <tt class="docutils literal">BIN</tt> in the <tt class="docutils literal">[patterns]</tt> section
  7585. are always stored as-is in the repository.</p>
  7586. <p>Example versioned <tt class="docutils literal">.hgeol</tt> file:</p>
  7587. <pre class="literal-block">
  7588. [patterns]
  7589. **.py = native
  7590. **.vcproj = CRLF
  7591. **.txt = native
  7592. Makefile = LF
  7593. **.jpg = BIN
  7594.  
  7595. [repository]
  7596. native = LF
  7597. </pre>
  7598. <div class="note">
  7599. <p class="first admonition-title">Note</p>
  7600. <p class="last">The rules will first apply when files are touched in the working
  7601. directory, e.g. by updating to null and back to tip to touch all files.</p>
  7602. </div>
  7603. <p>The extension uses an optional <tt class="docutils literal">[eol]</tt> section read from both the
  7604. normal Mercurial configuration files and the <tt class="docutils literal">.hgeol</tt> file, with the
  7605. latter overriding the former. You can use that section to control the
  7606. overall behavior. There are three settings:</p>
  7607. <ul class="simple">
  7608. <li><tt class="docutils literal">eol.native</tt> (default <tt class="docutils literal">os.linesep</tt>) can be set to <tt class="docutils literal">LF</tt> or
  7609. <tt class="docutils literal">CRLF</tt> to override the default interpretation of <tt class="docutils literal">native</tt> for
  7610. checkout. This can be used with <a class="reference external" href="hg.1.html#archive"><tt class="docutils literal">hg archive</tt></a> on Unix, say, to
  7611. generate an archive where files have line endings for Windows.</li>
  7612. <li><tt class="docutils literal"><span class="pre">eol.only-consistent</span></tt> (default True) can be set to False to make
  7613. the extension convert files with inconsistent EOLs. Inconsistent
  7614. means that there is both <tt class="docutils literal">CRLF</tt> and <tt class="docutils literal">LF</tt> present in the file.
  7615. Such files are normally not touched under the assumption that they
  7616. have mixed EOLs on purpose.</li>
  7617. <li><tt class="docutils literal"><span class="pre">eol.fix-trailing-newline</span></tt> (default False) can be set to True to
  7618. ensure that converted files end with a EOL character (either <tt class="docutils literal">\n</tt>
  7619. or <tt class="docutils literal">\r\n</tt> as per the configured patterns).</li>
  7620. </ul>
  7621. <p>The extension provides <tt class="docutils literal">cleverencode:</tt> and <tt class="docutils literal">cleverdecode:</tt> filters
  7622. like the deprecated win32text extension does. This means that you can
  7623. disable win32text and enable eol and your filters will still work. You
  7624. only need to these filters until you have prepared a <tt class="docutils literal">.hgeol</tt> file.</p>
  7625. <p>The <tt class="docutils literal">win32text.forbid*</tt> hooks provided by the win32text extension
  7626. have been unified into a single hook named <tt class="docutils literal">eol.checkheadshook</tt>. The
  7627. hook will lookup the expected line endings from the <tt class="docutils literal">.hgeol</tt> file,
  7628. which means you must migrate to a <tt class="docutils literal">.hgeol</tt> file first before using
  7629. the hook. <tt class="docutils literal">eol.checkheadshook</tt> only checks heads, intermediate
  7630. invalid revisions will be pushed. To forbid them completely, use the
  7631. <tt class="docutils literal">eol.checkallhook</tt> hook. These hooks are best used as
  7632. <tt class="docutils literal">pretxnchangegroup</tt> hooks.</p>
  7633. <p>See <a class="reference external" href="hg.1.html#patterns"><tt class="docutils literal">hg help patterns</tt></a> for more information about the glob patterns
  7634. used.</p>
  7635. </div>
  7636. <div class="section" id="extdiff">
  7637. <h2><a class="toc-backref" href="#id95">extdiff</a></h2>
  7638. <p>command to allow external programs to compare revisions</p>
  7639. <p>The extdiff Mercurial extension allows you to use external programs
  7640. to compare revisions, or revision with working directory. The external
  7641. diff programs are called with a configurable set of options and two
  7642. non-option arguments: paths to directories containing snapshots of
  7643. files to compare.</p>
  7644. <p>The extdiff extension also allows you to configure new diff commands, so
  7645. you do not need to type <a class="reference external" href="hg.1.html#extdiff"><tt class="docutils literal">hg extdiff <span class="pre">-p</span> kdiff3</tt></a> always.</p>
  7646. <pre class="literal-block">
  7647. [extdiff]
  7648. # add new command that runs GNU diff(1) in 'context diff' mode
  7649. cdiff = gdiff -Nprc5
  7650. ## or the old way:
  7651. #cmd.cdiff = gdiff
  7652. #opts.cdiff = -Nprc5
  7653.  
  7654. # add new command called meld, runs meld (no need to name twice).  If
  7655. # the meld executable is not available, the meld tool in [merge-tools]
  7656. # will be used, if available
  7657. meld =
  7658.  
  7659. # add new command called vimdiff, runs gvimdiff with DirDiff plugin
  7660. # (see http://www.vim.org/scripts/script.php?script_id=102) Non
  7661. # English user, be sure to put &quot;let g:DirDiffDynamicDiffText = 1&quot; in
  7662. # your .vimrc
  7663. vimdiff = gvim -f &quot;+next&quot; \
  7664.           &quot;+execute 'DirDiff' fnameescape(argv(0)) fnameescape(argv(1))&quot;
  7665. </pre>
  7666. <p>Tool arguments can include variables that are expanded at runtime:</p>
  7667. <pre class="literal-block">
  7668. $parent1, $plabel1 - filename, descriptive label of first parent
  7669. $child,   $clabel  - filename, descriptive label of child revision
  7670. $parent2, $plabel2 - filename, descriptive label of second parent
  7671. $root              - repository root
  7672. $parent is an alias for $parent1.
  7673. </pre>
  7674. <p>The extdiff extension will look in your [diff-tools] and [merge-tools]
  7675. sections for diff tool arguments, when none are specified in [extdiff].</p>
  7676. <pre class="literal-block">
  7677. [extdiff]
  7678. kdiff3 =
  7679.  
  7680. [diff-tools]
  7681. kdiff3.diffargs=--L1 '$plabel1' --L2 '$clabel' $parent $child
  7682. </pre>
  7683. <p>You can use -I/-X and list of file or directory names like normal
  7684. <a class="reference external" href="hg.1.html#diff"><tt class="docutils literal">hg diff</tt></a> command. The extdiff extension makes snapshots of only
  7685. needed files, so running the external diff program will actually be
  7686. pretty fast (at least faster than having to compare the entire tree).</p>
  7687. <div class="section" id="id25">
  7688. <h3>Commands</h3>
  7689. <div class="section" id="id26">
  7690. <h4>extdiff</h4>
  7691. <p>use external program to diff repository (or selected files):</p>
  7692. <pre class="literal-block">
  7693. hg extdiff [OPT]... [FILE]...
  7694. </pre>
  7695. <p>Show differences between revisions for the specified files, using
  7696. an external program. The default program used is diff, with
  7697. default options &quot;-Npru&quot;.</p>
  7698. <p>To select a different program, use the -p/--program option. The
  7699. program will be passed the names of two directories to compare. To
  7700. pass additional options to the program, use -o/--option. These
  7701. will be passed before the names of the directories to compare.</p>
  7702. <p>When two revision arguments are given, then changes are shown
  7703. between those revisions. If only one revision is specified then
  7704. that revision is compared to the working directory, and, when no
  7705. revisions are specified, the working directory files are compared
  7706. to its parent.</p>
  7707. <p>Options:</p>
  7708. <table class="docutils option-list" frame="void" rules="none">
  7709. <col class="option" />
  7710. <col class="description" />
  7711. <tbody valign="top">
  7712. <tr><td class="option-group" colspan="2">
  7713. <kbd><span class="option">-p</span>, <span class="option">--program <var>&lt;CMD&gt;</var></span></kbd></td>
  7714. </tr>
  7715. <tr><td>&nbsp;</td><td>comparison program to run</td></tr>
  7716. <tr><td class="option-group" colspan="2">
  7717. <kbd><span class="option">-o</span>, <span class="option">--option <var>&lt;OPT[+]&gt;</var></span></kbd></td>
  7718. </tr>
  7719. <tr><td>&nbsp;</td><td>pass option to comparison program</td></tr>
  7720. <tr><td class="option-group" colspan="2">
  7721. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  7722. </tr>
  7723. <tr><td>&nbsp;</td><td>revision</td></tr>
  7724. <tr><td class="option-group" colspan="2">
  7725. <kbd><span class="option">-c</span>, <span class="option">--change <var>&lt;REV&gt;</var></span></kbd></td>
  7726. </tr>
  7727. <tr><td>&nbsp;</td><td>change made by revision</td></tr>
  7728. <tr><td class="option-group" colspan="2">
  7729. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  7730. </tr>
  7731. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  7732. <tr><td class="option-group" colspan="2">
  7733. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  7734. </tr>
  7735. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  7736. <tr><td class="option-group">
  7737. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  7738. <td>recurse into subrepositories</td></tr>
  7739. </tbody>
  7740. </table>
  7741. <p>[+] marked option can be specified multiple times</p>
  7742. </div>
  7743. </div>
  7744. </div>
  7745. <div class="section" id="factotum">
  7746. <h2><a class="toc-backref" href="#id96">factotum</a></h2>
  7747. <p>http authentication with factotum</p>
  7748. <p>This extension allows the factotum(4) facility on Plan 9 from Bell Labs
  7749. platforms to provide authentication information for HTTP access. Configuration
  7750. entries specified in the auth section as well as authentication information
  7751. provided in the repository URL are fully supported. If no prefix is specified,
  7752. a value of &quot;*&quot; will be assumed.</p>
  7753. <p>By default, keys are specified as:</p>
  7754. <pre class="literal-block">
  7755. proto=pass service=hg prefix=&lt;prefix&gt; user=&lt;username&gt; !password=&lt;password&gt;
  7756. </pre>
  7757. <p>If the factotum extension is unable to read the required key, one will be
  7758. requested interactively.</p>
  7759. <p>A configuration section is available to customize runtime behavior. By
  7760. default, these entries are:</p>
  7761. <pre class="literal-block">
  7762. [factotum]
  7763. executable = /bin/auth/factotum
  7764. mountpoint = /mnt/factotum
  7765. service = hg
  7766. </pre>
  7767. <p>The executable entry defines the full path to the factotum binary. The
  7768. mountpoint entry defines the path to the factotum file service. Lastly, the
  7769. service entry controls the service name used when reading keys.</p>
  7770. </div>
  7771. <div class="section" id="fetch">
  7772. <h2><a class="toc-backref" href="#id97">fetch</a></h2>
  7773. <p>pull, update and merge in one command (DEPRECATED)</p>
  7774. <div class="section" id="id27">
  7775. <h3>Commands</h3>
  7776. <div class="section" id="id28">
  7777. <h4>fetch</h4>
  7778. <p>pull changes from a remote repository, merge new changes if needed.:</p>
  7779. <pre class="literal-block">
  7780. hg fetch [SOURCE]
  7781. </pre>
  7782. <p>This finds all changes from the repository at the specified path
  7783. or URL and adds them to the local repository.</p>
  7784. <p>If the pulled changes add a new branch head, the head is
  7785. automatically merged, and the result of the merge is committed.
  7786. Otherwise, the working directory is updated to include the new
  7787. changes.</p>
  7788. <p>When a merge is needed, the working directory is first updated to
  7789. the newly pulled changes. Local changes are then merged into the
  7790. pulled changes. To switch the merge order, use --switch-parent.</p>
  7791. <p>See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for a list of formats valid for -d/--date.</p>
  7792. <p>Returns 0 on success.</p>
  7793. <p>Options:</p>
  7794. <table class="docutils option-list" frame="void" rules="none">
  7795. <col class="option" />
  7796. <col class="description" />
  7797. <tbody valign="top">
  7798. <tr><td class="option-group" colspan="2">
  7799. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  7800. </tr>
  7801. <tr><td>&nbsp;</td><td>a specific revision you would like to pull</td></tr>
  7802. <tr><td class="option-group">
  7803. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  7804. <td>invoke editor on commit messages</td></tr>
  7805. <tr><td class="option-group">
  7806. <kbd><span class="option">--force-editor</span></kbd></td>
  7807. <td>edit commit message (DEPRECATED)</td></tr>
  7808. <tr><td class="option-group" colspan="2">
  7809. <kbd><span class="option">--switch-parent</span></kbd></td>
  7810. </tr>
  7811. <tr><td>&nbsp;</td><td>switch parents when merging</td></tr>
  7812. <tr><td class="option-group" colspan="2">
  7813. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  7814. </tr>
  7815. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  7816. <tr><td class="option-group" colspan="2">
  7817. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  7818. </tr>
  7819. <tr><td>&nbsp;</td><td>read commit message from file</td></tr>
  7820. <tr><td class="option-group" colspan="2">
  7821. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  7822. </tr>
  7823. <tr><td>&nbsp;</td><td>record the specified date as commit date</td></tr>
  7824. <tr><td class="option-group" colspan="2">
  7825. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  7826. </tr>
  7827. <tr><td>&nbsp;</td><td>record the specified user as committer</td></tr>
  7828. <tr><td class="option-group" colspan="2">
  7829. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  7830. </tr>
  7831. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  7832. <tr><td class="option-group" colspan="2">
  7833. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  7834. </tr>
  7835. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  7836. <tr><td class="option-group">
  7837. <kbd><span class="option">--insecure</span></kbd></td>
  7838. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  7839. </tbody>
  7840. </table>
  7841. <p>[+] marked option can be specified multiple times</p>
  7842. </div>
  7843. </div>
  7844. </div>
  7845. <div class="section" id="gpg">
  7846. <h2><a class="toc-backref" href="#id98">gpg</a></h2>
  7847. <p>commands to sign and verify changesets</p>
  7848. <div class="section" id="id29">
  7849. <h3>Commands</h3>
  7850. <div class="section" id="sigcheck">
  7851. <h4>sigcheck</h4>
  7852. <p>verify all the signatures there may be for a particular revision:</p>
  7853. <pre class="literal-block">
  7854. hg sigcheck REV
  7855. </pre>
  7856. <p>verify all the signatures there may be for a particular revision</p>
  7857. </div>
  7858. <div class="section" id="sign">
  7859. <h4>sign</h4>
  7860. <p>add a signature for the current or given revision:</p>
  7861. <pre class="literal-block">
  7862. hg sign [OPTION]... [REV]...
  7863. </pre>
  7864. <p>If no revision is given, the parent of the working directory is used,
  7865. or tip if no revision is checked out.</p>
  7866. <p>The <tt class="docutils literal">gpg.cmd</tt> config setting can be used to specify the command
  7867. to run. A default key can be specified with <tt class="docutils literal">gpg.key</tt>.</p>
  7868. <p>See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for a list of formats valid for -d/--date.</p>
  7869. <p>Options:</p>
  7870. <table class="docutils option-list" frame="void" rules="none">
  7871. <col class="option" />
  7872. <col class="description" />
  7873. <tbody valign="top">
  7874. <tr><td class="option-group">
  7875. <kbd><span class="option">-l</span>, <span class="option">--local</span></kbd></td>
  7876. <td>make the signature local</td></tr>
  7877. <tr><td class="option-group">
  7878. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  7879. <td>sign even if the sigfile is modified</td></tr>
  7880. <tr><td class="option-group">
  7881. <kbd><span class="option">--no-commit</span></kbd></td>
  7882. <td>do not commit the sigfile after signing</td></tr>
  7883. <tr><td class="option-group">
  7884. <kbd><span class="option">-k</span>, <span class="option">--key <var>&lt;ID&gt;</var></span></kbd></td>
  7885. <td>the key id to sign with</td></tr>
  7886. <tr><td class="option-group" colspan="2">
  7887. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  7888. </tr>
  7889. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  7890. <tr><td class="option-group">
  7891. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  7892. <td>invoke editor on commit messages</td></tr>
  7893. <tr><td class="option-group" colspan="2">
  7894. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  7895. </tr>
  7896. <tr><td>&nbsp;</td><td>record the specified date as commit date</td></tr>
  7897. <tr><td class="option-group" colspan="2">
  7898. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  7899. </tr>
  7900. <tr><td>&nbsp;</td><td>record the specified user as committer</td></tr>
  7901. </tbody>
  7902. </table>
  7903. </div>
  7904. <div class="section" id="sigs">
  7905. <h4>sigs</h4>
  7906. <p>list signed changesets:</p>
  7907. <pre class="literal-block">
  7908. hg sigs
  7909. </pre>
  7910. <p>list signed changesets</p>
  7911. </div>
  7912. </div>
  7913. </div>
  7914. <div class="section" id="graphlog">
  7915. <h2><a class="toc-backref" href="#id99">graphlog</a></h2>
  7916. <p>command to view revision graphs from a shell (DEPRECATED)</p>
  7917. <p>The functionality of this extension has been include in core Mercurial
  7918. since version 2.3.</p>
  7919. <p>This extension adds a --graph option to the incoming, outgoing and log
  7920. commands. When this options is given, an ASCII representation of the
  7921. revision graph is also shown.</p>
  7922. <div class="section" id="id30">
  7923. <h3>Commands</h3>
  7924. <div class="section" id="glog">
  7925. <h4>glog</h4>
  7926. <p>show revision history alongside an ASCII revision graph:</p>
  7927. <pre class="literal-block">
  7928. hg glog [OPTION]... [FILE]
  7929. </pre>
  7930. <p>Print a revision history alongside a revision graph drawn with
  7931. ASCII characters.</p>
  7932. <p>Nodes printed as an &#64; character are parents of the working
  7933. directory.</p>
  7934. <p>Options:</p>
  7935. <table class="docutils option-list" frame="void" rules="none">
  7936. <col class="option" />
  7937. <col class="description" />
  7938. <tbody valign="top">
  7939. <tr><td class="option-group">
  7940. <kbd><span class="option">-f</span>, <span class="option">--follow</span></kbd></td>
  7941. <td>follow changeset history, or file history across copies and renames</td></tr>
  7942. <tr><td class="option-group">
  7943. <kbd><span class="option">--follow-first</span></kbd></td>
  7944. <td>only follow the first parent of merge changesets (DEPRECATED)</td></tr>
  7945. <tr><td class="option-group" colspan="2">
  7946. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  7947. </tr>
  7948. <tr><td>&nbsp;</td><td>show revisions matching date spec</td></tr>
  7949. <tr><td class="option-group">
  7950. <kbd><span class="option">-C</span>, <span class="option">--copies</span></kbd></td>
  7951. <td>show copied files</td></tr>
  7952. <tr><td class="option-group" colspan="2">
  7953. <kbd><span class="option">-k</span>, <span class="option">--keyword <var>&lt;TEXT[+]&gt;</var></span></kbd></td>
  7954. </tr>
  7955. <tr><td>&nbsp;</td><td>do case-insensitive search for a given text</td></tr>
  7956. <tr><td class="option-group" colspan="2">
  7957. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  7958. </tr>
  7959. <tr><td>&nbsp;</td><td>show the specified revision or revset</td></tr>
  7960. <tr><td class="option-group">
  7961. <kbd><span class="option">--removed</span></kbd></td>
  7962. <td>include revisions where files were removed</td></tr>
  7963. <tr><td class="option-group" colspan="2">
  7964. <kbd><span class="option">-m</span>, <span class="option">--only-merges</span></kbd></td>
  7965. </tr>
  7966. <tr><td>&nbsp;</td><td>show only merges (DEPRECATED)</td></tr>
  7967. <tr><td class="option-group" colspan="2">
  7968. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER[+]&gt;</var></span></kbd></td>
  7969. </tr>
  7970. <tr><td>&nbsp;</td><td>revisions committed by user</td></tr>
  7971. <tr><td class="option-group" colspan="2">
  7972. <kbd><span class="option">--only-branch <var>&lt;BRANCH[+]&gt;</var></span></kbd></td>
  7973. </tr>
  7974. <tr><td>&nbsp;</td><td>show only changesets within the given named branch (DEPRECATED)</td></tr>
  7975. <tr><td class="option-group" colspan="2">
  7976. <kbd><span class="option">-b</span>, <span class="option">--branch <var>&lt;BRANCH[+]&gt;</var></span></kbd></td>
  7977. </tr>
  7978. <tr><td>&nbsp;</td><td>show changesets within the given named branch</td></tr>
  7979. <tr><td class="option-group" colspan="2">
  7980. <kbd><span class="option">-P</span>, <span class="option">--prune <var>&lt;REV[+]&gt;</var></span></kbd></td>
  7981. </tr>
  7982. <tr><td>&nbsp;</td><td>do not display revision or any of its ancestors</td></tr>
  7983. <tr><td class="option-group">
  7984. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  7985. <td>show patch</td></tr>
  7986. <tr><td class="option-group">
  7987. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  7988. <td>use git extended diff format</td></tr>
  7989. <tr><td class="option-group" colspan="2">
  7990. <kbd><span class="option">-l</span>, <span class="option">--limit <var>&lt;NUM&gt;</var></span></kbd></td>
  7991. </tr>
  7992. <tr><td>&nbsp;</td><td>limit number of changes displayed</td></tr>
  7993. <tr><td class="option-group" colspan="2">
  7994. <kbd><span class="option">-M</span>, <span class="option">--no-merges</span></kbd></td>
  7995. </tr>
  7996. <tr><td>&nbsp;</td><td>do not show merges</td></tr>
  7997. <tr><td class="option-group">
  7998. <kbd><span class="option">--stat</span></kbd></td>
  7999. <td>output diffstat-style summary of changes</td></tr>
  8000. <tr><td class="option-group">
  8001. <kbd><span class="option">-G</span>, <span class="option">--graph</span></kbd></td>
  8002. <td>show the revision DAG</td></tr>
  8003. <tr><td class="option-group" colspan="2">
  8004. <kbd><span class="option">--style <var>&lt;STYLE&gt;</var></span></kbd></td>
  8005. </tr>
  8006. <tr><td>&nbsp;</td><td>display using template map file (DEPRECATED)</td></tr>
  8007. <tr><td class="option-group" colspan="2">
  8008. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  8009. </tr>
  8010. <tr><td>&nbsp;</td><td>display with template</td></tr>
  8011. <tr><td class="option-group" colspan="2">
  8012. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8013. </tr>
  8014. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  8015. <tr><td class="option-group" colspan="2">
  8016. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8017. </tr>
  8018. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  8019. </tbody>
  8020. </table>
  8021. <p>[+] marked option can be specified multiple times</p>
  8022. </div>
  8023. </div>
  8024. </div>
  8025. <div class="section" id="hgcia">
  8026. <h2><a class="toc-backref" href="#id100">hgcia</a></h2>
  8027. <p>hooks for integrating with the CIA.vc notification service</p>
  8028. <p>This is meant to be run as a changegroup or incoming hook. To
  8029. configure it, set the following options in your hgrc:</p>
  8030. <pre class="literal-block">
  8031. [cia]
  8032. # your registered CIA user name
  8033. user = foo
  8034. # the name of the project in CIA
  8035. project = foo
  8036. # the module (subproject) (optional)
  8037. #module = foo
  8038. # Append a diffstat to the log message (optional)
  8039. #diffstat = False
  8040. # Template to use for log messages (optional)
  8041. #template = {desc}\n{baseurl}{webroot}/rev/{node}-- {diffstat}
  8042. # Style to use (optional)
  8043. #style = foo
  8044. # The URL of the CIA notification service (optional)
  8045. # You can use mailto: URLs to send by email, e.g.
  8046. # mailto:cia&#64;cia.vc
  8047. # Make sure to set email.from if you do this.
  8048. #url = http://cia.vc/
  8049. # print message instead of sending it (optional)
  8050. #test = False
  8051. # number of slashes to strip for url paths
  8052. #strip = 0
  8053.  
  8054. [hooks]
  8055. # one of these:
  8056. changegroup.cia = python:hgcia.hook
  8057. #incoming.cia = python:hgcia.hook
  8058.  
  8059. [web]
  8060. # If you want hyperlinks (optional)
  8061. baseurl = http://server/path/to/repo
  8062. </pre>
  8063. </div>
  8064. <div class="section" id="hgk">
  8065. <h2><a class="toc-backref" href="#id101">hgk</a></h2>
  8066. <p>browse the repository in a graphical way</p>
  8067. <p>The hgk extension allows browsing the history of a repository in a
  8068. graphical way. It requires Tcl/Tk version 8.4 or later. (Tcl/Tk is not
  8069. distributed with Mercurial.)</p>
  8070. <p>hgk consists of two parts: a Tcl script that does the displaying and
  8071. querying of information, and an extension to Mercurial named hgk.py,
  8072. which provides hooks for hgk to get information. hgk can be found in
  8073. the contrib directory, and the extension is shipped in the hgext
  8074. repository, and needs to be enabled.</p>
  8075. <p>The <a class="reference external" href="hg.1.html#view"><tt class="docutils literal">hg view</tt></a> command will launch the hgk Tcl script. For this command
  8076. to work, hgk must be in your search path. Alternately, you can specify
  8077. the path to hgk in your configuration file:</p>
  8078. <pre class="literal-block">
  8079. [hgk]
  8080. path = /location/of/hgk
  8081. </pre>
  8082. <p>hgk can make use of the extdiff extension to visualize revisions.
  8083. Assuming you had already configured extdiff vdiff command, just add:</p>
  8084. <pre class="literal-block">
  8085. [hgk]
  8086. vdiff=vdiff
  8087. </pre>
  8088. <p>Revisions context menu will now display additional entries to fire
  8089. vdiff on hovered and selected revisions.</p>
  8090. <div class="section" id="id31">
  8091. <h3>Commands</h3>
  8092. <div class="section" id="view">
  8093. <h4>view</h4>
  8094. <p>start interactive history viewer:</p>
  8095. <pre class="literal-block">
  8096. hg view [-l LIMIT] [REVRANGE]
  8097. </pre>
  8098. <p>start interactive history viewer</p>
  8099. <p>Options:</p>
  8100. <table class="docutils option-list" frame="void" rules="none">
  8101. <col class="option" />
  8102. <col class="description" />
  8103. <tbody valign="top">
  8104. <tr><td class="option-group" colspan="2">
  8105. <kbd><span class="option">-l</span>, <span class="option">--limit <var>&lt;NUM&gt;</var></span></kbd></td>
  8106. </tr>
  8107. <tr><td>&nbsp;</td><td>limit number of changes displayed</td></tr>
  8108. </tbody>
  8109. </table>
  8110. </div>
  8111. </div>
  8112. </div>
  8113. <div class="section" id="highlight">
  8114. <h2><a class="toc-backref" href="#id102">highlight</a></h2>
  8115. <p>syntax highlighting for hgweb (requires Pygments)</p>
  8116. <p>It depends on the Pygments syntax highlighting library:
  8117. <a class="reference external" href="http://pygments.org/">http://pygments.org/</a></p>
  8118. <p>There is a single configuration option:</p>
  8119. <pre class="literal-block">
  8120. [web]
  8121. pygments_style = &lt;style&gt;
  8122. </pre>
  8123. <p>The default is 'colorful'.</p>
  8124. </div>
  8125. <div class="section" id="histedit">
  8126. <h2><a class="toc-backref" href="#id103">histedit</a></h2>
  8127. <p>interactive history editing</p>
  8128. <p>With this extension installed, Mercurial gains one new command: histedit. Usage
  8129. is as follows, assuming the following history:</p>
  8130. <pre class="literal-block">
  8131. &#64;  3[tip]   7c2fd3b9020c   2009-04-27 18:04 -0500   durin42
  8132. |    Add delta
  8133. |
  8134. o  2   030b686bedc4   2009-04-27 18:04 -0500   durin42
  8135. |    Add gamma
  8136. |
  8137. o  1   c561b4e977df   2009-04-27 18:04 -0500   durin42
  8138. |    Add beta
  8139. |
  8140. o  0   d8d2fcd0e319   2009-04-27 18:04 -0500   durin42
  8141.      Add alpha
  8142. </pre>
  8143. <p>If you were to run <tt class="docutils literal">hg histedit c561b4e977df</tt>, you would see the following
  8144. file open in your editor:</p>
  8145. <pre class="literal-block">
  8146. pick c561b4e977df Add beta
  8147. pick 030b686bedc4 Add gamma
  8148. pick 7c2fd3b9020c Add delta
  8149.  
  8150. # Edit history between c561b4e977df and 7c2fd3b9020c
  8151. #
  8152. # Commits are listed from least to most recent
  8153. #
  8154. # Commands:
  8155. #  p, pick = use commit
  8156. #  e, edit = use commit, but stop for amending
  8157. #  f, fold = use commit, but combine it with the one above
  8158. #  r, roll = like fold, but discard this commit's description
  8159. #  d, drop = remove commit from history
  8160. #  m, mess = edit message without changing commit content
  8161. #
  8162. </pre>
  8163. <p>In this file, lines beginning with <tt class="docutils literal">#</tt> are ignored. You must specify a rule
  8164. for each revision in your history. For example, if you had meant to add gamma
  8165. before beta, and then wanted to add delta in the same revision as beta, you
  8166. would reorganize the file to look like this:</p>
  8167. <pre class="literal-block">
  8168. pick 030b686bedc4 Add gamma
  8169. pick c561b4e977df Add beta
  8170. fold 7c2fd3b9020c Add delta
  8171.  
  8172. # Edit history between c561b4e977df and 7c2fd3b9020c
  8173. #
  8174. # Commits are listed from least to most recent
  8175. #
  8176. # Commands:
  8177. #  p, pick = use commit
  8178. #  e, edit = use commit, but stop for amending
  8179. #  f, fold = use commit, but combine it with the one above
  8180. #  r, roll = like fold, but discard this commit's description
  8181. #  d, drop = remove commit from history
  8182. #  m, mess = edit message without changing commit content
  8183. #
  8184. </pre>
  8185. <p>At which point you close the editor and <tt class="docutils literal">histedit</tt> starts working. When you
  8186. specify a <tt class="docutils literal">fold</tt> operation, <tt class="docutils literal">histedit</tt> will open an editor when it folds
  8187. those revisions together, offering you a chance to clean up the commit message:</p>
  8188. <pre class="literal-block">
  8189. Add beta
  8190. ***
  8191. Add delta
  8192. </pre>
  8193. <p>Edit the commit message to your liking, then close the editor. For
  8194. this example, let's assume that the commit message was changed to
  8195. <tt class="docutils literal">Add beta and delta.</tt> After histedit has run and had a chance to
  8196. remove any old or temporary revisions it needed, the history looks
  8197. like this:</p>
  8198. <pre class="literal-block">
  8199. &#64;  2[tip]   989b4d060121   2009-04-27 18:04 -0500   durin42
  8200. |    Add beta and delta.
  8201. |
  8202. o  1   081603921c3f   2009-04-27 18:04 -0500   durin42
  8203. |    Add gamma
  8204. |
  8205. o  0   d8d2fcd0e319   2009-04-27 18:04 -0500   durin42
  8206.      Add alpha
  8207. </pre>
  8208. <p>Note that <tt class="docutils literal">histedit</tt> does <em>not</em> remove any revisions (even its own temporary
  8209. ones) until after it has completed all the editing operations, so it will
  8210. probably perform several strip operations when it's done. For the above example,
  8211. it had to run strip twice. Strip can be slow depending on a variety of factors,
  8212. so you might need to be a little patient. You can choose to keep the original
  8213. revisions by passing the <tt class="docutils literal"><span class="pre">--keep</span></tt> flag.</p>
  8214. <p>The <tt class="docutils literal">edit</tt> operation will drop you back to a command prompt,
  8215. allowing you to edit files freely, or even use <tt class="docutils literal">hg record</tt> to commit
  8216. some changes as a separate commit. When you're done, any remaining
  8217. uncommitted changes will be committed as well. When done, run <tt class="docutils literal">hg
  8218. histedit <span class="pre">--continue</span></tt> to finish this step. You'll be prompted for a
  8219. new commit message, but the default commit message will be the
  8220. original message for the <tt class="docutils literal">edit</tt> ed revision.</p>
  8221. <p>The <tt class="docutils literal">message</tt> operation will give you a chance to revise a commit
  8222. message without changing the contents. It's a shortcut for doing
  8223. <tt class="docutils literal">edit</tt> immediately followed by <cite>hg histedit --continue`</cite>.</p>
  8224. <p>If <tt class="docutils literal">histedit</tt> encounters a conflict when moving a revision (while
  8225. handling <tt class="docutils literal">pick</tt> or <tt class="docutils literal">fold</tt>), it'll stop in a similar manner to
  8226. <tt class="docutils literal">edit</tt> with the difference that it won't prompt you for a commit
  8227. message when done. If you decide at this point that you don't like how
  8228. much work it will be to rearrange history, or that you made a mistake,
  8229. you can use <tt class="docutils literal">hg histedit <span class="pre">--abort</span></tt> to abandon the new changes you
  8230. have made and return to the state before you attempted to edit your
  8231. history.</p>
  8232. <p>If we clone the histedit-ed example repository above and add four more
  8233. changes, such that we have the following history:</p>
  8234. <pre class="literal-block">
  8235. &#64;  6[tip]   038383181893   2009-04-27 18:04 -0500   stefan
  8236. |    Add theta
  8237. |
  8238. o  5   140988835471   2009-04-27 18:04 -0500   stefan
  8239. |    Add eta
  8240. |
  8241. o  4   122930637314   2009-04-27 18:04 -0500   stefan
  8242. |    Add zeta
  8243. |
  8244. o  3   836302820282   2009-04-27 18:04 -0500   stefan
  8245. |    Add epsilon
  8246. |
  8247. o  2   989b4d060121   2009-04-27 18:04 -0500   durin42
  8248. |    Add beta and delta.
  8249. |
  8250. o  1   081603921c3f   2009-04-27 18:04 -0500   durin42
  8251. |    Add gamma
  8252. |
  8253. o  0   d8d2fcd0e319   2009-04-27 18:04 -0500   durin42
  8254.      Add alpha
  8255. </pre>
  8256. <p>If you run <tt class="docutils literal">hg histedit <span class="pre">--outgoing</span></tt> on the clone then it is the same
  8257. as running <tt class="docutils literal">hg histedit 836302820282</tt>. If you need plan to push to a
  8258. repository that Mercurial does not detect to be related to the source
  8259. repo, you can add a <tt class="docutils literal"><span class="pre">--force</span></tt> option.</p>
  8260. <p>Histedit rule lines are truncated to 80 characters by default. You
  8261. can customise this behaviour by setting a different length in your
  8262. configuration file:</p>
  8263. <pre class="literal-block">
  8264. [histedit]
  8265. linelen = 120      # truncate rule lines at 120 characters
  8266. </pre>
  8267. <div class="section" id="id32">
  8268. <h3>Commands</h3>
  8269. <div class="section" id="id33">
  8270. <h4>histedit</h4>
  8271. <p>interactively edit changeset history:</p>
  8272. <pre class="literal-block">
  8273. hg histedit ANCESTOR | --outgoing [URL]
  8274. </pre>
  8275. <p>This command edits changesets between ANCESTOR and the parent of
  8276. the working directory.</p>
  8277. <p>With --outgoing, this edits changesets not found in the
  8278. destination repository. If URL of the destination is omitted, the
  8279. 'default-push' (or 'default') path will be used.</p>
  8280. <p>For safety, this command is aborted, also if there are ambiguous
  8281. outgoing revisions which may confuse users: for example, there are
  8282. multiple branches containing outgoing revisions.</p>
  8283. <p>Use &quot;min(outgoing() and ::.)&quot; or similar revset specification
  8284. instead of --outgoing to specify edit target revision exactly in
  8285. such ambiguous situation. See <a class="reference external" href="hg.1.html#revsets"><tt class="docutils literal">hg help revsets</tt></a> for detail about
  8286. selecting revisions.</p>
  8287. <p>Returns 0 on success, 1 if user intervention is required (not only
  8288. for intentional &quot;edit&quot; command, but also for resolving unexpected
  8289. conflicts).</p>
  8290. <p>Options:</p>
  8291. <table class="docutils option-list" frame="void" rules="none">
  8292. <col class="option" />
  8293. <col class="description" />
  8294. <tbody valign="top">
  8295. <tr><td class="option-group" colspan="2">
  8296. <kbd><span class="option">--commands <var>&lt;FILE&gt;</var></span></kbd></td>
  8297. </tr>
  8298. <tr><td>&nbsp;</td><td>read history edits from the specified file</td></tr>
  8299. <tr><td class="option-group">
  8300. <kbd><span class="option">-c</span>, <span class="option">--continue</span></kbd></td>
  8301. <td>continue an edit already in progress</td></tr>
  8302. <tr><td class="option-group">
  8303. <kbd><span class="option">--edit-plan</span></kbd></td>
  8304. <td>edit remaining actions list</td></tr>
  8305. <tr><td class="option-group">
  8306. <kbd><span class="option">-k</span>, <span class="option">--keep</span></kbd></td>
  8307. <td>don't strip old nodes after edit is complete</td></tr>
  8308. <tr><td class="option-group">
  8309. <kbd><span class="option">--abort</span></kbd></td>
  8310. <td>abort an edit in progress</td></tr>
  8311. <tr><td class="option-group">
  8312. <kbd><span class="option">-o</span>, <span class="option">--outgoing</span></kbd></td>
  8313. <td>changesets not found in destination</td></tr>
  8314. <tr><td class="option-group">
  8315. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  8316. <td>force outgoing even for unrelated repositories</td></tr>
  8317. <tr><td class="option-group" colspan="2">
  8318. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  8319. </tr>
  8320. <tr><td>&nbsp;</td><td>first revision to be edited</td></tr>
  8321. </tbody>
  8322. </table>
  8323. <p>[+] marked option can be specified multiple times</p>
  8324. </div>
  8325. </div>
  8326. </div>
  8327. <div class="section" id="keyword">
  8328. <h2><a class="toc-backref" href="#id104">keyword</a></h2>
  8329. <p>expand keywords in tracked files</p>
  8330. <p>This extension expands RCS/CVS-like or self-customized $Keywords$ in
  8331. tracked text files selected by your configuration.</p>
  8332. <p>Keywords are only expanded in local repositories and not stored in the
  8333. change history. The mechanism can be regarded as a convenience for the
  8334. current user or for archive distribution.</p>
  8335. <p>Keywords expand to the changeset data pertaining to the latest change
  8336. relative to the working directory parent of each file.</p>
  8337. <p>Configuration is done in the [keyword], [keywordset] and [keywordmaps]
  8338. sections of hgrc files.</p>
  8339. <p>Example:</p>
  8340. <pre class="literal-block">
  8341. [keyword]
  8342. # expand keywords in every python file except those matching &quot;x*&quot;
  8343. **.py =
  8344. x*    = ignore
  8345.  
  8346. [keywordset]
  8347. # prefer svn- over cvs-like default keywordmaps
  8348. svn = True
  8349. </pre>
  8350. <div class="note">
  8351. <p class="first admonition-title">Note</p>
  8352. <p class="last">The more specific you are in your filename patterns the less you
  8353. lose speed in huge repositories.</p>
  8354. </div>
  8355. <p>For [keywordmaps] template mapping and expansion demonstration and
  8356. control run <a class="reference external" href="hg.1.html#kwdemo"><tt class="docutils literal">hg kwdemo</tt></a>. See <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a> for a list of
  8357. available templates and filters.</p>
  8358. <p>Three additional date template filters are provided:</p>
  8359. <table class="docutils field-list" frame="void" rules="none">
  8360. <col class="field-name" />
  8361. <col class="field-body" />
  8362. <tbody valign="top">
  8363. <tr class="field"><th class="field-name"><tt class="docutils literal">utcdate</tt>:</th><td class="field-body">&quot;2006/09/18 15:13:13&quot;</td>
  8364. </tr>
  8365. <tr class="field"><th class="field-name"><tt class="docutils literal">svnutcdate</tt>:</th><td class="field-body">&quot;2006-09-18 15:13:13Z&quot;</td>
  8366. </tr>
  8367. <tr class="field"><th class="field-name"><tt class="docutils literal">svnisodate</tt>:</th><td class="field-body">&quot;2006-09-18 08:13:13 -700 (Mon, 18 Sep 2006)&quot;</td>
  8368. </tr>
  8369. </tbody>
  8370. </table>
  8371. <p>The default template mappings (view with <a class="reference external" href="hg.1.html#kwdemo"><tt class="docutils literal">hg kwdemo <span class="pre">-d</span></tt></a>) can be
  8372. replaced with customized keywords and templates. Again, run
  8373. <a class="reference external" href="hg.1.html#kwdemo"><tt class="docutils literal">hg kwdemo</tt></a> to control the results of your configuration changes.</p>
  8374. <p>Before changing/disabling active keywords, you must run <a class="reference external" href="hg.1.html#kwshrink"><tt class="docutils literal">hg kwshrink</tt></a>
  8375. to avoid storing expanded keywords in the change history.</p>
  8376. <p>To force expansion after enabling it, or a configuration change, run
  8377. <a class="reference external" href="hg.1.html#kwexpand"><tt class="docutils literal">hg kwexpand</tt></a>.</p>
  8378. <p>Expansions spanning more than one line and incremental expansions,
  8379. like CVS' $Log$, are not supported. A keyword template map &quot;Log =
  8380. {desc}&quot; expands to the first line of the changeset description.</p>
  8381. <div class="section" id="id34">
  8382. <h3>Commands</h3>
  8383. <div class="section" id="kwdemo">
  8384. <h4>kwdemo</h4>
  8385. <p>print [keywordmaps] configuration and an expansion example:</p>
  8386. <pre class="literal-block">
  8387. hg kwdemo [-d] [-f RCFILE] [TEMPLATEMAP]...
  8388. </pre>
  8389. <p>Show current, custom, or default keyword template maps and their
  8390. expansions.</p>
  8391. <p>Extend the current configuration by specifying maps as arguments
  8392. and using -f/--rcfile to source an external hgrc file.</p>
  8393. <p>Use -d/--default to disable current configuration.</p>
  8394. <p>See <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a> for information on templates and filters.</p>
  8395. <p>Options:</p>
  8396. <table class="docutils option-list" frame="void" rules="none">
  8397. <col class="option" />
  8398. <col class="description" />
  8399. <tbody valign="top">
  8400. <tr><td class="option-group">
  8401. <kbd><span class="option">-d</span>, <span class="option">--default</span></kbd></td>
  8402. <td>show default keyword template maps</td></tr>
  8403. <tr><td class="option-group" colspan="2">
  8404. <kbd><span class="option">-f</span>, <span class="option">--rcfile <var>&lt;FILE&gt;</var></span></kbd></td>
  8405. </tr>
  8406. <tr><td>&nbsp;</td><td>read maps from rcfile</td></tr>
  8407. </tbody>
  8408. </table>
  8409. </div>
  8410. <div class="section" id="kwexpand">
  8411. <h4>kwexpand</h4>
  8412. <p>expand keywords in the working directory:</p>
  8413. <pre class="literal-block">
  8414. hg kwexpand [OPTION]... [FILE]...
  8415. </pre>
  8416. <p>Run after (re)enabling keyword expansion.</p>
  8417. <p>kwexpand refuses to run if given files contain local changes.</p>
  8418. <p>Options:</p>
  8419. <table class="docutils option-list" frame="void" rules="none">
  8420. <col class="option" />
  8421. <col class="description" />
  8422. <tbody valign="top">
  8423. <tr><td class="option-group" colspan="2">
  8424. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8425. </tr>
  8426. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  8427. <tr><td class="option-group" colspan="2">
  8428. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8429. </tr>
  8430. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  8431. </tbody>
  8432. </table>
  8433. <p>[+] marked option can be specified multiple times</p>
  8434. </div>
  8435. <div class="section" id="kwfiles">
  8436. <h4>kwfiles</h4>
  8437. <p>show files configured for keyword expansion:</p>
  8438. <pre class="literal-block">
  8439. hg kwfiles [OPTION]... [FILE]...
  8440. </pre>
  8441. <p>List which files in the working directory are matched by the
  8442. [keyword] configuration patterns.</p>
  8443. <p>Useful to prevent inadvertent keyword expansion and to speed up
  8444. execution by including only files that are actual candidates for
  8445. expansion.</p>
  8446. <p>See <a class="reference external" href="hg.1.html#keyword"><tt class="docutils literal">hg help keyword</tt></a> on how to construct patterns both for
  8447. inclusion and exclusion of files.</p>
  8448. <p>With -A/--all and -v/--verbose the codes used to show the status
  8449. of files are:</p>
  8450. <pre class="literal-block">
  8451. K = keyword expansion candidate
  8452. k = keyword expansion candidate (not tracked)
  8453. I = ignored
  8454. i = ignored (not tracked)
  8455. </pre>
  8456. <p>Options:</p>
  8457. <table class="docutils option-list" frame="void" rules="none">
  8458. <col class="option" />
  8459. <col class="description" />
  8460. <tbody valign="top">
  8461. <tr><td class="option-group">
  8462. <kbd><span class="option">-A</span>, <span class="option">--all</span></kbd></td>
  8463. <td>show keyword status flags of all files</td></tr>
  8464. <tr><td class="option-group">
  8465. <kbd><span class="option">-i</span>, <span class="option">--ignore</span></kbd></td>
  8466. <td>show files excluded from expansion</td></tr>
  8467. <tr><td class="option-group">
  8468. <kbd><span class="option">-u</span>, <span class="option">--unknown</span></kbd></td>
  8469. <td>only show unknown (not tracked) files</td></tr>
  8470. <tr><td class="option-group" colspan="2">
  8471. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8472. </tr>
  8473. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  8474. <tr><td class="option-group" colspan="2">
  8475. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8476. </tr>
  8477. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  8478. </tbody>
  8479. </table>
  8480. <p>[+] marked option can be specified multiple times</p>
  8481. </div>
  8482. <div class="section" id="kwshrink">
  8483. <h4>kwshrink</h4>
  8484. <p>revert expanded keywords in the working directory:</p>
  8485. <pre class="literal-block">
  8486. hg kwshrink [OPTION]... [FILE]...
  8487. </pre>
  8488. <p>Must be run before changing/disabling active keywords.</p>
  8489. <p>kwshrink refuses to run if given files contain local changes.</p>
  8490. <p>Options:</p>
  8491. <table class="docutils option-list" frame="void" rules="none">
  8492. <col class="option" />
  8493. <col class="description" />
  8494. <tbody valign="top">
  8495. <tr><td class="option-group" colspan="2">
  8496. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8497. </tr>
  8498. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  8499. <tr><td class="option-group" colspan="2">
  8500. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8501. </tr>
  8502. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  8503. </tbody>
  8504. </table>
  8505. <p>[+] marked option can be specified multiple times</p>
  8506. </div>
  8507. </div>
  8508. </div>
  8509. <div class="section" id="largefiles">
  8510. <h2><a class="toc-backref" href="#id105">largefiles</a></h2>
  8511. <p>track large binary files</p>
  8512. <p>Large binary files tend to be not very compressible, not very
  8513. diffable, and not at all mergeable. Such files are not handled
  8514. efficiently by Mercurial's storage format (revlog), which is based on
  8515. compressed binary deltas; storing large binary files as regular
  8516. Mercurial files wastes bandwidth and disk space and increases
  8517. Mercurial's memory usage. The largefiles extension addresses these
  8518. problems by adding a centralized client-server layer on top of
  8519. Mercurial: largefiles live in a <em>central store</em> out on the network
  8520. somewhere, and you only fetch the revisions that you need when you
  8521. need them.</p>
  8522. <p>largefiles works by maintaining a &quot;standin file&quot; in .hglf/ for each
  8523. largefile. The standins are small (41 bytes: an SHA-1 hash plus
  8524. newline) and are tracked by Mercurial. Largefile revisions are
  8525. identified by the SHA-1 hash of their contents, which is written to
  8526. the standin. largefiles uses that revision ID to get/put largefile
  8527. revisions from/to the central store. This saves both disk space and
  8528. bandwidth, since you don't need to retrieve all historical revisions
  8529. of large files when you clone or pull.</p>
  8530. <p>To start a new repository or add new large binary files, just add
  8531. --large to your <a class="reference external" href="hg.1.html#add"><tt class="docutils literal">hg add</tt></a> command. For example:</p>
  8532. <pre class="literal-block">
  8533. $ dd if=/dev/urandom of=randomdata count=2000
  8534. $ hg add --large randomdata
  8535. $ hg commit -m 'add randomdata as a largefile'
  8536. </pre>
  8537. <p>When you push a changeset that adds/modifies largefiles to a remote
  8538. repository, its largefile revisions will be uploaded along with it.
  8539. Note that the remote Mercurial must also have the largefiles extension
  8540. enabled for this to work.</p>
  8541. <p>When you pull a changeset that affects largefiles from a remote
  8542. repository, the largefiles for the changeset will by default not be
  8543. pulled down. However, when you update to such a revision, any
  8544. largefiles needed by that revision are downloaded and cached (if
  8545. they have never been downloaded before). One way to pull largefiles
  8546. when pulling is thus to use --update, which will update your working
  8547. copy to the latest pulled revision (and thereby downloading any new
  8548. largefiles).</p>
  8549. <p>If you want to pull largefiles you don't need for update yet, then
  8550. you can use pull with the <cite>--lfrev</cite> option or the <a class="reference external" href="hg.1.html#lfpull"><tt class="docutils literal">hg lfpull</tt></a> command.</p>
  8551. <p>If you know you are pulling from a non-default location and want to
  8552. download all the largefiles that correspond to the new changesets at
  8553. the same time, then you can pull with <cite>--lfrev &quot;pulled()&quot;</cite>.</p>
  8554. <p>If you just want to ensure that you will have the largefiles needed to
  8555. merge or rebase with new heads that you are pulling, then you can pull
  8556. with <cite>--lfrev &quot;head(pulled())&quot;</cite> flag to pre-emptively download any largefiles
  8557. that are new in the heads you are pulling.</p>
  8558. <p>Keep in mind that network access may now be required to update to
  8559. changesets that you have not previously updated to. The nature of the
  8560. largefiles extension means that updating is no longer guaranteed to
  8561. be a local-only operation.</p>
  8562. <p>If you already have large files tracked by Mercurial without the
  8563. largefiles extension, you will need to convert your repository in
  8564. order to benefit from largefiles. This is done with the
  8565. <a class="reference external" href="hg.1.html#lfconvert"><tt class="docutils literal">hg lfconvert</tt></a> command:</p>
  8566. <pre class="literal-block">
  8567. $ hg lfconvert --size 10 oldrepo newrepo
  8568. </pre>
  8569. <p>In repositories that already have largefiles in them, any new file
  8570. over 10MB will automatically be added as a largefile. To change this
  8571. threshold, set <tt class="docutils literal">largefiles.minsize</tt> in your Mercurial config file
  8572. to the minimum size in megabytes to track as a largefile, or use the
  8573. --lfsize option to the add command (also in megabytes):</p>
  8574. <pre class="literal-block">
  8575. [largefiles]
  8576. minsize = 2
  8577.  
  8578. $ hg add --lfsize 2
  8579. </pre>
  8580. <p>The <tt class="docutils literal">largefiles.patterns</tt> config option allows you to specify a list
  8581. of filename patterns (see <a class="reference external" href="hg.1.html#patterns"><tt class="docutils literal">hg help patterns</tt></a>) that should always be
  8582. tracked as largefiles:</p>
  8583. <pre class="literal-block">
  8584. [largefiles]
  8585. patterns =
  8586.   *.jpg
  8587.   re:.*\.(png|bmp)$
  8588.   library.zip
  8589.   content/audio/*
  8590. </pre>
  8591. <p>Files that match one of these patterns will be added as largefiles
  8592. regardless of their size.</p>
  8593. <p>The <tt class="docutils literal">largefiles.minsize</tt> and <tt class="docutils literal">largefiles.patterns</tt> config options
  8594. will be ignored for any repositories not already containing a
  8595. largefile. To add the first largefile to a repository, you must
  8596. explicitly do so with the --large flag passed to the <a class="reference external" href="hg.1.html#add"><tt class="docutils literal">hg add</tt></a>
  8597. command.</p>
  8598. <div class="section" id="id35">
  8599. <h3>Commands</h3>
  8600. <div class="section" id="lfconvert">
  8601. <h4>lfconvert</h4>
  8602. <p>convert a normal repository to a largefiles repository:</p>
  8603. <pre class="literal-block">
  8604. hg lfconvert SOURCE DEST [FILE ...]
  8605. </pre>
  8606. <p>Convert repository SOURCE to a new repository DEST, identical to
  8607. SOURCE except that certain files will be converted as largefiles:
  8608. specifically, any file that matches any PATTERN <em>or</em> whose size is
  8609. above the minimum size threshold is converted as a largefile. The
  8610. size used to determine whether or not to track a file as a
  8611. largefile is the size of the first version of the file. The
  8612. minimum size can be specified either with --size or in
  8613. configuration as <tt class="docutils literal">largefiles.size</tt>.</p>
  8614. <p>After running this command you will need to make sure that
  8615. largefiles is enabled anywhere you intend to push the new
  8616. repository.</p>
  8617. <p>Use --to-normal to convert largefiles back to normal files; after
  8618. this, the DEST repository can be used without largefiles at all.</p>
  8619. <p>Options:</p>
  8620. <table class="docutils option-list" frame="void" rules="none">
  8621. <col class="option" />
  8622. <col class="description" />
  8623. <tbody valign="top">
  8624. <tr><td class="option-group" colspan="2">
  8625. <kbd><span class="option">-s</span>, <span class="option">--size <var>&lt;SIZE&gt;</var></span></kbd></td>
  8626. </tr>
  8627. <tr><td>&nbsp;</td><td>minimum size (MB) for files to be converted as largefiles</td></tr>
  8628. <tr><td class="option-group">
  8629. <kbd><span class="option">--to-normal</span></kbd></td>
  8630. <td>convert from a largefiles repo to a normal repo</td></tr>
  8631. </tbody>
  8632. </table>
  8633. </div>
  8634. <div class="section" id="lfpull">
  8635. <h4>lfpull</h4>
  8636. <p>pull largefiles for the specified revisions from the specified source:</p>
  8637. <pre class="literal-block">
  8638. hg lfpull -r REV... [-e CMD] [--remotecmd CMD] [SOURCE]
  8639. </pre>
  8640. <p>Pull largefiles that are referenced from local changesets but missing
  8641. locally, pulling from a remote repository to the local cache.</p>
  8642. <p>If SOURCE is omitted, the 'default' path will be used.
  8643. See <a class="reference external" href="hg.1.html#urls"><tt class="docutils literal">hg help urls</tt></a> for more information.</p>
  8644. <div class="verbose container">
  8645. <p>Some examples:</p>
  8646. <ul>
  8647. <li><p class="first">pull largefiles for all branch heads:</p>
  8648. <pre class="literal-block">
  8649. hg lfpull -r &quot;head() and not closed()&quot;
  8650. </pre>
  8651. </li>
  8652. <li><p class="first">pull largefiles on the default branch:</p>
  8653. <pre class="literal-block">
  8654. hg lfpull -r &quot;branch(default)&quot;
  8655. </pre>
  8656. </li>
  8657. </ul>
  8658. </div>
  8659. <p>Options:</p>
  8660. <table class="docutils option-list" frame="void" rules="none">
  8661. <col class="option" />
  8662. <col class="description" />
  8663. <tbody valign="top">
  8664. <tr><td class="option-group" colspan="2">
  8665. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;VALUE[+]&gt;</var></span></kbd></td>
  8666. </tr>
  8667. <tr><td>&nbsp;</td><td>pull largefiles for these revisions</td></tr>
  8668. <tr><td class="option-group" colspan="2">
  8669. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  8670. </tr>
  8671. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  8672. <tr><td class="option-group" colspan="2">
  8673. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  8674. </tr>
  8675. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  8676. <tr><td class="option-group">
  8677. <kbd><span class="option">--insecure</span></kbd></td>
  8678. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  8679. </tbody>
  8680. </table>
  8681. <p>[+] marked option can be specified multiple times</p>
  8682. </div>
  8683. </div>
  8684. </div>
  8685. <div class="section" id="mq">
  8686. <h2><a class="toc-backref" href="#id106">mq</a></h2>
  8687. <p>manage a stack of patches</p>
  8688. <p>This extension lets you work with a stack of patches in a Mercurial
  8689. repository. It manages two stacks of patches - all known patches, and
  8690. applied patches (subset of known patches).</p>
  8691. <p>Known patches are represented as patch files in the .hg/patches
  8692. directory. Applied patches are both patch files and changesets.</p>
  8693. <p>Common tasks (use <a class="reference external" href="hg.1.html#command"><tt class="docutils literal">hg help command</tt></a> for more details):</p>
  8694. <pre class="literal-block">
  8695. create new patch                          qnew
  8696. import existing patch                     qimport
  8697.  
  8698. print patch series                        qseries
  8699. print applied patches                     qapplied
  8700.  
  8701. add known patch to applied stack          qpush
  8702. remove patch from applied stack           qpop
  8703. refresh contents of top applied patch     qrefresh
  8704. </pre>
  8705. <p>By default, mq will automatically use git patches when required to
  8706. avoid losing file mode changes, copy records, binary files or empty
  8707. files creations or deletions. This behaviour can be configured with:</p>
  8708. <pre class="literal-block">
  8709. [mq]
  8710. git = auto/keep/yes/no
  8711. </pre>
  8712. <p>If set to 'keep', mq will obey the [diff] section configuration while
  8713. preserving existing git patches upon qrefresh. If set to 'yes' or
  8714. 'no', mq will override the [diff] section and always generate git or
  8715. regular patches, possibly losing data in the second case.</p>
  8716. <p>It may be desirable for mq changesets to be kept in the secret phase (see
  8717. <a class="reference external" href="hg.1.html#phases"><tt class="docutils literal">hg help phases</tt></a>), which can be enabled with the following setting:</p>
  8718. <pre class="literal-block">
  8719. [mq]
  8720. secret = True
  8721. </pre>
  8722. <p>You will by default be managing a patch queue named &quot;patches&quot;. You can
  8723. create other, independent patch queues with the <a class="reference external" href="hg.1.html#qqueue"><tt class="docutils literal">hg qqueue</tt></a> command.</p>
  8724. <p>If the working directory contains uncommitted files, qpush, qpop and
  8725. qgoto abort immediately. If -f/--force is used, the changes are
  8726. discarded. Setting:</p>
  8727. <pre class="literal-block">
  8728. [mq]
  8729. keepchanges = True
  8730. </pre>
  8731. <p>make them behave as if --keep-changes were passed, and non-conflicting
  8732. local changes will be tolerated and preserved. If incompatible options
  8733. such as -f/--force or --exact are passed, this setting is ignored.</p>
  8734. <p>This extension used to provide a strip command. This command now lives
  8735. in the strip extension.</p>
  8736. <div class="section" id="id36">
  8737. <h3>Commands</h3>
  8738. <div class="section" id="qapplied">
  8739. <h4>qapplied</h4>
  8740. <p>print the patches already applied:</p>
  8741. <pre class="literal-block">
  8742. hg qapplied [-1] [-s] [PATCH]
  8743. </pre>
  8744. <p>Returns 0 on success.</p>
  8745. <p>Options:</p>
  8746. <table class="docutils option-list" frame="void" rules="none">
  8747. <col class="option" />
  8748. <col class="description" />
  8749. <tbody valign="top">
  8750. <tr><td class="option-group">
  8751. <kbd><span class="option">-1</span>, <span class="option">--last</span></kbd></td>
  8752. <td>show only the preceding applied patch</td></tr>
  8753. <tr><td class="option-group">
  8754. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  8755. <td>print first line of patch header</td></tr>
  8756. </tbody>
  8757. </table>
  8758. </div>
  8759. <div class="section" id="qclone">
  8760. <h4>qclone</h4>
  8761. <p>clone main and patch repository at same time:</p>
  8762. <pre class="literal-block">
  8763. hg qclone [OPTION]... SOURCE [DEST]
  8764. </pre>
  8765. <p>If source is local, destination will have no patches applied. If
  8766. source is remote, this command can not check if patches are
  8767. applied in source, so cannot guarantee that patches are not
  8768. applied in destination. If you clone remote repository, be sure
  8769. before that it has no patches applied.</p>
  8770. <p>Source patch repository is looked for in &lt;src&gt;/.hg/patches by
  8771. default. Use -p &lt;url&gt; to change.</p>
  8772. <p>The patch directory must be a nested Mercurial repository, as
  8773. would be created by <a class="reference external" href="hg.1.html#init"><tt class="docutils literal">hg init <span class="pre">--mq</span></tt></a>.</p>
  8774. <p>Return 0 on success.</p>
  8775. <p>Options:</p>
  8776. <table class="docutils option-list" frame="void" rules="none">
  8777. <col class="option" />
  8778. <col class="description" />
  8779. <tbody valign="top">
  8780. <tr><td class="option-group">
  8781. <kbd><span class="option">--pull</span></kbd></td>
  8782. <td>use pull protocol to copy metadata</td></tr>
  8783. <tr><td class="option-group">
  8784. <kbd><span class="option">-U</span>, <span class="option">--noupdate</span></kbd></td>
  8785. <td>do not update the new working directories</td></tr>
  8786. <tr><td class="option-group">
  8787. <kbd><span class="option">--uncompressed</span></kbd></td>
  8788. <td>use uncompressed transfer (fast over LAN)</td></tr>
  8789. <tr><td class="option-group" colspan="2">
  8790. <kbd><span class="option">-p</span>, <span class="option">--patches <var>&lt;REPO&gt;</var></span></kbd></td>
  8791. </tr>
  8792. <tr><td>&nbsp;</td><td>location of source patch repository</td></tr>
  8793. <tr><td class="option-group" colspan="2">
  8794. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  8795. </tr>
  8796. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  8797. <tr><td class="option-group" colspan="2">
  8798. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  8799. </tr>
  8800. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  8801. <tr><td class="option-group">
  8802. <kbd><span class="option">--insecure</span></kbd></td>
  8803. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  8804. </tbody>
  8805. </table>
  8806. </div>
  8807. <div class="section" id="qcommit">
  8808. <h4>qcommit</h4>
  8809. <p>commit changes in the queue repository (DEPRECATED):</p>
  8810. <pre class="literal-block">
  8811. hg qcommit [OPTION]... [FILE]...
  8812. </pre>
  8813. <p>This command is deprecated; use <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit <span class="pre">--mq</span></tt></a> instead.</p>
  8814. <p>Options:</p>
  8815. <table class="docutils option-list" frame="void" rules="none">
  8816. <col class="option" />
  8817. <col class="description" />
  8818. <tbody valign="top">
  8819. <tr><td class="option-group" colspan="2">
  8820. <kbd><span class="option">-A</span>, <span class="option">--addremove</span></kbd></td>
  8821. </tr>
  8822. <tr><td>&nbsp;</td><td>mark new/missing files as added/removed before committing</td></tr>
  8823. <tr><td class="option-group">
  8824. <kbd><span class="option">--close-branch</span></kbd></td>
  8825. <td>mark a branch head as closed</td></tr>
  8826. <tr><td class="option-group">
  8827. <kbd><span class="option">--amend</span></kbd></td>
  8828. <td>amend the parent of the working directory</td></tr>
  8829. <tr><td class="option-group">
  8830. <kbd><span class="option">-s</span>, <span class="option">--secret</span></kbd></td>
  8831. <td>use the secret phase for committing</td></tr>
  8832. <tr><td class="option-group">
  8833. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  8834. <td>invoke editor on commit messages</td></tr>
  8835. <tr><td class="option-group" colspan="2">
  8836. <kbd><span class="option">-i</span>, <span class="option">--interactive</span></kbd></td>
  8837. </tr>
  8838. <tr><td>&nbsp;</td><td>use interactive mode</td></tr>
  8839. <tr><td class="option-group" colspan="2">
  8840. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8841. </tr>
  8842. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  8843. <tr><td class="option-group" colspan="2">
  8844. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8845. </tr>
  8846. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  8847. <tr><td class="option-group" colspan="2">
  8848. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  8849. </tr>
  8850. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  8851. <tr><td class="option-group" colspan="2">
  8852. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  8853. </tr>
  8854. <tr><td>&nbsp;</td><td>read commit message from file</td></tr>
  8855. <tr><td class="option-group" colspan="2">
  8856. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  8857. </tr>
  8858. <tr><td>&nbsp;</td><td>record the specified date as commit date</td></tr>
  8859. <tr><td class="option-group" colspan="2">
  8860. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  8861. </tr>
  8862. <tr><td>&nbsp;</td><td>record the specified user as committer</td></tr>
  8863. <tr><td class="option-group">
  8864. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  8865. <td>recurse into subrepositories</td></tr>
  8866. </tbody>
  8867. </table>
  8868. <p>[+] marked option can be specified multiple times</p>
  8869. <blockquote>
  8870. aliases: qci</blockquote>
  8871. </div>
  8872. <div class="section" id="qdelete">
  8873. <h4>qdelete</h4>
  8874. <p>remove patches from queue:</p>
  8875. <pre class="literal-block">
  8876. hg qdelete [-k] [PATCH]...
  8877. </pre>
  8878. <p>The patches must not be applied, and at least one patch is required. Exact
  8879. patch identifiers must be given. With -k/--keep, the patch files are
  8880. preserved in the patch directory.</p>
  8881. <p>To stop managing a patch and move it into permanent history,
  8882. use the <a class="reference external" href="hg.1.html#qfinish"><tt class="docutils literal">hg qfinish</tt></a> command.</p>
  8883. <p>Options:</p>
  8884. <table class="docutils option-list" frame="void" rules="none">
  8885. <col class="option" />
  8886. <col class="description" />
  8887. <tbody valign="top">
  8888. <tr><td class="option-group">
  8889. <kbd><span class="option">-k</span>, <span class="option">--keep</span></kbd></td>
  8890. <td>keep patch file</td></tr>
  8891. <tr><td class="option-group" colspan="2">
  8892. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  8893. </tr>
  8894. <tr><td>&nbsp;</td><td>stop managing a revision (DEPRECATED)</td></tr>
  8895. </tbody>
  8896. </table>
  8897. <p>[+] marked option can be specified multiple times</p>
  8898. <blockquote>
  8899. aliases: qremove qrm</blockquote>
  8900. </div>
  8901. <div class="section" id="qdiff">
  8902. <h4>qdiff</h4>
  8903. <p>diff of the current patch and subsequent modifications:</p>
  8904. <pre class="literal-block">
  8905. hg qdiff [OPTION]... [FILE]...
  8906. </pre>
  8907. <p>Shows a diff which includes the current patch as well as any
  8908. changes which have been made in the working directory since the
  8909. last refresh (thus showing what the current patch would become
  8910. after a qrefresh).</p>
  8911. <p>Use <a class="reference external" href="hg.1.html#diff"><tt class="docutils literal">hg diff</tt></a> if you only want to see the changes made since the
  8912. last qrefresh, or <a class="reference external" href="hg.1.html#export"><tt class="docutils literal">hg export qtip</tt></a> if you want to see changes
  8913. made by the current patch without including changes made since the
  8914. qrefresh.</p>
  8915. <p>Returns 0 on success.</p>
  8916. <p>Options:</p>
  8917. <table class="docutils option-list" frame="void" rules="none">
  8918. <col class="option" />
  8919. <col class="description" />
  8920. <tbody valign="top">
  8921. <tr><td class="option-group">
  8922. <kbd><span class="option">-a</span>, <span class="option">--text</span></kbd></td>
  8923. <td>treat all files as text</td></tr>
  8924. <tr><td class="option-group">
  8925. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  8926. <td>use git extended diff format</td></tr>
  8927. <tr><td class="option-group">
  8928. <kbd><span class="option">--nodates</span></kbd></td>
  8929. <td>omit dates from diff headers</td></tr>
  8930. <tr><td class="option-group">
  8931. <kbd><span class="option">--noprefix</span></kbd></td>
  8932. <td>omit a/ and b/ prefixes from filenames</td></tr>
  8933. <tr><td class="option-group" colspan="2">
  8934. <kbd><span class="option">-p</span>, <span class="option">--show-function</span></kbd></td>
  8935. </tr>
  8936. <tr><td>&nbsp;</td><td>show which function each change is in</td></tr>
  8937. <tr><td class="option-group">
  8938. <kbd><span class="option">--reverse</span></kbd></td>
  8939. <td>produce a diff that undoes the changes</td></tr>
  8940. <tr><td class="option-group" colspan="2">
  8941. <kbd><span class="option">-w</span>, <span class="option">--ignore-all-space</span></kbd></td>
  8942. </tr>
  8943. <tr><td>&nbsp;</td><td>ignore white space when comparing lines</td></tr>
  8944. <tr><td class="option-group" colspan="2">
  8945. <kbd><span class="option">-b</span>, <span class="option">--ignore-space-change</span></kbd></td>
  8946. </tr>
  8947. <tr><td>&nbsp;</td><td>ignore changes in the amount of white space</td></tr>
  8948. <tr><td class="option-group" colspan="2">
  8949. <kbd><span class="option">-B</span>, <span class="option">--ignore-blank-lines</span></kbd></td>
  8950. </tr>
  8951. <tr><td>&nbsp;</td><td>ignore changes whose lines are all blank</td></tr>
  8952. <tr><td class="option-group" colspan="2">
  8953. <kbd><span class="option">-U</span>, <span class="option">--unified <var>&lt;NUM&gt;</var></span></kbd></td>
  8954. </tr>
  8955. <tr><td>&nbsp;</td><td>number of lines of context to show</td></tr>
  8956. <tr><td class="option-group">
  8957. <kbd><span class="option">--stat</span></kbd></td>
  8958. <td>output diffstat-style summary of changes</td></tr>
  8959. <tr><td class="option-group">
  8960. <kbd><span class="option">--root <var>&lt;DIR&gt;</var></span></kbd></td>
  8961. <td>produce diffs relative to subdirectory</td></tr>
  8962. <tr><td class="option-group" colspan="2">
  8963. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8964. </tr>
  8965. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  8966. <tr><td class="option-group" colspan="2">
  8967. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  8968. </tr>
  8969. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  8970. </tbody>
  8971. </table>
  8972. <p>[+] marked option can be specified multiple times</p>
  8973. </div>
  8974. <div class="section" id="qfinish">
  8975. <h4>qfinish</h4>
  8976. <p>move applied patches into repository history:</p>
  8977. <pre class="literal-block">
  8978. hg qfinish [-a] [REV]...
  8979. </pre>
  8980. <p>Finishes the specified revisions (corresponding to applied
  8981. patches) by moving them out of mq control into regular repository
  8982. history.</p>
  8983. <p>Accepts a revision range or the -a/--applied option. If --applied
  8984. is specified, all applied mq revisions are removed from mq
  8985. control. Otherwise, the given revisions must be at the base of the
  8986. stack of applied patches.</p>
  8987. <p>This can be especially useful if your changes have been applied to
  8988. an upstream repository, or if you are about to push your changes
  8989. to upstream.</p>
  8990. <p>Returns 0 on success.</p>
  8991. <p>Options:</p>
  8992. <table class="docutils option-list" frame="void" rules="none">
  8993. <col class="option" />
  8994. <col class="description" />
  8995. <tbody valign="top">
  8996. <tr><td class="option-group">
  8997. <kbd><span class="option">-a</span>, <span class="option">--applied</span></kbd></td>
  8998. <td>finish all applied changesets</td></tr>
  8999. </tbody>
  9000. </table>
  9001. </div>
  9002. <div class="section" id="qfold">
  9003. <h4>qfold</h4>
  9004. <p>fold the named patches into the current patch:</p>
  9005. <pre class="literal-block">
  9006. hg qfold [-e] [-k] [-m TEXT] [-l FILE] PATCH...
  9007. </pre>
  9008. <p>Patches must not yet be applied. Each patch will be successively
  9009. applied to the current patch in the order given. If all the
  9010. patches apply successfully, the current patch will be refreshed
  9011. with the new cumulative patch, and the folded patches will be
  9012. deleted. With -k/--keep, the folded patch files will not be
  9013. removed afterwards.</p>
  9014. <p>The header for each folded patch will be concatenated with the
  9015. current patch header, separated by a line of <tt class="docutils literal">* * *</tt>.</p>
  9016. <p>Returns 0 on success.</p>
  9017. <p>Options:</p>
  9018. <table class="docutils option-list" frame="void" rules="none">
  9019. <col class="option" />
  9020. <col class="description" />
  9021. <tbody valign="top">
  9022. <tr><td class="option-group">
  9023. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  9024. <td>invoke editor on commit messages</td></tr>
  9025. <tr><td class="option-group">
  9026. <kbd><span class="option">-k</span>, <span class="option">--keep</span></kbd></td>
  9027. <td>keep folded patch files</td></tr>
  9028. <tr><td class="option-group" colspan="2">
  9029. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  9030. </tr>
  9031. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  9032. <tr><td class="option-group" colspan="2">
  9033. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  9034. </tr>
  9035. <tr><td>&nbsp;</td><td>read commit message from file</td></tr>
  9036. </tbody>
  9037. </table>
  9038. </div>
  9039. <div class="section" id="qgoto">
  9040. <h4>qgoto</h4>
  9041. <p>push or pop patches until named patch is at top of stack:</p>
  9042. <pre class="literal-block">
  9043. hg qgoto [OPTION]... PATCH
  9044. </pre>
  9045. <p>Returns 0 on success.</p>
  9046. <p>Options:</p>
  9047. <table class="docutils option-list" frame="void" rules="none">
  9048. <col class="option" />
  9049. <col class="description" />
  9050. <tbody valign="top">
  9051. <tr><td class="option-group">
  9052. <kbd><span class="option">--keep-changes</span></kbd></td>
  9053. <td>tolerate non-conflicting local changes</td></tr>
  9054. <tr><td class="option-group">
  9055. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  9056. <td>overwrite any local changes</td></tr>
  9057. <tr><td class="option-group">
  9058. <kbd><span class="option">--no-backup</span></kbd></td>
  9059. <td>do not save backup copies of files</td></tr>
  9060. </tbody>
  9061. </table>
  9062. </div>
  9063. <div class="section" id="qguard">
  9064. <h4>qguard</h4>
  9065. <p>set or print guards for a patch:</p>
  9066. <pre class="literal-block">
  9067. hg qguard [-l] [-n] [PATCH] [-- [+GUARD]... [-GUARD]...]
  9068. </pre>
  9069. <p>Guards control whether a patch can be pushed. A patch with no
  9070. guards is always pushed. A patch with a positive guard (&quot;+foo&quot;) is
  9071. pushed only if the <a class="reference external" href="hg.1.html#qselect"><tt class="docutils literal">hg qselect</tt></a> command has activated it. A patch with
  9072. a negative guard (&quot;-foo&quot;) is never pushed if the <a class="reference external" href="hg.1.html#qselect"><tt class="docutils literal">hg qselect</tt></a> command
  9073. has activated it.</p>
  9074. <p>With no arguments, print the currently active guards.
  9075. With arguments, set guards for the named patch.</p>
  9076. <div class="note">
  9077. <p class="first admonition-title">Note</p>
  9078. <p class="last">Specifying negative guards now requires '--'.</p>
  9079. </div>
  9080. <p>To set guards on another patch:</p>
  9081. <pre class="literal-block">
  9082. hg qguard other.patch -- +2.6.17 -stable
  9083. </pre>
  9084. <p>Returns 0 on success.</p>
  9085. <p>Options:</p>
  9086. <table class="docutils option-list" frame="void" rules="none">
  9087. <col class="option" />
  9088. <col class="description" />
  9089. <tbody valign="top">
  9090. <tr><td class="option-group">
  9091. <kbd><span class="option">-l</span>, <span class="option">--list</span></kbd></td>
  9092. <td>list all patches and guards</td></tr>
  9093. <tr><td class="option-group">
  9094. <kbd><span class="option">-n</span>, <span class="option">--none</span></kbd></td>
  9095. <td>drop all guards</td></tr>
  9096. </tbody>
  9097. </table>
  9098. </div>
  9099. <div class="section" id="qheader">
  9100. <h4>qheader</h4>
  9101. <p>print the header of the topmost or specified patch:</p>
  9102. <pre class="literal-block">
  9103. hg qheader [PATCH]
  9104. </pre>
  9105. <p>Returns 0 on success.</p>
  9106. </div>
  9107. <div class="section" id="qimport">
  9108. <h4>qimport</h4>
  9109. <p>import a patch or existing changeset:</p>
  9110. <pre class="literal-block">
  9111. hg qimport [-e] [-n NAME] [-f] [-g] [-P] [-r REV]... [FILE]...
  9112. </pre>
  9113. <p>The patch is inserted into the series after the last applied
  9114. patch. If no patches have been applied, qimport prepends the patch
  9115. to the series.</p>
  9116. <p>The patch will have the same name as its source file unless you
  9117. give it a new one with -n/--name.</p>
  9118. <p>You can register an existing patch inside the patch directory with
  9119. the -e/--existing flag.</p>
  9120. <p>With -f/--force, an existing patch of the same name will be
  9121. overwritten.</p>
  9122. <p>An existing changeset may be placed under mq control with -r/--rev
  9123. (e.g. qimport --rev . -n patch will place the current revision
  9124. under mq control). With -g/--git, patches imported with --rev will
  9125. use the git diff format. See the diffs help topic for information
  9126. on why this is important for preserving rename/copy information
  9127. and permission changes. Use <a class="reference external" href="hg.1.html#qfinish"><tt class="docutils literal">hg qfinish</tt></a> to remove changesets
  9128. from mq control.</p>
  9129. <p>To import a patch from standard input, pass - as the patch file.
  9130. When importing from standard input, a patch name must be specified
  9131. using the --name flag.</p>
  9132. <p>To import an existing patch while renaming it:</p>
  9133. <pre class="literal-block">
  9134. hg qimport -e existing-patch -n new-name
  9135. </pre>
  9136. <p>Returns 0 if import succeeded.</p>
  9137. <p>Options:</p>
  9138. <table class="docutils option-list" frame="void" rules="none">
  9139. <col class="option" />
  9140. <col class="description" />
  9141. <tbody valign="top">
  9142. <tr><td class="option-group">
  9143. <kbd><span class="option">-e</span>, <span class="option">--existing</span></kbd></td>
  9144. <td>import file in patch directory</td></tr>
  9145. <tr><td class="option-group" colspan="2">
  9146. <kbd><span class="option">-n</span>, <span class="option">--name <var>&lt;NAME&gt;</var></span></kbd></td>
  9147. </tr>
  9148. <tr><td>&nbsp;</td><td>name of patch file</td></tr>
  9149. <tr><td class="option-group">
  9150. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  9151. <td>overwrite existing files</td></tr>
  9152. <tr><td class="option-group" colspan="2">
  9153. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  9154. </tr>
  9155. <tr><td>&nbsp;</td><td>place existing revisions under mq control</td></tr>
  9156. <tr><td class="option-group">
  9157. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  9158. <td>use git extended diff format</td></tr>
  9159. <tr><td class="option-group">
  9160. <kbd><span class="option">-P</span>, <span class="option">--push</span></kbd></td>
  9161. <td>qpush after importing</td></tr>
  9162. </tbody>
  9163. </table>
  9164. <p>[+] marked option can be specified multiple times</p>
  9165. </div>
  9166. <div class="section" id="qinit">
  9167. <h4>qinit</h4>
  9168. <p>init a new queue repository (DEPRECATED):</p>
  9169. <pre class="literal-block">
  9170. hg qinit [-c]
  9171. </pre>
  9172. <p>The queue repository is unversioned by default. If
  9173. -c/--create-repo is specified, qinit will create a separate nested
  9174. repository for patches (qinit -c may also be run later to convert
  9175. an unversioned patch repository into a versioned one). You can use
  9176. qcommit to commit changes to this queue repository.</p>
  9177. <p>This command is deprecated. Without -c, it's implied by other relevant
  9178. commands. With -c, use <a class="reference external" href="hg.1.html#init"><tt class="docutils literal">hg init <span class="pre">--mq</span></tt></a> instead.</p>
  9179. <p>Options:</p>
  9180. <table class="docutils option-list" frame="void" rules="none">
  9181. <col class="option" />
  9182. <col class="description" />
  9183. <tbody valign="top">
  9184. <tr><td class="option-group" colspan="2">
  9185. <kbd><span class="option">-c</span>, <span class="option">--create-repo</span></kbd></td>
  9186. </tr>
  9187. <tr><td>&nbsp;</td><td>create queue repository</td></tr>
  9188. </tbody>
  9189. </table>
  9190. </div>
  9191. <div class="section" id="qnew">
  9192. <h4>qnew</h4>
  9193. <p>create a new patch:</p>
  9194. <pre class="literal-block">
  9195. hg qnew [-e] [-m TEXT] [-l FILE] PATCH [FILE]...
  9196. </pre>
  9197. <p>qnew creates a new patch on top of the currently-applied patch (if
  9198. any). The patch will be initialized with any outstanding changes
  9199. in the working directory. You may also use -I/--include,
  9200. -X/--exclude, and/or a list of files after the patch name to add
  9201. only changes to matching files to the new patch, leaving the rest
  9202. as uncommitted modifications.</p>
  9203. <p>-u/--user and -d/--date can be used to set the (given) user and
  9204. date, respectively. -U/--currentuser and -D/--currentdate set user
  9205. to current user and date to current date.</p>
  9206. <p>-e/--edit, -m/--message or -l/--logfile set the patch header as
  9207. well as the commit message. If none is specified, the header is
  9208. empty and the commit message is '[mq]: PATCH'.</p>
  9209. <p>Use the -g/--git option to keep the patch in the git extended diff
  9210. format. Read the diffs help topic for more information on why this
  9211. is important for preserving permission changes and copy/rename
  9212. information.</p>
  9213. <p>Returns 0 on successful creation of a new patch.</p>
  9214. <p>Options:</p>
  9215. <table class="docutils option-list" frame="void" rules="none">
  9216. <col class="option" />
  9217. <col class="description" />
  9218. <tbody valign="top">
  9219. <tr><td class="option-group">
  9220. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  9221. <td>invoke editor on commit messages</td></tr>
  9222. <tr><td class="option-group">
  9223. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  9224. <td>import uncommitted changes (DEPRECATED)</td></tr>
  9225. <tr><td class="option-group">
  9226. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  9227. <td>use git extended diff format</td></tr>
  9228. <tr><td class="option-group" colspan="2">
  9229. <kbd><span class="option">-U</span>, <span class="option">--currentuser</span></kbd></td>
  9230. </tr>
  9231. <tr><td>&nbsp;</td><td>add &quot;From: &lt;current user&gt;&quot; to patch</td></tr>
  9232. <tr><td class="option-group" colspan="2">
  9233. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  9234. </tr>
  9235. <tr><td>&nbsp;</td><td>add &quot;From: &lt;USER&gt;&quot; to patch</td></tr>
  9236. <tr><td class="option-group" colspan="2">
  9237. <kbd><span class="option">-D</span>, <span class="option">--currentdate</span></kbd></td>
  9238. </tr>
  9239. <tr><td>&nbsp;</td><td>add &quot;Date: &lt;current date&gt;&quot; to patch</td></tr>
  9240. <tr><td class="option-group" colspan="2">
  9241. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  9242. </tr>
  9243. <tr><td>&nbsp;</td><td>add &quot;Date: &lt;DATE&gt;&quot; to patch</td></tr>
  9244. <tr><td class="option-group" colspan="2">
  9245. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  9246. </tr>
  9247. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  9248. <tr><td class="option-group" colspan="2">
  9249. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  9250. </tr>
  9251. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  9252. <tr><td class="option-group" colspan="2">
  9253. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  9254. </tr>
  9255. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  9256. <tr><td class="option-group" colspan="2">
  9257. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  9258. </tr>
  9259. <tr><td>&nbsp;</td><td>read commit message from file</td></tr>
  9260. </tbody>
  9261. </table>
  9262. <p>[+] marked option can be specified multiple times</p>
  9263. </div>
  9264. <div class="section" id="qnext">
  9265. <h4>qnext</h4>
  9266. <p>print the name of the next pushable patch:</p>
  9267. <pre class="literal-block">
  9268. hg qnext [-s]
  9269. </pre>
  9270. <p>Returns 0 on success.</p>
  9271. <p>Options:</p>
  9272. <table class="docutils option-list" frame="void" rules="none">
  9273. <col class="option" />
  9274. <col class="description" />
  9275. <tbody valign="top">
  9276. <tr><td class="option-group">
  9277. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  9278. <td>print first line of patch header</td></tr>
  9279. </tbody>
  9280. </table>
  9281. </div>
  9282. <div class="section" id="qpop">
  9283. <h4>qpop</h4>
  9284. <p>pop the current patch off the stack:</p>
  9285. <pre class="literal-block">
  9286. hg qpop [-a] [-f] [PATCH | INDEX]
  9287. </pre>
  9288. <p>Without argument, pops off the top of the patch stack. If given a
  9289. patch name, keeps popping off patches until the named patch is at
  9290. the top of the stack.</p>
  9291. <p>By default, abort if the working directory contains uncommitted
  9292. changes. With --keep-changes, abort only if the uncommitted files
  9293. overlap with patched files. With -f/--force, backup and discard
  9294. changes made to such files.</p>
  9295. <p>Return 0 on success.</p>
  9296. <p>Options:</p>
  9297. <table class="docutils option-list" frame="void" rules="none">
  9298. <col class="option" />
  9299. <col class="description" />
  9300. <tbody valign="top">
  9301. <tr><td class="option-group">
  9302. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  9303. <td>pop all patches</td></tr>
  9304. <tr><td class="option-group" colspan="2">
  9305. <kbd><span class="option">-n</span>, <span class="option">--name <var>&lt;NAME&gt;</var></span></kbd></td>
  9306. </tr>
  9307. <tr><td>&nbsp;</td><td>queue name to pop (DEPRECATED)</td></tr>
  9308. <tr><td class="option-group">
  9309. <kbd><span class="option">--keep-changes</span></kbd></td>
  9310. <td>tolerate non-conflicting local changes</td></tr>
  9311. <tr><td class="option-group">
  9312. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  9313. <td>forget any local changes to patched files</td></tr>
  9314. <tr><td class="option-group">
  9315. <kbd><span class="option">--no-backup</span></kbd></td>
  9316. <td>do not save backup copies of files</td></tr>
  9317. </tbody>
  9318. </table>
  9319. </div>
  9320. <div class="section" id="qprev">
  9321. <h4>qprev</h4>
  9322. <p>print the name of the preceding applied patch:</p>
  9323. <pre class="literal-block">
  9324. hg qprev [-s]
  9325. </pre>
  9326. <p>Returns 0 on success.</p>
  9327. <p>Options:</p>
  9328. <table class="docutils option-list" frame="void" rules="none">
  9329. <col class="option" />
  9330. <col class="description" />
  9331. <tbody valign="top">
  9332. <tr><td class="option-group">
  9333. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  9334. <td>print first line of patch header</td></tr>
  9335. </tbody>
  9336. </table>
  9337. </div>
  9338. <div class="section" id="qpush">
  9339. <h4>qpush</h4>
  9340. <p>push the next patch onto the stack:</p>
  9341. <pre class="literal-block">
  9342. hg qpush [-f] [-l] [-a] [--move] [PATCH | INDEX]
  9343. </pre>
  9344. <p>By default, abort if the working directory contains uncommitted
  9345. changes. With --keep-changes, abort only if the uncommitted files
  9346. overlap with patched files. With -f/--force, backup and patch over
  9347. uncommitted changes.</p>
  9348. <p>Return 0 on success.</p>
  9349. <p>Options:</p>
  9350. <table class="docutils option-list" frame="void" rules="none">
  9351. <col class="option" />
  9352. <col class="description" />
  9353. <tbody valign="top">
  9354. <tr><td class="option-group">
  9355. <kbd><span class="option">--keep-changes</span></kbd></td>
  9356. <td>tolerate non-conflicting local changes</td></tr>
  9357. <tr><td class="option-group">
  9358. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  9359. <td>apply on top of local changes</td></tr>
  9360. <tr><td class="option-group">
  9361. <kbd><span class="option">-e</span>, <span class="option">--exact</span></kbd></td>
  9362. <td>apply the target patch to its recorded parent</td></tr>
  9363. <tr><td class="option-group">
  9364. <kbd><span class="option">-l</span>, <span class="option">--list</span></kbd></td>
  9365. <td>list patch name in commit text</td></tr>
  9366. <tr><td class="option-group">
  9367. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  9368. <td>apply all patches</td></tr>
  9369. <tr><td class="option-group">
  9370. <kbd><span class="option">-m</span>, <span class="option">--merge</span></kbd></td>
  9371. <td>merge from another queue (DEPRECATED)</td></tr>
  9372. <tr><td class="option-group" colspan="2">
  9373. <kbd><span class="option">-n</span>, <span class="option">--name <var>&lt;NAME&gt;</var></span></kbd></td>
  9374. </tr>
  9375. <tr><td>&nbsp;</td><td>merge queue name (DEPRECATED)</td></tr>
  9376. <tr><td class="option-group">
  9377. <kbd><span class="option">--move</span></kbd></td>
  9378. <td>reorder patch series and apply only the patch</td></tr>
  9379. <tr><td class="option-group">
  9380. <kbd><span class="option">--no-backup</span></kbd></td>
  9381. <td>do not save backup copies of files</td></tr>
  9382. </tbody>
  9383. </table>
  9384. </div>
  9385. <div class="section" id="qqueue">
  9386. <h4>qqueue</h4>
  9387. <p>manage multiple patch queues:</p>
  9388. <pre class="literal-block">
  9389. hg qqueue [OPTION] [QUEUE]
  9390. </pre>
  9391. <p>Supports switching between different patch queues, as well as creating
  9392. new patch queues and deleting existing ones.</p>
  9393. <p>Omitting a queue name or specifying -l/--list will show you the registered
  9394. queues - by default the &quot;normal&quot; patches queue is registered. The currently
  9395. active queue will be marked with &quot;(active)&quot;. Specifying --active will print
  9396. only the name of the active queue.</p>
  9397. <p>To create a new queue, use -c/--create. The queue is automatically made
  9398. active, except in the case where there are applied patches from the
  9399. currently active queue in the repository. Then the queue will only be
  9400. created and switching will fail.</p>
  9401. <p>To delete an existing queue, use --delete. You cannot delete the currently
  9402. active queue.</p>
  9403. <p>Returns 0 on success.</p>
  9404. <p>Options:</p>
  9405. <table class="docutils option-list" frame="void" rules="none">
  9406. <col class="option" />
  9407. <col class="description" />
  9408. <tbody valign="top">
  9409. <tr><td class="option-group">
  9410. <kbd><span class="option">-l</span>, <span class="option">--list</span></kbd></td>
  9411. <td>list all available queues</td></tr>
  9412. <tr><td class="option-group">
  9413. <kbd><span class="option">--active</span></kbd></td>
  9414. <td>print name of active queue</td></tr>
  9415. <tr><td class="option-group">
  9416. <kbd><span class="option">-c</span>, <span class="option">--create</span></kbd></td>
  9417. <td>create new queue</td></tr>
  9418. <tr><td class="option-group">
  9419. <kbd><span class="option">--rename</span></kbd></td>
  9420. <td>rename active queue</td></tr>
  9421. <tr><td class="option-group">
  9422. <kbd><span class="option">--delete</span></kbd></td>
  9423. <td>delete reference to queue</td></tr>
  9424. <tr><td class="option-group">
  9425. <kbd><span class="option">--purge</span></kbd></td>
  9426. <td>delete queue, and remove patch dir</td></tr>
  9427. </tbody>
  9428. </table>
  9429. </div>
  9430. <div class="section" id="qrefresh">
  9431. <h4>qrefresh</h4>
  9432. <p>update the current patch:</p>
  9433. <pre class="literal-block">
  9434. hg qrefresh [-I] [-X] [-e] [-m TEXT] [-l FILE] [-s] [FILE]...
  9435. </pre>
  9436. <p>If any file patterns are provided, the refreshed patch will
  9437. contain only the modifications that match those patterns; the
  9438. remaining modifications will remain in the working directory.</p>
  9439. <p>If -s/--short is specified, files currently included in the patch
  9440. will be refreshed just like matched files and remain in the patch.</p>
  9441. <p>If -e/--edit is specified, Mercurial will start your configured editor for
  9442. you to enter a message. In case qrefresh fails, you will find a backup of
  9443. your message in <tt class="docutils literal"><span class="pre">.hg/last-message.txt</span></tt>.</p>
  9444. <p>hg add/remove/copy/rename work as usual, though you might want to
  9445. use git-style patches (-g/--git or [diff] git=1) to track copies
  9446. and renames. See the diffs help topic for more information on the
  9447. git diff format.</p>
  9448. <p>Returns 0 on success.</p>
  9449. <p>Options:</p>
  9450. <table class="docutils option-list" frame="void" rules="none">
  9451. <col class="option" />
  9452. <col class="description" />
  9453. <tbody valign="top">
  9454. <tr><td class="option-group">
  9455. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  9456. <td>invoke editor on commit messages</td></tr>
  9457. <tr><td class="option-group">
  9458. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  9459. <td>use git extended diff format</td></tr>
  9460. <tr><td class="option-group">
  9461. <kbd><span class="option">-s</span>, <span class="option">--short</span></kbd></td>
  9462. <td>refresh only files already in the patch and specified files</td></tr>
  9463. <tr><td class="option-group" colspan="2">
  9464. <kbd><span class="option">-U</span>, <span class="option">--currentuser</span></kbd></td>
  9465. </tr>
  9466. <tr><td>&nbsp;</td><td>add/update author field in patch with current user</td></tr>
  9467. <tr><td class="option-group" colspan="2">
  9468. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  9469. </tr>
  9470. <tr><td>&nbsp;</td><td>add/update author field in patch with given user</td></tr>
  9471. <tr><td class="option-group" colspan="2">
  9472. <kbd><span class="option">-D</span>, <span class="option">--currentdate</span></kbd></td>
  9473. </tr>
  9474. <tr><td>&nbsp;</td><td>add/update date field in patch with current date</td></tr>
  9475. <tr><td class="option-group" colspan="2">
  9476. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  9477. </tr>
  9478. <tr><td>&nbsp;</td><td>add/update date field in patch with given date</td></tr>
  9479. <tr><td class="option-group" colspan="2">
  9480. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  9481. </tr>
  9482. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  9483. <tr><td class="option-group" colspan="2">
  9484. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  9485. </tr>
  9486. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  9487. <tr><td class="option-group" colspan="2">
  9488. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  9489. </tr>
  9490. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  9491. <tr><td class="option-group" colspan="2">
  9492. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  9493. </tr>
  9494. <tr><td>&nbsp;</td><td>read commit message from file</td></tr>
  9495. </tbody>
  9496. </table>
  9497. <p>[+] marked option can be specified multiple times</p>
  9498. </div>
  9499. <div class="section" id="qrename">
  9500. <h4>qrename</h4>
  9501. <p>rename a patch:</p>
  9502. <pre class="literal-block">
  9503. hg qrename PATCH1 [PATCH2]
  9504. </pre>
  9505. <p>With one argument, renames the current patch to PATCH1.
  9506. With two arguments, renames PATCH1 to PATCH2.</p>
  9507. <p>Returns 0 on success.</p>
  9508. <blockquote>
  9509. aliases: qmv</blockquote>
  9510. </div>
  9511. <div class="section" id="qrestore">
  9512. <h4>qrestore</h4>
  9513. <p>restore the queue state saved by a revision (DEPRECATED):</p>
  9514. <pre class="literal-block">
  9515. hg qrestore [-d] [-u] REV
  9516. </pre>
  9517. <p>This command is deprecated, use <a class="reference external" href="hg.1.html#rebase"><tt class="docutils literal">hg rebase</tt></a> instead.</p>
  9518. <p>Options:</p>
  9519. <table class="docutils option-list" frame="void" rules="none">
  9520. <col class="option" />
  9521. <col class="description" />
  9522. <tbody valign="top">
  9523. <tr><td class="option-group">
  9524. <kbd><span class="option">-d</span>, <span class="option">--delete</span></kbd></td>
  9525. <td>delete save entry</td></tr>
  9526. <tr><td class="option-group">
  9527. <kbd><span class="option">-u</span>, <span class="option">--update</span></kbd></td>
  9528. <td>update queue working directory</td></tr>
  9529. </tbody>
  9530. </table>
  9531. </div>
  9532. <div class="section" id="qsave">
  9533. <h4>qsave</h4>
  9534. <p>save current queue state (DEPRECATED):</p>
  9535. <pre class="literal-block">
  9536. hg qsave [-m TEXT] [-l FILE] [-c] [-n NAME] [-e] [-f]
  9537. </pre>
  9538. <p>This command is deprecated, use <a class="reference external" href="hg.1.html#rebase"><tt class="docutils literal">hg rebase</tt></a> instead.</p>
  9539. <p>Options:</p>
  9540. <table class="docutils option-list" frame="void" rules="none">
  9541. <col class="option" />
  9542. <col class="description" />
  9543. <tbody valign="top">
  9544. <tr><td class="option-group">
  9545. <kbd><span class="option">-c</span>, <span class="option">--copy</span></kbd></td>
  9546. <td>copy patch directory</td></tr>
  9547. <tr><td class="option-group" colspan="2">
  9548. <kbd><span class="option">-n</span>, <span class="option">--name <var>&lt;NAME&gt;</var></span></kbd></td>
  9549. </tr>
  9550. <tr><td>&nbsp;</td><td>copy directory name</td></tr>
  9551. <tr><td class="option-group">
  9552. <kbd><span class="option">-e</span>, <span class="option">--empty</span></kbd></td>
  9553. <td>clear queue status file</td></tr>
  9554. <tr><td class="option-group">
  9555. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  9556. <td>force copy</td></tr>
  9557. <tr><td class="option-group" colspan="2">
  9558. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  9559. </tr>
  9560. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  9561. <tr><td class="option-group" colspan="2">
  9562. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  9563. </tr>
  9564. <tr><td>&nbsp;</td><td>read commit message from file</td></tr>
  9565. </tbody>
  9566. </table>
  9567. </div>
  9568. <div class="section" id="qselect">
  9569. <h4>qselect</h4>
  9570. <p>set or print guarded patches to push:</p>
  9571. <pre class="literal-block">
  9572. hg qselect [OPTION]... [GUARD]...
  9573. </pre>
  9574. <p>Use the <a class="reference external" href="hg.1.html#qguard"><tt class="docutils literal">hg qguard</tt></a> command to set or print guards on patch, then use
  9575. qselect to tell mq which guards to use. A patch will be pushed if
  9576. it has no guards or any positive guards match the currently
  9577. selected guard, but will not be pushed if any negative guards
  9578. match the current guard. For example:</p>
  9579. <pre class="literal-block">
  9580. qguard foo.patch -- -stable    (negative guard)
  9581. qguard bar.patch    +stable    (positive guard)
  9582. qselect stable
  9583. </pre>
  9584. <p>This activates the &quot;stable&quot; guard. mq will skip foo.patch (because
  9585. it has a negative match) but push bar.patch (because it has a
  9586. positive match).</p>
  9587. <p>With no arguments, prints the currently active guards.
  9588. With one argument, sets the active guard.</p>
  9589. <p>Use -n/--none to deactivate guards (no other arguments needed).
  9590. When no guards are active, patches with positive guards are
  9591. skipped and patches with negative guards are pushed.</p>
  9592. <p>qselect can change the guards on applied patches. It does not pop
  9593. guarded patches by default. Use --pop to pop back to the last
  9594. applied patch that is not guarded. Use --reapply (which implies
  9595. --pop) to push back to the current patch afterwards, but skip
  9596. guarded patches.</p>
  9597. <p>Use -s/--series to print a list of all guards in the series file
  9598. (no other arguments needed). Use -v for more information.</p>
  9599. <p>Returns 0 on success.</p>
  9600. <p>Options:</p>
  9601. <table class="docutils option-list" frame="void" rules="none">
  9602. <col class="option" />
  9603. <col class="description" />
  9604. <tbody valign="top">
  9605. <tr><td class="option-group">
  9606. <kbd><span class="option">-n</span>, <span class="option">--none</span></kbd></td>
  9607. <td>disable all guards</td></tr>
  9608. <tr><td class="option-group">
  9609. <kbd><span class="option">-s</span>, <span class="option">--series</span></kbd></td>
  9610. <td>list all guards in series file</td></tr>
  9611. <tr><td class="option-group">
  9612. <kbd><span class="option">--pop</span></kbd></td>
  9613. <td>pop to before first guarded applied patch</td></tr>
  9614. <tr><td class="option-group">
  9615. <kbd><span class="option">--reapply</span></kbd></td>
  9616. <td>pop, then reapply patches</td></tr>
  9617. </tbody>
  9618. </table>
  9619. </div>
  9620. <div class="section" id="qseries">
  9621. <h4>qseries</h4>
  9622. <p>print the entire series file:</p>
  9623. <pre class="literal-block">
  9624. hg qseries [-ms]
  9625. </pre>
  9626. <p>Returns 0 on success.</p>
  9627. <p>Options:</p>
  9628. <table class="docutils option-list" frame="void" rules="none">
  9629. <col class="option" />
  9630. <col class="description" />
  9631. <tbody valign="top">
  9632. <tr><td class="option-group">
  9633. <kbd><span class="option">-m</span>, <span class="option">--missing</span></kbd></td>
  9634. <td>print patches not in series</td></tr>
  9635. <tr><td class="option-group">
  9636. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  9637. <td>print first line of patch header</td></tr>
  9638. </tbody>
  9639. </table>
  9640. </div>
  9641. <div class="section" id="qtop">
  9642. <h4>qtop</h4>
  9643. <p>print the name of the current patch:</p>
  9644. <pre class="literal-block">
  9645. hg qtop [-s]
  9646. </pre>
  9647. <p>Returns 0 on success.</p>
  9648. <p>Options:</p>
  9649. <table class="docutils option-list" frame="void" rules="none">
  9650. <col class="option" />
  9651. <col class="description" />
  9652. <tbody valign="top">
  9653. <tr><td class="option-group">
  9654. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  9655. <td>print first line of patch header</td></tr>
  9656. </tbody>
  9657. </table>
  9658. </div>
  9659. <div class="section" id="qunapplied">
  9660. <h4>qunapplied</h4>
  9661. <p>print the patches not yet applied:</p>
  9662. <pre class="literal-block">
  9663. hg qunapplied [-1] [-s] [PATCH]
  9664. </pre>
  9665. <p>Returns 0 on success.</p>
  9666. <p>Options:</p>
  9667. <table class="docutils option-list" frame="void" rules="none">
  9668. <col class="option" />
  9669. <col class="description" />
  9670. <tbody valign="top">
  9671. <tr><td class="option-group">
  9672. <kbd><span class="option">-1</span>, <span class="option">--first</span></kbd></td>
  9673. <td>show only the first patch</td></tr>
  9674. <tr><td class="option-group">
  9675. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  9676. <td>print first line of patch header</td></tr>
  9677. </tbody>
  9678. </table>
  9679. </div>
  9680. </div>
  9681. </div>
  9682. <div class="section" id="notify">
  9683. <h2><a class="toc-backref" href="#id107">notify</a></h2>
  9684. <p>hooks for sending email push notifications</p>
  9685. <p>This extension implements hooks to send email notifications when
  9686. changesets are sent from or received by the local repository.</p>
  9687. <p>First, enable the extension as explained in <a class="reference external" href="hg.1.html#extensions"><tt class="docutils literal">hg help extensions</tt></a>, and
  9688. register the hook you want to run. <tt class="docutils literal">incoming</tt> and <tt class="docutils literal">changegroup</tt> hooks
  9689. are run when changesets are received, while <tt class="docutils literal">outgoing</tt> hooks are for
  9690. changesets sent to another repository:</p>
  9691. <pre class="literal-block">
  9692. [hooks]
  9693. # one email for each incoming changeset
  9694. incoming.notify = python:hgext.notify.hook
  9695. # one email for all incoming changesets
  9696. changegroup.notify = python:hgext.notify.hook
  9697.  
  9698. # one email for all outgoing changesets
  9699. outgoing.notify = python:hgext.notify.hook
  9700. </pre>
  9701. <p>This registers the hooks. To enable notification, subscribers must
  9702. be assigned to repositories. The <tt class="docutils literal">[usersubs]</tt> section maps multiple
  9703. repositories to a given recipient. The <tt class="docutils literal">[reposubs]</tt> section maps
  9704. multiple recipients to a single repository:</p>
  9705. <pre class="literal-block">
  9706. [usersubs]
  9707. # key is subscriber email, value is a comma-separated list of repo patterns
  9708. user&#64;host = pattern
  9709.  
  9710. [reposubs]
  9711. # key is repo pattern, value is a comma-separated list of subscriber emails
  9712. pattern = user&#64;host
  9713. </pre>
  9714. <p>A <tt class="docutils literal">pattern</tt> is a <tt class="docutils literal">glob</tt> matching the absolute path to a repository,
  9715. optionally combined with a revset expression. A revset expression, if
  9716. present, is separated from the glob by a hash. Example:</p>
  9717. <pre class="literal-block">
  9718. [reposubs]
  9719. */widgets#branch(release) = qa-team&#64;example.com
  9720. </pre>
  9721. <p>This sends to <tt class="docutils literal"><span class="pre">qa-team&#64;example.com</span></tt> whenever a changeset on the <tt class="docutils literal">release</tt>
  9722. branch triggers a notification in any repository ending in <tt class="docutils literal">widgets</tt>.</p>
  9723. <p>In order to place them under direct user management, <tt class="docutils literal">[usersubs]</tt> and
  9724. <tt class="docutils literal">[reposubs]</tt> sections may be placed in a separate <tt class="docutils literal">hgrc</tt> file and
  9725. incorporated by reference:</p>
  9726. <pre class="literal-block">
  9727. [notify]
  9728. config = /path/to/subscriptionsfile
  9729. </pre>
  9730. <p>Notifications will not be sent until the <tt class="docutils literal">notify.test</tt> value is set
  9731. to <tt class="docutils literal">False</tt>; see below.</p>
  9732. <p>Notifications content can be tweaked with the following configuration entries:</p>
  9733. <dl class="docutils">
  9734. <dt>notify.test</dt>
  9735. <dd>If <tt class="docutils literal">True</tt>, print messages to stdout instead of sending them. Default: True.</dd>
  9736. <dt>notify.sources</dt>
  9737. <dd><p class="first">Space-separated list of change sources. Notifications are activated only
  9738. when a changeset's source is in this list. Sources may be:</p>
  9739. <table class="docutils field-list" frame="void" rules="none">
  9740. <col class="field-name" />
  9741. <col class="field-body" />
  9742. <tbody valign="top">
  9743. <tr class="field"><th class="field-name"><tt class="docutils literal">serve</tt>:</th><td class="field-body">changesets received via http or ssh</td>
  9744. </tr>
  9745. <tr class="field"><th class="field-name"><tt class="docutils literal">pull</tt>:</th><td class="field-body">changesets received via <tt class="docutils literal">hg pull</tt></td>
  9746. </tr>
  9747. <tr class="field"><th class="field-name"><tt class="docutils literal">unbundle</tt>:</th><td class="field-body">changesets received via <tt class="docutils literal">hg unbundle</tt></td>
  9748. </tr>
  9749. <tr class="field"><th class="field-name"><tt class="docutils literal">push</tt>:</th><td class="field-body">changesets sent or received via <tt class="docutils literal">hg push</tt></td>
  9750. </tr>
  9751. <tr class="field"><th class="field-name"><tt class="docutils literal">bundle</tt>:</th><td class="field-body">changesets sent via <tt class="docutils literal">hg unbundle</tt></td>
  9752. </tr>
  9753. </tbody>
  9754. </table>
  9755. <p class="last">Default: serve.</p>
  9756. </dd>
  9757. <dt>notify.strip</dt>
  9758. <dd>Number of leading slashes to strip from url paths. By default, notifications
  9759. reference repositories with their absolute path. <tt class="docutils literal">notify.strip</tt> lets you
  9760. turn them into relative paths. For example, <tt class="docutils literal">notify.strip=3</tt> will change
  9761. <tt class="docutils literal">/long/path/repository</tt> into <tt class="docutils literal">repository</tt>. Default: 0.</dd>
  9762. <dt>notify.domain</dt>
  9763. <dd>Default email domain for sender or recipients with no explicit domain.</dd>
  9764. <dt>notify.style</dt>
  9765. <dd>Style file to use when formatting emails.</dd>
  9766. <dt>notify.template</dt>
  9767. <dd>Template to use when formatting emails.</dd>
  9768. <dt>notify.incoming</dt>
  9769. <dd>Template to use when run as an incoming hook, overriding <tt class="docutils literal">notify.template</tt>.</dd>
  9770. <dt>notify.outgoing</dt>
  9771. <dd>Template to use when run as an outgoing hook, overriding <tt class="docutils literal">notify.template</tt>.</dd>
  9772. <dt>notify.changegroup</dt>
  9773. <dd>Template to use when running as a changegroup hook, overriding
  9774. <tt class="docutils literal">notify.template</tt>.</dd>
  9775. <dt>notify.maxdiff</dt>
  9776. <dd>Maximum number of diff lines to include in notification email. Set to 0
  9777. to disable the diff, or -1 to include all of it. Default: 300.</dd>
  9778. <dt>notify.maxsubject</dt>
  9779. <dd>Maximum number of characters in email's subject line. Default: 67.</dd>
  9780. <dt>notify.diffstat</dt>
  9781. <dd>Set to True to include a diffstat before diff content. Default: True.</dd>
  9782. <dt>notify.merge</dt>
  9783. <dd>If True, send notifications for merge changesets. Default: True.</dd>
  9784. <dt>notify.mbox</dt>
  9785. <dd>If set, append mails to this mbox file instead of sending. Default: None.</dd>
  9786. <dt>notify.fromauthor</dt>
  9787. <dd>If set, use the committer of the first changeset in a changegroup for
  9788. the &quot;From&quot; field of the notification mail. If not set, take the user
  9789. from the pushing repo.  Default: False.</dd>
  9790. </dl>
  9791. <p>If set, the following entries will also be used to customize the
  9792. notifications:</p>
  9793. <dl class="docutils">
  9794. <dt>email.from</dt>
  9795. <dd>Email <tt class="docutils literal">From</tt> address to use if none can be found in the generated
  9796. email content.</dd>
  9797. <dt>web.baseurl</dt>
  9798. <dd>Root repository URL to combine with repository paths when making
  9799. references. See also <tt class="docutils literal">notify.strip</tt>.</dd>
  9800. </dl>
  9801. </div>
  9802. <div class="section" id="pager">
  9803. <h2><a class="toc-backref" href="#id108">pager</a></h2>
  9804. <p>browse command output with an external pager</p>
  9805. <p>To set the pager that should be used, set the application variable:</p>
  9806. <pre class="literal-block">
  9807. [pager]
  9808. pager = less -FRX
  9809. </pre>
  9810. <p>If no pager is set, the pager extensions uses the environment variable
  9811. $PAGER. If neither pager.pager, nor $PAGER is set, no pager is used.</p>
  9812. <p>You can disable the pager for certain commands by adding them to the
  9813. pager.ignore list:</p>
  9814. <pre class="literal-block">
  9815. [pager]
  9816. ignore = version, help, update
  9817. </pre>
  9818. <p>You can also enable the pager only for certain commands using
  9819. pager.attend. Below is the default list of commands to be paged:</p>
  9820. <pre class="literal-block">
  9821. [pager]
  9822. attend = annotate, cat, diff, export, glog, log, qdiff
  9823. </pre>
  9824. <p>Setting pager.attend to an empty value will cause all commands to be
  9825. paged.</p>
  9826. <p>If pager.attend is present, pager.ignore will be ignored.</p>
  9827. <p>Lastly, you can enable and disable paging for individual commands with
  9828. the attend-&lt;command&gt; option. This setting takes precedence over
  9829. existing attend and ignore options and defaults:</p>
  9830. <pre class="literal-block">
  9831. [pager]
  9832. attend-cat = false
  9833. </pre>
  9834. <p>To ignore global commands like <a class="reference external" href="hg.1.html#version"><tt class="docutils literal">hg version</tt></a> or <a class="reference external" href="hg.1.html#help"><tt class="docutils literal">hg help</tt></a>, you have
  9835. to specify them in your user configuration file.</p>
  9836. <p>The --pager=... option can also be used to control when the pager is
  9837. used. Use a boolean value like yes, no, on, off, or use auto for
  9838. normal behavior.</p>
  9839. </div>
  9840. <div class="section" id="patchbomb">
  9841. <h2><a class="toc-backref" href="#id109">patchbomb</a></h2>
  9842. <p>command to send changesets as (a series of) patch emails</p>
  9843. <p>The series is started off with a &quot;[PATCH 0 of N]&quot; introduction, which
  9844. describes the series as a whole.</p>
  9845. <p>Each patch email has a Subject line of &quot;[PATCH M of N] ...&quot;, using the
  9846. first line of the changeset description as the subject text. The
  9847. message contains two or three body parts:</p>
  9848. <ul class="simple">
  9849. <li>The changeset description.</li>
  9850. <li>[Optional] The result of running diffstat on the patch.</li>
  9851. <li>The patch itself, as generated by <a class="reference external" href="hg.1.html#export"><tt class="docutils literal">hg export</tt></a>.</li>
  9852. </ul>
  9853. <p>Each message refers to the first in the series using the In-Reply-To
  9854. and References headers, so they will show up as a sequence in threaded
  9855. mail and news readers, and in mail archives.</p>
  9856. <p>To configure other defaults, add a section like this to your
  9857. configuration file:</p>
  9858. <pre class="literal-block">
  9859. [email]
  9860. from = My Name &lt;my&#64;email&gt;
  9861. to = recipient1, recipient2, ...
  9862. cc = cc1, cc2, ...
  9863. bcc = bcc1, bcc2, ...
  9864. reply-to = address1, address2, ...
  9865. </pre>
  9866. <p>Use <tt class="docutils literal">[patchbomb]</tt> as configuration section name if you need to
  9867. override global <tt class="docutils literal">[email]</tt> address settings.</p>
  9868. <p>Then you can use the <a class="reference external" href="hg.1.html#email"><tt class="docutils literal">hg email</tt></a> command to mail a series of
  9869. changesets as a patchbomb.</p>
  9870. <p>You can also either configure the method option in the email section
  9871. to be a sendmail compatible mailer or fill out the [smtp] section so
  9872. that the patchbomb extension can automatically send patchbombs
  9873. directly from the commandline. See the [email] and [smtp] sections in
  9874. hgrc(5) for details.</p>
  9875. <p>You can control the default inclusion of an introduction message with the
  9876. <tt class="docutils literal">patchbomb.intro</tt> configuration option. The configuration is always
  9877. overwritten by command line flags like --intro and --desc:</p>
  9878. <pre class="literal-block">
  9879. [patchbomb]
  9880. intro=auto   # include introduction message if more than 1 patch (default)
  9881. intro=never  # never include an introduction message
  9882. intro=always # always include an introduction message
  9883. </pre>
  9884. <p>You can set patchbomb to always ask for confirmation by setting
  9885. <tt class="docutils literal">patchbomb.confirm</tt> to true.</p>
  9886. <div class="section" id="id37">
  9887. <h3>Commands</h3>
  9888. <div class="section" id="email">
  9889. <h4>email</h4>
  9890. <p>send changesets by email:</p>
  9891. <pre class="literal-block">
  9892. hg email [OPTION]... [DEST]...
  9893. </pre>
  9894. <p>By default, diffs are sent in the format generated by
  9895. <a class="reference external" href="hg.1.html#export"><tt class="docutils literal">hg export</tt></a>, one per message. The series starts with a &quot;[PATCH 0
  9896. of N]&quot; introduction, which describes the series as a whole.</p>
  9897. <p>Each patch email has a Subject line of &quot;[PATCH M of N] ...&quot;, using
  9898. the first line of the changeset description as the subject text.
  9899. The message contains two or three parts. First, the changeset
  9900. description.</p>
  9901. <p>With the -d/--diffstat option, if the diffstat program is
  9902. installed, the result of running diffstat on the patch is inserted.</p>
  9903. <p>Finally, the patch itself, as generated by <a class="reference external" href="hg.1.html#export"><tt class="docutils literal">hg export</tt></a>.</p>
  9904. <p>With the -d/--diffstat or --confirm options, you will be presented
  9905. with a final summary of all messages and asked for confirmation before
  9906. the messages are sent.</p>
  9907. <p>By default the patch is included as text in the email body for
  9908. easy reviewing. Using the -a/--attach option will instead create
  9909. an attachment for the patch. With -i/--inline an inline attachment
  9910. will be created. You can include a patch both as text in the email
  9911. body and as a regular or an inline attachment by combining the
  9912. -a/--attach or -i/--inline with the --body option.</p>
  9913. <p>With -o/--outgoing, emails will be generated for patches not found
  9914. in the destination repository (or only those which are ancestors
  9915. of the specified revisions if any are provided)</p>
  9916. <p>With -b/--bundle, changesets are selected as for --outgoing, but a
  9917. single email containing a binary Mercurial bundle as an attachment
  9918. will be sent.</p>
  9919. <p>With -m/--mbox, instead of previewing each patchbomb message in a
  9920. pager or sending the messages directly, it will create a UNIX
  9921. mailbox file with the patch emails. This mailbox file can be
  9922. previewed with any mail user agent which supports UNIX mbox
  9923. files.</p>
  9924. <p>With -n/--test, all steps will run, but mail will not be sent.
  9925. You will be prompted for an email recipient address, a subject and
  9926. an introductory message describing the patches of your patchbomb.
  9927. Then when all is done, patchbomb messages are displayed. If the
  9928. PAGER environment variable is set, your pager will be fired up once
  9929. for each patchbomb message, so you can verify everything is alright.</p>
  9930. <p>In case email sending fails, you will find a backup of your series
  9931. introductory message in <tt class="docutils literal"><span class="pre">.hg/last-email.txt</span></tt>.</p>
  9932. <p>The default behavior of this command can be customized through
  9933. configuration. (See <a class="reference external" href="hg.1.html#patchbomb"><tt class="docutils literal">hg help patchbomb</tt></a> for details)</p>
  9934. <p>Examples:</p>
  9935. <pre class="literal-block">
  9936. hg email -r 3000          # send patch 3000 only
  9937. hg email -r 3000 -r 3001  # send patches 3000 and 3001
  9938. hg email -r 3000:3005     # send patches 3000 through 3005
  9939. hg email 3000             # send patch 3000 (deprecated)
  9940.  
  9941. hg email -o               # send all patches not in default
  9942. hg email -o DEST          # send all patches not in DEST
  9943. hg email -o -r 3000       # send all ancestors of 3000 not in default
  9944. hg email -o -r 3000 DEST  # send all ancestors of 3000 not in DEST
  9945.  
  9946. hg email -b               # send bundle of all patches not in default
  9947. hg email -b DEST          # send bundle of all patches not in DEST
  9948. hg email -b -r 3000       # bundle of all ancestors of 3000 not in default
  9949. hg email -b -r 3000 DEST  # bundle of all ancestors of 3000 not in DEST
  9950.  
  9951. hg email -o -m mbox &amp;&amp;    # generate an mbox file...
  9952.   mutt -R -f mbox         # ... and view it with mutt
  9953. hg email -o -m mbox &amp;&amp;    # generate an mbox file ...
  9954.   formail -s sendmail \   # ... and use formail to send from the mbox
  9955.     -bm -t &lt; mbox         # ... using sendmail
  9956. </pre>
  9957. <p>Before using this command, you will need to enable email in your
  9958. hgrc. See the [email] section in hgrc(5) for details.</p>
  9959. <p>Options:</p>
  9960. <table class="docutils option-list" frame="void" rules="none">
  9961. <col class="option" />
  9962. <col class="description" />
  9963. <tbody valign="top">
  9964. <tr><td class="option-group">
  9965. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  9966. <td>use git extended diff format</td></tr>
  9967. <tr><td class="option-group">
  9968. <kbd><span class="option">--plain</span></kbd></td>
  9969. <td>omit hg patch header</td></tr>
  9970. <tr><td class="option-group">
  9971. <kbd><span class="option">-o</span>, <span class="option">--outgoing</span></kbd></td>
  9972. <td>send changes not found in the target repository</td></tr>
  9973. <tr><td class="option-group">
  9974. <kbd><span class="option">-b</span>, <span class="option">--bundle</span></kbd></td>
  9975. <td>send changes not in target as a binary bundle</td></tr>
  9976. <tr><td class="option-group" colspan="2">
  9977. <kbd><span class="option">--bundlename <var>&lt;NAME&gt;</var></span></kbd></td>
  9978. </tr>
  9979. <tr><td>&nbsp;</td><td>name of the bundle attachment file (default: bundle)</td></tr>
  9980. <tr><td class="option-group" colspan="2">
  9981. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  9982. </tr>
  9983. <tr><td>&nbsp;</td><td>a revision to send</td></tr>
  9984. <tr><td class="option-group">
  9985. <kbd><span class="option">--force</span></kbd></td>
  9986. <td>run even when remote repository is unrelated (with -b/--bundle)</td></tr>
  9987. <tr><td class="option-group" colspan="2">
  9988. <kbd><span class="option">--base <var>&lt;REV[+]&gt;</var></span></kbd></td>
  9989. </tr>
  9990. <tr><td>&nbsp;</td><td>a base changeset to specify instead of a destination (with -b/--bundle)</td></tr>
  9991. <tr><td class="option-group">
  9992. <kbd><span class="option">--intro</span></kbd></td>
  9993. <td>send an introduction email for a single patch</td></tr>
  9994. <tr><td class="option-group">
  9995. <kbd><span class="option">--body</span></kbd></td>
  9996. <td>send patches as inline message text (default)</td></tr>
  9997. <tr><td class="option-group">
  9998. <kbd><span class="option">-a</span>, <span class="option">--attach</span></kbd></td>
  9999. <td>send patches as attachments</td></tr>
  10000. <tr><td class="option-group">
  10001. <kbd><span class="option">-i</span>, <span class="option">--inline</span></kbd></td>
  10002. <td>send patches as inline attachments</td></tr>
  10003. <tr><td class="option-group" colspan="2">
  10004. <kbd><span class="option">--bcc <var>&lt;VALUE[+]&gt;</var></span></kbd></td>
  10005. </tr>
  10006. <tr><td>&nbsp;</td><td>email addresses of blind carbon copy recipients</td></tr>
  10007. <tr><td class="option-group" colspan="2">
  10008. <kbd><span class="option">-c</span>, <span class="option">--cc <var>&lt;VALUE[+]&gt;</var></span></kbd></td>
  10009. </tr>
  10010. <tr><td>&nbsp;</td><td>email addresses of copy recipients</td></tr>
  10011. <tr><td class="option-group">
  10012. <kbd><span class="option">--confirm</span></kbd></td>
  10013. <td>ask for confirmation before sending</td></tr>
  10014. <tr><td class="option-group">
  10015. <kbd><span class="option">-d</span>, <span class="option">--diffstat</span></kbd></td>
  10016. <td>add diffstat output to messages</td></tr>
  10017. <tr><td class="option-group">
  10018. <kbd><span class="option">--date <var>&lt;VALUE&gt;</var></span></kbd></td>
  10019. <td>use the given date as the sending date</td></tr>
  10020. <tr><td class="option-group">
  10021. <kbd><span class="option">--desc <var>&lt;VALUE&gt;</var></span></kbd></td>
  10022. <td>use the given file as the series description</td></tr>
  10023. <tr><td class="option-group" colspan="2">
  10024. <kbd><span class="option">-f</span>, <span class="option">--from <var>&lt;VALUE&gt;</var></span></kbd></td>
  10025. </tr>
  10026. <tr><td>&nbsp;</td><td>email address of sender</td></tr>
  10027. <tr><td class="option-group">
  10028. <kbd><span class="option">-n</span>, <span class="option">--test</span></kbd></td>
  10029. <td>print messages that would be sent</td></tr>
  10030. <tr><td class="option-group" colspan="2">
  10031. <kbd><span class="option">-m</span>, <span class="option">--mbox <var>&lt;VALUE&gt;</var></span></kbd></td>
  10032. </tr>
  10033. <tr><td>&nbsp;</td><td>write messages to mbox file instead of sending them</td></tr>
  10034. <tr><td class="option-group" colspan="2">
  10035. <kbd><span class="option">--reply-to <var>&lt;VALUE[+]&gt;</var></span></kbd></td>
  10036. </tr>
  10037. <tr><td>&nbsp;</td><td>email addresses replies should be sent to</td></tr>
  10038. <tr><td class="option-group" colspan="2">
  10039. <kbd><span class="option">-s</span>, <span class="option">--subject <var>&lt;VALUE&gt;</var></span></kbd></td>
  10040. </tr>
  10041. <tr><td>&nbsp;</td><td>subject of first message (intro or single patch)</td></tr>
  10042. <tr><td class="option-group" colspan="2">
  10043. <kbd><span class="option">--in-reply-to <var>&lt;VALUE&gt;</var></span></kbd></td>
  10044. </tr>
  10045. <tr><td>&nbsp;</td><td>message identifier to reply to</td></tr>
  10046. <tr><td class="option-group" colspan="2">
  10047. <kbd><span class="option">--flag <var>&lt;VALUE[+]&gt;</var></span></kbd></td>
  10048. </tr>
  10049. <tr><td>&nbsp;</td><td>flags to add in subject prefixes</td></tr>
  10050. <tr><td class="option-group" colspan="2">
  10051. <kbd><span class="option">-t</span>, <span class="option">--to <var>&lt;VALUE[+]&gt;</var></span></kbd></td>
  10052. </tr>
  10053. <tr><td>&nbsp;</td><td>email addresses of recipients</td></tr>
  10054. <tr><td class="option-group" colspan="2">
  10055. <kbd><span class="option">-e</span>, <span class="option">--ssh <var>&lt;CMD&gt;</var></span></kbd></td>
  10056. </tr>
  10057. <tr><td>&nbsp;</td><td>specify ssh command to use</td></tr>
  10058. <tr><td class="option-group" colspan="2">
  10059. <kbd><span class="option">--remotecmd <var>&lt;CMD&gt;</var></span></kbd></td>
  10060. </tr>
  10061. <tr><td>&nbsp;</td><td>specify hg command to run on the remote side</td></tr>
  10062. <tr><td class="option-group">
  10063. <kbd><span class="option">--insecure</span></kbd></td>
  10064. <td>do not verify server certificate (ignoring web.cacerts config)</td></tr>
  10065. </tbody>
  10066. </table>
  10067. <p>[+] marked option can be specified multiple times</p>
  10068. </div>
  10069. </div>
  10070. </div>
  10071. <div class="section" id="progress">
  10072. <h2><a class="toc-backref" href="#id110">progress</a></h2>
  10073. <p>show progress bars for some actions (DEPRECATED)</p>
  10074. <p>This extension has been merged into core, you can remove it from your config.
  10075. See hg help config.progress for configuration options.</p>
  10076. </div>
  10077. <div class="section" id="purge">
  10078. <h2><a class="toc-backref" href="#id111">purge</a></h2>
  10079. <p>command to delete untracked files from the working directory</p>
  10080. <div class="section" id="id38">
  10081. <h3>Commands</h3>
  10082. <div class="section" id="id39">
  10083. <h4>purge</h4>
  10084. <p>removes files not tracked by Mercurial:</p>
  10085. <pre class="literal-block">
  10086. hg purge [OPTION]... [DIR]...
  10087. </pre>
  10088. <p>Delete files not known to Mercurial. This is useful to test local
  10089. and uncommitted changes in an otherwise-clean source tree.</p>
  10090. <p>This means that purge will delete the following by default:</p>
  10091. <ul class="simple">
  10092. <li>Unknown files: files marked with &quot;?&quot; by <a class="reference external" href="hg.1.html#status"><tt class="docutils literal">hg status</tt></a></li>
  10093. <li>Empty directories: in fact Mercurial ignores directories unless
  10094. they contain files under source control management</li>
  10095. </ul>
  10096. <p>But it will leave untouched:</p>
  10097. <ul class="simple">
  10098. <li>Modified and unmodified tracked files</li>
  10099. <li>Ignored files (unless --all is specified)</li>
  10100. <li>New files added to the repository (with <a class="reference external" href="hg.1.html#add"><tt class="docutils literal">hg add</tt></a>)</li>
  10101. </ul>
  10102. <p>The --files and --dirs options can be used to direct purge to delete
  10103. only files, only directories, or both. If neither option is given,
  10104. both will be deleted.</p>
  10105. <p>If directories are given on the command line, only files in these
  10106. directories are considered.</p>
  10107. <p>Be careful with purge, as you could irreversibly delete some files
  10108. you forgot to add to the repository. If you only want to print the
  10109. list of files that this program would delete, use the --print
  10110. option.</p>
  10111. <p>Options:</p>
  10112. <table class="docutils option-list" frame="void" rules="none">
  10113. <col class="option" />
  10114. <col class="description" />
  10115. <tbody valign="top">
  10116. <tr><td class="option-group" colspan="2">
  10117. <kbd><span class="option">-a</span>, <span class="option">--abort-on-err</span></kbd></td>
  10118. </tr>
  10119. <tr><td>&nbsp;</td><td>abort if an error occurs</td></tr>
  10120. <tr><td class="option-group">
  10121. <kbd><span class="option">--all</span></kbd></td>
  10122. <td>purge ignored files too</td></tr>
  10123. <tr><td class="option-group">
  10124. <kbd><span class="option">--dirs</span></kbd></td>
  10125. <td>purge empty directories</td></tr>
  10126. <tr><td class="option-group">
  10127. <kbd><span class="option">--files</span></kbd></td>
  10128. <td>purge files</td></tr>
  10129. <tr><td class="option-group">
  10130. <kbd><span class="option">-p</span>, <span class="option">--print</span></kbd></td>
  10131. <td>print filenames instead of deleting them</td></tr>
  10132. <tr><td class="option-group">
  10133. <kbd><span class="option">-0</span>, <span class="option">--print0</span></kbd></td>
  10134. <td>end filenames with NUL, for use with xargs (implies -p/--print)</td></tr>
  10135. <tr><td class="option-group" colspan="2">
  10136. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  10137. </tr>
  10138. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  10139. <tr><td class="option-group" colspan="2">
  10140. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  10141. </tr>
  10142. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  10143. </tbody>
  10144. </table>
  10145. <p>[+] marked option can be specified multiple times</p>
  10146. <blockquote>
  10147. aliases: clean</blockquote>
  10148. </div>
  10149. </div>
  10150. </div>
  10151. <div class="section" id="rebase">
  10152. <h2><a class="toc-backref" href="#id112">rebase</a></h2>
  10153. <p>command to move sets of revisions to a different ancestor</p>
  10154. <p>This extension lets you rebase changesets in an existing Mercurial
  10155. repository.</p>
  10156. <p>For more information:
  10157. <a class="reference external" href="http://mercurial.selenic.com/wiki/RebaseExtension">http://mercurial.selenic.com/wiki/RebaseExtension</a></p>
  10158. <div class="section" id="id40">
  10159. <h3>Commands</h3>
  10160. <div class="section" id="id41">
  10161. <h4>rebase</h4>
  10162. <p>move changeset (and descendants) to a different branch:</p>
  10163. <pre class="literal-block">
  10164. hg rebase [-s REV | -b REV] [-d REV] [OPTION]
  10165. </pre>
  10166. <p>Rebase uses repeated merging to graft changesets from one part of
  10167. history (the source) onto another (the destination). This can be
  10168. useful for linearizing <em>local</em> changes relative to a master
  10169. development tree.</p>
  10170. <p>You should not rebase changesets that have already been shared
  10171. with others. Doing so will force everybody else to perform the
  10172. same rebase or they will end up with duplicated changesets after
  10173. pulling in your rebased changesets.</p>
  10174. <p>In its default configuration, Mercurial will prevent you from
  10175. rebasing published changes. See <a class="reference external" href="hg.1.html#phases"><tt class="docutils literal">hg help phases</tt></a> for details.</p>
  10176. <p>If you don't specify a destination changeset (<tt class="docutils literal"><span class="pre">-d/--dest</span></tt>),
  10177. rebase uses the current branch tip as the destination. (The
  10178. destination changeset is not modified by rebasing, but new
  10179. changesets are added as its descendants.)</p>
  10180. <p>You can specify which changesets to rebase in two ways: as a
  10181. &quot;source&quot; changeset or as a &quot;base&quot; changeset. Both are shorthand
  10182. for a topologically related set of changesets (the &quot;source
  10183. branch&quot;). If you specify source (<tt class="docutils literal"><span class="pre">-s/--source</span></tt>), rebase will
  10184. rebase that changeset and all of its descendants onto dest. If you
  10185. specify base (<tt class="docutils literal"><span class="pre">-b/--base</span></tt>), rebase will select ancestors of base
  10186. back to but not including the common ancestor with dest. Thus,
  10187. <tt class="docutils literal"><span class="pre">-b</span></tt> is less precise but more convenient than <tt class="docutils literal"><span class="pre">-s</span></tt>: you can
  10188. specify any changeset in the source branch, and rebase will select
  10189. the whole branch. If you specify neither <tt class="docutils literal"><span class="pre">-s</span></tt> nor <tt class="docutils literal"><span class="pre">-b</span></tt>, rebase
  10190. uses the parent of the working directory as the base.</p>
  10191. <p>For advanced usage, a third way is available through the <tt class="docutils literal"><span class="pre">--rev</span></tt>
  10192. option. It allows you to specify an arbitrary set of changesets to
  10193. rebase. Descendants of revs you specify with this option are not
  10194. automatically included in the rebase.</p>
  10195. <p>By default, rebase recreates the changesets in the source branch
  10196. as descendants of dest and then destroys the originals. Use
  10197. <tt class="docutils literal"><span class="pre">--keep</span></tt> to preserve the original source changesets. Some
  10198. changesets in the source branch (e.g. merges from the destination
  10199. branch) may be dropped if they no longer contribute any change.</p>
  10200. <p>One result of the rules for selecting the destination changeset
  10201. and source branch is that, unlike <tt class="docutils literal">merge</tt>, rebase will do
  10202. nothing if you are at the branch tip of a named branch
  10203. with two heads. You need to explicitly specify source and/or
  10204. destination (or <tt class="docutils literal">update</tt> to the other head, if it's the head of
  10205. the intended source branch).</p>
  10206. <p>If a rebase is interrupted to manually resolve a merge, it can be
  10207. continued with --continue/-c or aborted with --abort/-a.</p>
  10208. <div class="verbose container">
  10209. <p>Examples:</p>
  10210. <ul>
  10211. <li><p class="first">move &quot;local changes&quot; (current commit back to branching point)
  10212. to the current branch tip after a pull:</p>
  10213. <pre class="literal-block">
  10214. hg rebase
  10215. </pre>
  10216. </li>
  10217. <li><p class="first">move a single changeset to the stable branch:</p>
  10218. <pre class="literal-block">
  10219. hg rebase -r 5f493448 -d stable
  10220. </pre>
  10221. </li>
  10222. <li><p class="first">splice a commit and all its descendants onto another part of history:</p>
  10223. <pre class="literal-block">
  10224. hg rebase --source c0c3 --dest 4cf9
  10225. </pre>
  10226. </li>
  10227. <li><p class="first">rebase everything on a branch marked by a bookmark onto the
  10228. default branch:</p>
  10229. <pre class="literal-block">
  10230. hg rebase --base myfeature --dest default
  10231. </pre>
  10232. </li>
  10233. <li><p class="first">collapse a sequence of changes into a single commit:</p>
  10234. <pre class="literal-block">
  10235. hg rebase --collapse -r 1520:1525 -d .
  10236. </pre>
  10237. </li>
  10238. <li><p class="first">move a named branch while preserving its name:</p>
  10239. <pre class="literal-block">
  10240. hg rebase -r &quot;branch(featureX)&quot; -d 1.3 --keepbranches
  10241. </pre>
  10242. </li>
  10243. </ul>
  10244. </div>
  10245. <p>Returns 0 on success, 1 if nothing to rebase or there are
  10246. unresolved conflicts.</p>
  10247. <p>Options:</p>
  10248. <table class="docutils option-list" frame="void" rules="none">
  10249. <col class="option" />
  10250. <col class="description" />
  10251. <tbody valign="top">
  10252. <tr><td class="option-group" colspan="2">
  10253. <kbd><span class="option">-s</span>, <span class="option">--source <var>&lt;REV&gt;</var></span></kbd></td>
  10254. </tr>
  10255. <tr><td>&nbsp;</td><td>rebase the specified changeset and descendants</td></tr>
  10256. <tr><td class="option-group" colspan="2">
  10257. <kbd><span class="option">-b</span>, <span class="option">--base <var>&lt;REV&gt;</var></span></kbd></td>
  10258. </tr>
  10259. <tr><td>&nbsp;</td><td>rebase everything from branching point of specified changeset</td></tr>
  10260. <tr><td class="option-group" colspan="2">
  10261. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  10262. </tr>
  10263. <tr><td>&nbsp;</td><td>rebase these revisions</td></tr>
  10264. <tr><td class="option-group" colspan="2">
  10265. <kbd><span class="option">-d</span>, <span class="option">--dest <var>&lt;REV&gt;</var></span></kbd></td>
  10266. </tr>
  10267. <tr><td>&nbsp;</td><td>rebase onto the specified changeset</td></tr>
  10268. <tr><td class="option-group">
  10269. <kbd><span class="option">--collapse</span></kbd></td>
  10270. <td>collapse the rebased changesets</td></tr>
  10271. <tr><td class="option-group" colspan="2">
  10272. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  10273. </tr>
  10274. <tr><td>&nbsp;</td><td>use text as collapse commit message</td></tr>
  10275. <tr><td class="option-group">
  10276. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  10277. <td>invoke editor on commit messages</td></tr>
  10278. <tr><td class="option-group" colspan="2">
  10279. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  10280. </tr>
  10281. <tr><td>&nbsp;</td><td>read collapse commit message from file</td></tr>
  10282. <tr><td class="option-group">
  10283. <kbd><span class="option">-k</span>, <span class="option">--keep</span></kbd></td>
  10284. <td>keep original changesets</td></tr>
  10285. <tr><td class="option-group">
  10286. <kbd><span class="option">--keepbranches</span></kbd></td>
  10287. <td>keep original branch names</td></tr>
  10288. <tr><td class="option-group">
  10289. <kbd><span class="option">-D</span>, <span class="option">--detach</span></kbd></td>
  10290. <td>(DEPRECATED)</td></tr>
  10291. <tr><td class="option-group" colspan="2">
  10292. <kbd><span class="option">-i</span>, <span class="option">--interactive</span></kbd></td>
  10293. </tr>
  10294. <tr><td>&nbsp;</td><td>(DEPRECATED)</td></tr>
  10295. <tr><td class="option-group" colspan="2">
  10296. <kbd><span class="option">-t</span>, <span class="option">--tool <var>&lt;VALUE&gt;</var></span></kbd></td>
  10297. </tr>
  10298. <tr><td>&nbsp;</td><td>specify merge tool</td></tr>
  10299. <tr><td class="option-group">
  10300. <kbd><span class="option">-c</span>, <span class="option">--continue</span></kbd></td>
  10301. <td>continue an interrupted rebase</td></tr>
  10302. <tr><td class="option-group">
  10303. <kbd><span class="option">-a</span>, <span class="option">--abort</span></kbd></td>
  10304. <td>abort an interrupted rebase</td></tr>
  10305. <tr><td class="option-group" colspan="2">
  10306. <kbd><span class="option">--style <var>&lt;STYLE&gt;</var></span></kbd></td>
  10307. </tr>
  10308. <tr><td>&nbsp;</td><td>display using template map file (DEPRECATED)</td></tr>
  10309. <tr><td class="option-group" colspan="2">
  10310. <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
  10311. </tr>
  10312. <tr><td>&nbsp;</td><td>display with template</td></tr>
  10313. </tbody>
  10314. </table>
  10315. <p>[+] marked option can be specified multiple times</p>
  10316. </div>
  10317. </div>
  10318. </div>
  10319. <div class="section" id="record">
  10320. <h2><a class="toc-backref" href="#id113">record</a></h2>
  10321. <p>commands to interactively select changes for commit/qrefresh</p>
  10322. <div class="section" id="id42">
  10323. <h3>Commands</h3>
  10324. <div class="section" id="qrecord">
  10325. <h4>qrecord</h4>
  10326. <p>interactively record a new patch:</p>
  10327. <pre class="literal-block">
  10328. hg qrecord [OPTION]... PATCH [FILE]...
  10329. </pre>
  10330. <p>See <a class="reference external" href="hg.1.html#qnew"><tt class="docutils literal">hg help qnew</tt></a> &amp; <a class="reference external" href="hg.1.html#record"><tt class="docutils literal">hg help record</tt></a> for more information and
  10331. usage.</p>
  10332. </div>
  10333. <div class="section" id="id43">
  10334. <h4>record</h4>
  10335. <p>interactively select changes to commit:</p>
  10336. <pre class="literal-block">
  10337. hg record [OPTION]... [FILE]...
  10338. </pre>
  10339. <p>If a list of files is omitted, all changes reported by <a class="reference external" href="hg.1.html#status"><tt class="docutils literal">hg status</tt></a>
  10340. will be candidates for recording.</p>
  10341. <p>See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help dates</tt></a> for a list of formats valid for -d/--date.</p>
  10342. <p>You will be prompted for whether to record changes to each
  10343. modified file, and for files with multiple changes, for each
  10344. change to use. For each query, the following responses are
  10345. possible:</p>
  10346. <pre class="literal-block">
  10347. y - record this change
  10348. n - skip this change
  10349. e - edit this change manually
  10350.  
  10351. s - skip remaining changes to this file
  10352. f - record remaining changes to this file
  10353.  
  10354. d - done, skip remaining changes and files
  10355. a - record all changes to all remaining files
  10356. q - quit, recording no changes
  10357.  
  10358. ? - display help
  10359. </pre>
  10360. <p>This command is not available when committing a merge.</p>
  10361. <p>Options:</p>
  10362. <table class="docutils option-list" frame="void" rules="none">
  10363. <col class="option" />
  10364. <col class="description" />
  10365. <tbody valign="top">
  10366. <tr><td class="option-group" colspan="2">
  10367. <kbd><span class="option">-A</span>, <span class="option">--addremove</span></kbd></td>
  10368. </tr>
  10369. <tr><td>&nbsp;</td><td>mark new/missing files as added/removed before committing</td></tr>
  10370. <tr><td class="option-group">
  10371. <kbd><span class="option">--close-branch</span></kbd></td>
  10372. <td>mark a branch head as closed</td></tr>
  10373. <tr><td class="option-group">
  10374. <kbd><span class="option">--amend</span></kbd></td>
  10375. <td>amend the parent of the working directory</td></tr>
  10376. <tr><td class="option-group">
  10377. <kbd><span class="option">-s</span>, <span class="option">--secret</span></kbd></td>
  10378. <td>use the secret phase for committing</td></tr>
  10379. <tr><td class="option-group">
  10380. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  10381. <td>invoke editor on commit messages</td></tr>
  10382. <tr><td class="option-group" colspan="2">
  10383. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  10384. </tr>
  10385. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  10386. <tr><td class="option-group" colspan="2">
  10387. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  10388. </tr>
  10389. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  10390. <tr><td class="option-group" colspan="2">
  10391. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  10392. </tr>
  10393. <tr><td>&nbsp;</td><td>use text as commit message</td></tr>
  10394. <tr><td class="option-group" colspan="2">
  10395. <kbd><span class="option">-l</span>, <span class="option">--logfile <var>&lt;FILE&gt;</var></span></kbd></td>
  10396. </tr>
  10397. <tr><td>&nbsp;</td><td>read commit message from file</td></tr>
  10398. <tr><td class="option-group" colspan="2">
  10399. <kbd><span class="option">-d</span>, <span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  10400. </tr>
  10401. <tr><td>&nbsp;</td><td>record the specified date as commit date</td></tr>
  10402. <tr><td class="option-group" colspan="2">
  10403. <kbd><span class="option">-u</span>, <span class="option">--user <var>&lt;USER&gt;</var></span></kbd></td>
  10404. </tr>
  10405. <tr><td>&nbsp;</td><td>record the specified user as committer</td></tr>
  10406. <tr><td class="option-group">
  10407. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  10408. <td>recurse into subrepositories</td></tr>
  10409. <tr><td class="option-group" colspan="2">
  10410. <kbd><span class="option">-w</span>, <span class="option">--ignore-all-space</span></kbd></td>
  10411. </tr>
  10412. <tr><td>&nbsp;</td><td>ignore white space when comparing lines</td></tr>
  10413. <tr><td class="option-group" colspan="2">
  10414. <kbd><span class="option">-b</span>, <span class="option">--ignore-space-change</span></kbd></td>
  10415. </tr>
  10416. <tr><td>&nbsp;</td><td>ignore changes in the amount of white space</td></tr>
  10417. <tr><td class="option-group" colspan="2">
  10418. <kbd><span class="option">-B</span>, <span class="option">--ignore-blank-lines</span></kbd></td>
  10419. </tr>
  10420. <tr><td>&nbsp;</td><td>ignore changes whose lines are all blank</td></tr>
  10421. </tbody>
  10422. </table>
  10423. <p>[+] marked option can be specified multiple times</p>
  10424. </div>
  10425. </div>
  10426. </div>
  10427. <div class="section" id="relink">
  10428. <h2><a class="toc-backref" href="#id114">relink</a></h2>
  10429. <p>recreates hardlinks between repository clones</p>
  10430. <div class="section" id="id44">
  10431. <h3>Commands</h3>
  10432. <div class="section" id="id45">
  10433. <h4>relink</h4>
  10434. <p>recreate hardlinks between two repositories:</p>
  10435. <pre class="literal-block">
  10436. hg relink [ORIGIN]
  10437. </pre>
  10438. <p>When repositories are cloned locally, their data files will be
  10439. hardlinked so that they only use the space of a single repository.</p>
  10440. <p>Unfortunately, subsequent pulls into either repository will break
  10441. hardlinks for any files touched by the new changesets, even if
  10442. both repositories end up pulling the same changes.</p>
  10443. <p>Similarly, passing --rev to &quot;hg clone&quot; will fail to use any
  10444. hardlinks, falling back to a complete copy of the source
  10445. repository.</p>
  10446. <p>This command lets you recreate those hardlinks and reclaim that
  10447. wasted space.</p>
  10448. <p>This repository will be relinked to share space with ORIGIN, which
  10449. must be on the same local disk. If ORIGIN is omitted, looks for
  10450. &quot;default-relink&quot;, then &quot;default&quot;, in [paths].</p>
  10451. <p>Do not attempt any read operations on this repository while the
  10452. command is running. (Both repositories will be locked against
  10453. writes.)</p>
  10454. </div>
  10455. </div>
  10456. </div>
  10457. <div class="section" id="schemes">
  10458. <h2><a class="toc-backref" href="#id115">schemes</a></h2>
  10459. <p>extend schemes with shortcuts to repository swarms</p>
  10460. <p>This extension allows you to specify shortcuts for parent URLs with a
  10461. lot of repositories to act like a scheme, for example:</p>
  10462. <pre class="literal-block">
  10463. [schemes]
  10464. py = http://code.python.org/hg/
  10465. </pre>
  10466. <p>After that you can use it like:</p>
  10467. <pre class="literal-block">
  10468. hg clone py://trunk/
  10469. </pre>
  10470. <p>Additionally there is support for some more complex schemas, for
  10471. example used by Google Code:</p>
  10472. <pre class="literal-block">
  10473. [schemes]
  10474. gcode = http://{1}.googlecode.com/hg/
  10475. </pre>
  10476. <p>The syntax is taken from Mercurial templates, and you have unlimited
  10477. number of variables, starting with <tt class="docutils literal">{1}</tt> and continuing with
  10478. <tt class="docutils literal">{2}</tt>, <tt class="docutils literal">{3}</tt> and so on. This variables will receive parts of URL
  10479. supplied, split by <tt class="docutils literal">/</tt>. Anything not specified as <tt class="docutils literal">{part}</tt> will be
  10480. just appended to an URL.</p>
  10481. <p>For convenience, the extension adds these schemes by default:</p>
  10482. <pre class="literal-block">
  10483. [schemes]
  10484. py = http://hg.python.org/
  10485. bb = https://bitbucket.org/
  10486. bb+ssh = ssh://hg&#64;bitbucket.org/
  10487. gcode = https://{1}.googlecode.com/hg/
  10488. kiln = https://{1}.kilnhg.com/Repo/
  10489. </pre>
  10490. <p>You can override a predefined scheme by defining a new scheme with the
  10491. same name.</p>
  10492. </div>
  10493. <div class="section" id="share">
  10494. <h2><a class="toc-backref" href="#id116">share</a></h2>
  10495. <p>share a common history between several working directories</p>
  10496. <div class="section" id="automatic-pooled-storage-for-clones">
  10497. <h3>Automatic Pooled Storage for Clones</h3>
  10498. <p>When this extension is active, <a class="reference external" href="hg.1.html#clone"><tt class="docutils literal">hg clone</tt></a> can be configured to
  10499. automatically share/pool storage across multiple clones. This
  10500. mode effectively converts <a class="reference external" href="hg.1.html#clone"><tt class="docutils literal">hg clone</tt></a> to <a class="reference external" href="hg.1.html#clone"><tt class="docutils literal">hg clone</tt></a> + <a class="reference external" href="hg.1.html#share"><tt class="docutils literal">hg share</tt></a>.
  10501. The benefit of using this mode is the automatic management of
  10502. store paths and intelligent pooling of related repositories.</p>
  10503. <p>The following <tt class="docutils literal">share.</tt> config options influence this feature:</p>
  10504. <dl class="docutils">
  10505. <dt><tt class="docutils literal">share.pool</tt></dt>
  10506. <dd>Filesystem path where shared repository data will be stored. When
  10507. defined, <a class="reference external" href="hg.1.html#clone"><tt class="docutils literal">hg clone</tt></a> will automatically use shared repository
  10508. storage instead of creating a store inside each clone.</dd>
  10509. <dt><tt class="docutils literal">share.poolnaming</tt></dt>
  10510. <dd><p class="first">How directory names in <tt class="docutils literal">share.pool</tt> are constructed.</p>
  10511. <p>&quot;identity&quot; means the name is derived from the first changeset in the
  10512. repository. In this mode, different remotes share storage if their
  10513. root/initial changeset is identical. In this mode, the local shared
  10514. repository is an aggregate of all encountered remote repositories.</p>
  10515. <p>&quot;remote&quot; means the name is derived from the source repository's
  10516. path or URL. In this mode, storage is only shared if the path or URL
  10517. requested in the <a class="reference external" href="hg.1.html#clone"><tt class="docutils literal">hg clone</tt></a> command matches exactly to a repository
  10518. that was cloned before.</p>
  10519. <p class="last">The default naming mode is &quot;identity.&quot;</p>
  10520. </dd>
  10521. </dl>
  10522. </div>
  10523. <div class="section" id="id46">
  10524. <h3>Commands</h3>
  10525. <div class="section" id="id47">
  10526. <h4>share</h4>
  10527. <p>create a new shared repository:</p>
  10528. <pre class="literal-block">
  10529. hg share [-U] [-B] SOURCE [DEST]
  10530. </pre>
  10531. <p>Initialize a new repository and working directory that shares its
  10532. history (and optionally bookmarks) with another repository.</p>
  10533. <div class="note">
  10534. <p class="first admonition-title">Note</p>
  10535. <p class="last">using rollback or extensions that destroy/modify history (mq,
  10536. rebase, etc.) can cause considerable confusion with shared
  10537. clones. In particular, if two shared clones are both updated to
  10538. the same changeset, and one of them destroys that changeset
  10539. with rollback, the other clone will suddenly stop working: all
  10540. operations will fail with &quot;abort: working directory has unknown
  10541. parent&quot;. The only known workaround is to use debugsetparents on
  10542. the broken clone to reset it to a changeset that still exists.</p>
  10543. </div>
  10544. <p>Options:</p>
  10545. <table class="docutils option-list" frame="void" rules="none">
  10546. <col class="option" />
  10547. <col class="description" />
  10548. <tbody valign="top">
  10549. <tr><td class="option-group">
  10550. <kbd><span class="option">-U</span>, <span class="option">--noupdate</span></kbd></td>
  10551. <td>do not create a working directory</td></tr>
  10552. <tr><td class="option-group" colspan="2">
  10553. <kbd><span class="option">-B</span>, <span class="option">--bookmarks</span></kbd></td>
  10554. </tr>
  10555. <tr><td>&nbsp;</td><td>also share bookmarks</td></tr>
  10556. </tbody>
  10557. </table>
  10558. </div>
  10559. <div class="section" id="unshare">
  10560. <h4>unshare</h4>
  10561. <p>convert a shared repository to a normal one:</p>
  10562. <pre class="literal-block">
  10563. hg unshare
  10564. </pre>
  10565. <p>Copy the store data to the repo and remove the sharedpath data.</p>
  10566. </div>
  10567. </div>
  10568. </div>
  10569. <div class="section" id="shelve">
  10570. <h2><a class="toc-backref" href="#id117">shelve</a></h2>
  10571. <p>save and restore changes to the working directory</p>
  10572. <p>The &quot;hg shelve&quot; command saves changes made to the working directory
  10573. and reverts those changes, resetting the working directory to a clean
  10574. state.</p>
  10575. <p>Later on, the &quot;hg unshelve&quot; command restores the changes saved by &quot;hg
  10576. shelve&quot;. Changes can be restored even after updating to a different
  10577. parent, in which case Mercurial's merge machinery will resolve any
  10578. conflicts if necessary.</p>
  10579. <p>You can have more than one shelved change outstanding at a time; each
  10580. shelved change has a distinct name. For details, see the help for &quot;hg
  10581. shelve&quot;.</p>
  10582. <div class="section" id="id48">
  10583. <h3>Commands</h3>
  10584. <div class="section" id="id49">
  10585. <h4>shelve</h4>
  10586. <p>save and set aside changes from the working directory:</p>
  10587. <pre class="literal-block">
  10588. hg shelve [OPTION]... [FILE]...
  10589. </pre>
  10590. <p>Shelving takes files that &quot;hg status&quot; reports as not clean, saves
  10591. the modifications to a bundle (a shelved change), and reverts the
  10592. files so that their state in the working directory becomes clean.</p>
  10593. <p>To restore these changes to the working directory, using &quot;hg
  10594. unshelve&quot;; this will work even if you switch to a different
  10595. commit.</p>
  10596. <p>When no files are specified, &quot;hg shelve&quot; saves all not-clean
  10597. files. If specific files or directories are named, only changes to
  10598. those files are shelved.</p>
  10599. <p>Each shelved change has a name that makes it easier to find later.
  10600. The name of a shelved change defaults to being based on the active
  10601. bookmark, or if there is no active bookmark, the current named
  10602. branch.  To specify a different name, use <tt class="docutils literal"><span class="pre">--name</span></tt>.</p>
  10603. <p>To see a list of existing shelved changes, use the <tt class="docutils literal"><span class="pre">--list</span></tt>
  10604. option. For each shelved change, this will print its name, age,
  10605. and description; use <tt class="docutils literal"><span class="pre">--patch</span></tt> or <tt class="docutils literal"><span class="pre">--stat</span></tt> for more details.</p>
  10606. <p>To delete specific shelved changes, use <tt class="docutils literal"><span class="pre">--delete</span></tt>. To delete
  10607. all shelved changes, use <tt class="docutils literal"><span class="pre">--cleanup</span></tt>.</p>
  10608. <p>Options:</p>
  10609. <table class="docutils option-list" frame="void" rules="none">
  10610. <col class="option" />
  10611. <col class="description" />
  10612. <tbody valign="top">
  10613. <tr><td class="option-group" colspan="2">
  10614. <kbd><span class="option">-A</span>, <span class="option">--addremove</span></kbd></td>
  10615. </tr>
  10616. <tr><td>&nbsp;</td><td>mark new/missing files as added/removed before shelving</td></tr>
  10617. <tr><td class="option-group">
  10618. <kbd><span class="option">--cleanup</span></kbd></td>
  10619. <td>delete all shelved changes</td></tr>
  10620. <tr><td class="option-group">
  10621. <kbd><span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  10622. <td>shelve with the specified commit date</td></tr>
  10623. <tr><td class="option-group">
  10624. <kbd><span class="option">-d</span>, <span class="option">--delete</span></kbd></td>
  10625. <td>delete the named shelved change(s)</td></tr>
  10626. <tr><td class="option-group">
  10627. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  10628. <td>invoke editor on commit messages</td></tr>
  10629. <tr><td class="option-group">
  10630. <kbd><span class="option">-l</span>, <span class="option">--list</span></kbd></td>
  10631. <td>list current shelves</td></tr>
  10632. <tr><td class="option-group" colspan="2">
  10633. <kbd><span class="option">-m</span>, <span class="option">--message <var>&lt;TEXT&gt;</var></span></kbd></td>
  10634. </tr>
  10635. <tr><td>&nbsp;</td><td>use text as shelve message</td></tr>
  10636. <tr><td class="option-group" colspan="2">
  10637. <kbd><span class="option">-n</span>, <span class="option">--name <var>&lt;NAME&gt;</var></span></kbd></td>
  10638. </tr>
  10639. <tr><td>&nbsp;</td><td>use the given name for the shelved commit</td></tr>
  10640. <tr><td class="option-group">
  10641. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  10642. <td>show patch</td></tr>
  10643. <tr><td class="option-group" colspan="2">
  10644. <kbd><span class="option">-i</span>, <span class="option">--interactive</span></kbd></td>
  10645. </tr>
  10646. <tr><td>&nbsp;</td><td>interactive mode, only works while creating a shelve</td></tr>
  10647. <tr><td class="option-group">
  10648. <kbd><span class="option">--stat</span></kbd></td>
  10649. <td>output diffstat-style summary of changes</td></tr>
  10650. <tr><td class="option-group" colspan="2">
  10651. <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  10652. </tr>
  10653. <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
  10654. <tr><td class="option-group" colspan="2">
  10655. <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
  10656. </tr>
  10657. <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
  10658. </tbody>
  10659. </table>
  10660. <p>[+] marked option can be specified multiple times</p>
  10661. </div>
  10662. <div class="section" id="unshelve">
  10663. <h4>unshelve</h4>
  10664. <p>restore a shelved change to the working directory:</p>
  10665. <pre class="literal-block">
  10666. hg unshelve [SHELVED]
  10667. </pre>
  10668. <p>This command accepts an optional name of a shelved change to
  10669. restore. If none is given, the most recent shelved change is used.</p>
  10670. <p>If a shelved change is applied successfully, the bundle that
  10671. contains the shelved changes is moved to a backup location
  10672. (.hg/shelve-backup).</p>
  10673. <p>Since you can restore a shelved change on top of an arbitrary
  10674. commit, it is possible that unshelving will result in a conflict
  10675. between your changes and the commits you are unshelving onto. If
  10676. this occurs, you must resolve the conflict, then use
  10677. <tt class="docutils literal"><span class="pre">--continue</span></tt> to complete the unshelve operation. (The bundle
  10678. will not be moved until you successfully complete the unshelve.)</p>
  10679. <p>(Alternatively, you can use <tt class="docutils literal"><span class="pre">--abort</span></tt> to abandon an unshelve
  10680. that causes a conflict. This reverts the unshelved changes, and
  10681. leaves the bundle in place.)</p>
  10682. <p>After a successful unshelve, the shelved changes are stored in a
  10683. backup directory. Only the N most recent backups are kept. N
  10684. defaults to 10 but can be overridden using the <tt class="docutils literal">shelve.maxbackups</tt>
  10685. configuration option.</p>
  10686. <div class="verbose container">
  10687. Timestamp in seconds is used to decide order of backups. More
  10688. than <tt class="docutils literal">maxbackups</tt> backups are kept, if same timestamp
  10689. prevents from deciding exact order of them, for safety.</div>
  10690. <p>Options:</p>
  10691. <table class="docutils option-list" frame="void" rules="none">
  10692. <col class="option" />
  10693. <col class="description" />
  10694. <tbody valign="top">
  10695. <tr><td class="option-group">
  10696. <kbd><span class="option">-a</span>, <span class="option">--abort</span></kbd></td>
  10697. <td>abort an incomplete unshelve operation</td></tr>
  10698. <tr><td class="option-group">
  10699. <kbd><span class="option">-c</span>, <span class="option">--continue</span></kbd></td>
  10700. <td>continue an incomplete unshelve operation</td></tr>
  10701. <tr><td class="option-group">
  10702. <kbd><span class="option">--keep</span></kbd></td>
  10703. <td>keep shelve after unshelving</td></tr>
  10704. <tr><td class="option-group">
  10705. <kbd><span class="option">--date <var>&lt;DATE&gt;</var></span></kbd></td>
  10706. <td>set date for temporary commits (DEPRECATED)</td></tr>
  10707. </tbody>
  10708. </table>
  10709. </div>
  10710. </div>
  10711. </div>
  10712. <div class="section" id="strip">
  10713. <h2><a class="toc-backref" href="#id118">strip</a></h2>
  10714. <p>strip changesets and their descendants from history</p>
  10715. <p>This extension allows you to strip changesets and all their descendants from the
  10716. repository. See the command help for details.</p>
  10717. <div class="section" id="id50">
  10718. <h3>Commands</h3>
  10719. <div class="section" id="id51">
  10720. <h4>strip</h4>
  10721. <p>strip changesets and all their descendants from the repository:</p>
  10722. <pre class="literal-block">
  10723. hg strip [-k] [-f] [-n] [-B bookmark] [-r] REV...
  10724. </pre>
  10725. <p>The strip command removes the specified changesets and all their
  10726. descendants. If the working directory has uncommitted changes, the
  10727. operation is aborted unless the --force flag is supplied, in which
  10728. case changes will be discarded.</p>
  10729. <p>If a parent of the working directory is stripped, then the working
  10730. directory will automatically be updated to the most recent
  10731. available ancestor of the stripped parent after the operation
  10732. completes.</p>
  10733. <p>Any stripped changesets are stored in <tt class="docutils literal"><span class="pre">.hg/strip-backup</span></tt> as a
  10734. bundle (see <a class="reference external" href="hg.1.html#bundle"><tt class="docutils literal">hg help bundle</tt></a> and <a class="reference external" href="hg.1.html#unbundle"><tt class="docutils literal">hg help unbundle</tt></a>). They can
  10735. be restored by running <a class="reference external" href="hg.1.html#unbundle"><tt class="docutils literal">hg unbundle <span class="pre">.hg/strip-backup/BUNDLE</span></tt></a>,
  10736. where BUNDLE is the bundle file created by the strip. Note that
  10737. the local revision numbers will in general be different after the
  10738. restore.</p>
  10739. <p>Use the --no-backup option to discard the backup bundle once the
  10740. operation completes.</p>
  10741. <p>Strip is not a history-rewriting operation and can be used on
  10742. changesets in the public phase. But if the stripped changesets have
  10743. been pushed to a remote repository you will likely pull them again.</p>
  10744. <p>Return 0 on success.</p>
  10745. <p>Options:</p>
  10746. <table class="docutils option-list" frame="void" rules="none">
  10747. <col class="option" />
  10748. <col class="description" />
  10749. <tbody valign="top">
  10750. <tr><td class="option-group" colspan="2">
  10751. <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
  10752. </tr>
  10753. <tr><td>&nbsp;</td><td>strip specified revision (optional, can specify revisions without this option)</td></tr>
  10754. <tr><td class="option-group">
  10755. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  10756. <td>force removal of changesets, discard uncommitted changes (no backup)</td></tr>
  10757. <tr><td class="option-group">
  10758. <kbd><span class="option">--no-backup</span></kbd></td>
  10759. <td>no backups</td></tr>
  10760. <tr><td class="option-group">
  10761. <kbd><span class="option">--nobackup</span></kbd></td>
  10762. <td>no backups (DEPRECATED)</td></tr>
  10763. <tr><td class="option-group">
  10764. <kbd><span class="option">-n</span></kbd></td>
  10765. <td>ignored  (DEPRECATED)</td></tr>
  10766. <tr><td class="option-group">
  10767. <kbd><span class="option">-k</span>, <span class="option">--keep</span></kbd></td>
  10768. <td>do not modify working directory during strip</td></tr>
  10769. <tr><td class="option-group" colspan="2">
  10770. <kbd><span class="option">-B</span>, <span class="option">--bookmark <var>&lt;VALUE&gt;</var></span></kbd></td>
  10771. </tr>
  10772. <tr><td>&nbsp;</td><td>remove revs only reachable from given bookmark</td></tr>
  10773. </tbody>
  10774. </table>
  10775. <p>[+] marked option can be specified multiple times</p>
  10776. </div>
  10777. </div>
  10778. </div>
  10779. <div class="section" id="transplant">
  10780. <h2><a class="toc-backref" href="#id119">transplant</a></h2>
  10781. <p>command to transplant changesets from another branch</p>
  10782. <p>This extension allows you to transplant changes to another parent revision,
  10783. possibly in another repository. The transplant is done using 'diff' patches.</p>
  10784. <p>Transplanted patches are recorded in .hg/transplant/transplants, as a
  10785. map from a changeset hash to its hash in the source repository.</p>
  10786. <div class="section" id="id52">
  10787. <h3>Commands</h3>
  10788. <div class="section" id="id53">
  10789. <h4>transplant</h4>
  10790. <p>transplant changesets from another branch:</p>
  10791. <pre class="literal-block">
  10792. hg transplant [-s REPO] [-b BRANCH [-a]] [-p REV] [-m REV] [REV]...
  10793. </pre>
  10794. <p>Selected changesets will be applied on top of the current working
  10795. directory with the log of the original changeset. The changesets
  10796. are copied and will thus appear twice in the history with different
  10797. identities.</p>
  10798. <p>Consider using the graft command if everything is inside the same
  10799. repository - it will use merges and will usually give a better result.
  10800. Use the rebase extension if the changesets are unpublished and you want
  10801. to move them instead of copying them.</p>
  10802. <p>If --log is specified, log messages will have a comment appended
  10803. of the form:</p>
  10804. <pre class="literal-block">
  10805. (transplanted from CHANGESETHASH)
  10806. </pre>
  10807. <p>You can rewrite the changelog message with the --filter option.
  10808. Its argument will be invoked with the current changelog message as
  10809. $1 and the patch as $2.</p>
  10810. <p>--source/-s specifies another repository to use for selecting changesets,
  10811. just as if it temporarily had been pulled.
  10812. If --branch/-b is specified, these revisions will be used as
  10813. heads when deciding which changesets to transplant, just as if only
  10814. these revisions had been pulled.
  10815. If --all/-a is specified, all the revisions up to the heads specified
  10816. with --branch will be transplanted.</p>
  10817. <p>Example:</p>
  10818. <ul>
  10819. <li><p class="first">transplant all changes up to REV on top of your current revision:</p>
  10820. <pre class="literal-block">
  10821. hg transplant --branch REV --all
  10822. </pre>
  10823. </li>
  10824. </ul>
  10825. <p>You can optionally mark selected transplanted changesets as merge
  10826. changesets. You will not be prompted to transplant any ancestors
  10827. of a merged transplant, and you can merge descendants of them
  10828. normally instead of transplanting them.</p>
  10829. <p>Merge changesets may be transplanted directly by specifying the
  10830. proper parent changeset by calling <a class="reference external" href="hg.1.html#transplant"><tt class="docutils literal">hg transplant <span class="pre">--parent</span></tt></a>.</p>
  10831. <p>If no merges or revisions are provided, <a class="reference external" href="hg.1.html#transplant"><tt class="docutils literal">hg transplant</tt></a> will
  10832. start an interactive changeset browser.</p>
  10833. <p>If a changeset application fails, you can fix the merge by hand
  10834. and then resume where you left off by calling <a class="reference external" href="hg.1.html#transplant"><tt class="docutils literal">hg transplant
  10835. <span class="pre">--continue/-c</span></tt></a>.</p>
  10836. <p>Options:</p>
  10837. <table class="docutils option-list" frame="void" rules="none">
  10838. <col class="option" />
  10839. <col class="description" />
  10840. <tbody valign="top">
  10841. <tr><td class="option-group" colspan="2">
  10842. <kbd><span class="option">-s</span>, <span class="option">--source <var>&lt;REPO&gt;</var></span></kbd></td>
  10843. </tr>
  10844. <tr><td>&nbsp;</td><td>transplant changesets from REPO</td></tr>
  10845. <tr><td class="option-group" colspan="2">
  10846. <kbd><span class="option">-b</span>, <span class="option">--branch <var>&lt;REV[+]&gt;</var></span></kbd></td>
  10847. </tr>
  10848. <tr><td>&nbsp;</td><td>use this source changeset as head</td></tr>
  10849. <tr><td class="option-group">
  10850. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  10851. <td>pull all changesets up to the --branch revisions</td></tr>
  10852. <tr><td class="option-group" colspan="2">
  10853. <kbd><span class="option">-p</span>, <span class="option">--prune <var>&lt;REV[+]&gt;</var></span></kbd></td>
  10854. </tr>
  10855. <tr><td>&nbsp;</td><td>skip over REV</td></tr>
  10856. <tr><td class="option-group" colspan="2">
  10857. <kbd><span class="option">-m</span>, <span class="option">--merge <var>&lt;REV[+]&gt;</var></span></kbd></td>
  10858. </tr>
  10859. <tr><td>&nbsp;</td><td>merge at REV</td></tr>
  10860. <tr><td class="option-group">
  10861. <kbd><span class="option">--parent <var>&lt;REV&gt;</var></span></kbd></td>
  10862. <td>parent to choose when transplanting merge</td></tr>
  10863. <tr><td class="option-group">
  10864. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  10865. <td>invoke editor on commit messages</td></tr>
  10866. <tr><td class="option-group">
  10867. <kbd><span class="option">--log</span></kbd></td>
  10868. <td>append transplant info to log message</td></tr>
  10869. <tr><td class="option-group">
  10870. <kbd><span class="option">-c</span>, <span class="option">--continue</span></kbd></td>
  10871. <td>continue last transplant session after fixing conflicts</td></tr>
  10872. <tr><td class="option-group">
  10873. <kbd><span class="option">--filter <var>&lt;CMD&gt;</var></span></kbd></td>
  10874. <td>filter changesets through command</td></tr>
  10875. </tbody>
  10876. </table>
  10877. <p>[+] marked option can be specified multiple times</p>
  10878. </div>
  10879. </div>
  10880. </div>
  10881. <div class="section" id="win32mbcs">
  10882. <h2><a class="toc-backref" href="#id120">win32mbcs</a></h2>
  10883. <p>allow the use of MBCS paths with problematic encodings</p>
  10884. <p>Some MBCS encodings are not good for some path operations (i.e.
  10885. splitting path, case conversion, etc.) with its encoded bytes. We call
  10886. such a encoding (i.e. shift_jis and big5) as &quot;problematic encoding&quot;.
  10887. This extension can be used to fix the issue with those encodings by
  10888. wrapping some functions to convert to Unicode string before path
  10889. operation.</p>
  10890. <p>This extension is useful for:</p>
  10891. <ul class="simple">
  10892. <li>Japanese Windows users using shift_jis encoding.</li>
  10893. <li>Chinese Windows users using big5 encoding.</li>
  10894. <li>All users who use a repository with one of problematic encodings on
  10895. case-insensitive file system.</li>
  10896. </ul>
  10897. <p>This extension is not needed for:</p>
  10898. <ul class="simple">
  10899. <li>Any user who use only ASCII chars in path.</li>
  10900. <li>Any user who do not use any of problematic encodings.</li>
  10901. </ul>
  10902. <p>Note that there are some limitations on using this extension:</p>
  10903. <ul class="simple">
  10904. <li>You should use single encoding in one repository.</li>
  10905. <li>If the repository path ends with 0x5c, .hg/hgrc cannot be read.</li>
  10906. <li>win32mbcs is not compatible with fixutf8 extension.</li>
  10907. </ul>
  10908. <p>By default, win32mbcs uses encoding.encoding decided by Mercurial.
  10909. You can specify the encoding by config option:</p>
  10910. <pre class="literal-block">
  10911. [win32mbcs]
  10912. encoding = sjis
  10913. </pre>
  10914. <p>It is useful for the users who want to commit with UTF-8 log message.</p>
  10915. </div>
  10916. <div class="section" id="win32text">
  10917. <h2><a class="toc-backref" href="#id121">win32text</a></h2>
  10918. <p>perform automatic newline conversion (DEPRECATED)</p>
  10919. <blockquote>
  10920. <p>Deprecation: The win32text extension requires each user to configure
  10921. the extension again and again for each clone since the configuration
  10922. is not copied when cloning.</p>
  10923. <p>We have therefore made the <tt class="docutils literal">eol</tt> as an alternative. The <tt class="docutils literal">eol</tt>
  10924. uses a version controlled file for its configuration and each clone
  10925. will therefore use the right settings from the start.</p>
  10926. </blockquote>
  10927. <p>To perform automatic newline conversion, use:</p>
  10928. <pre class="literal-block">
  10929. [extensions]
  10930. win32text =
  10931. [encode]
  10932. ** = cleverencode:
  10933. # or ** = macencode:
  10934.  
  10935. [decode]
  10936. ** = cleverdecode:
  10937. # or ** = macdecode:
  10938. </pre>
  10939. <p>If not doing conversion, to make sure you do not commit CRLF/CR by accident:</p>
  10940. <pre class="literal-block">
  10941. [hooks]
  10942. pretxncommit.crlf = python:hgext.win32text.forbidcrlf
  10943. # or pretxncommit.cr = python:hgext.win32text.forbidcr
  10944. </pre>
  10945. <p>To do the same check on a server to prevent CRLF/CR from being
  10946. pushed or pulled:</p>
  10947. <pre class="literal-block">
  10948. [hooks]
  10949. pretxnchangegroup.crlf = python:hgext.win32text.forbidcrlf
  10950. # or pretxnchangegroup.cr = python:hgext.win32text.forbidcr
  10951. </pre>
  10952. </div>
  10953. <div class="section" id="zeroconf">
  10954. <h2><a class="toc-backref" href="#id122">zeroconf</a></h2>
  10955. <p>discover and advertise repositories on the local network</p>
  10956. <p>Zeroconf-enabled repositories will be announced in a network without
  10957. the need to configure a server or a service. They can be discovered
  10958. without knowing their actual IP address.</p>
  10959. <p>To allow other people to discover your repository using run
  10960. <a class="reference external" href="hg.1.html#serve"><tt class="docutils literal">hg serve</tt></a> in your repository:</p>
  10961. <pre class="literal-block">
  10962. $ cd test
  10963. $ hg serve
  10964. </pre>
  10965. <p>You can discover Zeroconf-enabled repositories by running
  10966. <a class="reference external" href="hg.1.html#paths"><tt class="docutils literal">hg paths</tt></a>:</p>
  10967. <pre class="literal-block">
  10968. $ hg paths
  10969. zc-test = http://example.com:8000/test
  10970. </pre>
  10971. </div>
  10972. </div>
  10973. <div class="section" id="id54">
  10974. <h1><a class="toc-backref" href="#contents">Files</a></h1>
  10975. <dl class="docutils">
  10976. <dt><tt class="docutils literal">/etc/mercurial/hgrc</tt>, <tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt>, <tt class="docutils literal">.hg/hgrc</tt></dt>
  10977. <dd>This file contains defaults and configuration. Values in
  10978. <tt class="docutils literal">.hg/hgrc</tt> override those in <tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt>, and these override
  10979. settings made in the global <tt class="docutils literal">/etc/mercurial/hgrc</tt> configuration.
  10980. See <a class="reference external" href="hgrc.5.html"><strong>hgrc</strong>(5)</a> for details of the contents and format of these
  10981. files.</dd>
  10982. <dt><tt class="docutils literal">.hgignore</tt></dt>
  10983. <dd>This file contains regular expressions (one per line) that
  10984. describe file names that should be ignored by <strong>hg</strong>. For details,
  10985. see <a class="reference external" href="hgignore.5.html"><strong>hgignore</strong>(5)</a>.</dd>
  10986. <dt><tt class="docutils literal">.hgsub</tt></dt>
  10987. <dd>This file defines the locations of all subrepositories, and
  10988. tells where the subrepository checkouts came from. For details, see
  10989. <a class="reference external" href="hg.1.html#subrepos"><tt class="docutils literal">hg help subrepos</tt></a>.</dd>
  10990. <dt><tt class="docutils literal">.hgsubstate</tt></dt>
  10991. <dd>This file is where Mercurial stores all nested repository states. <em>NB: This
  10992. file should not be edited manually.</em></dd>
  10993. <dt><tt class="docutils literal">.hgtags</tt></dt>
  10994. <dd>This file contains changeset hash values and text tag names (one
  10995. of each separated by spaces) that correspond to tagged versions of
  10996. the repository contents. The file content is encoded using UTF-8.</dd>
  10997. <dt><tt class="docutils literal"><span class="pre">.hg/last-message.txt</span></tt></dt>
  10998. <dd>This file is used by <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit</tt></a> to store a backup of the commit message
  10999. in case the commit fails.</dd>
  11000. <dt><tt class="docutils literal">.hg/localtags</tt></dt>
  11001. <dd>This file can be used to define local tags which are not shared among
  11002. repositories. The file format is the same as for <tt class="docutils literal">.hgtags</tt>, but it is
  11003. encoded using the local system encoding.</dd>
  11004. </dl>
  11005. <p>Some commands (e.g. revert) produce backup files ending in <tt class="docutils literal">.orig</tt>,
  11006. if the <tt class="docutils literal">.orig</tt> file already exists and is not tracked by Mercurial,
  11007. it will be overwritten.</p>
  11008. </div>
  11009. <div class="section" id="bugs">
  11010. <h1><a class="toc-backref" href="#contents">Bugs</a></h1>
  11011. <p>Probably lots, please post them to the mailing list (see <a class="reference internal" href="#resources">Resources</a>
  11012. below) when you find them.</p>
  11013. </div>
  11014. <div class="section" id="see-also">
  11015. <h1><a class="toc-backref" href="#contents">See Also</a></h1>
  11016. <p><a class="reference external" href="hgignore.5.html"><strong>hgignore</strong>(5)</a>, <a class="reference external" href="hgrc.5.html"><strong>hgrc</strong>(5)</a></p>
  11017. </div>
  11018. <div class="section" id="author">
  11019. <h1><a class="toc-backref" href="#contents">Author</a></h1>
  11020. <p>Written by Matt Mackall &lt;<a class="reference external" href="mailto:mpm&#64;selenic.com">mpm&#64;selenic.com</a>&gt;</p>
  11021. </div>
  11022. <div class="section" id="resources">
  11023. <h1><a class="toc-backref" href="#contents">Resources</a></h1>
  11024. <p>Main Web Site: <a class="reference external" href="http://mercurial.selenic.com/">http://mercurial.selenic.com/</a></p>
  11025. <p>Source code repository: <a class="reference external" href="http://selenic.com/hg">http://selenic.com/hg</a></p>
  11026. <p>Mailing list: <a class="reference external" href="http://selenic.com/mailman/listinfo/mercurial">http://selenic.com/mailman/listinfo/mercurial</a></p>
  11027. </div>
  11028. <div class="section" id="copying">
  11029. <h1><a class="toc-backref" href="#contents">Copying</a></h1>
  11030. <p>Copyright (C) 2005-2015 Matt Mackall.
  11031. Free use of this software is granted under the terms of the GNU General
  11032. Public License version 2 or any later version.</p>
  11033. <span class="target" id="common"></span><!-- Common link and substitution definitions. -->
  11034. </div>
  11035. </div>
  11036. </body>
  11037. </html>
# Change User Description Committed
#1 15913 Doug_Napoleone Initial checkin of the latest stabel mercurial to then integrate the changes from //guest/...sven_erik_knop/mercurial on top of (preserving the new HG code).
The purpose is to get it working with the latest version of HG. «		 10 years ago