Loading...
Helix SwarmHelix Swarm
Loading...

hg.1.html

  • //
  • guest/
  • sven_erik_knop/
  • mercurial/
  • doc/
  • hg.1.html #1
  • View
  • Commits
  • Open Download .zip Download (325 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.7: 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. <h1 class="title">hg</h1>
  15. <h2 class="subtitle" id="mercurial-source-code-management-system">Mercurial source code management system</h2>
  16. <table class="docinfo" frame="void" rules="none">
  17. <col class="docinfo-name" />
  18. <col class="docinfo-content" />
  19. <tbody valign="top">
  20. <tr><th class="docinfo-name">Author:</th>
  21. <td>Matt Mackall &lt;<a class="reference external" href="mailto:mpm&#64;selenic.com">mpm&#64;selenic.com</a>&gt;</td></tr>
  22. <tr><th class="docinfo-name">Organization:</th>
  23. <td>Mercurial</td></tr>
  24. <tr class="field"><th class="docinfo-name">Manual section:</th><td class="field-body">1</td>
  25. </tr>
  26. <tr class="field"><th class="docinfo-name">Manual group:</th><td class="field-body">Mercurial Manual</td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. <div class="contents htmlonly topic" id="contents">
  31. <p class="topic-title first">Contents</p>
  32. <ul class="simple">
  33. <li><a class="reference internal" href="#synopsis" id="id36">Synopsis</a></li>
  34. <li><a class="reference internal" href="#description" id="id37">Description</a></li>
  35. <li><a class="reference internal" href="#command-elements" id="id38">Command Elements</a></li>
  36. <li><a class="reference internal" href="#options" id="id39">Options</a></li>
  37. <li><a class="reference internal" href="#commands" id="id40">Commands</a></li>
  38. <li><a class="reference internal" href="#configuration-files" id="id41">Configuration Files</a></li>
  39. <li><a class="reference internal" href="#date-formats" id="id42">Date Formats</a></li>
  40. <li><a class="reference internal" href="#file-name-patterns" id="id43">File Name Patterns</a></li>
  41. <li><a class="reference internal" href="#environment-variables" id="id44">Environment Variables</a></li>
  42. <li><a class="reference internal" href="#specifying-single-revisions" id="id45">Specifying Single Revisions</a></li>
  43. <li><a class="reference internal" href="#specifying-multiple-revisions" id="id46">Specifying Multiple Revisions</a></li>
  44. <li><a class="reference internal" href="#specifying-revision-sets" id="id47">Specifying Revision Sets</a></li>
  45. <li><a class="reference internal" href="#diff-formats" id="id48">Diff Formats</a></li>
  46. <li><a class="reference internal" href="#id1" id="id49">Merge Tools</a></li>
  47. <li><a class="reference internal" href="#template-usage" id="id50">Template Usage</a></li>
  48. <li><a class="reference internal" href="#url-paths" id="id51">URL Paths</a></li>
  49. <li><a class="reference internal" href="#using-additional-features" id="id52">Using additional features</a></li>
  50. <li><a class="reference internal" href="#subrepositories" id="id53">Subrepositories</a></li>
  51. <li><a class="reference internal" href="#adding-a-subrepository" id="id54">Adding a Subrepository</a></li>
  52. <li><a class="reference internal" href="#synchronizing-a-subrepository" id="id55">Synchronizing a Subrepository</a></li>
  53. <li><a class="reference internal" href="#deleting-a-subrepository" id="id56">Deleting a Subrepository</a></li>
  54. <li><a class="reference internal" href="#interaction-with-mercurial-commands" id="id57">Interaction with Mercurial Commands</a></li>
  55. <li><a class="reference internal" href="#remapping-subrepositories-sources" id="id58">Remapping Subrepositories Sources</a></li>
  56. <li><a class="reference internal" href="#configuring-hgweb" id="id59">Configuring hgweb</a></li>
  57. <li><a class="reference internal" href="#id2" id="id60">Glossary</a></li>
  58. <li><a class="reference internal" href="#id3" id="id61">Extensions</a></li>
  59. <li><a class="reference internal" href="#files" id="id62">Files</a></li>
  60. <li><a class="reference internal" href="#bugs" id="id63">Bugs</a></li>
  61. <li><a class="reference internal" href="#see-also" id="id64">See Also</a></li>
  62. <li><a class="reference internal" href="#author" id="id65">Author</a></li>
  63. <li><a class="reference internal" href="#resources" id="id66">Resources</a></li>
  64. <li><a class="reference internal" href="#copying" id="id67">Copying</a></li>
  65. </ul>
  66. </div>
  67. <div class="section" id="synopsis">
  68. <h1><a class="toc-backref" href="#contents">Synopsis</a></h1>
  69. <p><strong>hg</strong> <em>command</em> [<em>option</em>]... [<em>argument</em>]...</p>
  70. </div>
  71. <div class="section" id="description">
  72. <h1><a class="toc-backref" href="#contents">Description</a></h1>
  73. <p>The <strong>hg</strong> command provides a command line interface to the Mercurial
  74. system.</p>
  75. </div>
  76. <div class="section" id="command-elements">
  77. <h1><a class="toc-backref" href="#contents">Command Elements</a></h1>
  78. <dl class="docutils">
  79. <dt>files...</dt>
  80. <dd>indicates one or more filename or relative path filenames; see
  81. <a class="reference internal" href="#file-name-patterns">File Name Patterns</a> for information on pattern matching</dd>
  82. <dt>path</dt>
  83. <dd>indicates a path on the local machine</dd>
  84. <dt>revision</dt>
  85. <dd>indicates a changeset which can be specified as a changeset
  86. revision number, a tag, or a unique substring of the changeset
  87. hash value</dd>
  88. <dt>repository path</dt>
  89. <dd>either the pathname of a local repository or the URI of a remote
  90. repository.</dd>
  91. </dl>
  92. </div>
  93. <div class="section" id="options">
  94. <h1><a class="toc-backref" href="#contents">Options</a></h1>
  95. <table class="docutils option-list" frame="void" rules="none">
  96. <col class="option" />
  97. <col class="description" />
  98. <tbody valign="top">
  99. <tr><td class="option-group" colspan="2">
  100. <kbd><span class="option">-R</span>, <span class="option">--repository</span></kbd></td>
  101. </tr>
  102. <tr><td>&nbsp;</td><td>repository root directory or name of overlay bundle file</td></tr>
  103. <tr><td class="option-group">
  104. <kbd><span class="option">--cwd</span></kbd></td>
  105. <td>change working directory</td></tr>
  106. <tr><td class="option-group" colspan="2">
  107. <kbd><span class="option">-y</span>, <span class="option">--noninteractive</span></kbd></td>
  108. </tr>
  109. <tr><td>&nbsp;</td><td>do not prompt, assume 'yes' for any required answers</td></tr>
  110. <tr><td class="option-group">
  111. <kbd><span class="option">-q</span>, <span class="option">--quiet</span></kbd></td>
  112. <td>suppress output</td></tr>
  113. <tr><td class="option-group">
  114. <kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></td>
  115. <td>enable additional output</td></tr>
  116. <tr><td class="option-group">
  117. <kbd><span class="option">--config</span></kbd></td>
  118. <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">
  126. <kbd><span class="option">--encoding</span></kbd></td>
  127. <td>set the charset encoding (default: ascii)</td></tr>
  128. <tr><td class="option-group">
  129. <kbd><span class="option">--encodingmode</span></kbd></td>
  130. <td>set the charset encoding mode (default: strict)</td></tr>
  131. <tr><td class="option-group">
  132. <kbd><span class="option">--traceback</span></kbd></td>
  133. <td>always print a traceback on exception</td></tr>
  134. <tr><td class="option-group">
  135. <kbd><span class="option">--time</span></kbd></td>
  136. <td>time how long the command takes</td></tr>
  137. <tr><td class="option-group">
  138. <kbd><span class="option">--profile</span></kbd></td>
  139. <td>print command execution profile</td></tr>
  140. <tr><td class="option-group">
  141. <kbd><span class="option">--version</span></kbd></td>
  142. <td>output version information and exit</td></tr>
  143. <tr><td class="option-group">
  144. <kbd><span class="option">-h</span>, <span class="option">--help</span></kbd></td>
  145. <td>display help and exit</td></tr>
  146. </tbody>
  147. </table>
  148. </div>
  149. <div class="section" id="commands">
  150. <h1><a class="toc-backref" href="#contents">Commands</a></h1>
  151. <div class="section" id="add">
  152. <h2>add</h2>
  153. <pre class="literal-block">
  154. hg add [OPTION]... [FILE]...
  155. </pre>
  156. <p>Schedule files to be version controlled and added to the
  157. repository.</p>
  158. <p>The files will be added to the repository at the next commit. To
  159. undo an add before that, see <a class="reference external" href="hg.1.html#forget"><tt class="docutils literal">hg forget</tt></a>.</p>
  160. <p>If no names are given, add all files to the repository.</p>
  161. <div class="verbose container">
  162. <p>An example showing how new (unknown) files are added
  163. automatically by <a class="reference external" href="hg.1.html#add"><tt class="docutils literal">hg add</tt></a>:</p>
  164. <pre class="literal-block">
  165. $ ls
  166. foo.c
  167. $ hg status
  168. ? foo.c
  169. $ hg add
  170. adding foo.c
  171. $ hg status
  172. A foo.c
  173. </pre>
  174. </div>
  175. <p>Returns 0 if all files are successfully added.</p>
  176. <p>options:</p>
  177. <table class="docutils option-list" frame="void" rules="none">
  178. <col class="option" />
  179. <col class="description" />
  180. <tbody valign="top">
  181. <tr><td class="option-group">
  182. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  183. <td>include names matching the given patterns</td></tr>
  184. <tr><td class="option-group">
  185. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  186. <td>exclude names matching the given patterns</td></tr>
  187. <tr><td class="option-group">
  188. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  189. <td>recurse into subrepositories</td></tr>
  190. <tr><td class="option-group">
  191. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  192. <td>do not perform actions, just print output</td></tr>
  193. </tbody>
  194. </table>
  195. </div>
  196. <div class="section" id="addremove">
  197. <h2>addremove</h2>
  198. <pre class="literal-block">
  199. hg addremove [OPTION]... [FILE]...
  200. </pre>
  201. <p>Add all new files and remove all missing files from the
  202. repository.</p>
  203. <p>New files are ignored if they match any of the patterns in
  204. .hgignore. As with add, these changes take effect at the next
  205. commit.</p>
  206. <p>Use the -s/--similarity option to detect renamed files. With a
  207. parameter greater than 0, this compares every removed file with
  208. every added file and records those similar enough as renames. This
  209. option takes a percentage between 0 (disabled) and 100 (files must
  210. be identical) as its parameter. Detecting renamed files this way
  211. 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
  212. used to check which files were identified as moved or renamed.</p>
  213. <p>Returns 0 if all files are successfully added.</p>
  214. <p>options:</p>
  215. <table class="docutils option-list" frame="void" rules="none">
  216. <col class="option" />
  217. <col class="description" />
  218. <tbody valign="top">
  219. <tr><td class="option-group" colspan="2">
  220. <kbd><span class="option">-s</span>, <span class="option">--similarity</span></kbd></td>
  221. </tr>
  222. <tr><td>&nbsp;</td><td>guess renamed files by similarity (0&lt;=s&lt;=100)</td></tr>
  223. <tr><td class="option-group">
  224. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  225. <td>include names matching the given patterns</td></tr>
  226. <tr><td class="option-group">
  227. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  228. <td>exclude names matching the given patterns</td></tr>
  229. <tr><td class="option-group">
  230. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  231. <td>do not perform actions, just print output</td></tr>
  232. </tbody>
  233. </table>
  234. </div>
  235. <div class="section" id="annotate">
  236. <h2>annotate</h2>
  237. <pre class="literal-block">
  238. hg annotate [-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...
  239. </pre>
  240. <p>List changes in files, showing the revision id responsible for
  241. each line</p>
  242. <p>This command is useful for discovering when a change was made and
  243. by whom.</p>
  244. <p>Without the -a/--text option, annotate will avoid processing files
  245. it detects as binary. With -a, annotate will annotate the file
  246. anyway, although the results will probably be neither useful
  247. nor desirable.</p>
  248. <p>Returns 0 on success.</p>
  249. <p>options:</p>
  250. <table class="docutils option-list" frame="void" rules="none">
  251. <col class="option" />
  252. <col class="description" />
  253. <tbody valign="top">
  254. <tr><td class="option-group">
  255. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  256. <td>annotate the specified revision</td></tr>
  257. <tr><td class="option-group">
  258. <kbd><span class="option">--follow</span></kbd></td>
  259. <td>follow copies/renames and list the filename (DEPRECATED)</td></tr>
  260. <tr><td class="option-group">
  261. <kbd><span class="option">--no-follow</span></kbd></td>
  262. <td>don't follow copies and renames</td></tr>
  263. <tr><td class="option-group">
  264. <kbd><span class="option">-a</span>, <span class="option">--text</span></kbd></td>
  265. <td>treat all files as text</td></tr>
  266. <tr><td class="option-group">
  267. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  268. <td>list the author (long with -v)</td></tr>
  269. <tr><td class="option-group">
  270. <kbd><span class="option">-f</span>, <span class="option">--file</span></kbd></td>
  271. <td>list the filename</td></tr>
  272. <tr><td class="option-group">
  273. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  274. <td>list the date (short with -q)</td></tr>
  275. <tr><td class="option-group">
  276. <kbd><span class="option">-n</span>, <span class="option">--number</span></kbd></td>
  277. <td>list the revision number (default)</td></tr>
  278. <tr><td class="option-group" colspan="2">
  279. <kbd><span class="option">-c</span>, <span class="option">--changeset</span></kbd></td>
  280. </tr>
  281. <tr><td>&nbsp;</td><td>list the changeset</td></tr>
  282. <tr><td class="option-group" colspan="2">
  283. <kbd><span class="option">-l</span>, <span class="option">--line-number</span></kbd></td>
  284. </tr>
  285. <tr><td>&nbsp;</td><td>show line number at the first appearance</td></tr>
  286. <tr><td class="option-group">
  287. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  288. <td>include names matching the given patterns</td></tr>
  289. <tr><td class="option-group">
  290. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  291. <td><p class="first">exclude names matching the given patterns</p>
  292. <p class="last">aliases: blame</p>
  293. </td></tr>
  294. </tbody>
  295. </table>
  296. </div>
  297. <div class="section" id="archive">
  298. <h2>archive</h2>
  299. <pre class="literal-block">
  300. hg archive [OPTION]... DEST
  301. </pre>
  302. <p>By default, the revision used is the parent of the working
  303. directory; use -r/--rev to specify a different revision.</p>
  304. <p>The archive type is automatically detected based on file
  305. extension (or override using -t/--type).</p>
  306. <p>Valid types are:</p>
  307. <table class="docutils field-list" frame="void" rules="none">
  308. <col class="field-name" />
  309. <col class="field-body" />
  310. <tbody valign="top">
  311. <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>
  312. </tr>
  313. <tr class="field"><th class="field-name"><tt class="docutils literal">tar</tt>:</th><td class="field-body">tar archive, uncompressed</td>
  314. </tr>
  315. <tr class="field"><th class="field-name"><tt class="docutils literal">tbz2</tt>:</th><td class="field-body">tar archive, compressed using bzip2</td>
  316. </tr>
  317. <tr class="field"><th class="field-name"><tt class="docutils literal">tgz</tt>:</th><td class="field-body">tar archive, compressed using gzip</td>
  318. </tr>
  319. <tr class="field"><th class="field-name"><tt class="docutils literal">uzip</tt>:</th><td class="field-body">zip archive, uncompressed</td>
  320. </tr>
  321. <tr class="field"><th class="field-name"><tt class="docutils literal">zip</tt>:</th><td class="field-body">zip archive, compressed using deflate</td>
  322. </tr>
  323. </tbody>
  324. </table>
  325. <p>The exact name of the destination archive or directory is given
  326. 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>
  327. <p>Each member added to an archive file has a directory prefix
  328. prepended. Use -p/--prefix to specify a format string for the
  329. prefix. The default is the basename of the archive, with suffixes
  330. removed.</p>
  331. <p>Returns 0 on success.</p>
  332. <p>options:</p>
  333. <table class="docutils option-list" frame="void" rules="none">
  334. <col class="option" />
  335. <col class="description" />
  336. <tbody valign="top">
  337. <tr><td class="option-group">
  338. <kbd><span class="option">--no-decode</span></kbd></td>
  339. <td>do not pass files through decoders</td></tr>
  340. <tr><td class="option-group">
  341. <kbd><span class="option">-p</span>, <span class="option">--prefix</span></kbd></td>
  342. <td>directory prefix for files in archive</td></tr>
  343. <tr><td class="option-group">
  344. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  345. <td>revision to distribute</td></tr>
  346. <tr><td class="option-group">
  347. <kbd><span class="option">-t</span>, <span class="option">--type</span></kbd></td>
  348. <td>type of distribution to create</td></tr>
  349. <tr><td class="option-group">
  350. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  351. <td>recurse into subrepositories</td></tr>
  352. <tr><td class="option-group">
  353. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  354. <td>include names matching the given patterns</td></tr>
  355. <tr><td class="option-group">
  356. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  357. <td>exclude names matching the given patterns</td></tr>
  358. </tbody>
  359. </table>
  360. </div>
  361. <div class="section" id="backout">
  362. <h2>backout</h2>
  363. <pre class="literal-block">
  364. hg backout [OPTION]... [-r] REV
  365. </pre>
  366. <p>The backout command merges the reverse effect of the reverted
  367. changeset into the working directory.</p>
  368. <p>With the --merge option, it first commits the reverted changes
  369. as a new changeset. This new changeset is a child of the reverted
  370. changeset.
  371. The --merge option remembers the parent of the working directory
  372. before starting the backout, then merges the new head with that
  373. changeset afterwards.
  374. This will result in an explicit merge in the history.</p>
  375. <p>If you backout a changeset other than the original parent of the
  376. working directory, the result of this merge is not committed,
  377. as with a normal merge. Otherwise, no merge is needed and the
  378. commit is automatic.</p>
  379. <p>Note that the default behavior (without --merge) has changed in
  380. version 1.7. To restore the previous default behavior, use
  381. <a class="reference external" href="hg.1.html#backout"><tt class="docutils literal">hg backout <span class="pre">--merge</span></tt></a> and then <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update <span class="pre">--clean</span> .</tt></a> to get rid of
  382. the ongoing merge.</p>
  383. <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>
  384. <p>Returns 0 on success.</p>
  385. <p>options:</p>
  386. <table class="docutils option-list" frame="void" rules="none">
  387. <col class="option" />
  388. <col class="description" />
  389. <tbody valign="top">
  390. <tr><td class="option-group">
  391. <kbd><span class="option">--merge</span></kbd></td>
  392. <td>merge with old dirstate parent after backout</td></tr>
  393. <tr><td class="option-group">
  394. <kbd><span class="option">--parent</span></kbd></td>
  395. <td>parent to choose when backing out merge</td></tr>
  396. <tr><td class="option-group">
  397. <kbd><span class="option">-t</span>, <span class="option">--tool</span></kbd></td>
  398. <td>specify merge tool</td></tr>
  399. <tr><td class="option-group">
  400. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  401. <td>revision to backout</td></tr>
  402. <tr><td class="option-group">
  403. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  404. <td>include names matching the given patterns</td></tr>
  405. <tr><td class="option-group">
  406. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  407. <td>exclude names matching the given patterns</td></tr>
  408. <tr><td class="option-group">
  409. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  410. <td>use text as commit message</td></tr>
  411. <tr><td class="option-group">
  412. <kbd><span class="option">-l</span>, <span class="option">--logfile</span></kbd></td>
  413. <td>read commit message from file</td></tr>
  414. <tr><td class="option-group">
  415. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  416. <td>record datecode as commit date</td></tr>
  417. <tr><td class="option-group">
  418. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  419. <td>record the specified user as committer</td></tr>
  420. </tbody>
  421. </table>
  422. </div>
  423. <div class="section" id="bisect">
  424. <h2>bisect</h2>
  425. <pre class="literal-block">
  426. hg bisect [-gbsr] [-U] [-c CMD] [REV]
  427. </pre>
  428. <p>This command helps to find changesets which introduce problems. To
  429. use, mark the earliest changeset you know exhibits the problem as
  430. bad, then mark the latest changeset which is free from the problem
  431. as good. Bisect will update your working directory to a revision
  432. for testing (unless the -U/--noupdate option is specified). Once
  433. you have performed tests, mark the working directory as good or
  434. bad, and bisect will either update to another candidate changeset
  435. or announce that it has found the bad revision.</p>
  436. <p>As a shortcut, you can also use the revision argument to mark a
  437. revision as good or bad without checking it out first.</p>
  438. <p>If you supply a command, it will be used for automatic bisection.
  439. Its exit status will be used to mark revisions as good or bad:
  440. status 0 means good, 125 means to skip the revision, 127
  441. (command not found) will abort the bisection, and any other
  442. non-zero exit status means the revision is bad.</p>
  443. <p>Returns 0 on success.</p>
  444. <p>options:</p>
  445. <table class="docutils option-list" frame="void" rules="none">
  446. <col class="option" />
  447. <col class="description" />
  448. <tbody valign="top">
  449. <tr><td class="option-group">
  450. <kbd><span class="option">-r</span>, <span class="option">--reset</span></kbd></td>
  451. <td>reset bisect state</td></tr>
  452. <tr><td class="option-group">
  453. <kbd><span class="option">-g</span>, <span class="option">--good</span></kbd></td>
  454. <td>mark changeset good</td></tr>
  455. <tr><td class="option-group">
  456. <kbd><span class="option">-b</span>, <span class="option">--bad</span></kbd></td>
  457. <td>mark changeset bad</td></tr>
  458. <tr><td class="option-group">
  459. <kbd><span class="option">-s</span>, <span class="option">--skip</span></kbd></td>
  460. <td>skip testing changeset</td></tr>
  461. <tr><td class="option-group">
  462. <kbd><span class="option">-c</span>, <span class="option">--command</span></kbd></td>
  463. <td>use command to check changeset state</td></tr>
  464. <tr><td class="option-group">
  465. <kbd><span class="option">-U</span>, <span class="option">--noupdate</span></kbd></td>
  466. <td>do not update to target</td></tr>
  467. </tbody>
  468. </table>
  469. </div>
  470. <div class="section" id="branch">
  471. <h2>branch</h2>
  472. <pre class="literal-block">
  473. hg branch [-fC] [NAME]
  474. </pre>
  475. <p>With no argument, show the current branch name. With one argument,
  476. set the working directory branch name (the branch will not exist
  477. in the repository until the next commit). Standard practice
  478. recommends that primary development take place on the 'default'
  479. branch.</p>
  480. <p>Unless -f/--force is specified, branch will not let you set a
  481. branch name that already exists, even if it's inactive.</p>
  482. <p>Use -C/--clean to reset the working directory branch to that of
  483. the parent of the working directory, negating a previous branch
  484. change.</p>
  485. <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
  486. <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 as closed.</p>
  487. <p>Returns 0 on success.</p>
  488. <p>options:</p>
  489. <table class="docutils option-list" frame="void" rules="none">
  490. <col class="option" />
  491. <col class="description" />
  492. <tbody valign="top">
  493. <tr><td class="option-group">
  494. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  495. <td>set branch name even if it shadows an existing branch</td></tr>
  496. <tr><td class="option-group">
  497. <kbd><span class="option">-C</span>, <span class="option">--clean</span></kbd></td>
  498. <td>reset branch name to parent branch name</td></tr>
  499. </tbody>
  500. </table>
  501. </div>
  502. <div class="section" id="branches">
  503. <h2>branches</h2>
  504. <pre class="literal-block">
  505. hg branches [-ac]
  506. </pre>
  507. <p>List the repository's named branches, indicating which ones are
  508. inactive. If -c/--closed is specified, also list branches which have
  509. 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>
  510. <p>If -a/--active is specified, only show active branches. A branch
  511. is considered active if it contains repository heads.</p>
  512. <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>
  513. <p>Returns 0.</p>
  514. <p>options:</p>
  515. <table class="docutils option-list" frame="void" rules="none">
  516. <col class="option" />
  517. <col class="description" />
  518. <tbody valign="top">
  519. <tr><td class="option-group">
  520. <kbd><span class="option">-a</span>, <span class="option">--active</span></kbd></td>
  521. <td>show only branches that have unmerged heads</td></tr>
  522. <tr><td class="option-group">
  523. <kbd><span class="option">-c</span>, <span class="option">--closed</span></kbd></td>
  524. <td>show normal and closed branches</td></tr>
  525. </tbody>
  526. </table>
  527. </div>
  528. <div class="section" id="bundle">
  529. <h2>bundle</h2>
  530. <pre class="literal-block">
  531. hg bundle [-f] [-t TYPE] [-a] [-r REV]... [--base REV]... FILE [DEST]
  532. </pre>
  533. <p>Generate a compressed changegroup file collecting changesets not
  534. known to be in another repository.</p>
  535. <p>If you omit the destination repository, then hg assumes the
  536. destination will have all the nodes you specify with --base
  537. parameters. To create a bundle containing all changesets, use
  538. -a/--all (or --base null).</p>
  539. <p>You can change compression method with the -t/--type option.
  540. The available compression methods are: none, bzip2, and
  541. gzip (by default, bundles are compressed using bzip2).</p>
  542. <p>The bundle file can then be transferred using conventional means
  543. and applied to another repository with the unbundle or pull
  544. command. This is useful when direct push and pull are not
  545. available or when exporting an entire repository is undesirable.</p>
  546. <p>Applying bundles preserves all changeset contents including
  547. permissions, copy/rename information, and revision history.</p>
  548. <p>Returns 0 on success, 1 if no changes found.</p>
  549. <p>options:</p>
  550. <table class="docutils option-list" frame="void" rules="none">
  551. <col class="option" />
  552. <col class="description" />
  553. <tbody valign="top">
  554. <tr><td class="option-group">
  555. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  556. <td>run even when the destination is unrelated</td></tr>
  557. <tr><td class="option-group">
  558. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  559. <td>a changeset intended to be added to the destination</td></tr>
  560. <tr><td class="option-group">
  561. <kbd><span class="option">-b</span>, <span class="option">--branch</span></kbd></td>
  562. <td>a specific branch you would like to bundle</td></tr>
  563. <tr><td class="option-group">
  564. <kbd><span class="option">--base</span></kbd></td>
  565. <td>a base changeset assumed to be available at the destination</td></tr>
  566. <tr><td class="option-group">
  567. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  568. <td>bundle all changesets in the repository</td></tr>
  569. <tr><td class="option-group">
  570. <kbd><span class="option">-t</span>, <span class="option">--type</span></kbd></td>
  571. <td>bundle compression type to use (default: bzip2)</td></tr>
  572. <tr><td class="option-group">
  573. <kbd><span class="option">-e</span>, <span class="option">--ssh</span></kbd></td>
  574. <td>specify ssh command to use</td></tr>
  575. <tr><td class="option-group">
  576. <kbd><span class="option">--remotecmd</span></kbd></td>
  577. <td>specify hg command to run on the remote side</td></tr>
  578. </tbody>
  579. </table>
  580. </div>
  581. <div class="section" id="cat">
  582. <h2>cat</h2>
  583. <pre class="literal-block">
  584. hg cat [OPTION]... FILE...
  585. </pre>
  586. <p>Print the specified files as they were at the given revision. If
  587. no revision is given, the parent of the working directory is used,
  588. or tip if no revision is checked out.</p>
  589. <p>Output may be to a file, in which case the name of the file is
  590. given using a format string. The formatting rules are the same as
  591. for the export command, with the following additions:</p>
  592. <table class="docutils field-list" frame="void" rules="none">
  593. <col class="field-name" />
  594. <col class="field-body" />
  595. <tbody valign="top">
  596. <tr class="field"><th class="field-name"><tt class="docutils literal">%s</tt>:</th><td class="field-body">basename of file being printed</td>
  597. </tr>
  598. <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>
  599. </tr>
  600. <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>
  601. </tr>
  602. </tbody>
  603. </table>
  604. <p>Returns 0 on success.</p>
  605. <p>options:</p>
  606. <table class="docutils option-list" frame="void" rules="none">
  607. <col class="option" />
  608. <col class="description" />
  609. <tbody valign="top">
  610. <tr><td class="option-group">
  611. <kbd><span class="option">-o</span>, <span class="option">--output</span></kbd></td>
  612. <td>print output to file with formatted name</td></tr>
  613. <tr><td class="option-group">
  614. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  615. <td>print the given revision</td></tr>
  616. <tr><td class="option-group">
  617. <kbd><span class="option">--decode</span></kbd></td>
  618. <td>apply any matching decode filter</td></tr>
  619. <tr><td class="option-group">
  620. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  621. <td>include names matching the given patterns</td></tr>
  622. <tr><td class="option-group">
  623. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  624. <td>exclude names matching the given patterns</td></tr>
  625. </tbody>
  626. </table>
  627. </div>
  628. <div class="section" id="clone">
  629. <h2>clone</h2>
  630. <pre class="literal-block">
  631. hg clone [OPTION]... SOURCE [DEST]
  632. </pre>
  633. <p>Create a copy of an existing repository in a new directory.</p>
  634. <p>If no destination directory name is specified, it defaults to the
  635. basename of the source.</p>
  636. <p>The location of the source is added to the new repository's
  637. .hg/hgrc file, as the default to be used for future pulls.</p>
  638. <p>See <a class="reference external" href="hg.1.html#urls"><tt class="docutils literal">hg help urls</tt></a> for valid source format details.</p>
  639. <p>It is possible to specify an <tt class="docutils literal"><span class="pre">ssh://</span></tt> URL as the destination, but no
  640. .hg/hgrc and working directory will be created on the remote side.
  641. 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> URLs.</p>
  642. <p>A set of changesets (tags, or branch names) to pull may be specified
  643. by listing each changeset (tag, or branch name) with -r/--rev.
  644. If -r/--rev is used, the cloned repository will contain only a subset
  645. of the changesets of the source repository. Only the set of changesets
  646. defined by all -r/--rev options (including all their ancestors)
  647. will be pulled into the destination repository.
  648. No subsequent changesets (including subsequent tags) will be present
  649. in the destination.</p>
  650. <p>Using -r/--rev (or 'clone src#rev dest') implies --pull, even for
  651. local source repositories.</p>
  652. <p>For efficiency, hardlinks are used for cloning whenever the source
  653. and destination are on the same filesystem (note this applies only
  654. to the repository data, not to the working directory). Some
  655. filesystems, such as AFS, implement hardlinking incorrectly, but
  656. do not report errors. In these cases, use the --pull option to
  657. avoid hardlinking.</p>
  658. <p>In some cases, you can clone repositories and the working directory
  659. using full hardlinks with</p>
  660. <pre class="literal-block">
  661. $ cp -al REPO REPOCLONE
  662. </pre>
  663. <p>This is the fastest way to clone, but it is not always safe. The
  664. operation is not atomic (making sure REPO is not modified during
  665. the operation is up to you) and you have to make sure your editor
  666. breaks hardlinks (Emacs and most Linux Kernel tools do so). Also,
  667. this is not compatible with certain extensions that place their
  668. metadata under the .hg directory, such as mq.</p>
  669. <p>Mercurial will update the working directory to the first applicable
  670. revision from this list:</p>
  671. <ol class="loweralpha simple">
  672. <li>null if -U or the source repository has no changesets</li>
  673. <li>if -u . and the source repository is local, the first parent of
  674. the source repository's working directory</li>
  675. <li>the changeset specified with -u (if a branch name, this means the
  676. latest head of that branch)</li>
  677. <li>the changeset specified with -r</li>
  678. <li>the tipmost head specified with -b</li>
  679. <li>the tipmost head specified with the url#branch source syntax</li>
  680. <li>the tipmost head of the default branch</li>
  681. <li>tip</li>
  682. </ol>
  683. <p>Returns 0 on success.</p>
  684. <p>options:</p>
  685. <table class="docutils option-list" frame="void" rules="none">
  686. <col class="option" />
  687. <col class="description" />
  688. <tbody valign="top">
  689. <tr><td class="option-group">
  690. <kbd><span class="option">-U</span>, <span class="option">--noupdate</span></kbd></td>
  691. <td>the clone will include an empty working copy (only a repository)</td></tr>
  692. <tr><td class="option-group" colspan="2">
  693. <kbd><span class="option">-u</span>, <span class="option">--updaterev</span></kbd></td>
  694. </tr>
  695. <tr><td>&nbsp;</td><td>revision, tag or branch to check out</td></tr>
  696. <tr><td class="option-group">
  697. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  698. <td>include the specified changeset</td></tr>
  699. <tr><td class="option-group">
  700. <kbd><span class="option">-b</span>, <span class="option">--branch</span></kbd></td>
  701. <td>clone only the specified branch</td></tr>
  702. <tr><td class="option-group">
  703. <kbd><span class="option">--pull</span></kbd></td>
  704. <td>use pull protocol to copy metadata</td></tr>
  705. <tr><td class="option-group">
  706. <kbd><span class="option">--uncompressed</span></kbd></td>
  707. <td>use uncompressed transfer (fast over LAN)</td></tr>
  708. <tr><td class="option-group">
  709. <kbd><span class="option">-e</span>, <span class="option">--ssh</span></kbd></td>
  710. <td>specify ssh command to use</td></tr>
  711. <tr><td class="option-group">
  712. <kbd><span class="option">--remotecmd</span></kbd></td>
  713. <td>specify hg command to run on the remote side</td></tr>
  714. </tbody>
  715. </table>
  716. </div>
  717. <div class="section" id="commit">
  718. <h2>commit</h2>
  719. <pre class="literal-block">
  720. hg commit [OPTION]... [FILE]...
  721. </pre>
  722. <p>Commit changes to the given files into the repository. Unlike a
  723. centralized RCS, this operation is a local operation. See
  724. <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>
  725. <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>
  726. will be committed.</p>
  727. <p>If you are committing the result of a merge, do not provide any
  728. filenames or -I/-X filters.</p>
  729. <p>If no commit message is specified, Mercurial starts your
  730. configured editor where you can enter a message. In case your
  731. commit fails, you will find a backup of your message in
  732. <tt class="docutils literal"><span class="pre">.hg/last-message.txt</span></tt>.</p>
  733. <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>
  734. <p>Returns 0 on success, 1 if nothing changed.</p>
  735. <p>options:</p>
  736. <table class="docutils option-list" frame="void" rules="none">
  737. <col class="option" />
  738. <col class="description" />
  739. <tbody valign="top">
  740. <tr><td class="option-group" colspan="2">
  741. <kbd><span class="option">-A</span>, <span class="option">--addremove</span></kbd></td>
  742. </tr>
  743. <tr><td>&nbsp;</td><td>mark new/missing files as added/removed before committing</td></tr>
  744. <tr><td class="option-group">
  745. <kbd><span class="option">--close-branch</span></kbd></td>
  746. <td>mark a branch as closed, hiding it from the branch list</td></tr>
  747. <tr><td class="option-group">
  748. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  749. <td>include names matching the given patterns</td></tr>
  750. <tr><td class="option-group">
  751. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  752. <td>exclude names matching the given patterns</td></tr>
  753. <tr><td class="option-group">
  754. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  755. <td>use text as commit message</td></tr>
  756. <tr><td class="option-group">
  757. <kbd><span class="option">-l</span>, <span class="option">--logfile</span></kbd></td>
  758. <td>read commit message from file</td></tr>
  759. <tr><td class="option-group">
  760. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  761. <td>record datecode as commit date</td></tr>
  762. <tr><td class="option-group">
  763. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  764. <td><p class="first">record the specified user as committer</p>
  765. <p class="last">aliases: ci</p>
  766. </td></tr>
  767. </tbody>
  768. </table>
  769. </div>
  770. <div class="section" id="copy">
  771. <h2>copy</h2>
  772. <pre class="literal-block">
  773. hg copy [OPTION]... [SOURCE]... DEST
  774. </pre>
  775. <p>Mark dest as having copies of source files. If dest is a
  776. directory, copies are put in that directory. If dest is a file,
  777. the source must be a single file.</p>
  778. <p>By default, this command copies the contents of files as they
  779. exist in the working directory. If invoked with -A/--after, the
  780. operation is recorded, but no copying is performed.</p>
  781. <p>This command takes effect with the next commit. To undo a copy
  782. before that, see <a class="reference external" href="hg.1.html#revert"><tt class="docutils literal">hg revert</tt></a>.</p>
  783. <p>Returns 0 on success, 1 if errors are encountered.</p>
  784. <p>options:</p>
  785. <table class="docutils option-list" frame="void" rules="none">
  786. <col class="option" />
  787. <col class="description" />
  788. <tbody valign="top">
  789. <tr><td class="option-group">
  790. <kbd><span class="option">-A</span>, <span class="option">--after</span></kbd></td>
  791. <td>record a copy that has already occurred</td></tr>
  792. <tr><td class="option-group">
  793. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  794. <td>forcibly copy over an existing managed file</td></tr>
  795. <tr><td class="option-group">
  796. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  797. <td>include names matching the given patterns</td></tr>
  798. <tr><td class="option-group">
  799. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  800. <td>exclude names matching the given patterns</td></tr>
  801. <tr><td class="option-group">
  802. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  803. <td><p class="first">do not perform actions, just print output</p>
  804. <p class="last">aliases: cp</p>
  805. </td></tr>
  806. </tbody>
  807. </table>
  808. </div>
  809. <div class="section" id="diff">
  810. <h2>diff</h2>
  811. <pre class="literal-block">
  812. hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
  813. </pre>
  814. <p>Show differences between revisions for the specified files.</p>
  815. <p>Differences between files are shown using the unified diff format.</p>
  816. <div class="note">
  817. <p class="first admonition-title">Note</p>
  818. <p class="last">diff may generate unexpected results for merges, as it will
  819. default to comparing against the working directory's first
  820. parent changeset if no revisions are specified.</p>
  821. </div>
  822. <p>When two revision arguments are given, then changes are shown
  823. between those revisions. If only one revision is specified then
  824. that revision is compared to the working directory, and, when no
  825. revisions are specified, the working directory files are compared
  826. to its parent.</p>
  827. <p>Alternatively you can specify -c/--change with a revision to see
  828. the changes in that changeset relative to its first parent.</p>
  829. <p>Without the -a/--text option, diff will avoid generating diffs of
  830. files it detects as binary. With -a, diff will generate a diff
  831. anyway, probably with undesirable results.</p>
  832. <p>Use the -g/--git option to generate diffs in the git extended diff
  833. format. For more information, read <a class="reference external" href="hg.1.html#diffs"><tt class="docutils literal">hg help diffs</tt></a>.</p>
  834. <p>Returns 0 on success.</p>
  835. <p>options:</p>
  836. <table class="docutils option-list" frame="void" rules="none">
  837. <col class="option" />
  838. <col class="description" />
  839. <tbody valign="top">
  840. <tr><td class="option-group">
  841. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  842. <td>revision</td></tr>
  843. <tr><td class="option-group">
  844. <kbd><span class="option">-c</span>, <span class="option">--change</span></kbd></td>
  845. <td>change made by revision</td></tr>
  846. <tr><td class="option-group">
  847. <kbd><span class="option">-a</span>, <span class="option">--text</span></kbd></td>
  848. <td>treat all files as text</td></tr>
  849. <tr><td class="option-group">
  850. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  851. <td>use git extended diff format</td></tr>
  852. <tr><td class="option-group">
  853. <kbd><span class="option">--nodates</span></kbd></td>
  854. <td>omit dates from diff headers</td></tr>
  855. <tr><td class="option-group" colspan="2">
  856. <kbd><span class="option">-p</span>, <span class="option">--show-function</span></kbd></td>
  857. </tr>
  858. <tr><td>&nbsp;</td><td>show which function each change is in</td></tr>
  859. <tr><td class="option-group">
  860. <kbd><span class="option">--reverse</span></kbd></td>
  861. <td>produce a diff that undoes the changes</td></tr>
  862. <tr><td class="option-group" colspan="2">
  863. <kbd><span class="option">-w</span>, <span class="option">--ignore-all-space</span></kbd></td>
  864. </tr>
  865. <tr><td>&nbsp;</td><td>ignore white space when comparing lines</td></tr>
  866. <tr><td class="option-group" colspan="2">
  867. <kbd><span class="option">-b</span>, <span class="option">--ignore-space-change</span></kbd></td>
  868. </tr>
  869. <tr><td>&nbsp;</td><td>ignore changes in the amount of white space</td></tr>
  870. <tr><td class="option-group" colspan="2">
  871. <kbd><span class="option">-B</span>, <span class="option">--ignore-blank-lines</span></kbd></td>
  872. </tr>
  873. <tr><td>&nbsp;</td><td>ignore changes whose lines are all blank</td></tr>
  874. <tr><td class="option-group">
  875. <kbd><span class="option">-U</span>, <span class="option">--unified</span></kbd></td>
  876. <td>number of lines of context to show</td></tr>
  877. <tr><td class="option-group">
  878. <kbd><span class="option">--stat</span></kbd></td>
  879. <td>output diffstat-style summary of changes</td></tr>
  880. <tr><td class="option-group">
  881. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  882. <td>include names matching the given patterns</td></tr>
  883. <tr><td class="option-group">
  884. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  885. <td>exclude names matching the given patterns</td></tr>
  886. <tr><td class="option-group">
  887. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  888. <td>recurse into subrepositories</td></tr>
  889. </tbody>
  890. </table>
  891. </div>
  892. <div class="section" id="export">
  893. <h2>export</h2>
  894. <pre class="literal-block">
  895. hg export [OPTION]... [-o OUTFILESPEC] REV...
  896. </pre>
  897. <p>Print the changeset header and diffs for one or more revisions.</p>
  898. <p>The information shown in the changeset header is: author, date,
  899. branch name (if non-default), changeset hash, parent(s) and commit
  900. comment.</p>
  901. <div class="note">
  902. <p class="first admonition-title">Note</p>
  903. <p class="last">export may generate unexpected diff output for merge
  904. changesets, as it will compare the merge changeset against its
  905. first parent only.</p>
  906. </div>
  907. <p>Output may be to a file, in which case the name of the file is
  908. given using a format string. The formatting rules are as follows:</p>
  909. <table class="docutils field-list" frame="void" rules="none">
  910. <col class="field-name" />
  911. <col class="field-body" />
  912. <tbody valign="top">
  913. <tr class="field"><th class="field-name"><tt class="docutils literal">%%</tt>:</th><td class="field-body">literal &quot;%&quot; character</td>
  914. </tr>
  915. <tr class="field"><th class="field-name"><tt class="docutils literal">%H</tt>:</th><td class="field-body">changeset hash (40 hexadecimal digits)</td>
  916. </tr>
  917. <tr class="field"><th class="field-name"><tt class="docutils literal">%N</tt>:</th><td class="field-body">number of patches being generated</td>
  918. </tr>
  919. <tr class="field"><th class="field-name"><tt class="docutils literal">%R</tt>:</th><td class="field-body">changeset revision number</td>
  920. </tr>
  921. <tr class="field"><th class="field-name"><tt class="docutils literal">%b</tt>:</th><td class="field-body">basename of the exporting repository</td>
  922. </tr>
  923. <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>
  924. </tr>
  925. <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>
  926. </tr>
  927. <tr class="field"><th class="field-name"><tt class="docutils literal">%r</tt>:</th><td class="field-body">zero-padded changeset revision number</td>
  928. </tr>
  929. </tbody>
  930. </table>
  931. <p>Without the -a/--text option, export will avoid generating diffs
  932. of files it detects as binary. With -a, export will generate a
  933. diff anyway, probably with undesirable results.</p>
  934. <p>Use the -g/--git option to generate diffs in the git extended diff
  935. format. See <a class="reference external" href="hg.1.html#diffs"><tt class="docutils literal">hg help diffs</tt></a> for more information.</p>
  936. <p>With the --switch-parent option, the diff will be against the
  937. second parent. It can be useful to review a merge.</p>
  938. <p>Returns 0 on success.</p>
  939. <p>options:</p>
  940. <table class="docutils option-list" frame="void" rules="none">
  941. <col class="option" />
  942. <col class="description" />
  943. <tbody valign="top">
  944. <tr><td class="option-group">
  945. <kbd><span class="option">-o</span>, <span class="option">--output</span></kbd></td>
  946. <td>print output to file with formatted name</td></tr>
  947. <tr><td class="option-group" colspan="2">
  948. <kbd><span class="option">--switch-parent</span></kbd></td>
  949. </tr>
  950. <tr><td>&nbsp;</td><td>diff against the second parent</td></tr>
  951. <tr><td class="option-group">
  952. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  953. <td>revisions to export</td></tr>
  954. <tr><td class="option-group">
  955. <kbd><span class="option">-a</span>, <span class="option">--text</span></kbd></td>
  956. <td>treat all files as text</td></tr>
  957. <tr><td class="option-group">
  958. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  959. <td>use git extended diff format</td></tr>
  960. <tr><td class="option-group">
  961. <kbd><span class="option">--nodates</span></kbd></td>
  962. <td>omit dates from diff headers</td></tr>
  963. </tbody>
  964. </table>
  965. </div>
  966. <div class="section" id="forget">
  967. <h2>forget</h2>
  968. <pre class="literal-block">
  969. hg forget [OPTION]... FILE...
  970. </pre>
  971. <p>Mark the specified files so they will no longer be tracked
  972. after the next commit.</p>
  973. <p>This only removes files from the current branch, not from the
  974. entire project history, and it does not delete them from the
  975. working directory.</p>
  976. <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>
  977. <p>Returns 0 on success.</p>
  978. <p>options:</p>
  979. <table class="docutils option-list" frame="void" rules="none">
  980. <col class="option" />
  981. <col class="description" />
  982. <tbody valign="top">
  983. <tr><td class="option-group">
  984. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  985. <td>include names matching the given patterns</td></tr>
  986. <tr><td class="option-group">
  987. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  988. <td>exclude names matching the given patterns</td></tr>
  989. </tbody>
  990. </table>
  991. </div>
  992. <div class="section" id="grep">
  993. <h2>grep</h2>
  994. <pre class="literal-block">
  995. hg grep [OPTION]... PATTERN [FILE]...
  996. </pre>
  997. <p>Search revisions of files for a regular expression.</p>
  998. <p>This command behaves differently than Unix grep. It only accepts
  999. Python/Perl regexps. It searches repository history, not the
  1000. working directory. It always prints the revision number in which a
  1001. match appears.</p>
  1002. <p>By default, grep only prints output for the first revision of a
  1003. file in which it finds a match. To get it to print every revision
  1004. that contains a change in match status (&quot;-&quot; for a match that
  1005. becomes a non-match, or &quot;+&quot; for a non-match that becomes a match),
  1006. use the --all flag.</p>
  1007. <p>Returns 0 if a match is found, 1 otherwise.</p>
  1008. <p>options:</p>
  1009. <table class="docutils option-list" frame="void" rules="none">
  1010. <col class="option" />
  1011. <col class="description" />
  1012. <tbody valign="top">
  1013. <tr><td class="option-group">
  1014. <kbd><span class="option">-0</span>, <span class="option">--print0</span></kbd></td>
  1015. <td>end fields with NUL</td></tr>
  1016. <tr><td class="option-group">
  1017. <kbd><span class="option">--all</span></kbd></td>
  1018. <td>print all revisions that match</td></tr>
  1019. <tr><td class="option-group">
  1020. <kbd><span class="option">-f</span>, <span class="option">--follow</span></kbd></td>
  1021. <td>follow changeset history, or file history across copies and renames</td></tr>
  1022. <tr><td class="option-group" colspan="2">
  1023. <kbd><span class="option">-i</span>, <span class="option">--ignore-case</span></kbd></td>
  1024. </tr>
  1025. <tr><td>&nbsp;</td><td>ignore case when matching</td></tr>
  1026. <tr><td class="option-group" colspan="2">
  1027. <kbd><span class="option">-l</span>, <span class="option">--files-with-matches</span></kbd></td>
  1028. </tr>
  1029. <tr><td>&nbsp;</td><td>print only filenames and revisions that match</td></tr>
  1030. <tr><td class="option-group" colspan="2">
  1031. <kbd><span class="option">-n</span>, <span class="option">--line-number</span></kbd></td>
  1032. </tr>
  1033. <tr><td>&nbsp;</td><td>print matching line numbers</td></tr>
  1034. <tr><td class="option-group">
  1035. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1036. <td>only search files changed within revision range</td></tr>
  1037. <tr><td class="option-group">
  1038. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  1039. <td>list the author (long with -v)</td></tr>
  1040. <tr><td class="option-group">
  1041. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  1042. <td>list the date (short with -q)</td></tr>
  1043. <tr><td class="option-group">
  1044. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  1045. <td>include names matching the given patterns</td></tr>
  1046. <tr><td class="option-group">
  1047. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  1048. <td>exclude names matching the given patterns</td></tr>
  1049. </tbody>
  1050. </table>
  1051. </div>
  1052. <div class="section" id="heads">
  1053. <h2>heads</h2>
  1054. <pre class="literal-block">
  1055. hg heads [-ac] [-r STARTREV] [REV]...
  1056. </pre>
  1057. <p>With no arguments, show all repository branch heads.</p>
  1058. <p>Repository &quot;heads&quot; are changesets with no child changesets. They are
  1059. where development generally takes place and are the usual targets
  1060. for update and merge operations. Branch heads are changesets that have
  1061. no child changeset on the same branch.</p>
  1062. <p>If one or more REVs are given, only branch heads on the branches
  1063. associated with the specified changesets are shown.</p>
  1064. <p>If -c/--closed is specified, also show branch heads marked closed
  1065. (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>
  1066. <p>If STARTREV is specified, only those heads that are descendants of
  1067. STARTREV will be displayed.</p>
  1068. <p>If -t/--topo is specified, named branch mechanics will be ignored and only
  1069. changesets without children will be shown.</p>
  1070. <p>Returns 0 if matching heads are found, 1 if not.</p>
  1071. <p>options:</p>
  1072. <table class="docutils option-list" frame="void" rules="none">
  1073. <col class="option" />
  1074. <col class="description" />
  1075. <tbody valign="top">
  1076. <tr><td class="option-group">
  1077. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1078. <td>show only heads which are descendants of STARTREV</td></tr>
  1079. <tr><td class="option-group">
  1080. <kbd><span class="option">-t</span>, <span class="option">--topo</span></kbd></td>
  1081. <td>show topological heads only</td></tr>
  1082. <tr><td class="option-group">
  1083. <kbd><span class="option">-a</span>, <span class="option">--active</span></kbd></td>
  1084. <td>show active branchheads only (DEPRECATED)</td></tr>
  1085. <tr><td class="option-group">
  1086. <kbd><span class="option">-c</span>, <span class="option">--closed</span></kbd></td>
  1087. <td>show normal and closed branch heads</td></tr>
  1088. <tr><td class="option-group">
  1089. <kbd><span class="option">--style</span></kbd></td>
  1090. <td>display using template map file</td></tr>
  1091. <tr><td class="option-group">
  1092. <kbd><span class="option">--template</span></kbd></td>
  1093. <td>display with template</td></tr>
  1094. </tbody>
  1095. </table>
  1096. </div>
  1097. <div class="section" id="help">
  1098. <h2>help</h2>
  1099. <pre class="literal-block">
  1100. hg help [TOPIC]
  1101. </pre>
  1102. <p>With no arguments, print a list of commands with short help messages.</p>
  1103. <p>Given a topic, extension, or command name, print help for that
  1104. topic.</p>
  1105. <p>Returns 0 if successful.</p>
  1106. </div>
  1107. <div class="section" id="identify">
  1108. <h2>identify</h2>
  1109. <pre class="literal-block">
  1110. hg identify [-nibt] [-r REV] [SOURCE]
  1111. </pre>
  1112. <p>With no revision, print a summary of the current state of the
  1113. repository.</p>
  1114. <p>Specifying a path to a repository root or Mercurial bundle will
  1115. cause lookup to operate on that repository/bundle.</p>
  1116. <p>This summary identifies the repository state using one or two
  1117. parent hash identifiers, followed by a &quot;+&quot; if there are
  1118. uncommitted changes in the working directory, a list of tags for
  1119. this revision and a branch name for non-default branches.</p>
  1120. <p>Returns 0 if successful.</p>
  1121. <p>options:</p>
  1122. <table class="docutils option-list" frame="void" rules="none">
  1123. <col class="option" />
  1124. <col class="description" />
  1125. <tbody valign="top">
  1126. <tr><td class="option-group">
  1127. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1128. <td>identify the specified revision</td></tr>
  1129. <tr><td class="option-group">
  1130. <kbd><span class="option">-n</span>, <span class="option">--num</span></kbd></td>
  1131. <td>show local revision number</td></tr>
  1132. <tr><td class="option-group">
  1133. <kbd><span class="option">-i</span>, <span class="option">--id</span></kbd></td>
  1134. <td>show global revision id</td></tr>
  1135. <tr><td class="option-group">
  1136. <kbd><span class="option">-b</span>, <span class="option">--branch</span></kbd></td>
  1137. <td>show branch</td></tr>
  1138. <tr><td class="option-group">
  1139. <kbd><span class="option">-t</span>, <span class="option">--tags</span></kbd></td>
  1140. <td><p class="first">show tags</p>
  1141. <p class="last">aliases: id</p>
  1142. </td></tr>
  1143. </tbody>
  1144. </table>
  1145. </div>
  1146. <div class="section" id="import">
  1147. <h2>import</h2>
  1148. <pre class="literal-block">
  1149. hg import [OPTION]... PATCH...
  1150. </pre>
  1151. <p>Import a list of patches and commit them individually (unless
  1152. --no-commit is specified).</p>
  1153. <p>If there are outstanding changes in the working directory, import
  1154. will abort unless given the -f/--force flag.</p>
  1155. <p>You can import a patch straight from a mail message. Even patches
  1156. as attachments work (to use the body part, it must have type
  1157. text/plain or text/x-patch). From and Subject headers of email
  1158. message are used as default committer and commit message. All
  1159. text/plain body parts before first diff are added to commit
  1160. message.</p>
  1161. <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
  1162. description from patch override values from message headers and
  1163. body. Values given on command line with -m/--message and -u/--user
  1164. override these.</p>
  1165. <p>If --exact is specified, import will set the working directory to
  1166. the parent of each patch before applying it, and will abort if the
  1167. resulting changeset has a different ID than the one recorded in
  1168. the patch. This may happen due to character set problems or other
  1169. deficiencies in the text patch format.</p>
  1170. <p>With -s/--similarity, hg will attempt to discover renames and
  1171. copies in the patch in the same way as 'addremove'.</p>
  1172. <p>To read a patch from standard input, use &quot;-&quot; as the patch name. If
  1173. a URL is specified, the patch will be downloaded from it.
  1174. 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>
  1175. <p>Returns 0 on success.</p>
  1176. <p>options:</p>
  1177. <table class="docutils option-list" frame="void" rules="none">
  1178. <col class="option" />
  1179. <col class="description" />
  1180. <tbody valign="top">
  1181. <tr><td class="option-group">
  1182. <kbd><span class="option">-p</span>, <span class="option">--strip</span></kbd></td>
  1183. <td>directory strip option for patch. This has the same meaning as the corresponding patch option (default: 1)</td></tr>
  1184. <tr><td class="option-group">
  1185. <kbd><span class="option">-b</span>, <span class="option">--base</span></kbd></td>
  1186. <td>base path</td></tr>
  1187. <tr><td class="option-group">
  1188. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  1189. <td>skip check for outstanding uncommitted changes</td></tr>
  1190. <tr><td class="option-group">
  1191. <kbd><span class="option">--no-commit</span></kbd></td>
  1192. <td>don't commit, just update the working directory</td></tr>
  1193. <tr><td class="option-group">
  1194. <kbd><span class="option">--exact</span></kbd></td>
  1195. <td>apply patch to the nodes from which it was generated</td></tr>
  1196. <tr><td class="option-group" colspan="2">
  1197. <kbd><span class="option">--import-branch</span></kbd></td>
  1198. </tr>
  1199. <tr><td>&nbsp;</td><td>use any branch information in patch (implied by --exact)</td></tr>
  1200. <tr><td class="option-group">
  1201. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  1202. <td>use text as commit message</td></tr>
  1203. <tr><td class="option-group">
  1204. <kbd><span class="option">-l</span>, <span class="option">--logfile</span></kbd></td>
  1205. <td>read commit message from file</td></tr>
  1206. <tr><td class="option-group">
  1207. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  1208. <td>record datecode as commit date</td></tr>
  1209. <tr><td class="option-group">
  1210. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  1211. <td>record the specified user as committer</td></tr>
  1212. <tr><td class="option-group" colspan="2">
  1213. <kbd><span class="option">-s</span>, <span class="option">--similarity</span></kbd></td>
  1214. </tr>
  1215. <tr><td>&nbsp;</td><td><p class="first">guess renamed files by similarity (0&lt;=s&lt;=100)</p>
  1216. <p class="last">aliases: patch</p>
  1217. </td></tr>
  1218. </tbody>
  1219. </table>
  1220. </div>
  1221. <div class="section" id="incoming">
  1222. <h2>incoming</h2>
  1223. <pre class="literal-block">
  1224. hg incoming [-p] [-n] [-M] [-f] [-r REV]... [--bundle FILENAME] [SOURCE]
  1225. </pre>
  1226. <p>Show new changesets found in the specified path/URL or the default
  1227. pull location. These are the changesets that would have been pulled
  1228. if a pull at the time you issued this command.</p>
  1229. <p>For remote repository, using --bundle avoids downloading the
  1230. changesets twice if the incoming is followed by a pull.</p>
  1231. <p>See pull for valid source format details.</p>
  1232. <p>Returns 0 if there are incoming changes, 1 otherwise.</p>
  1233. <p>options:</p>
  1234. <table class="docutils option-list" frame="void" rules="none">
  1235. <col class="option" />
  1236. <col class="description" />
  1237. <tbody valign="top">
  1238. <tr><td class="option-group">
  1239. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  1240. <td>run even if remote repository is unrelated</td></tr>
  1241. <tr><td class="option-group" colspan="2">
  1242. <kbd><span class="option">-n</span>, <span class="option">--newest-first</span></kbd></td>
  1243. </tr>
  1244. <tr><td>&nbsp;</td><td>show newest record first</td></tr>
  1245. <tr><td class="option-group">
  1246. <kbd><span class="option">--bundle</span></kbd></td>
  1247. <td>file to store the bundles into</td></tr>
  1248. <tr><td class="option-group">
  1249. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1250. <td>a remote changeset intended to be added</td></tr>
  1251. <tr><td class="option-group">
  1252. <kbd><span class="option">-b</span>, <span class="option">--branch</span></kbd></td>
  1253. <td>a specific branch you would like to pull</td></tr>
  1254. <tr><td class="option-group">
  1255. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  1256. <td>show patch</td></tr>
  1257. <tr><td class="option-group">
  1258. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  1259. <td>use git extended diff format</td></tr>
  1260. <tr><td class="option-group">
  1261. <kbd><span class="option">-l</span>, <span class="option">--limit</span></kbd></td>
  1262. <td>limit number of changes displayed</td></tr>
  1263. <tr><td class="option-group" colspan="2">
  1264. <kbd><span class="option">-M</span>, <span class="option">--no-merges</span></kbd></td>
  1265. </tr>
  1266. <tr><td>&nbsp;</td><td>do not show merges</td></tr>
  1267. <tr><td class="option-group">
  1268. <kbd><span class="option">--stat</span></kbd></td>
  1269. <td>output diffstat-style summary of changes</td></tr>
  1270. <tr><td class="option-group">
  1271. <kbd><span class="option">--style</span></kbd></td>
  1272. <td>display using template map file</td></tr>
  1273. <tr><td class="option-group">
  1274. <kbd><span class="option">--template</span></kbd></td>
  1275. <td>display with template</td></tr>
  1276. <tr><td class="option-group">
  1277. <kbd><span class="option">-e</span>, <span class="option">--ssh</span></kbd></td>
  1278. <td>specify ssh command to use</td></tr>
  1279. <tr><td class="option-group">
  1280. <kbd><span class="option">--remotecmd</span></kbd></td>
  1281. <td>specify hg command to run on the remote side</td></tr>
  1282. <tr><td class="option-group">
  1283. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  1284. <td><p class="first">recurse into subrepositories</p>
  1285. <p class="last">aliases: in</p>
  1286. </td></tr>
  1287. </tbody>
  1288. </table>
  1289. </div>
  1290. <div class="section" id="init">
  1291. <h2>init</h2>
  1292. <pre class="literal-block">
  1293. hg init [-e CMD] [--remotecmd CMD] [DEST]
  1294. </pre>
  1295. <p>Initialize a new repository in the given directory. If the given
  1296. directory does not exist, it will be created.</p>
  1297. <p>If no directory is given, the current directory is used.</p>
  1298. <p>It is possible to specify an <tt class="docutils literal"><span class="pre">ssh://</span></tt> URL as the destination.
  1299. See <a class="reference external" href="hg.1.html#urls"><tt class="docutils literal">hg help urls</tt></a> for more information.</p>
  1300. <p>Returns 0 on success.</p>
  1301. <p>options:</p>
  1302. <table class="docutils option-list" frame="void" rules="none">
  1303. <col class="option" />
  1304. <col class="description" />
  1305. <tbody valign="top">
  1306. <tr><td class="option-group">
  1307. <kbd><span class="option">-e</span>, <span class="option">--ssh</span></kbd></td>
  1308. <td>specify ssh command to use</td></tr>
  1309. <tr><td class="option-group">
  1310. <kbd><span class="option">--remotecmd</span></kbd></td>
  1311. <td>specify hg command to run on the remote side</td></tr>
  1312. </tbody>
  1313. </table>
  1314. </div>
  1315. <div class="section" id="locate">
  1316. <h2>locate</h2>
  1317. <pre class="literal-block">
  1318. hg locate [OPTION]... [PATTERN]...
  1319. </pre>
  1320. <p>Print files under Mercurial control in the working directory whose
  1321. names match the given patterns.</p>
  1322. <p>By default, this command searches all directories in the working
  1323. directory. To search just the current directory and its
  1324. subdirectories, use &quot;--include .&quot;.</p>
  1325. <p>If no patterns are given to match, this command prints the names
  1326. of all files under Mercurial control in the working directory.</p>
  1327. <p>If you want to feed the output of this command into the &quot;xargs&quot;
  1328. command, use the -0 option to both this command and &quot;xargs&quot;. This
  1329. will avoid the problem of &quot;xargs&quot; treating single filenames that
  1330. contain whitespace as multiple filenames.</p>
  1331. <p>Returns 0 if a match is found, 1 otherwise.</p>
  1332. <p>options:</p>
  1333. <table class="docutils option-list" frame="void" rules="none">
  1334. <col class="option" />
  1335. <col class="description" />
  1336. <tbody valign="top">
  1337. <tr><td class="option-group">
  1338. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1339. <td>search the repository as it is in REV</td></tr>
  1340. <tr><td class="option-group">
  1341. <kbd><span class="option">-0</span>, <span class="option">--print0</span></kbd></td>
  1342. <td>end filenames with NUL, for use with xargs</td></tr>
  1343. <tr><td class="option-group">
  1344. <kbd><span class="option">-f</span>, <span class="option">--fullpath</span></kbd></td>
  1345. <td>print complete paths from the filesystem root</td></tr>
  1346. <tr><td class="option-group">
  1347. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  1348. <td>include names matching the given patterns</td></tr>
  1349. <tr><td class="option-group">
  1350. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  1351. <td>exclude names matching the given patterns</td></tr>
  1352. </tbody>
  1353. </table>
  1354. </div>
  1355. <div class="section" id="log">
  1356. <h2>log</h2>
  1357. <pre class="literal-block">
  1358. hg log [OPTION]... [FILE]
  1359. </pre>
  1360. <p>Print the revision history of the specified files or the entire
  1361. project.</p>
  1362. <p>File history is shown without following rename or copy history of
  1363. files. Use -f/--follow with a filename to follow history across
  1364. renames and copies. --follow without a filename will only show
  1365. ancestors or descendants of the starting revision. --follow-first
  1366. only follows the first parent of merge revisions.</p>
  1367. <p>If no revision range is specified, the default is <tt class="docutils literal">tip:0</tt> unless
  1368. --follow is set, in which case the working directory parent is
  1369. used as the starting revision. You can specify a revision set for
  1370. log, see <a class="reference external" href="hg.1.html#revsets"><tt class="docutils literal">hg help revsets</tt></a> for more information.</p>
  1371. <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>
  1372. <p>By default this command prints revision number and changeset id,
  1373. tags, non-trivial parents, user, date and time, and a summary for
  1374. each commit. When the -v/--verbose switch is used, the list of
  1375. changed files and full commit message are shown.</p>
  1376. <div class="note">
  1377. <p class="first admonition-title">Note</p>
  1378. <p class="last">log -p/--patch may generate unexpected diff output for merge
  1379. changesets, as it will only compare the merge changeset against
  1380. its first parent. Also, only files different from BOTH parents
  1381. will appear in files:.</p>
  1382. </div>
  1383. <p>Returns 0 on success.</p>
  1384. <p>options:</p>
  1385. <table class="docutils option-list" frame="void" rules="none">
  1386. <col class="option" />
  1387. <col class="description" />
  1388. <tbody valign="top">
  1389. <tr><td class="option-group">
  1390. <kbd><span class="option">-f</span>, <span class="option">--follow</span></kbd></td>
  1391. <td>follow changeset history, or file history across copies and renames</td></tr>
  1392. <tr><td class="option-group">
  1393. <kbd><span class="option">--follow-first</span></kbd></td>
  1394. <td>only follow the first parent of merge changesets</td></tr>
  1395. <tr><td class="option-group">
  1396. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  1397. <td>show revisions matching date spec</td></tr>
  1398. <tr><td class="option-group">
  1399. <kbd><span class="option">-C</span>, <span class="option">--copies</span></kbd></td>
  1400. <td>show copied files</td></tr>
  1401. <tr><td class="option-group">
  1402. <kbd><span class="option">-k</span>, <span class="option">--keyword</span></kbd></td>
  1403. <td>do case-insensitive search for a given text</td></tr>
  1404. <tr><td class="option-group">
  1405. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1406. <td>show the specified revision or range</td></tr>
  1407. <tr><td class="option-group">
  1408. <kbd><span class="option">--removed</span></kbd></td>
  1409. <td>include revisions where files were removed</td></tr>
  1410. <tr><td class="option-group" colspan="2">
  1411. <kbd><span class="option">-m</span>, <span class="option">--only-merges</span></kbd></td>
  1412. </tr>
  1413. <tr><td>&nbsp;</td><td>show only merges</td></tr>
  1414. <tr><td class="option-group">
  1415. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  1416. <td>revisions committed by user</td></tr>
  1417. <tr><td class="option-group">
  1418. <kbd><span class="option">--only-branch</span></kbd></td>
  1419. <td>show only changesets within the given named branch (DEPRECATED)</td></tr>
  1420. <tr><td class="option-group">
  1421. <kbd><span class="option">-b</span>, <span class="option">--branch</span></kbd></td>
  1422. <td>show changesets within the given named branch</td></tr>
  1423. <tr><td class="option-group">
  1424. <kbd><span class="option">-P</span>, <span class="option">--prune</span></kbd></td>
  1425. <td>do not display revision or any of its ancestors</td></tr>
  1426. <tr><td class="option-group">
  1427. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  1428. <td>show patch</td></tr>
  1429. <tr><td class="option-group">
  1430. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  1431. <td>use git extended diff format</td></tr>
  1432. <tr><td class="option-group">
  1433. <kbd><span class="option">-l</span>, <span class="option">--limit</span></kbd></td>
  1434. <td>limit number of changes displayed</td></tr>
  1435. <tr><td class="option-group" colspan="2">
  1436. <kbd><span class="option">-M</span>, <span class="option">--no-merges</span></kbd></td>
  1437. </tr>
  1438. <tr><td>&nbsp;</td><td>do not show merges</td></tr>
  1439. <tr><td class="option-group">
  1440. <kbd><span class="option">--stat</span></kbd></td>
  1441. <td>output diffstat-style summary of changes</td></tr>
  1442. <tr><td class="option-group">
  1443. <kbd><span class="option">--style</span></kbd></td>
  1444. <td>display using template map file</td></tr>
  1445. <tr><td class="option-group">
  1446. <kbd><span class="option">--template</span></kbd></td>
  1447. <td>display with template</td></tr>
  1448. <tr><td class="option-group">
  1449. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  1450. <td>include names matching the given patterns</td></tr>
  1451. <tr><td class="option-group">
  1452. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  1453. <td><p class="first">exclude names matching the given patterns</p>
  1454. <p class="last">aliases: history</p>
  1455. </td></tr>
  1456. </tbody>
  1457. </table>
  1458. </div>
  1459. <div class="section" id="manifest">
  1460. <h2>manifest</h2>
  1461. <pre class="literal-block">
  1462. hg manifest [-r REV]
  1463. </pre>
  1464. <p>Print a list of version controlled files for the given revision.
  1465. If no revision is given, the first parent of the working directory
  1466. is used, or the null revision if no revision is checked out.</p>
  1467. <p>With -v, print file permissions, symlink and executable bits.
  1468. With --debug, print file revision hashes.</p>
  1469. <p>Returns 0 on success.</p>
  1470. <p>options:</p>
  1471. <table class="docutils option-list" frame="void" rules="none">
  1472. <col class="option" />
  1473. <col class="description" />
  1474. <tbody valign="top">
  1475. <tr><td class="option-group">
  1476. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1477. <td>revision to display</td></tr>
  1478. </tbody>
  1479. </table>
  1480. </div>
  1481. <div class="section" id="merge">
  1482. <h2>merge</h2>
  1483. <pre class="literal-block">
  1484. hg merge [-P] [-f] [[-r] REV]
  1485. </pre>
  1486. <p>The current working directory is updated with all changes made in
  1487. the requested revision since the last common predecessor revision.</p>
  1488. <p>Files that changed between either parent are marked as changed for
  1489. the next commit and a commit must be performed before any further
  1490. updates to the repository are allowed. The next commit will have
  1491. two parents.</p>
  1492. <p><tt class="docutils literal"><span class="pre">--tool</span></tt> can be used to specify the merge tool used for file
  1493. merges. It overrides the HGMERGE environment variable and your
  1494. configuration files.</p>
  1495. <p>If no revision is specified, the working directory's parent is a
  1496. head revision, and the current branch contains exactly one other
  1497. head, the other head is merged with by default. Otherwise, an
  1498. explicit revision with which to merge with must be provided.</p>
  1499. <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>
  1500. <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
  1501. will check out a clean copy of the original merge parent, losing
  1502. all changes.</p>
  1503. <p>Returns 0 on success, 1 if there are unresolved files.</p>
  1504. <p>options:</p>
  1505. <table class="docutils option-list" frame="void" rules="none">
  1506. <col class="option" />
  1507. <col class="description" />
  1508. <tbody valign="top">
  1509. <tr><td class="option-group">
  1510. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  1511. <td>force a merge with outstanding changes</td></tr>
  1512. <tr><td class="option-group">
  1513. <kbd><span class="option">-t</span>, <span class="option">--tool</span></kbd></td>
  1514. <td>specify merge tool</td></tr>
  1515. <tr><td class="option-group">
  1516. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1517. <td>revision to merge</td></tr>
  1518. <tr><td class="option-group">
  1519. <kbd><span class="option">-P</span>, <span class="option">--preview</span></kbd></td>
  1520. <td>review revisions to merge (no merge is performed)</td></tr>
  1521. </tbody>
  1522. </table>
  1523. </div>
  1524. <div class="section" id="outgoing">
  1525. <h2>outgoing</h2>
  1526. <pre class="literal-block">
  1527. hg outgoing [-M] [-p] [-n] [-f] [-r REV]... [DEST]
  1528. </pre>
  1529. <p>Show changesets not found in the specified destination repository
  1530. or the default push location. These are the changesets that would
  1531. be pushed if a push was requested.</p>
  1532. <p>See pull for details of valid destination formats.</p>
  1533. <p>Returns 0 if there are outgoing changes, 1 otherwise.</p>
  1534. <p>options:</p>
  1535. <table class="docutils option-list" frame="void" rules="none">
  1536. <col class="option" />
  1537. <col class="description" />
  1538. <tbody valign="top">
  1539. <tr><td class="option-group">
  1540. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  1541. <td>run even when the destination is unrelated</td></tr>
  1542. <tr><td class="option-group">
  1543. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1544. <td>a changeset intended to be included in the destination</td></tr>
  1545. <tr><td class="option-group" colspan="2">
  1546. <kbd><span class="option">-n</span>, <span class="option">--newest-first</span></kbd></td>
  1547. </tr>
  1548. <tr><td>&nbsp;</td><td>show newest record first</td></tr>
  1549. <tr><td class="option-group">
  1550. <kbd><span class="option">-b</span>, <span class="option">--branch</span></kbd></td>
  1551. <td>a specific branch you would like to push</td></tr>
  1552. <tr><td class="option-group">
  1553. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  1554. <td>show patch</td></tr>
  1555. <tr><td class="option-group">
  1556. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  1557. <td>use git extended diff format</td></tr>
  1558. <tr><td class="option-group">
  1559. <kbd><span class="option">-l</span>, <span class="option">--limit</span></kbd></td>
  1560. <td>limit number of changes displayed</td></tr>
  1561. <tr><td class="option-group" colspan="2">
  1562. <kbd><span class="option">-M</span>, <span class="option">--no-merges</span></kbd></td>
  1563. </tr>
  1564. <tr><td>&nbsp;</td><td>do not show merges</td></tr>
  1565. <tr><td class="option-group">
  1566. <kbd><span class="option">--stat</span></kbd></td>
  1567. <td>output diffstat-style summary of changes</td></tr>
  1568. <tr><td class="option-group">
  1569. <kbd><span class="option">--style</span></kbd></td>
  1570. <td>display using template map file</td></tr>
  1571. <tr><td class="option-group">
  1572. <kbd><span class="option">--template</span></kbd></td>
  1573. <td>display with template</td></tr>
  1574. <tr><td class="option-group">
  1575. <kbd><span class="option">-e</span>, <span class="option">--ssh</span></kbd></td>
  1576. <td>specify ssh command to use</td></tr>
  1577. <tr><td class="option-group">
  1578. <kbd><span class="option">--remotecmd</span></kbd></td>
  1579. <td>specify hg command to run on the remote side</td></tr>
  1580. <tr><td class="option-group">
  1581. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  1582. <td><p class="first">recurse into subrepositories</p>
  1583. <p class="last">aliases: out</p>
  1584. </td></tr>
  1585. </tbody>
  1586. </table>
  1587. </div>
  1588. <div class="section" id="parents">
  1589. <h2>parents</h2>
  1590. <pre class="literal-block">
  1591. hg parents [-r REV] [FILE]
  1592. </pre>
  1593. <p>Print the working directory's parent revisions. If a revision is
  1594. given via -r/--rev, the parent of that revision will be printed.
  1595. If a file argument is given, the revision in which the file was
  1596. last changed (before the working directory revision or the
  1597. argument to --rev if given) is printed.</p>
  1598. <p>Returns 0 on success.</p>
  1599. <p>options:</p>
  1600. <table class="docutils option-list" frame="void" rules="none">
  1601. <col class="option" />
  1602. <col class="description" />
  1603. <tbody valign="top">
  1604. <tr><td class="option-group">
  1605. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1606. <td>show parents of the specified revision</td></tr>
  1607. <tr><td class="option-group">
  1608. <kbd><span class="option">--style</span></kbd></td>
  1609. <td>display using template map file</td></tr>
  1610. <tr><td class="option-group">
  1611. <kbd><span class="option">--template</span></kbd></td>
  1612. <td>display with template</td></tr>
  1613. </tbody>
  1614. </table>
  1615. </div>
  1616. <div class="section" id="paths">
  1617. <h2>paths</h2>
  1618. <pre class="literal-block">
  1619. hg paths [NAME]
  1620. </pre>
  1621. <p>Show definition of symbolic path name NAME. If no name is given,
  1622. show definition of all available names.</p>
  1623. <p>Path names are defined in the [paths] section of your
  1624. configuration file and in <tt class="docutils literal">/etc/mercurial/hgrc</tt>. If run inside a
  1625. repository, <tt class="docutils literal">.hg/hgrc</tt> is used, too.</p>
  1626. <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
  1627. meaning.  When performing a push or pull operation, they are used
  1628. as fallbacks if no location is specified on the command-line.
  1629. When <tt class="docutils literal"><span class="pre">default-push</span></tt> is set, it will be used for push and
  1630. <tt class="docutils literal">default</tt> will be used for pull; otherwise <tt class="docutils literal">default</tt> is used
  1631. as the fallback for both.  When cloning a repository, the clone
  1632. source is written as <tt class="docutils literal">default</tt> in <tt class="docutils literal">.hg/hgrc</tt>.  Note that
  1633. <tt class="docutils literal">default</tt> and <tt class="docutils literal"><span class="pre">default-push</span></tt> apply to all inbound (e.g.
  1634. <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
  1635. <a class="reference external" href="hg.1.html#bundle"><tt class="docutils literal">hg bundle</tt></a>) operations.</p>
  1636. <p>See <a class="reference external" href="hg.1.html#urls"><tt class="docutils literal">hg help urls</tt></a> for more information.</p>
  1637. <p>Returns 0 on success.</p>
  1638. </div>
  1639. <div class="section" id="pull">
  1640. <h2>pull</h2>
  1641. <pre class="literal-block">
  1642. hg pull [-u] [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [SOURCE]
  1643. </pre>
  1644. <p>Pull changes from a remote repository to a local one.</p>
  1645. <p>This finds all changes from the repository at the specified path
  1646. or URL and adds them to a local repository (the current one unless
  1647. -R is specified). By default, this does not update the copy of the
  1648. project in the working directory.</p>
  1649. <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
  1650. by a pull at the time you issued this command. If you then decide
  1651. 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
  1652. <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>
  1653. <p>If SOURCE is omitted, the 'default' path will be used.
  1654. See <a class="reference external" href="hg.1.html#urls"><tt class="docutils literal">hg help urls</tt></a> for more information.</p>
  1655. <p>Returns 0 on success, 1 if an update had unresolved files.</p>
  1656. <p>options:</p>
  1657. <table class="docutils option-list" frame="void" rules="none">
  1658. <col class="option" />
  1659. <col class="description" />
  1660. <tbody valign="top">
  1661. <tr><td class="option-group">
  1662. <kbd><span class="option">-u</span>, <span class="option">--update</span></kbd></td>
  1663. <td>update to new branch head if changesets were pulled</td></tr>
  1664. <tr><td class="option-group">
  1665. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  1666. <td>run even when remote repository is unrelated</td></tr>
  1667. <tr><td class="option-group">
  1668. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1669. <td>a remote changeset intended to be added</td></tr>
  1670. <tr><td class="option-group">
  1671. <kbd><span class="option">-b</span>, <span class="option">--branch</span></kbd></td>
  1672. <td>a specific branch you would like to pull</td></tr>
  1673. <tr><td class="option-group">
  1674. <kbd><span class="option">-e</span>, <span class="option">--ssh</span></kbd></td>
  1675. <td>specify ssh command to use</td></tr>
  1676. <tr><td class="option-group">
  1677. <kbd><span class="option">--remotecmd</span></kbd></td>
  1678. <td>specify hg command to run on the remote side</td></tr>
  1679. </tbody>
  1680. </table>
  1681. </div>
  1682. <div class="section" id="push">
  1683. <h2>push</h2>
  1684. <pre class="literal-block">
  1685. hg push [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [DEST]
  1686. </pre>
  1687. <p>Push changesets from the local repository to the specified
  1688. destination.</p>
  1689. <p>This operation is symmetrical to pull: it is identical to a pull
  1690. in the destination repository from the current one.</p>
  1691. <p>By default, push will not allow creation of new heads at the
  1692. destination, since multiple heads would make it unclear which head
  1693. to use. In this situation, it is recommended to pull and merge
  1694. before pushing.</p>
  1695. <p>Use --new-branch if you want to allow push to create a new named
  1696. branch that is not present at the destination. This allows you to
  1697. only create a new branch without forcing other changes.</p>
  1698. <p>Use -f/--force to override the default behavior and push all
  1699. changesets on all branches.</p>
  1700. <p>If -r/--rev is used, the specified revision and all its ancestors
  1701. will be pushed to the remote repository.</p>
  1702. <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>
  1703. URLs. If DESTINATION is omitted, a default path will be used.</p>
  1704. <p>Returns 0 if push was successful, 1 if nothing to push.</p>
  1705. <p>options:</p>
  1706. <table class="docutils option-list" frame="void" rules="none">
  1707. <col class="option" />
  1708. <col class="description" />
  1709. <tbody valign="top">
  1710. <tr><td class="option-group">
  1711. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  1712. <td>force push</td></tr>
  1713. <tr><td class="option-group">
  1714. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1715. <td>a changeset intended to be included in the destination</td></tr>
  1716. <tr><td class="option-group">
  1717. <kbd><span class="option">-b</span>, <span class="option">--branch</span></kbd></td>
  1718. <td>a specific branch you would like to push</td></tr>
  1719. <tr><td class="option-group">
  1720. <kbd><span class="option">--new-branch</span></kbd></td>
  1721. <td>allow pushing a new branch</td></tr>
  1722. <tr><td class="option-group">
  1723. <kbd><span class="option">-e</span>, <span class="option">--ssh</span></kbd></td>
  1724. <td>specify ssh command to use</td></tr>
  1725. <tr><td class="option-group">
  1726. <kbd><span class="option">--remotecmd</span></kbd></td>
  1727. <td>specify hg command to run on the remote side</td></tr>
  1728. </tbody>
  1729. </table>
  1730. </div>
  1731. <div class="section" id="recover">
  1732. <h2>recover</h2>
  1733. <pre class="literal-block">
  1734. hg recover
  1735. </pre>
  1736. <p>Recover from an interrupted commit or pull.</p>
  1737. <p>This command tries to fix the repository status after an
  1738. interrupted operation. It should only be necessary when Mercurial
  1739. suggests it.</p>
  1740. <p>Returns 0 if successful, 1 if nothing to recover or verify fails.</p>
  1741. </div>
  1742. <div class="section" id="remove">
  1743. <h2>remove</h2>
  1744. <pre class="literal-block">
  1745. hg remove [OPTION]... FILE...
  1746. </pre>
  1747. <p>Schedule the indicated files for removal from the repository.</p>
  1748. <p>This only removes files from the current branch, not from the
  1749. entire project history. -A/--after can be used to remove only
  1750. files that have already been deleted, -f/--force can be used to
  1751. force deletion, and -Af can be used to remove files from the next
  1752. revision without deleting them from the working directory.</p>
  1753. <p>The following table details the behavior of remove for different
  1754. file states (columns) and option combinations (rows). The file
  1755. states are Added [A], Clean [C], Modified [M] and Missing [!] (as
  1756. reported by <a class="reference external" href="hg.1.html#status"><tt class="docutils literal">hg status</tt></a>). The actions are Warn, Remove (from
  1757. branch) and Delete (from disk):</p>
  1758. <pre class="literal-block">
  1759.        A  C  M  !
  1760. none   W  RD W  R
  1761. -f     R  RD RD R
  1762. -A     W  W  W  R
  1763. -Af    R  R  R  R
  1764. </pre>
  1765. <p>This command schedules the files to be removed at the next commit.
  1766. To undo a remove before that, see <a class="reference external" href="hg.1.html#revert"><tt class="docutils literal">hg revert</tt></a>.</p>
  1767. <p>Returns 0 on success, 1 if any warnings encountered.</p>
  1768. <p>options:</p>
  1769. <table class="docutils option-list" frame="void" rules="none">
  1770. <col class="option" />
  1771. <col class="description" />
  1772. <tbody valign="top">
  1773. <tr><td class="option-group">
  1774. <kbd><span class="option">-A</span>, <span class="option">--after</span></kbd></td>
  1775. <td>record delete for missing files</td></tr>
  1776. <tr><td class="option-group">
  1777. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  1778. <td>remove (and delete) file even if added or modified</td></tr>
  1779. <tr><td class="option-group">
  1780. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  1781. <td>include names matching the given patterns</td></tr>
  1782. <tr><td class="option-group">
  1783. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  1784. <td><p class="first">exclude names matching the given patterns</p>
  1785. <p class="last">aliases: rm</p>
  1786. </td></tr>
  1787. </tbody>
  1788. </table>
  1789. </div>
  1790. <div class="section" id="rename">
  1791. <h2>rename</h2>
  1792. <pre class="literal-block">
  1793. hg rename [OPTION]... SOURCE... DEST
  1794. </pre>
  1795. <p>Mark dest as copies of sources; mark sources for deletion. If dest
  1796. is a directory, copies are put in that directory. If dest is a
  1797. file, there can only be one source.</p>
  1798. <p>By default, this command copies the contents of files as they
  1799. exist in the working directory. If invoked with -A/--after, the
  1800. operation is recorded, but no copying is performed.</p>
  1801. <p>This command takes effect at the next commit. To undo a rename
  1802. before that, see <a class="reference external" href="hg.1.html#revert"><tt class="docutils literal">hg revert</tt></a>.</p>
  1803. <p>Returns 0 on success, 1 if errors are encountered.</p>
  1804. <p>options:</p>
  1805. <table class="docutils option-list" frame="void" rules="none">
  1806. <col class="option" />
  1807. <col class="description" />
  1808. <tbody valign="top">
  1809. <tr><td class="option-group">
  1810. <kbd><span class="option">-A</span>, <span class="option">--after</span></kbd></td>
  1811. <td>record a rename that has already occurred</td></tr>
  1812. <tr><td class="option-group">
  1813. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  1814. <td>forcibly copy over an existing managed file</td></tr>
  1815. <tr><td class="option-group">
  1816. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  1817. <td>include names matching the given patterns</td></tr>
  1818. <tr><td class="option-group">
  1819. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  1820. <td>exclude names matching the given patterns</td></tr>
  1821. <tr><td class="option-group">
  1822. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  1823. <td><p class="first">do not perform actions, just print output</p>
  1824. <p class="last">aliases: move mv</p>
  1825. </td></tr>
  1826. </tbody>
  1827. </table>
  1828. </div>
  1829. <div class="section" id="resolve">
  1830. <h2>resolve</h2>
  1831. <pre class="literal-block">
  1832. hg resolve [OPTION]... [FILE]...
  1833. </pre>
  1834. <p>Merges with unresolved conflicts are often the result of
  1835. non-interactive merging using the <tt class="docutils literal">internal:merge</tt> configuration
  1836. setting, or a command-line merge tool like <tt class="docutils literal">diff3</tt>. The resolve
  1837. command is used to manage the files involved in a merge, after
  1838. <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
  1839. working directory must have two parents).</p>
  1840. <p>The resolve command can be used in the following ways:</p>
  1841. <ul class="simple">
  1842. <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
  1843. files, discarding any previous merge attempts. Re-merging is not
  1844. performed for files already marked as resolved. Use <tt class="docutils literal"><span class="pre">--all/-a</span></tt>
  1845. to selects all unresolved files. <tt class="docutils literal"><span class="pre">--tool</span></tt> can be used to specify
  1846. the merge tool used for the given files. It overrides the HGMERGE
  1847. environment variable and your configuration files.</li>
  1848. <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
  1849. (e.g. after having manually fixed-up the files). The default is
  1850. to mark all unresolved files.</li>
  1851. <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
  1852. default is to mark all resolved files.</li>
  1853. <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.
  1854. In the printed list, <tt class="docutils literal">U</tt> = unresolved and <tt class="docutils literal">R</tt> = resolved.</li>
  1855. </ul>
  1856. <p>Note that Mercurial will not let you commit files with unresolved
  1857. 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
  1858. commit after a conflicting merge.</p>
  1859. <p>Returns 0 on success, 1 if any files fail a resolve attempt.</p>
  1860. <p>options:</p>
  1861. <table class="docutils option-list" frame="void" rules="none">
  1862. <col class="option" />
  1863. <col class="description" />
  1864. <tbody valign="top">
  1865. <tr><td class="option-group">
  1866. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  1867. <td>select all unresolved files</td></tr>
  1868. <tr><td class="option-group">
  1869. <kbd><span class="option">-l</span>, <span class="option">--list</span></kbd></td>
  1870. <td>list state of files needing merge</td></tr>
  1871. <tr><td class="option-group">
  1872. <kbd><span class="option">-m</span>, <span class="option">--mark</span></kbd></td>
  1873. <td>mark files as resolved</td></tr>
  1874. <tr><td class="option-group">
  1875. <kbd><span class="option">-u</span>, <span class="option">--unmark</span></kbd></td>
  1876. <td>mark files as unresolved</td></tr>
  1877. <tr><td class="option-group">
  1878. <kbd><span class="option">-t</span>, <span class="option">--tool</span></kbd></td>
  1879. <td>specify merge tool</td></tr>
  1880. <tr><td class="option-group" colspan="2">
  1881. <kbd><span class="option">-n</span>, <span class="option">--no-status</span></kbd></td>
  1882. </tr>
  1883. <tr><td>&nbsp;</td><td>hide status prefix</td></tr>
  1884. <tr><td class="option-group">
  1885. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  1886. <td>include names matching the given patterns</td></tr>
  1887. <tr><td class="option-group">
  1888. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  1889. <td>exclude names matching the given patterns</td></tr>
  1890. </tbody>
  1891. </table>
  1892. </div>
  1893. <div class="section" id="revert">
  1894. <h2>revert</h2>
  1895. <pre class="literal-block">
  1896. hg revert [OPTION]... [-r REV] [NAME]...
  1897. </pre>
  1898. <div class="note">
  1899. <p class="first admonition-title">Note</p>
  1900. <p class="last">This command is most likely not what you are looking for.
  1901. Revert will partially overwrite content in the working
  1902. directory without changing the working directory parents. Use
  1903. <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update <span class="pre">-r</span> rev</tt></a> to check out earlier revisions, or
  1904. <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update <span class="pre">--clean</span> .</tt></a> to undo a merge which has added another
  1905. parent.</p>
  1906. </div>
  1907. <p>With no revision specified, revert the named files or directories
  1908. to the contents they had in the parent of the working directory.
  1909. This restores the contents of the affected files to an unmodified
  1910. state and unschedules adds, removes, copies, and renames. If the
  1911. working directory has two parents, you must explicitly specify a
  1912. revision.</p>
  1913. <p>Using the -r/--rev option, revert the given files or directories
  1914. to their contents as of a specific revision. This can be helpful
  1915. to &quot;roll back&quot; some or all of an earlier change. See <a class="reference external" href="hg.1.html#dates"><tt class="docutils literal">hg help
  1916. dates</tt></a> for a list of formats valid for -d/--date.</p>
  1917. <p>Revert modifies the working directory. It does not commit any
  1918. changes, or change the parent of the working directory. If you
  1919. revert to a revision other than the parent of the working
  1920. directory, the reverted files will thus appear modified
  1921. afterwards.</p>
  1922. <p>If a file has been deleted, it is restored. If the executable mode
  1923. of a file was changed, it is reset.</p>
  1924. <p>If names are given, all files matching the names are reverted.
  1925. If no arguments are given, no files are reverted.</p>
  1926. <p>Modified files are saved with a .orig suffix before reverting.
  1927. To disable these backups, use --no-backup.</p>
  1928. <p>Returns 0 on success.</p>
  1929. <p>options:</p>
  1930. <table class="docutils option-list" frame="void" rules="none">
  1931. <col class="option" />
  1932. <col class="description" />
  1933. <tbody valign="top">
  1934. <tr><td class="option-group">
  1935. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  1936. <td>revert all changes when no arguments given</td></tr>
  1937. <tr><td class="option-group">
  1938. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  1939. <td>tipmost revision matching date</td></tr>
  1940. <tr><td class="option-group">
  1941. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  1942. <td>revert to the specified revision</td></tr>
  1943. <tr><td class="option-group">
  1944. <kbd><span class="option">--no-backup</span></kbd></td>
  1945. <td>do not save backup copies of files</td></tr>
  1946. <tr><td class="option-group">
  1947. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  1948. <td>include names matching the given patterns</td></tr>
  1949. <tr><td class="option-group">
  1950. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  1951. <td>exclude names matching the given patterns</td></tr>
  1952. <tr><td class="option-group">
  1953. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  1954. <td>do not perform actions, just print output</td></tr>
  1955. </tbody>
  1956. </table>
  1957. </div>
  1958. <div class="section" id="rollback">
  1959. <h2>rollback</h2>
  1960. <pre class="literal-block">
  1961. hg rollback
  1962. </pre>
  1963. <p>This command should be used with care. There is only one level of
  1964. rollback, and there is no way to undo a rollback. It will also
  1965. restore the dirstate at the time of the last transaction, losing
  1966. any dirstate changes since that time. This command does not alter
  1967. the working directory.</p>
  1968. <p>Transactions are used to encapsulate the effects of all commands
  1969. that create new changesets or propagate existing changesets into a
  1970. repository. For example, the following commands are transactional,
  1971. and their effects can be rolled back:</p>
  1972. <ul class="simple">
  1973. <li>commit</li>
  1974. <li>import</li>
  1975. <li>pull</li>
  1976. <li>push (with this repository as the destination)</li>
  1977. <li>unbundle</li>
  1978. </ul>
  1979. <p>This command is not intended for use on public repositories. Once
  1980. changes are visible for pull by other users, rolling a transaction
  1981. back locally is ineffective (someone else may already have pulled
  1982. the changes). Furthermore, a race is possible with readers of the
  1983. repository; for example an in-progress pull from the repository
  1984. may fail if a rollback is performed.</p>
  1985. <p>Returns 0 on success, 1 if no rollback data is available.</p>
  1986. <p>options:</p>
  1987. <table class="docutils option-list" frame="void" rules="none">
  1988. <col class="option" />
  1989. <col class="description" />
  1990. <tbody valign="top">
  1991. <tr><td class="option-group">
  1992. <kbd><span class="option">-n</span>, <span class="option">--dry-run</span></kbd></td>
  1993. <td>do not perform actions, just print output</td></tr>
  1994. </tbody>
  1995. </table>
  1996. </div>
  1997. <div class="section" id="root">
  1998. <h2>root</h2>
  1999. <pre class="literal-block">
  2000. hg root
  2001. </pre>
  2002. <p>Print the root directory of the current repository.</p>
  2003. <p>Returns 0 on success.</p>
  2004. </div>
  2005. <div class="section" id="serve">
  2006. <h2>serve</h2>
  2007. <pre class="literal-block">
  2008. hg serve [OPTION]...
  2009. </pre>
  2010. <p>Start a local HTTP repository browser and pull server. You can use
  2011. this for ad-hoc sharing and browsing of repositories. It is
  2012. recommended to use a real web server to serve a repository for
  2013. longer periods of time.</p>
  2014. <p>Please note that the server does not implement access control.
  2015. This means that, by default, anybody can read from the server and
  2016. nobody can write to it by default. Set the <tt class="docutils literal">web.allow_push</tt>
  2017. option to <tt class="docutils literal">*</tt> to allow everybody to push to the server. You
  2018. should use a real web server if you need to authenticate users.</p>
  2019. <p>By default, the server logs accesses to stdout and errors to
  2020. stderr. Use the -A/--accesslog and -E/--errorlog options to log to
  2021. files.</p>
  2022. <p>To have the server choose a free port number to listen on, specify
  2023. a port number of 0; in this case, the server will print the port
  2024. number it uses.</p>
  2025. <p>Returns 0 on success.</p>
  2026. <p>options:</p>
  2027. <table class="docutils option-list" frame="void" rules="none">
  2028. <col class="option" />
  2029. <col class="description" />
  2030. <tbody valign="top">
  2031. <tr><td class="option-group" colspan="2">
  2032. <kbd><span class="option">-A</span>, <span class="option">--accesslog</span></kbd></td>
  2033. </tr>
  2034. <tr><td>&nbsp;</td><td>name of access log file to write to</td></tr>
  2035. <tr><td class="option-group">
  2036. <kbd><span class="option">-d</span>, <span class="option">--daemon</span></kbd></td>
  2037. <td>run server in background</td></tr>
  2038. <tr><td class="option-group" colspan="2">
  2039. <kbd><span class="option">--daemon-pipefds</span></kbd></td>
  2040. </tr>
  2041. <tr><td>&nbsp;</td><td>used internally by daemon mode</td></tr>
  2042. <tr><td class="option-group">
  2043. <kbd><span class="option">-E</span>, <span class="option">--errorlog</span></kbd></td>
  2044. <td>name of error log file to write to</td></tr>
  2045. <tr><td class="option-group">
  2046. <kbd><span class="option">-p</span>, <span class="option">--port</span></kbd></td>
  2047. <td>port to listen on (default: 8000)</td></tr>
  2048. <tr><td class="option-group">
  2049. <kbd><span class="option">-a</span>, <span class="option">--address</span></kbd></td>
  2050. <td>address to listen on (default: all interfaces)</td></tr>
  2051. <tr><td class="option-group">
  2052. <kbd><span class="option">--prefix</span></kbd></td>
  2053. <td>prefix path to serve from (default: server root)</td></tr>
  2054. <tr><td class="option-group">
  2055. <kbd><span class="option">-n</span>, <span class="option">--name</span></kbd></td>
  2056. <td>name to show in web pages (default: working directory)</td></tr>
  2057. <tr><td class="option-group">
  2058. <kbd><span class="option">--web-conf</span></kbd></td>
  2059. <td>name of the hgweb config file (see &quot;hg help hgweb&quot;)</td></tr>
  2060. <tr><td class="option-group">
  2061. <kbd><span class="option">--webdir-conf</span></kbd></td>
  2062. <td>name of the hgweb config file (DEPRECATED)</td></tr>
  2063. <tr><td class="option-group">
  2064. <kbd><span class="option">--pid-file</span></kbd></td>
  2065. <td>name of file to write process ID to</td></tr>
  2066. <tr><td class="option-group">
  2067. <kbd><span class="option">--stdio</span></kbd></td>
  2068. <td>for remote clients</td></tr>
  2069. <tr><td class="option-group" colspan="2">
  2070. <kbd><span class="option">-t</span>, <span class="option">--templates</span></kbd></td>
  2071. </tr>
  2072. <tr><td>&nbsp;</td><td>web templates to use</td></tr>
  2073. <tr><td class="option-group">
  2074. <kbd><span class="option">--style</span></kbd></td>
  2075. <td>template style to use</td></tr>
  2076. <tr><td class="option-group">
  2077. <kbd><span class="option">-6</span>, <span class="option">--ipv6</span></kbd></td>
  2078. <td>use IPv6 in addition to IPv4</td></tr>
  2079. <tr><td class="option-group">
  2080. <kbd><span class="option">--certificate</span></kbd></td>
  2081. <td>SSL certificate file</td></tr>
  2082. </tbody>
  2083. </table>
  2084. </div>
  2085. <div class="section" id="showconfig">
  2086. <h2>showconfig</h2>
  2087. <pre class="literal-block">
  2088. hg showconfig [-u] [NAME]...
  2089. </pre>
  2090. <p>With no arguments, print names and values of all config items.</p>
  2091. <p>With one argument of the form section.name, print just the value
  2092. of that config item.</p>
  2093. <p>With multiple arguments, print names and values of all config
  2094. items with matching section names.</p>
  2095. <p>With --debug, the source (filename and line number) is printed
  2096. for each config item.</p>
  2097. <p>Returns 0 on success.</p>
  2098. <p>options:</p>
  2099. <table class="docutils option-list" frame="void" rules="none">
  2100. <col class="option" />
  2101. <col class="description" />
  2102. <tbody valign="top">
  2103. <tr><td class="option-group" colspan="2">
  2104. <kbd><span class="option">-u</span>, <span class="option">--untrusted</span></kbd></td>
  2105. </tr>
  2106. <tr><td>&nbsp;</td><td><p class="first">show untrusted configuration options</p>
  2107. <p class="last">aliases: debugconfig</p>
  2108. </td></tr>
  2109. </tbody>
  2110. </table>
  2111. </div>
  2112. <div class="section" id="status">
  2113. <h2>status</h2>
  2114. <pre class="literal-block">
  2115. hg status [OPTION]... [FILE]...
  2116. </pre>
  2117. <p>Show status of files in the repository. If names are given, only
  2118. files that match are shown. Files that are clean or ignored or
  2119. the source of a copy/move operation, are not listed unless
  2120. -c/--clean, -i/--ignored, -C/--copies or -A/--all are given.
  2121. Unless options described with &quot;show only ...&quot; are given, the
  2122. options -mardu are used.</p>
  2123. <p>Option -q/--quiet hides untracked (unknown and ignored) files
  2124. unless explicitly requested with -u/--unknown or -i/--ignored.</p>
  2125. <div class="note">
  2126. <p class="first admonition-title">Note</p>
  2127. <p class="last">status may appear to disagree with diff if permissions have
  2128. changed or a merge has occurred. The standard diff format does
  2129. not report permission changes and diff only reports changes
  2130. relative to one merge parent.</p>
  2131. </div>
  2132. <p>If one revision is given, it is used as the base revision.
  2133. If two revisions are given, the differences between them are
  2134. shown. The --change option can also be used as a shortcut to list
  2135. the changed files of a revision from its first parent.</p>
  2136. <p>The codes used to show the status of files are:</p>
  2137. <pre class="literal-block">
  2138. M = modified
  2139. A = added
  2140. R = removed
  2141. C = clean
  2142. ! = missing (deleted by non-hg command, but still tracked)
  2143. ? = not tracked
  2144. I = ignored
  2145.   = origin of the previous file listed as A (added)
  2146. </pre>
  2147. <p>Returns 0 on success.</p>
  2148. <p>options:</p>
  2149. <table class="docutils option-list" frame="void" rules="none">
  2150. <col class="option" />
  2151. <col class="description" />
  2152. <tbody valign="top">
  2153. <tr><td class="option-group">
  2154. <kbd><span class="option">-A</span>, <span class="option">--all</span></kbd></td>
  2155. <td>show status of all files</td></tr>
  2156. <tr><td class="option-group">
  2157. <kbd><span class="option">-m</span>, <span class="option">--modified</span></kbd></td>
  2158. <td>show only modified files</td></tr>
  2159. <tr><td class="option-group">
  2160. <kbd><span class="option">-a</span>, <span class="option">--added</span></kbd></td>
  2161. <td>show only added files</td></tr>
  2162. <tr><td class="option-group">
  2163. <kbd><span class="option">-r</span>, <span class="option">--removed</span></kbd></td>
  2164. <td>show only removed files</td></tr>
  2165. <tr><td class="option-group">
  2166. <kbd><span class="option">-d</span>, <span class="option">--deleted</span></kbd></td>
  2167. <td>show only deleted (but tracked) files</td></tr>
  2168. <tr><td class="option-group">
  2169. <kbd><span class="option">-c</span>, <span class="option">--clean</span></kbd></td>
  2170. <td>show only files without changes</td></tr>
  2171. <tr><td class="option-group">
  2172. <kbd><span class="option">-u</span>, <span class="option">--unknown</span></kbd></td>
  2173. <td>show only unknown (not tracked) files</td></tr>
  2174. <tr><td class="option-group">
  2175. <kbd><span class="option">-i</span>, <span class="option">--ignored</span></kbd></td>
  2176. <td>show only ignored files</td></tr>
  2177. <tr><td class="option-group" colspan="2">
  2178. <kbd><span class="option">-n</span>, <span class="option">--no-status</span></kbd></td>
  2179. </tr>
  2180. <tr><td>&nbsp;</td><td>hide status prefix</td></tr>
  2181. <tr><td class="option-group">
  2182. <kbd><span class="option">-C</span>, <span class="option">--copies</span></kbd></td>
  2183. <td>show source of copied files</td></tr>
  2184. <tr><td class="option-group">
  2185. <kbd><span class="option">-0</span>, <span class="option">--print0</span></kbd></td>
  2186. <td>end filenames with NUL, for use with xargs</td></tr>
  2187. <tr><td class="option-group">
  2188. <kbd><span class="option">--rev</span></kbd></td>
  2189. <td>show difference from revision</td></tr>
  2190. <tr><td class="option-group">
  2191. <kbd><span class="option">--change</span></kbd></td>
  2192. <td>list the changed files of a revision</td></tr>
  2193. <tr><td class="option-group">
  2194. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  2195. <td>include names matching the given patterns</td></tr>
  2196. <tr><td class="option-group">
  2197. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  2198. <td>exclude names matching the given patterns</td></tr>
  2199. <tr><td class="option-group">
  2200. <kbd><span class="option">-S</span>, <span class="option">--subrepos</span></kbd></td>
  2201. <td><p class="first">recurse into subrepositories</p>
  2202. <p class="last">aliases: st</p>
  2203. </td></tr>
  2204. </tbody>
  2205. </table>
  2206. </div>
  2207. <div class="section" id="summary">
  2208. <h2>summary</h2>
  2209. <pre class="literal-block">
  2210. hg summary [--remote]
  2211. </pre>
  2212. <p>This generates a brief summary of the working directory state,
  2213. including parents, branch, commit status, and available updates.</p>
  2214. <p>With the --remote option, this will check the default paths for
  2215. incoming and outgoing changes. This can be time-consuming.</p>
  2216. <p>Returns 0 on success.</p>
  2217. <p>options:</p>
  2218. <table class="docutils option-list" frame="void" rules="none">
  2219. <col class="option" />
  2220. <col class="description" />
  2221. <tbody valign="top">
  2222. <tr><td class="option-group">
  2223. <kbd><span class="option">--remote</span></kbd></td>
  2224. <td><p class="first">check for push and pull</p>
  2225. <p class="last">aliases: sum</p>
  2226. </td></tr>
  2227. </tbody>
  2228. </table>
  2229. </div>
  2230. <div class="section" id="tag">
  2231. <h2>tag</h2>
  2232. <pre class="literal-block">
  2233. hg tag [-f] [-l] [-m TEXT] [-d DATE] [-u USER] [-r REV] NAME...
  2234. </pre>
  2235. <p>Name a particular revision using &lt;name&gt;.</p>
  2236. <p>Tags are used to name particular revisions of the repository and are
  2237. very useful to compare different revisions, to go back to significant
  2238. earlier versions or to mark branch points as releases, etc. Changing
  2239. an existing tag is normally disallowed; use -f/--force to override.</p>
  2240. <p>If no revision is given, the parent of the working directory is
  2241. used, or tip if no revision is checked out.</p>
  2242. <p>To facilitate version control, distribution, and merging of tags,
  2243. they are stored as a file named &quot;.hgtags&quot; which is managed similarly
  2244. to other project files and can be hand-edited if necessary. This
  2245. also means that tagging creates a new commit. The file
  2246. &quot;.hg/localtags&quot; is used for local tags (not shared among
  2247. repositories).</p>
  2248. <p>Tag commits are usually made at the head of a branch. If the parent
  2249. 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
  2250. -f/--force to force the tag commit to be based on a non-head
  2251. changeset.</p>
  2252. <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>
  2253. <p>Since tag names have priority over branch names during revision
  2254. lookup, using an existing branch name as a tag name is discouraged.</p>
  2255. <p>Returns 0 on success.</p>
  2256. <p>options:</p>
  2257. <table class="docutils option-list" frame="void" rules="none">
  2258. <col class="option" />
  2259. <col class="description" />
  2260. <tbody valign="top">
  2261. <tr><td class="option-group">
  2262. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  2263. <td>force tag</td></tr>
  2264. <tr><td class="option-group">
  2265. <kbd><span class="option">-l</span>, <span class="option">--local</span></kbd></td>
  2266. <td>make the tag local</td></tr>
  2267. <tr><td class="option-group">
  2268. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  2269. <td>revision to tag</td></tr>
  2270. <tr><td class="option-group">
  2271. <kbd><span class="option">--remove</span></kbd></td>
  2272. <td>remove a tag</td></tr>
  2273. <tr><td class="option-group">
  2274. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  2275. <td>edit commit message</td></tr>
  2276. <tr><td class="option-group">
  2277. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  2278. <td>use &lt;text&gt; as commit message</td></tr>
  2279. <tr><td class="option-group">
  2280. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  2281. <td>record datecode as commit date</td></tr>
  2282. <tr><td class="option-group">
  2283. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  2284. <td>record the specified user as committer</td></tr>
  2285. </tbody>
  2286. </table>
  2287. </div>
  2288. <div class="section" id="tags">
  2289. <h2>tags</h2>
  2290. <pre class="literal-block">
  2291. hg tags
  2292. </pre>
  2293. <p>This lists both regular and local tags. When the -v/--verbose
  2294. switch is used, a third column &quot;local&quot; is printed for local tags.</p>
  2295. <p>Returns 0 on success.</p>
  2296. </div>
  2297. <div class="section" id="tip">
  2298. <h2>tip</h2>
  2299. <pre class="literal-block">
  2300. hg tip [-p] [-g]
  2301. </pre>
  2302. <p>The tip revision (usually just called the tip) is the changeset
  2303. most recently added to the repository (and therefore the most
  2304. recently changed head).</p>
  2305. <p>If you have just made a commit, that commit will be the tip. If
  2306. you have just pulled changes from another repository, the tip of
  2307. that repository becomes the current tip. The &quot;tip&quot; tag is special
  2308. and cannot be renamed or assigned to a different changeset.</p>
  2309. <p>Returns 0 on success.</p>
  2310. <p>options:</p>
  2311. <table class="docutils option-list" frame="void" rules="none">
  2312. <col class="option" />
  2313. <col class="description" />
  2314. <tbody valign="top">
  2315. <tr><td class="option-group">
  2316. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  2317. <td>show patch</td></tr>
  2318. <tr><td class="option-group">
  2319. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  2320. <td>use git extended diff format</td></tr>
  2321. <tr><td class="option-group">
  2322. <kbd><span class="option">--style</span></kbd></td>
  2323. <td>display using template map file</td></tr>
  2324. <tr><td class="option-group">
  2325. <kbd><span class="option">--template</span></kbd></td>
  2326. <td>display with template</td></tr>
  2327. </tbody>
  2328. </table>
  2329. </div>
  2330. <div class="section" id="unbundle">
  2331. <h2>unbundle</h2>
  2332. <pre class="literal-block">
  2333. hg unbundle [-u] FILE...
  2334. </pre>
  2335. <p>Apply one or more compressed changegroup files generated by the
  2336. bundle command.</p>
  2337. <p>Returns 0 on success, 1 if an update has unresolved files.</p>
  2338. <p>options:</p>
  2339. <table class="docutils option-list" frame="void" rules="none">
  2340. <col class="option" />
  2341. <col class="description" />
  2342. <tbody valign="top">
  2343. <tr><td class="option-group">
  2344. <kbd><span class="option">-u</span>, <span class="option">--update</span></kbd></td>
  2345. <td>update to new branch head if changesets were unbundled</td></tr>
  2346. </tbody>
  2347. </table>
  2348. </div>
  2349. <div class="section" id="update">
  2350. <h2>update</h2>
  2351. <pre class="literal-block">
  2352. hg update [-c] [-C] [-d DATE] [[-r] REV]
  2353. </pre>
  2354. <p>Update the repository's working directory to the specified
  2355. changeset. If no changeset is specified, update to the tip of the
  2356. current named branch.</p>
  2357. <p>If the changeset is not a descendant of the working directory's
  2358. parent, the update is aborted. With the -c/--check option, the
  2359. working directory is checked for uncommitted changes; if none are
  2360. found, the working directory is updated to the specified
  2361. changeset.</p>
  2362. <p>The following rules apply when the working directory contains
  2363. uncommitted changes:</p>
  2364. <ol class="arabic simple">
  2365. <li>If neither -c/--check nor -C/--clean is specified, and if
  2366. the requested changeset is an ancestor or descendant of
  2367. the working directory's parent, the uncommitted changes
  2368. are merged into the requested changeset and the merged
  2369. result is left uncommitted. If the requested changeset is
  2370. not an ancestor or descendant (that is, it is on another
  2371. branch), the update is aborted and the uncommitted changes
  2372. are preserved.</li>
  2373. <li>With the -c/--check option, the update is aborted and the
  2374. uncommitted changes are preserved.</li>
  2375. <li>With the -C/--clean option, uncommitted changes are discarded and
  2376. the working directory is updated to the requested changeset.</li>
  2377. </ol>
  2378. <p>Use null as the changeset to remove the working directory (like
  2379. <a class="reference external" href="hg.1.html#clone"><tt class="docutils literal">hg clone <span class="pre">-U</span></tt></a>).</p>
  2380. <p>If you want to update just one file to an older changeset, use
  2381. <a class="reference external" href="hg.1.html#revert"><tt class="docutils literal">hg revert</tt></a>.</p>
  2382. <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>
  2383. <p>Returns 0 on success, 1 if there are unresolved files.</p>
  2384. <p>options:</p>
  2385. <table class="docutils option-list" frame="void" rules="none">
  2386. <col class="option" />
  2387. <col class="description" />
  2388. <tbody valign="top">
  2389. <tr><td class="option-group">
  2390. <kbd><span class="option">-C</span>, <span class="option">--clean</span></kbd></td>
  2391. <td>discard uncommitted changes (no backup)</td></tr>
  2392. <tr><td class="option-group">
  2393. <kbd><span class="option">-c</span>, <span class="option">--check</span></kbd></td>
  2394. <td>update across branches if no uncommitted changes</td></tr>
  2395. <tr><td class="option-group">
  2396. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  2397. <td>tipmost revision matching date</td></tr>
  2398. <tr><td class="option-group">
  2399. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  2400. <td><p class="first">revision</p>
  2401. <p class="last">aliases: up checkout co</p>
  2402. </td></tr>
  2403. </tbody>
  2404. </table>
  2405. </div>
  2406. <div class="section" id="verify">
  2407. <h2>verify</h2>
  2408. <pre class="literal-block">
  2409. hg verify
  2410. </pre>
  2411. <p>Verify the integrity of the current repository.</p>
  2412. <p>This will perform an extensive check of the repository's
  2413. integrity, validating the hashes and checksums of each entry in
  2414. the changelog, manifest, and tracked files, as well as the
  2415. integrity of their crosslinks and indices.</p>
  2416. <p>Returns 0 on success, 1 if errors are encountered.</p>
  2417. </div>
  2418. <div class="section" id="version">
  2419. <h2>version</h2>
  2420. <pre class="literal-block">
  2421. hg version
  2422. </pre>
  2423. <p>output version and copyright information</p>
  2424. </div>
  2425. </div>
  2426. <div class="section" id="configuration-files">
  2427. <span id="hgrc"></span><span id="config"></span><h1><a class="toc-backref" href="#contents">Configuration Files</a></h1>
  2428. <p>Mercurial reads configuration data from several files, if they exist.
  2429. Below we list the most specific file first.</p>
  2430. <p>On Windows, these configuration files are read:</p>
  2431. <ul class="simple">
  2432. <li><tt class="docutils literal"><span class="pre">&lt;repo&gt;\.hg\hgrc</span></tt></li>
  2433. <li><tt class="docutils literal"><span class="pre">%USERPROFILE%\.hgrc</span></tt></li>
  2434. <li><tt class="docutils literal"><span class="pre">%USERPROFILE%\mercurial.ini</span></tt></li>
  2435. <li><tt class="docutils literal"><span class="pre">%HOME%\.hgrc</span></tt></li>
  2436. <li><tt class="docutils literal"><span class="pre">%HOME%\mercurial.ini</span></tt></li>
  2437. <li><tt class="docutils literal"><span class="pre">C:\mercurial\mercurial.ini</span></tt> (unless regkey or hgrc.dor mercurial.ini found)</li>
  2438. <li><tt class="docutils literal">HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial</tt> (unless hgrc.dor mercurial.ini found)</li>
  2439. <li><tt class="docutils literal"><span class="pre">&lt;hg.exe-dir&gt;\hgrc.d\*.rc</span></tt> (unless mercurial.ini found)</li>
  2440. <li><tt class="docutils literal"><span class="pre">&lt;hg.exe-dir&gt;\mercurial.ini</span></tt></li>
  2441. </ul>
  2442. <p>On Unix, these files are read:</p>
  2443. <ul class="simple">
  2444. <li><tt class="docutils literal"><span class="pre">&lt;repo&gt;/.hg/hgrc</span></tt></li>
  2445. <li><tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt></li>
  2446. <li><tt class="docutils literal">/etc/mercurial/hgrc</tt></li>
  2447. <li><tt class="docutils literal"><span class="pre">/etc/mercurial/hgrc.d/*.rc</span></tt></li>
  2448. <li><tt class="docutils literal"><span class="pre">&lt;install-root&gt;/etc/mercurial/hgrc</span></tt></li>
  2449. <li><tt class="docutils literal"><span class="pre">&lt;install-root&gt;/etc/mercurial/hgrc.d/*.rc</span></tt></li>
  2450. </ul>
  2451. <p>If there is a per-repository configuration file which is not owned by
  2452. the active user, Mercurial will warn you that the file is skipped:</p>
  2453. <pre class="literal-block">
  2454. not trusting file &lt;repo&gt;/.hg/hgrc from untrusted user USER, group GROUP
  2455. </pre>
  2456. <p>If this bothers you, the warning can be silenced (the file would still
  2457. be ignored) or trust can be established. Use one of the following
  2458. settings, the syntax is explained below:</p>
  2459. <ul class="simple">
  2460. <li><tt class="docutils literal">ui.report_untrusted = False</tt></li>
  2461. <li><tt class="docutils literal">trusted.users = USER</tt></li>
  2462. <li><tt class="docutils literal">trusted.groups = GROUP</tt></li>
  2463. </ul>
  2464. <p>The configuration files for Mercurial use a simple ini-file format. A
  2465. configuration file consists of sections, led by a <tt class="docutils literal">[section]</tt> header
  2466. and followed by <tt class="docutils literal">name = value</tt> entries:</p>
  2467. <pre class="literal-block">
  2468. [ui]
  2469. username = Firstname Lastname &lt;firstname.lastname&#64;example.net&gt;
  2470. verbose = True
  2471. </pre>
  2472. <p>The above entries will be referred to as <tt class="docutils literal">ui.username</tt> and
  2473. <tt class="docutils literal">ui.verbose</tt>, respectively. Please see the hgrc man page for a full
  2474. description of the possible configuration values:</p>
  2475. <ul class="simple">
  2476. <li>on Unix-like systems: <tt class="docutils literal">man hgrc</tt></li>
  2477. <li>online: <a class="reference external" href="http://www.selenic.com/mercurial/hgrc.5.html">http://www.selenic.com/mercurial/hgrc.5.html</a></li>
  2478. </ul>
  2479. </div>
  2480. <div class="section" id="date-formats">
  2481. <span id="dates"></span><h1><a class="toc-backref" href="#contents">Date Formats</a></h1>
  2482. <p>Some commands allow the user to specify a date, e.g.:</p>
  2483. <ul class="simple">
  2484. <li>backout, commit, import, tag: Specify the commit date.</li>
  2485. <li>log, revert, update: Select revision(s) by date.</li>
  2486. </ul>
  2487. <p>Many date formats are valid. Here are some examples:</p>
  2488. <ul class="simple">
  2489. <li><tt class="docutils literal">Wed Dec 6 13:18:29 2006</tt> (local timezone assumed)</li>
  2490. <li><tt class="docutils literal">Dec 6 13:18 <span class="pre">-0600</span></tt> (year assumed, time offset provided)</li>
  2491. <li><tt class="docutils literal">Dec 6 13:18 UTC</tt> (UTC and GMT are aliases for +0000)</li>
  2492. <li><tt class="docutils literal">Dec 6</tt> (midnight)</li>
  2493. <li><tt class="docutils literal">13:18</tt> (today assumed)</li>
  2494. <li><tt class="docutils literal">3:39</tt> (3:39AM assumed)</li>
  2495. <li><tt class="docutils literal">3:39pm</tt> (15:39)</li>
  2496. <li><tt class="docutils literal"><span class="pre">2006-12-06</span> 13:18:29</tt> (ISO 8601 format)</li>
  2497. <li><tt class="docutils literal"><span class="pre">2006-12-6</span> 13:18</tt></li>
  2498. <li><tt class="docutils literal"><span class="pre">2006-12-6</span></tt></li>
  2499. <li><tt class="docutils literal"><span class="pre">12-6</span></tt></li>
  2500. <li><tt class="docutils literal">12/6</tt></li>
  2501. <li><tt class="docutils literal">12/6/6</tt> (Dec 6 2006)</li>
  2502. </ul>
  2503. <p>Lastly, there is Mercurial's internal format:</p>
  2504. <ul class="simple">
  2505. <li><tt class="docutils literal">1165432709 0</tt> (Wed Dec 6 13:18:29 2006 UTC)</li>
  2506. </ul>
  2507. <p>This is the internal representation format for dates. unixtime is the
  2508. number of seconds since the epoch (1970-01-01 00:00 UTC). offset is
  2509. the offset of the local timezone, in seconds west of UTC (negative if
  2510. the timezone is east of UTC).</p>
  2511. <p>The log command also accepts date ranges:</p>
  2512. <ul class="simple">
  2513. <li><tt class="docutils literal">&lt;{datetime}</tt> - at or before a given date/time</li>
  2514. <li><tt class="docutils literal">&gt;{datetime}</tt> - on or after a given date/time</li>
  2515. <li><tt class="docutils literal">{datetime} to {datetime}</tt> - a date range, inclusive</li>
  2516. <li><tt class="docutils literal"><span class="pre">-{days}</span></tt> - within a given number of days of today</li>
  2517. </ul>
  2518. </div>
  2519. <div class="section" id="file-name-patterns">
  2520. <span id="patterns"></span><h1><a class="toc-backref" href="#contents">File Name Patterns</a></h1>
  2521. <p>Mercurial accepts several notations for identifying one or more files
  2522. at a time.</p>
  2523. <p>By default, Mercurial treats filenames as shell-style extended glob
  2524. patterns.</p>
  2525. <p>Alternate pattern notations must be specified explicitly.</p>
  2526. <p>To use a plain path name without any pattern matching, start it with
  2527. <tt class="docutils literal">path:</tt>. These path names must completely match starting at the
  2528. current repository root.</p>
  2529. <p>To use an extended glob, start a name with <tt class="docutils literal">glob:</tt>. Globs are rooted
  2530. at the current directory; a glob such as <tt class="docutils literal">*.c</tt> will only match files
  2531. in the current directory ending with <tt class="docutils literal">.c</tt>.</p>
  2532. <p>The supported glob syntax extensions are <tt class="docutils literal">**</tt> to match any string
  2533. across path separators and <tt class="docutils literal">{a,b}</tt> to mean &quot;a or b&quot;.</p>
  2534. <p>To use a Perl/Python regular expression, start a name with <tt class="docutils literal">re:</tt>.
  2535. Regexp pattern matching is anchored at the root of the repository.</p>
  2536. <p>Plain examples:</p>
  2537. <pre class="literal-block">
  2538. path:foo/bar   a name bar in a directory named foo in the root
  2539.                of the repository
  2540. path:path:name a file or directory named &quot;path:name&quot;
  2541. </pre>
  2542. <p>Glob examples:</p>
  2543. <pre class="literal-block">
  2544. glob:*.c       any name ending in &quot;.c&quot; in the current directory
  2545. *.c            any name ending in &quot;.c&quot; in the current directory
  2546. **.c           any name ending in &quot;.c&quot; in any subdirectory of the
  2547.                current directory including itself.
  2548. foo/*.c        any name ending in &quot;.c&quot; in the directory foo
  2549. foo/**.c       any name ending in &quot;.c&quot; in any subdirectory of foo
  2550.                including itself.
  2551. </pre>
  2552. <p>Regexp examples:</p>
  2553. <pre class="literal-block">
  2554. re:.*\.c$      any name ending in &quot;.c&quot;, anywhere in the repository
  2555. </pre>
  2556. </div>
  2557. <div class="section" id="environment-variables">
  2558. <span id="env"></span><span id="environment"></span><h1><a class="toc-backref" href="#contents">Environment Variables</a></h1>
  2559. <dl class="docutils">
  2560. <dt>HG</dt>
  2561. <dd>Path to the 'hg' executable, automatically passed when running
  2562. hooks, extensions or external tools. If unset or empty, this is
  2563. the hg executable's name if it's frozen, or an executable named
  2564. 'hg' (with %PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on
  2565. Windows) is searched.</dd>
  2566. <dt>HGEDITOR</dt>
  2567. <dd><p class="first">This is the name of the editor to run when committing. See EDITOR.</p>
  2568. <p class="last">(deprecated, use configuration file)</p>
  2569. </dd>
  2570. <dt>HGENCODING</dt>
  2571. <dd>This overrides the default locale setting detected by Mercurial.
  2572. This setting is used to convert data including usernames,
  2573. changeset descriptions, tag names, and branches. This setting can
  2574. be overridden with the --encoding command-line option.</dd>
  2575. <dt>HGENCODINGMODE</dt>
  2576. <dd>This sets Mercurial's behavior for handling unknown characters
  2577. while transcoding user input. The default is &quot;strict&quot;, which
  2578. causes Mercurial to abort if it can't map a character. Other
  2579. settings include &quot;replace&quot;, which replaces unknown characters, and
  2580. &quot;ignore&quot;, which drops them. This setting can be overridden with
  2581. the --encodingmode command-line option.</dd>
  2582. <dt>HGENCODINGAMBIGUOUS</dt>
  2583. <dd>This sets Mercurial's behavior for handling characters with
  2584. &quot;ambiguous&quot; widths like accented Latin characters with East Asian
  2585. fonts. By default, Mercurial assumes ambiguous characters are
  2586. narrow, set this variable to &quot;wide&quot; if such characters cause
  2587. formatting problems.</dd>
  2588. <dt>HGMERGE</dt>
  2589. <dd><p class="first">An executable to use for resolving merge conflicts. The program
  2590. will be executed with three arguments: local file, remote file,
  2591. ancestor file.</p>
  2592. <p class="last">(deprecated, use configuration file)</p>
  2593. </dd>
  2594. <dt>HGRCPATH</dt>
  2595. <dd><p class="first">A list of files or directories to search for configuration
  2596. files. Item separator is &quot;:&quot; on Unix, &quot;;&quot; on Windows. If HGRCPATH
  2597. is not set, platform default search path is used. If empty, only
  2598. the .hg/hgrc from the current repository is read.</p>
  2599. <p>For each element in HGRCPATH:</p>
  2600. <ul class="last simple">
  2601. <li>if it's a directory, all files ending with .rc are added</li>
  2602. <li>otherwise, the file itself will be added</li>
  2603. </ul>
  2604. </dd>
  2605. <dt>HGPLAIN</dt>
  2606. <dd><p class="first">When set, this disables any configuration settings that might
  2607. change Mercurial's default output. This includes encoding,
  2608. defaults, verbose mode, debug mode, quiet mode, tracebacks, and
  2609. localization. This can be useful when scripting against Mercurial
  2610. in the face of existing user configuration.</p>
  2611. <p class="last">Equivalent options set via command line flags or environment
  2612. variables are not overridden.</p>
  2613. </dd>
  2614. <dt>HGUSER</dt>
  2615. <dd><p class="first">This is the string used as the author of a commit. If not set,
  2616. available values will be considered in this order:</p>
  2617. <ul class="simple">
  2618. <li>HGUSER (deprecated)</li>
  2619. <li>configuration files from the HGRCPATH</li>
  2620. <li>EMAIL</li>
  2621. <li>interactive prompt</li>
  2622. <li>LOGNAME (with <tt class="docutils literal">&#64;hostname</tt> appended)</li>
  2623. </ul>
  2624. <p class="last">(deprecated, use configuration file)</p>
  2625. </dd>
  2626. <dt>EMAIL</dt>
  2627. <dd>May be used as the author of a commit; see HGUSER.</dd>
  2628. <dt>LOGNAME</dt>
  2629. <dd>May be used as the author of a commit; see HGUSER.</dd>
  2630. <dt>VISUAL</dt>
  2631. <dd>This is the name of the editor to use when committing. See EDITOR.</dd>
  2632. <dt>EDITOR</dt>
  2633. <dd>Sometimes Mercurial needs to open a text file in an editor for a
  2634. user to modify, for example when writing commit messages. The
  2635. editor it uses is determined by looking at the environment
  2636. variables HGEDITOR, VISUAL and EDITOR, in that order. The first
  2637. non-empty one is chosen. If all of them are empty, the editor
  2638. defaults to 'vi'.</dd>
  2639. <dt>PYTHONPATH</dt>
  2640. <dd>This is used by Python to find imported modules and may need to be
  2641. set appropriately if this Mercurial is not installed system-wide.</dd>
  2642. </dl>
  2643. </div>
  2644. <div class="section" id="specifying-single-revisions">
  2645. <span id="revisions"></span><span id="revs"></span><h1><a class="toc-backref" href="#contents">Specifying Single Revisions</a></h1>
  2646. <p>Mercurial supports several ways to specify individual revisions.</p>
  2647. <p>A plain integer is treated as a revision number. Negative integers are
  2648. treated as sequential offsets from the tip, with -1 denoting the tip,
  2649. -2 denoting the revision prior to the tip, and so forth.</p>
  2650. <p>A 40-digit hexadecimal string is treated as a unique revision
  2651. identifier.</p>
  2652. <p>A hexadecimal string less than 40 characters long is treated as a
  2653. unique revision identifier and is referred to as a short-form
  2654. identifier. A short-form identifier is only valid if it is the prefix
  2655. of exactly one full-length identifier.</p>
  2656. <p>Any other string is treated as a tag or branch name. A tag name is a
  2657. symbolic name associated with a revision identifier. A branch name
  2658. denotes the tipmost revision of that branch. Tag and branch names must
  2659. not contain the &quot;:&quot; character.</p>
  2660. <p>The reserved name &quot;tip&quot; is a special tag that always identifies the
  2661. most recent revision.</p>
  2662. <p>The reserved name &quot;null&quot; indicates the null revision. This is the
  2663. revision of an empty repository, and the parent of revision 0.</p>
  2664. <p>The reserved name &quot;.&quot; indicates the working directory parent. If no
  2665. working directory is checked out, it is equivalent to null. If an
  2666. uncommitted merge is in progress, &quot;.&quot; is the revision of the first
  2667. parent.</p>
  2668. </div>
  2669. <div class="section" id="specifying-multiple-revisions">
  2670. <span id="multirevs"></span><span id="mrevs"></span><h1><a class="toc-backref" href="#contents">Specifying Multiple Revisions</a></h1>
  2671. <p>When Mercurial accepts more than one revision, they may be specified
  2672. individually, or provided as a topologically continuous range,
  2673. separated by the &quot;:&quot; character.</p>
  2674. <p>The syntax of range notation is [BEGIN]:[END], where BEGIN and END are
  2675. revision identifiers. Both BEGIN and END are optional. If BEGIN is not
  2676. specified, it defaults to revision number 0. If END is not specified,
  2677. it defaults to the tip. The range &quot;:&quot; thus means &quot;all revisions&quot;.</p>
  2678. <p>If BEGIN is greater than END, revisions are treated in reverse order.</p>
  2679. <p>A range acts as a closed interval. This means that a range of 3:5
  2680. gives 3, 4 and 5. Similarly, a range of 9:6 gives 9, 8, 7, and 6.</p>
  2681. </div>
  2682. <div class="section" id="specifying-revision-sets">
  2683. <span id="revsets"></span><span id="revset"></span><h1><a class="toc-backref" href="#contents">Specifying Revision Sets</a></h1>
  2684. <p>Mercurial supports a functional language for selecting a set of
  2685. revisions.</p>
  2686. <p>The language supports a number of predicates which are joined by infix
  2687. operators. Parenthesis can be used for grouping.</p>
  2688. <p>Identifiers such as branch names must be quoted with single or double
  2689. quotes if they contain characters outside of
  2690. <tt class="docutils literal"><span class="pre">[._a-zA-Z0-9\x80-\xff]</span></tt> or if they match one of the predefined
  2691. predicates.</p>
  2692. <p>Special characters can be used in quoted identifiers by escaping them,
  2693. e.g., <tt class="docutils literal">\n</tt> is interpreted as a newline. To prevent them from being
  2694. 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>
  2695. <p>There is a single prefix operator:</p>
  2696. <dl class="docutils">
  2697. <dt><tt class="docutils literal">not x</tt></dt>
  2698. <dd>Changesets not in x. Short form is <tt class="docutils literal">! x</tt>.</dd>
  2699. </dl>
  2700. <p>These are the supported infix operators:</p>
  2701. <dl class="docutils">
  2702. <dt><tt class="docutils literal"><span class="pre">x::y</span></tt></dt>
  2703. <dd><p class="first">A DAG range, meaning all changesets that are descendants of x and
  2704. ancestors of y, including x and y themselves. If the first endpoint
  2705. is left out, this is equivalent to <tt class="docutils literal">ancestors(y)</tt>, if the second
  2706. is left out it is equivalent to <tt class="docutils literal">descendants(x)</tt>.</p>
  2707. <p class="last">An alternative syntax is <tt class="docutils literal"><span class="pre">x..y</span></tt>.</p>
  2708. </dd>
  2709. <dt><tt class="docutils literal">x:y</tt></dt>
  2710. <dd>All changesets with revision numbers between x and y, both
  2711. inclusive. Either endpoint can be left out, they default to 0 and
  2712. tip.</dd>
  2713. <dt><tt class="docutils literal">x and y</tt></dt>
  2714. <dd>The intersection of changesets in x and y. Short form is <tt class="docutils literal">x &amp; y</tt>.</dd>
  2715. <dt><tt class="docutils literal">x or y</tt></dt>
  2716. <dd>The union of changesets in x and y. There are two alternative short
  2717. forms: <tt class="docutils literal">x | y</tt> and <tt class="docutils literal">x + y</tt>.</dd>
  2718. <dt><tt class="docutils literal">x - y</tt></dt>
  2719. <dd>Changesets in x but not in y.</dd>
  2720. </dl>
  2721. <p>The following predicates are supported:</p>
  2722. <!-- predicatesmarker -->
  2723. <p>Command line equivalents for <a class="reference external" href="hg.1.html#log"><tt class="docutils literal">hg log</tt></a>:</p>
  2724. <pre class="literal-block">
  2725. -f    -&gt;  ::.
  2726. -d x  -&gt;  date(x)
  2727. -k x  -&gt;  keyword(x)
  2728. -m    -&gt;  merge()
  2729. -u x  -&gt;  user(x)
  2730. -b x  -&gt;  branch(x)
  2731. -P x  -&gt;  !::x
  2732. -l x  -&gt;  limit(expr, x)
  2733. </pre>
  2734. <p>Some sample queries:</p>
  2735. <ul>
  2736. <li><p class="first">Changesets on the default branch:</p>
  2737. <pre class="literal-block">
  2738. hg log -r &quot;branch(default)&quot;
  2739. </pre>
  2740. </li>
  2741. <li><p class="first">Changesets on the default branch since tag 1.5 (excluding merges):</p>
  2742. <pre class="literal-block">
  2743. hg log -r &quot;branch(default) and 1.5:: and not merge()&quot;
  2744. </pre>
  2745. </li>
  2746. <li><p class="first">Open branch heads:</p>
  2747. <pre class="literal-block">
  2748. hg log -r &quot;head() and not closed()&quot;
  2749. </pre>
  2750. </li>
  2751. <li><p class="first">Changesets between tags 1.3 and 1.5 mentioning &quot;bug&quot; that affect
  2752. <tt class="docutils literal">hgext/*</tt>:</p>
  2753. <pre class="literal-block">
  2754. hg log -r &quot;1.3::1.5 and keyword(bug) and file('hgext/*')&quot;
  2755. </pre>
  2756. </li>
  2757. <li><p class="first">Changesets in committed May 2008, sorted by user:</p>
  2758. <pre class="literal-block">
  2759. hg log -r &quot;sort(date('May 2008'), user)&quot;
  2760. </pre>
  2761. </li>
  2762. <li><p class="first">Changesets mentioning &quot;bug&quot; or &quot;issue&quot; that are not in a tagged
  2763. release:</p>
  2764. <pre class="literal-block">
  2765. hg log -r &quot;(keyword(bug) or keyword(issue)) and not ancestors(tagged())&quot;
  2766. </pre>
  2767. </li>
  2768. </ul>
  2769. </div>
  2770. <div class="section" id="diff-formats">
  2771. <span id="diffs"></span><h1><a class="toc-backref" href="#contents">Diff Formats</a></h1>
  2772. <p>Mercurial's default format for showing changes between two versions of
  2773. a file is compatible with the unified format of GNU diff, which can be
  2774. used by GNU patch and many other standard tools.</p>
  2775. <p>While this standard format is often enough, it does not encode the
  2776. following information:</p>
  2777. <ul class="simple">
  2778. <li>executable status and other permission bits</li>
  2779. <li>copy or rename information</li>
  2780. <li>changes in binary files</li>
  2781. <li>creation or deletion of empty files</li>
  2782. </ul>
  2783. <p>Mercurial also supports the extended diff format from the git VCS
  2784. which addresses these limitations. The git diff format is not produced
  2785. by default because a few widespread tools still do not understand this
  2786. format.</p>
  2787. <p>This means that when generating diffs from a Mercurial repository
  2788. (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
  2789. copies and renames or other things mentioned above, because when
  2790. applying a standard diff to a different repository, this extra
  2791. information is lost. Mercurial's internal operations (like push and
  2792. pull) are not affected by this, because they use an internal binary
  2793. format for communicating changes.</p>
  2794. <p>To make Mercurial produce the git extended diff format, use the --git
  2795. option available for many commands, or set 'git = True' in the [diff]
  2796. section of your configuration file. You do not need to set this option
  2797. when importing diffs in this format or using them in the mq extension.</p>
  2798. </div>
  2799. <div class="section" id="id1">
  2800. <span id="merge-tools"></span><h1><a class="toc-backref" href="#contents">Merge Tools</a></h1>
  2801. <p>To merge files Mercurial uses merge tools.</p>
  2802. <p>A merge tool combines two different versions of a file into a merged
  2803. file. Merge tools are given the two files and the greatest common
  2804. ancestor of the two file versions, so they can determine the changes
  2805. made on both branches.</p>
  2806. <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>,
  2807. <a class="reference external" href="hg.1.html#backout"><tt class="docutils literal">hg backout</tt></a> and in several extensions.</p>
  2808. <p>Usually, the merge tool tries to automatically reconcile the files by
  2809. combining all non-overlapping changes that occurred separately in
  2810. the two different evolutions of the same initial base file. Furthermore, some
  2811. interactive merge programs make it easier to manually resolve
  2812. conflicting merges, either in a graphical way, or by inserting some
  2813. conflict markers. Mercurial does not include any interactive merge
  2814. programs but relies on external tools for that.</p>
  2815. <div class="section" id="available-merge-tools">
  2816. <h2>Available merge tools</h2>
  2817. <p>External merge tools and their properties are configured in the
  2818. merge-tools configuration section - see hgrc(5) - but they can often just
  2819. be named by their executable.</p>
  2820. <p>A merge tool is generally usable if its executable can be found on the
  2821. system and if it can handle the merge. The executable is found if it
  2822. is an absolute or relative executable path or the name of an
  2823. application in the executable search path. The tool is assumed to be
  2824. able to handle the merge if it can handle symlinks if the file is a
  2825. symlink, if it can handle binary files if the file is binary, and if a
  2826. GUI is available if the tool requires a GUI.</p>
  2827. <p>There are some internal merge tools which can be used. The internal
  2828. merge tools are:</p>
  2829. <dl class="docutils">
  2830. <dt><tt class="docutils literal">internal:merge</tt></dt>
  2831. <dd>Uses the internal non-interactive simple merge algorithm for merging
  2832. files. It will fail if there are any conflicts and leave markers in
  2833. the partially merged file.</dd>
  2834. <dt><tt class="docutils literal">internal:fail</tt></dt>
  2835. <dd>Rather than attempting to merge files that were modified on both
  2836. branches, it marks them as unresolved. The resolve command must be
  2837. used to resolve these conflicts.</dd>
  2838. <dt><tt class="docutils literal">internal:local</tt></dt>
  2839. <dd>Uses the local version of files as the merged version.</dd>
  2840. <dt><tt class="docutils literal">internal:other</tt></dt>
  2841. <dd>Uses the other version of files as the merged version.</dd>
  2842. <dt><tt class="docutils literal">internal:prompt</tt></dt>
  2843. <dd>Asks the user which of the local or the other version to keep as
  2844. the merged version.</dd>
  2845. <dt><tt class="docutils literal">internal:dump</tt></dt>
  2846. <dd>Creates three versions of the files to merge, containing the
  2847. contents of local, other and base. These files can then be used to
  2848. perform a merge manually. If the file to be merged is named
  2849. <tt class="docutils literal">a.txt</tt>, these files will accordingly be named <tt class="docutils literal">a.txt.local</tt>,
  2850. <tt class="docutils literal">a.txt.other</tt> and <tt class="docutils literal">a.txt.base</tt> and they will be placed in the
  2851. same directory as <tt class="docutils literal">a.txt</tt>.</dd>
  2852. </dl>
  2853. <p>Internal tools are always available and do not require a GUI but will by default
  2854. not handle symlinks or binary files.</p>
  2855. </div>
  2856. <div class="section" id="choosing-a-merge-tool">
  2857. <h2>Choosing a merge tool</h2>
  2858. <p>Mercurial uses these rules when deciding which merge tool to use:</p>
  2859. <ol class="arabic simple">
  2860. <li>If a tool has been specified with the --tool option to merge or resolve, it
  2861. is used.  If it is the name of a tool in the merge-tools configuration, its
  2862. configuration is used. Otherwise the specified tool must be executable by
  2863. the shell.</li>
  2864. <li>If the <tt class="docutils literal">HGMERGE</tt> environment variable is present, its value is used and
  2865. must be executable by the shell.</li>
  2866. <li>If the filename of the file to be merged matches any of the patterns in the
  2867. merge-patterns configuration section, the first usable merge tool
  2868. corresponding to a matching pattern is used. Here, binary capabilities of the
  2869. merge tool are not considered.</li>
  2870. <li>If ui.merge is set it will be considered next. If the value is not the name
  2871. of a configured tool, the specified value is used and must be executable by
  2872. the shell. Otherwise the named tool is used if it is usable.</li>
  2873. <li>If any usable merge tools are present in the merge-tools configuration
  2874. section, the one with the highest priority is used.</li>
  2875. <li>If a program named <tt class="docutils literal">hgmerge</tt> can be found on the system, it is used - but
  2876. it will by default not be used for symlinks and binary files.</li>
  2877. <li>If the file to be merged is not binary and is not a symlink, then
  2878. <tt class="docutils literal">internal:merge</tt> is used.</li>
  2879. <li>The merge of the file fails and must be resolved before commit.</li>
  2880. </ol>
  2881. <div class="note">
  2882. <p class="first admonition-title">Note</p>
  2883. <p class="last">After selecting a merge program, Mercurial will by default attempt
  2884. to merge the files using a simple merge algorithm first. Only if it doesn't
  2885. succeed because of conflicting changes Mercurial will actually execute the
  2886. merge program. Whether to use the simple merge algorithm first can be
  2887. controlled by the premerge setting of the merge tool. Premerge is enabled by
  2888. default unless the file is binary or a symlink.</p>
  2889. </div>
  2890. <p>See the merge-tools and ui sections of hgrc(5) for details on the
  2891. configuration of merge tools.</p>
  2892. </div>
  2893. </div>
  2894. <div class="section" id="template-usage">
  2895. <span id="templates"></span><span id="templating"></span><h1><a class="toc-backref" href="#contents">Template Usage</a></h1>
  2896. <p>Mercurial allows you to customize output of commands through
  2897. templates. You can either pass in a template from the command
  2898. line, via the --template option, or select an existing
  2899. template-style (--style).</p>
  2900. <p>You can customize output for any &quot;log-like&quot; command: log,
  2901. outgoing, incoming, tip, parents, heads and glog.</p>
  2902. <p>Four styles are packaged with Mercurial: default (the style used
  2903. when no explicit preference is passed), compact, changelog,
  2904. and xml.
  2905. Usage:</p>
  2906. <pre class="literal-block">
  2907. $ hg log -r1 --style changelog
  2908. </pre>
  2909. <p>A template is a piece of text, with markup to invoke variable
  2910. expansion:</p>
  2911. <pre class="literal-block">
  2912. $ hg log -r1 --template &quot;{node}\n&quot;
  2913. b56ce7b07c52de7d5fd79fb89701ea538af65746
  2914. </pre>
  2915. <p>Strings in curly braces are called keywords. The availability of
  2916. keywords depends on the exact context of the templater. These
  2917. keywords are usually available for templating a log-like command:</p>
  2918. <table class="docutils field-list" frame="void" rules="none">
  2919. <col class="field-name" />
  2920. <col class="field-body" />
  2921. <tbody valign="top">
  2922. <tr class="field"><th class="field-name">author:</th><td class="field-body">String. The unmodified author of the changeset.</td>
  2923. </tr>
  2924. <tr class="field"><th class="field-name">branches:</th><td class="field-body">List of strings. The name of the branch on which the
  2925. changeset was committed. Will be empty if the branch name was
  2926. default.</td>
  2927. </tr>
  2928. <tr class="field"><th class="field-name">children:</th><td class="field-body">List of strings. The children of the changeset.</td>
  2929. </tr>
  2930. <tr class="field"><th class="field-name">date:</th><td class="field-body">Date information. The date when the changeset was committed.</td>
  2931. </tr>
  2932. <tr class="field"><th class="field-name">desc:</th><td class="field-body">String. The text of the changeset description.</td>
  2933. </tr>
  2934. <tr class="field"><th class="field-name">diffstat:</th><td class="field-body">String. Statistics of changes with the following format:
  2935. &quot;modified files: +added/-removed lines&quot;</td>
  2936. </tr>
  2937. <tr class="field"><th class="field-name">files:</th><td class="field-body">List of strings. All files modified, added, or removed by this
  2938. changeset.</td>
  2939. </tr>
  2940. <tr class="field"><th class="field-name">file_adds:</th><td class="field-body">List of strings. Files added by this changeset.</td>
  2941. </tr>
  2942. <tr class="field"><th class="field-name">file_copies:</th><td class="field-body">List of strings. Files copied in this changeset with
  2943. their sources.</td>
  2944. </tr>
  2945. <tr class="field"><th class="field-name" colspan="2">file_copies_switch:</th></tr>
  2946. <tr><td>&nbsp;</td><td class="field-body">List of strings. Like &quot;file_copies&quot; but displayed
  2947. only if the --copied switch is set.</td>
  2948. </tr>
  2949. <tr class="field"><th class="field-name">file_mods:</th><td class="field-body">List of strings. Files modified by this changeset.</td>
  2950. </tr>
  2951. <tr class="field"><th class="field-name">file_dels:</th><td class="field-body">List of strings. Files removed by this changeset.</td>
  2952. </tr>
  2953. <tr class="field"><th class="field-name">node:</th><td class="field-body">String. The changeset identification hash, as a 40 hexadecimal
  2954. digit string.</td>
  2955. </tr>
  2956. <tr class="field"><th class="field-name">parents:</th><td class="field-body">List of strings. The parents of the changeset.</td>
  2957. </tr>
  2958. <tr class="field"><th class="field-name">rev:</th><td class="field-body">Integer. The repository-local changeset revision number.</td>
  2959. </tr>
  2960. <tr class="field"><th class="field-name">tags:</th><td class="field-body">List of strings. Any tags associated with the changeset.</td>
  2961. </tr>
  2962. <tr class="field"><th class="field-name">latesttag:</th><td class="field-body">String. Most recent global tag in the ancestors of this
  2963. changeset.</td>
  2964. </tr>
  2965. <tr class="field"><th class="field-name" colspan="2">latesttagdistance:</th></tr>
  2966. <tr><td>&nbsp;</td><td class="field-body">Integer. Longest path to the latest tag.</td>
  2967. </tr>
  2968. </tbody>
  2969. </table>
  2970. <p>The &quot;date&quot; keyword does not produce human-readable output. If you
  2971. want to use a date in your output, you can use a filter to process
  2972. it. Filters are functions which return a string based on the input
  2973. variable. Be sure to use the stringify filter first when you're
  2974. applying a string-input filter to a list-like input variable.
  2975. You can also use a chain of filters to get the desired output:</p>
  2976. <pre class="literal-block">
  2977. $ hg tip --template &quot;{date|isodate}\n&quot;
  2978. 2008-08-21 18:22 +0000
  2979. </pre>
  2980. <p>List of filters:</p>
  2981. <table class="docutils field-list" frame="void" rules="none">
  2982. <col class="field-name" />
  2983. <col class="field-body" />
  2984. <tbody valign="top">
  2985. <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
  2986. every line except the last.</td>
  2987. </tr>
  2988. <tr class="field"><th class="field-name">age:</th><td class="field-body">Date. Returns a human-readable date/time difference between the
  2989. given date/time and the current date/time.</td>
  2990. </tr>
  2991. <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
  2992. component of the path after splitting by the path separator
  2993. (ignoring trailing separators). For example, &quot;foo/bar/baz&quot; becomes
  2994. &quot;baz&quot; and &quot;foo/bar//&quot; becomes &quot;bar&quot;.</td>
  2995. </tr>
  2996. <tr class="field"><th class="field-name">stripdir:</th><td class="field-body">Treat the text as path and strip a directory level, if
  2997. possible. For example, &quot;foo&quot; and &quot;foo/bar&quot; becomes &quot;foo&quot;.</td>
  2998. </tr>
  2999. <tr class="field"><th class="field-name">date:</th><td class="field-body">Date. Returns a date in a Unix date format, including the
  3000. timezone: &quot;Mon Sep 04 15:13:13 2006 0700&quot;.</td>
  3001. </tr>
  3002. <tr class="field"><th class="field-name">domain:</th><td class="field-body">Any text. Finds the first string that looks like an email
  3003. address, and extracts just the domain component. Example: <tt class="docutils literal">User
  3004. &lt;user&#64;example.com&gt;</tt> becomes <tt class="docutils literal">example.com</tt>.</td>
  3005. </tr>
  3006. <tr class="field"><th class="field-name">email:</th><td class="field-body">Any text. Extracts the first string that looks like an email
  3007. address. Example: <tt class="docutils literal">User &lt;user&#64;example.com&gt;</tt> becomes
  3008. <tt class="docutils literal">user&#64;example.com</tt>.</td>
  3009. </tr>
  3010. <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;
  3011. and &quot;&gt;&quot; with XML entities.</td>
  3012. </tr>
  3013. <tr class="field"><th class="field-name">hex:</th><td class="field-body">Any text. Convert a binary Mercurial node identifier into
  3014. its long hexadecimal representation.</td>
  3015. </tr>
  3016. <tr class="field"><th class="field-name">fill68:</th><td class="field-body">Any text. Wraps the text to fit in 68 columns.</td>
  3017. </tr>
  3018. <tr class="field"><th class="field-name">fill76:</th><td class="field-body">Any text. Wraps the text to fit in 76 columns.</td>
  3019. </tr>
  3020. <tr class="field"><th class="field-name">firstline:</th><td class="field-body">Any text. Returns the first line of text.</td>
  3021. </tr>
  3022. <tr class="field"><th class="field-name">nonempty:</th><td class="field-body">Any text. Returns '(none)' if the string is empty.</td>
  3023. </tr>
  3024. <tr class="field"><th class="field-name">hgdate:</th><td class="field-body">Date. Returns the date as a pair of numbers: &quot;1157407993
  3025. 25200&quot; (Unix timestamp, timezone offset).</td>
  3026. </tr>
  3027. <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
  3028. +0200&quot;.</td>
  3029. </tr>
  3030. <tr class="field"><th class="field-name">isodatesec:</th><td class="field-body">Date. Returns the date in ISO 8601 format, including
  3031. seconds: &quot;2009-08-18 13:00:13 +0200&quot;. See also the rfc3339date
  3032. filter.</td>
  3033. </tr>
  3034. <tr class="field"><th class="field-name">localdate:</th><td class="field-body">Date. Converts a date to local date.</td>
  3035. </tr>
  3036. <tr class="field"><th class="field-name">obfuscate:</th><td class="field-body">Any text. Returns the input text rendered as a sequence of
  3037. XML entities.</td>
  3038. </tr>
  3039. <tr class="field"><th class="field-name">person:</th><td class="field-body">Any text. Returns the text before an email address.</td>
  3040. </tr>
  3041. <tr class="field"><th class="field-name">rfc822date:</th><td class="field-body">Date. Returns a date using the same format used in email
  3042. headers: &quot;Tue, 18 Aug 2009 13:00:13 +0200&quot;.</td>
  3043. </tr>
  3044. <tr class="field"><th class="field-name">rfc3339date:</th><td class="field-body">Date. Returns a date using the Internet date format
  3045. specified in RFC 3339: &quot;2009-08-18T13:00:13+02:00&quot;.</td>
  3046. </tr>
  3047. <tr class="field"><th class="field-name">short:</th><td class="field-body">Changeset hash. Returns the short form of a changeset hash,
  3048. i.e. a 12 hexadecimal digit string.</td>
  3049. </tr>
  3050. <tr class="field"><th class="field-name">shortdate:</th><td class="field-body">Date. Returns a date like &quot;2006-09-18&quot;.</td>
  3051. </tr>
  3052. <tr class="field"><th class="field-name">stringify:</th><td class="field-body">Any type. Turns the value into text by converting values into
  3053. text and concatenating them.</td>
  3054. </tr>
  3055. <tr class="field"><th class="field-name">strip:</th><td class="field-body">Any text. Strips all leading and trailing whitespace.</td>
  3056. </tr>
  3057. <tr class="field"><th class="field-name">tabindent:</th><td class="field-body">Any text. Returns the text, with every line except the
  3058. first starting with a tab character.</td>
  3059. </tr>
  3060. <tr class="field"><th class="field-name">urlescape:</th><td class="field-body">Any text. Escapes all &quot;special&quot; characters. For example,
  3061. &quot;foo bar&quot; becomes &quot;foo%20bar&quot;.</td>
  3062. </tr>
  3063. <tr class="field"><th class="field-name">user:</th><td class="field-body">Any text. Returns the user portion of an email address.</td>
  3064. </tr>
  3065. </tbody>
  3066. </table>
  3067. </div>
  3068. <div class="section" id="url-paths">
  3069. <span id="urls"></span><h1><a class="toc-backref" href="#contents">URL Paths</a></h1>
  3070. <p>Valid URLs are of the form:</p>
  3071. <pre class="literal-block">
  3072. local/filesystem/path[#revision]
  3073. file://local/filesystem/path[#revision]
  3074. http://[user[:pass]&#64;]host[:port]/[path][#revision]
  3075. https://[user[:pass]&#64;]host[:port]/[path][#revision]
  3076. ssh://[user[:pass]&#64;]host[:port]/[path][#revision]
  3077. </pre>
  3078. <p>Paths in the local filesystem can either point to Mercurial
  3079. 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 :hg:`
  3080. incoming --bundle`). See also <a class="reference external" href="hg.1.html#paths"><tt class="docutils literal">hg help paths</tt></a>.</p>
  3081. <p>An optional identifier after # indicates a particular branch, tag, or
  3082. changeset to use from the remote repository. See also <a class="reference external" href="hg.1.html#revisions"><tt class="docutils literal">hg help
  3083. revisions</tt></a>.</p>
  3084. <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
  3085. possible if the feature is explicitly enabled on the remote Mercurial
  3086. server.</p>
  3087. <p>Note that the security of HTTPS URLs depends on proper configuration of
  3088. web.cacerts.</p>
  3089. <p>Some notes about using SSH with Mercurial:</p>
  3090. <ul>
  3091. <li><p class="first">SSH requires an accessible shell account on the destination machine
  3092. and a copy of hg in the remote path or specified with as remotecmd.</p>
  3093. </li>
  3094. <li><p class="first">path is relative to the remote user's home directory by default. Use
  3095. an extra slash at the start of a path to specify an absolute path:</p>
  3096. <pre class="literal-block">
  3097. ssh://example.com//tmp/repository
  3098. </pre>
  3099. </li>
  3100. <li><p class="first">Mercurial doesn't use its own compression via SSH; the right thing
  3101. to do is to configure it in your ~/.ssh/config, e.g.:</p>
  3102. <pre class="literal-block">
  3103. Host *.mylocalnetwork.example.com
  3104.   Compression no
  3105. Host *
  3106.   Compression yes
  3107. </pre>
  3108. <p>Alternatively specify &quot;ssh -C&quot; as your ssh command in your
  3109. configuration file or with the --ssh command line option.</p>
  3110. </li>
  3111. </ul>
  3112. <p>These URLs can all be stored in your configuration file with path
  3113. aliases under the [paths] section like so:</p>
  3114. <pre class="literal-block">
  3115. [paths]
  3116. alias1 = URL1
  3117. alias2 = URL2
  3118. ...
  3119. </pre>
  3120. <p>You can then use the alias for any command that uses a URL (for
  3121. 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>
  3122. <p>Two path aliases are special because they are used as defaults when
  3123. you do not provide the URL to a command:</p>
  3124. <dl class="docutils">
  3125. <dt>default:</dt>
  3126. <dd>When you create a repository with hg clone, the clone command saves
  3127. the location of the source repository as the new repository's
  3128. 'default' path. This is then used when you omit path from push- and
  3129. pull-like commands (including incoming and outgoing).</dd>
  3130. <dt>default-push:</dt>
  3131. <dd>The push command will look for a path named 'default-push', and
  3132. prefer it over 'default' if both are defined.</dd>
  3133. </dl>
  3134. </div>
  3135. <div class="section" id="using-additional-features">
  3136. <span id="extensions"></span><h1><a class="toc-backref" href="#contents">Using additional features</a></h1>
  3137. <p>Mercurial has the ability to add new features through the use of
  3138. extensions. Extensions may add new commands, add options to
  3139. existing commands, change the default behavior of commands, or
  3140. implement hooks.</p>
  3141. <p>Extensions are not loaded by default for a variety of reasons:
  3142. they can increase startup overhead; they may be meant for advanced
  3143. usage only; they may provide potentially dangerous abilities (such
  3144. as letting you destroy or modify history); they might not be ready
  3145. for prime time; or they may alter some usual behaviors of stock
  3146. Mercurial. It is thus up to the user to activate extensions as
  3147. needed.</p>
  3148. <p>To enable the &quot;foo&quot; extension, either shipped with Mercurial or in the
  3149. Python search path, create an entry for it in your configuration file,
  3150. like this:</p>
  3151. <pre class="literal-block">
  3152. [extensions]
  3153. foo =
  3154. </pre>
  3155. <p>You may also specify the full path to an extension:</p>
  3156. <pre class="literal-block">
  3157. [extensions]
  3158. myfeature = ~/.hgext/myfeature.py
  3159. </pre>
  3160. <p>To explicitly disable an extension enabled in a configuration file of
  3161. broader scope, prepend its path with !:</p>
  3162. <pre class="literal-block">
  3163. [extensions]
  3164. # disabling extension bar residing in /path/to/extension/bar.py
  3165. bar = !/path/to/extension/bar.py
  3166. # ditto, but no path was supplied for extension baz
  3167. baz = !
  3168. </pre>
  3169. <p>disabled extensions:</p>
  3170. <blockquote>
  3171. <table class="docutils field-list" frame="void" rules="none">
  3172. <col class="field-name" />
  3173. <col class="field-body" />
  3174. <tbody valign="top">
  3175. <tr class="field"><th class="field-name">acl:</th><td class="field-body">hooks for controlling repository access</td>
  3176. </tr>
  3177. <tr class="field"><th class="field-name">bookmarks:</th><td class="field-body">track a line of development with movable markers</td>
  3178. </tr>
  3179. <tr class="field"><th class="field-name">bugzilla:</th><td class="field-body">hooks for integrating with the Bugzilla bug tracker</td>
  3180. </tr>
  3181. <tr class="field"><th class="field-name">children:</th><td class="field-body">command to display child changesets</td>
  3182. </tr>
  3183. <tr class="field"><th class="field-name">churn:</th><td class="field-body">command to display statistics about repository history</td>
  3184. </tr>
  3185. <tr class="field"><th class="field-name">color:</th><td class="field-body">colorize output from some commands</td>
  3186. </tr>
  3187. <tr class="field"><th class="field-name">convert:</th><td class="field-body">import revisions from foreign VCS repositories into Mercurial</td>
  3188. </tr>
  3189. <tr class="field"><th class="field-name">eol:</th><td class="field-body">automatically manage newlines in repository files</td>
  3190. </tr>
  3191. <tr class="field"><th class="field-name">extdiff:</th><td class="field-body">command to allow external programs to compare revisions</td>
  3192. </tr>
  3193. <tr class="field"><th class="field-name">fetch:</th><td class="field-body">pull, update and merge in one command</td>
  3194. </tr>
  3195. <tr class="field"><th class="field-name">gpg:</th><td class="field-body">commands to sign and verify changesets</td>
  3196. </tr>
  3197. <tr class="field"><th class="field-name">graphlog:</th><td class="field-body">command to view revision graphs from a shell</td>
  3198. </tr>
  3199. <tr class="field"><th class="field-name">hgcia:</th><td class="field-body">hooks for integrating with the CIA.vc notification service</td>
  3200. </tr>
  3201. <tr class="field"><th class="field-name">hgk:</th><td class="field-body">browse the repository in a graphical way</td>
  3202. </tr>
  3203. <tr class="field"><th class="field-name">highlight:</th><td class="field-body">syntax highlighting for hgweb (requires Pygments)</td>
  3204. </tr>
  3205. <tr class="field"><th class="field-name">inotify:</th><td class="field-body">accelerate status report using Linux's inotify service</td>
  3206. </tr>
  3207. <tr class="field"><th class="field-name">interhg:</th><td class="field-body">expand expressions into changelog and summaries</td>
  3208. </tr>
  3209. <tr class="field"><th class="field-name">keyword:</th><td class="field-body">expand keywords in tracked files</td>
  3210. </tr>
  3211. <tr class="field"><th class="field-name">mq:</th><td class="field-body">manage a stack of patches</td>
  3212. </tr>
  3213. <tr class="field"><th class="field-name">notify:</th><td class="field-body">hooks for sending email notifications at commit/push time</td>
  3214. </tr>
  3215. <tr class="field"><th class="field-name">pager:</th><td class="field-body">browse command output with an external pager</td>
  3216. </tr>
  3217. <tr class="field"><th class="field-name">parentrevspec:</th><td class="field-body">interpret suffixes to refer to ancestor revisions</td>
  3218. </tr>
  3219. <tr class="field"><th class="field-name">patchbomb:</th><td class="field-body">command to send changesets as (a series of) patch emails</td>
  3220. </tr>
  3221. <tr class="field"><th class="field-name">progress:</th><td class="field-body">show progress bars for some actions</td>
  3222. </tr>
  3223. <tr class="field"><th class="field-name">purge:</th><td class="field-body">command to delete untracked files from the working directory</td>
  3224. </tr>
  3225. <tr class="field"><th class="field-name">rebase:</th><td class="field-body">command to move sets of revisions to a different ancestor</td>
  3226. </tr>
  3227. <tr class="field"><th class="field-name">record:</th><td class="field-body">commands to interactively select changes for commit/qrefresh</td>
  3228. </tr>
  3229. <tr class="field"><th class="field-name">relink:</th><td class="field-body">recreates hardlinks between repository clones</td>
  3230. </tr>
  3231. <tr class="field"><th class="field-name">schemes:</th><td class="field-body">extend schemes with shortcuts to repository swarms</td>
  3232. </tr>
  3233. <tr class="field"><th class="field-name">share:</th><td class="field-body">share a common history between several working directories</td>
  3234. </tr>
  3235. <tr class="field"><th class="field-name">transplant:</th><td class="field-body">command to transplant changesets from another branch</td>
  3236. </tr>
  3237. <tr class="field"><th class="field-name">win32mbcs:</th><td class="field-body">allow the use of MBCS paths with problematic encodings</td>
  3238. </tr>
  3239. <tr class="field"><th class="field-name">win32text:</th><td class="field-body">perform automatic newline conversion</td>
  3240. </tr>
  3241. <tr class="field"><th class="field-name">zeroconf:</th><td class="field-body">discover and advertise repositories on the local network</td>
  3242. </tr>
  3243. </tbody>
  3244. </table>
  3245. </blockquote>
  3246. </div>
  3247. <div class="section" id="subrepositories">
  3248. <span id="subrepos"></span><span id="subrepo"></span><h1><a class="toc-backref" href="#contents">Subrepositories</a></h1>
  3249. <p>Subrepositories let you nest external repositories or projects into a
  3250. parent Mercurial repository, and make commands operate on them as a
  3251. group. External Mercurial and Subversion projects are currently
  3252. supported.</p>
  3253. <p>Subrepositories are made of three components:</p>
  3254. <ol class="arabic">
  3255. <li><p class="first">Nested repository checkouts. They can appear anywhere in the
  3256. parent working directory, and are Mercurial clones or Subversion
  3257. checkouts.</p>
  3258. </li>
  3259. <li><p class="first">Nested repository references. They are defined in <tt class="docutils literal">.hgsub</tt> and
  3260. tell where the subrepository checkouts come from. Mercurial
  3261. subrepositories are referenced like:</p>
  3262. <blockquote>
  3263. <p>path/to/nested = <a class="reference external" href="https://example.com/nested/repo/path">https://example.com/nested/repo/path</a></p>
  3264. </blockquote>
  3265. <p>where <tt class="docutils literal">path/to/nested</tt> is the checkout location relatively to the
  3266. parent Mercurial root, and <tt class="docutils literal"><span class="pre">https://example.com/nested/repo/path</span></tt>
  3267. is the source repository path. The source can also reference a
  3268. filesystem path. Subversion repositories are defined with:</p>
  3269. <blockquote>
  3270. <p>path/to/nested = [svn]https://example.com/nested/trunk/path</p>
  3271. </blockquote>
  3272. <p>Note that <tt class="docutils literal">.hgsub</tt> does not exist by default in Mercurial
  3273. repositories, you have to create and add it to the parent
  3274. repository before using subrepositories.</p>
  3275. </li>
  3276. <li><p class="first">Nested repository states. They are defined in <tt class="docutils literal">.hgsubstate</tt> and
  3277. capture whatever information is required to restore the
  3278. subrepositories to the state they were committed in a parent
  3279. repository changeset. Mercurial automatically record the nested
  3280. repositories states when committing in the parent repository.</p>
  3281. <div class="note">
  3282. <p class="first admonition-title">Note</p>
  3283. <p class="last">The <tt class="docutils literal">.hgsubstate</tt> file should not be edited manually.</p>
  3284. </div>
  3285. </li>
  3286. </ol>
  3287. </div>
  3288. <div class="section" id="adding-a-subrepository">
  3289. <h1><a class="toc-backref" href="#contents">Adding a Subrepository</a></h1>
  3290. <p>If <tt class="docutils literal">.hgsub</tt> does not exist, create it and add it to the parent
  3291. repository. Clone or checkout the external projects where you want it
  3292. to live in the parent repository. Edit <tt class="docutils literal">.hgsub</tt> and add the
  3293. subrepository entry as described above. At this point, the
  3294. subrepository is tracked and the next commit will record its state in
  3295. <tt class="docutils literal">.hgsubstate</tt> and bind it to the committed changeset.</p>
  3296. </div>
  3297. <div class="section" id="synchronizing-a-subrepository">
  3298. <h1><a class="toc-backref" href="#contents">Synchronizing a Subrepository</a></h1>
  3299. <p>Subrepos do not automatically track the latest changeset of their
  3300. sources. Instead, they are updated to the changeset that corresponds
  3301. with the changeset checked out in the top-level changeset. This is so
  3302. developers always get a consistent set of compatible code and
  3303. libraries when they update.</p>
  3304. <p>Thus, updating subrepos is a manual process. Simply check out target
  3305. subrepo at the desired revision, test in the top-level repo, then
  3306. commit in the parent repository to record the new combination.</p>
  3307. </div>
  3308. <div class="section" id="deleting-a-subrepository">
  3309. <h1><a class="toc-backref" href="#contents">Deleting a Subrepository</a></h1>
  3310. <p>To remove a subrepository from the parent repository, delete its
  3311. reference from <tt class="docutils literal">.hgsub</tt>, then remove its files.</p>
  3312. </div>
  3313. <div class="section" id="interaction-with-mercurial-commands">
  3314. <h1><a class="toc-backref" href="#contents">Interaction with Mercurial Commands</a></h1>
  3315. <table class="docutils field-list" frame="void" rules="none">
  3316. <col class="field-name" />
  3317. <col class="field-body" />
  3318. <tbody valign="top">
  3319. <tr class="field"><th class="field-name">add:</th><td class="field-body">add does not recurse in subrepos unless -S/--subrepos is
  3320. specified. Subversion subrepositories are currently silently
  3321. ignored.</td>
  3322. </tr>
  3323. <tr class="field"><th class="field-name">archive:</th><td class="field-body">archive does not recurse in subrepositories unless
  3324. -S/--subrepos is specified.</td>
  3325. </tr>
  3326. <tr class="field"><th class="field-name">commit:</th><td class="field-body">commit creates a consistent snapshot of the state of the
  3327. entire project and its subrepositories. It does this by first
  3328. attempting to commit all modified subrepositories, then recording
  3329. their state and finally committing it in the parent repository.</td>
  3330. </tr>
  3331. <tr class="field"><th class="field-name">diff:</th><td class="field-body">diff does not recurse in subrepos unless -S/--subrepos is
  3332. specified. Changes are displayed as usual, on the subrepositories
  3333. elements. Subversion subrepositories are currently silently
  3334. ignored.</td>
  3335. </tr>
  3336. <tr class="field"><th class="field-name">incoming:</th><td class="field-body">incoming does not recurse in subrepos unless -S/--subrepos
  3337. is specified. Subversion subrepositories are currently silently
  3338. ignored.</td>
  3339. </tr>
  3340. <tr class="field"><th class="field-name">outgoing:</th><td class="field-body">outgoing does not recurse in subrepos unless -S/--subrepos
  3341. is specified. Subversion subrepositories are currently silently
  3342. ignored.</td>
  3343. </tr>
  3344. <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
  3345. to running <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a>. Listing and retrieving all
  3346. subrepositories changes referenced by the parent repository pulled
  3347. changesets is expensive at best, impossible in the Subversion
  3348. case.</td>
  3349. </tr>
  3350. <tr class="field"><th class="field-name">push:</th><td class="field-body">Mercurial will automatically push all subrepositories first
  3351. when the parent repository is being pushed. This ensures new
  3352. subrepository changes are available when referenced by top-level
  3353. repositories.</td>
  3354. </tr>
  3355. <tr class="field"><th class="field-name">status:</th><td class="field-body">status does not recurse into subrepositories unless
  3356. -S/--subrepos is specified. Subrepository changes are displayed as
  3357. regular Mercurial changes on the subrepository
  3358. elements. Subversion subrepositories are currently silently
  3359. ignored.</td>
  3360. </tr>
  3361. <tr class="field"><th class="field-name">update:</th><td class="field-body">update restores the subrepos in the state they were
  3362. originally committed in target changeset. If the recorded
  3363. changeset is not available in the current subrepository, Mercurial
  3364. will pull it in first before updating.  This means that updating
  3365. can require network access when using subrepositories.</td>
  3366. </tr>
  3367. </tbody>
  3368. </table>
  3369. </div>
  3370. <div class="section" id="remapping-subrepositories-sources">
  3371. <h1><a class="toc-backref" href="#contents">Remapping Subrepositories Sources</a></h1>
  3372. <p>A subrepository source location may change during a project life,
  3373. invalidating references stored in the parent repository history. To
  3374. fix this, rewriting rules can be defined in parent repository <tt class="docutils literal">hgrc</tt>
  3375. file or in Mercurial configuration. See the <tt class="docutils literal">[subpaths]</tt> section in
  3376. hgrc(5) for more details.</p>
  3377. </div>
  3378. <div class="section" id="configuring-hgweb">
  3379. <span id="hgweb"></span><h1><a class="toc-backref" href="#contents">Configuring hgweb</a></h1>
  3380. <p>Mercurial's internal web server, hgweb, can serve either a single
  3381. repository, or a collection of them. In the latter case, a special
  3382. configuration file can be used to specify the repository paths to use
  3383. and global web configuration options.</p>
  3384. <p>This file uses the same syntax as hgrc configuration files, but only
  3385. the following sections are recognized:</p>
  3386. <blockquote>
  3387. <ul class="simple">
  3388. <li>web</li>
  3389. <li>paths</li>
  3390. <li>collections</li>
  3391. </ul>
  3392. </blockquote>
  3393. <p>The <tt class="docutils literal">web</tt> section can specify all the settings described in the web
  3394. section of the hgrc documentation.</p>
  3395. <p>The <tt class="docutils literal">paths</tt> section provides mappings of physical repository
  3396. paths to virtual ones. For instance:</p>
  3397. <pre class="literal-block">
  3398. [paths]
  3399. projects/a = /foo/bar
  3400. projects/b = /baz/quux
  3401. web/root = /real/root/*
  3402. / = /real/root2/*
  3403. virtual/root2 = /real/root2/**
  3404. </pre>
  3405. <ul class="simple">
  3406. <li>The first two entries make two repositories in different directories
  3407. appear under the same directory in the web interface</li>
  3408. <li>The third entry maps every Mercurial repository found in '/real/root'
  3409. into 'web/root'. This format is preferred over the [collections] one,
  3410. since using absolute paths as configuration keys is not supported on every
  3411. platform (especially on Windows).</li>
  3412. <li>The fourth entry is a special case mapping all repositories in
  3413. '/real/root2' in the root of the virtual directory.</li>
  3414. <li>The fifth entry recursively finds all repositories under the real
  3415. root, and maps their relative paths under the virtual root.</li>
  3416. </ul>
  3417. <p>The <tt class="docutils literal">collections</tt> section provides mappings of trees of physical
  3418. repositories paths to virtual ones, though the paths syntax is generally
  3419. preferred. For instance:</p>
  3420. <pre class="literal-block">
  3421. [collections]
  3422. /foo = /foo
  3423. </pre>
  3424. <p>Here, the left side will be stripped off all repositories found in the
  3425. right side. Thus <tt class="docutils literal">/foo/bar</tt> and <tt class="docutils literal">foo/quux/baz</tt> will be listed as
  3426. <tt class="docutils literal">bar</tt> and <tt class="docutils literal">quux/baz</tt> respectively.</p>
  3427. </div>
  3428. <div class="section" id="id2">
  3429. <span id="glossary"></span><h1><a class="toc-backref" href="#contents">Glossary</a></h1>
  3430. <dl class="docutils">
  3431. <dt>Ancestor</dt>
  3432. <dd>Any changeset that can be reached by an unbroken chain of parent
  3433. changesets from a given changeset. More precisely, the ancestors
  3434. of a changeset can be defined by two properties: a parent of a
  3435. changeset is an ancestor, and a parent of an ancestor is an
  3436. ancestor. See also: 'Descendant'.</dd>
  3437. <dt>Branch</dt>
  3438. <dd><p class="first">(Noun) A child changeset that has been created from a parent that
  3439. is not a head. These are known as topological branches, see
  3440. 'Branch, topological'. If a topological branch is named, it becomes
  3441. a named branch. If a topological branch is not named, it becomes
  3442. an anonymous branch. See 'Branch, anonymous' and 'Branch, named'.</p>
  3443. <p>Branches may be created when changes are pulled from or pushed to
  3444. a remote repository, since new heads may be created by these
  3445. operations. Note that the term branch can also be used informally
  3446. to describe a development process in which certain development is
  3447. done independently of other development. This is sometimes done
  3448. explicitly with a named branch, but it can also be done locally,
  3449. using bookmarks or clones and anonymous branches.</p>
  3450. <p>Example: &quot;The experimental branch&quot;.</p>
  3451. <p>(Verb) The action of creating a child changeset which results in
  3452. its parent having more than one child.</p>
  3453. <p class="last">Example: &quot;I'm going to branch at X&quot;.</p>
  3454. </dd>
  3455. <dt>Branch, anonymous</dt>
  3456. <dd>Every time a new child changeset is created from a parent that is not
  3457. a head and the name of the branch is not changed, a new anonymous
  3458. branch is created.</dd>
  3459. <dt>Branch, closed</dt>
  3460. <dd>A named branch whose branch heads have all been closed.</dd>
  3461. <dt>Branch, default</dt>
  3462. <dd>The branch assigned to a changeset when no name has previously been
  3463. assigned.</dd>
  3464. <dt>Branch head</dt>
  3465. <dd>See 'Head, branch'.</dd>
  3466. <dt>Branch, inactive</dt>
  3467. <dd><p class="first">If a named branch has no topological heads, it is considered to be
  3468. inactive. As an example, a feature branch becomes inactive when it
  3469. 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
  3470. shows inactive branches by default, though they can be hidden with
  3471. <a class="reference external" href="hg.1.html#branches"><tt class="docutils literal">hg branches <span class="pre">--active</span></tt></a>.</p>
  3472. <p class="last">NOTE: this concept is deprecated because it is too implicit.
  3473. Branches should now be explicitly closed using <a class="reference external" href="hg.1.html#commit"><tt class="docutils literal">hg commit
  3474. <span class="pre">--close-branch</span></tt></a> when they are no longer needed.</p>
  3475. </dd>
  3476. <dt>Branch, named</dt>
  3477. <dd><p class="first">A collection of changesets which have the same branch name. By
  3478. default, children of a changeset in a named branch belong to the
  3479. same named branch. A child can be explicitly assigned to a
  3480. 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
  3481. <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
  3482. branches.</p>
  3483. <p class="last">Named branches can be thought of as a kind of namespace, dividing
  3484. the collection of changesets that comprise the repository into a
  3485. collection of disjoint subsets. A named branch is not necessarily
  3486. a topological branch. If a new named branch is created from the
  3487. head of another named branch, or the default branch, but no
  3488. further changesets are added to that previous branch, then that
  3489. previous branch will be a branch in name only.</p>
  3490. </dd>
  3491. <dt>Branch tip</dt>
  3492. <dd>See 'Tip, branch'.</dd>
  3493. <dt>Branch, topological</dt>
  3494. <dd>Every time a new child changeset is created from a parent that is
  3495. not a head, a new topological branch is created. If a topological
  3496. branch is named, it becomes a named branch. If a topological
  3497. branch is not named, it becomes an anonymous branch of the
  3498. current, possibly default, branch.</dd>
  3499. <dt>Changelog</dt>
  3500. <dd>A record of the changesets in the order in which they were added
  3501. to the repository. This includes details such as changeset id,
  3502. author, commit message, date, and list of changed files.</dd>
  3503. <dt>Changeset</dt>
  3504. <dd>A snapshot of the state of the repository used to record a change.</dd>
  3505. <dt>Changeset, child</dt>
  3506. <dd>The converse of parent changeset: if P is a parent of C, then C is
  3507. a child of P. There is no limit to the number of children that a
  3508. changeset may have.</dd>
  3509. <dt>Changeset id</dt>
  3510. <dd>A SHA-1 hash that uniquely identifies a changeset. It may be
  3511. represented as either a &quot;long&quot; 40 hexadecimal digit string, or a
  3512. &quot;short&quot; 12 hexadecimal digit string.</dd>
  3513. <dt>Changeset, merge</dt>
  3514. <dd>A changeset with two parents. This occurs when a merge is
  3515. committed.</dd>
  3516. <dt>Changeset, parent</dt>
  3517. <dd>A revision upon which a child changeset is based. Specifically, a
  3518. parent changeset of a changeset C is a changeset whose node
  3519. immediately precedes C in the DAG. Changesets have at most two
  3520. parents.</dd>
  3521. <dt>Checkout</dt>
  3522. <dd><p class="first">(Noun) The working directory being updated to a specific
  3523. revision. This use should probably be avoided where possible, as
  3524. changeset is much more appropriate than checkout in this context.</p>
  3525. <p>Example: &quot;I'm using checkout X.&quot;</p>
  3526. <p>(Verb) Updating the working directory to a specific changeset. See
  3527. <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg help update</tt></a>.</p>
  3528. <p class="last">Example: &quot;I'm going to check out changeset X.&quot;</p>
  3529. </dd>
  3530. <dt>Child changeset</dt>
  3531. <dd>See 'Changeset, child'.</dd>
  3532. <dt>Close changeset</dt>
  3533. <dd>See 'Changeset, close'.</dd>
  3534. <dt>Closed branch</dt>
  3535. <dd>See 'Branch, closed'.</dd>
  3536. <dt>Clone</dt>
  3537. <dd><p class="first">(Noun) An entire or partial copy of a repository. The partial
  3538. clone must be in the form of a revision and its ancestors.</p>
  3539. <p>Example: &quot;Is your clone up to date?&quot;.</p>
  3540. <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>
  3541. <p class="last">Example: &quot;I'm going to clone the repository&quot;.</p>
  3542. </dd>
  3543. <dt>Closed branch head</dt>
  3544. <dd>See 'Head, closed branch'.</dd>
  3545. <dt>Commit</dt>
  3546. <dd><p class="first">(Noun) A synonym for changeset.</p>
  3547. <p>Example: &quot;Is the bug fixed in your recent commit?&quot;</p>
  3548. <p>(Verb) The act of recording changes to a repository. When files
  3549. are committed in a working directory, Mercurial finds the
  3550. differences between the committed files and their parent
  3551. changeset, creating a new changeset in the repository.</p>
  3552. <p class="last">Example: &quot;You should commit those changes now.&quot;</p>
  3553. </dd>
  3554. <dt>Cset</dt>
  3555. <dd>A common abbreviation of the term changeset.</dd>
  3556. <dt>DAG</dt>
  3557. <dd>The repository of changesets of a distributed version control
  3558. system (DVCS) can be described as a directed acyclic graph (DAG),
  3559. consisting of nodes and edges, where nodes correspond to
  3560. changesets and edges imply a parent -&gt; child relation. This graph
  3561. can be visualized by graphical tools such as <a class="reference external" href="hg.1.html#glog"><tt class="docutils literal">hg glog</tt></a>
  3562. (graphlog). In Mercurial, the DAG is limited by the requirement
  3563. for children to have at most two parents.</dd>
  3564. <dt>Default branch</dt>
  3565. <dd>See 'Branch, default'.</dd>
  3566. <dt>Descendant</dt>
  3567. <dd>Any changeset that can be reached by a chain of child changesets
  3568. from a given changeset. More precisely, the descendants of a
  3569. changeset can be defined by two properties: the child of a
  3570. changeset is a descendant, and the child of a descendant is a
  3571. descendant. See also: 'Ancestor'.</dd>
  3572. <dt>Diff</dt>
  3573. <dd><p class="first">(Noun) The difference between the contents and attributes of files
  3574. in two changesets or a changeset and the current working
  3575. directory. The difference is usually represented in a standard
  3576. form called a &quot;diff&quot; or &quot;patch&quot;. The &quot;git diff&quot; format is used
  3577. when the changes include copies, renames, or changes to file
  3578. attributes, none of which can be represented/handled by classic
  3579. &quot;diff&quot; and &quot;patch&quot;.</p>
  3580. <p>Example: &quot;Did you see my correction in the diff?&quot;</p>
  3581. <p>(Verb) Diffing two changesets is the action of creating a diff or
  3582. patch.</p>
  3583. <p class="last">Example: &quot;If you diff with changeset X, you will see what I mean.&quot;</p>
  3584. </dd>
  3585. <dt>Directory, working</dt>
  3586. <dd>The working directory represents the state of the files tracked by
  3587. Mercurial, that will be recorded in the next commit. The working
  3588. directory initially corresponds to the snapshot at an existing
  3589. changeset, known as the parent of the working directory. See
  3590. 'Parent, working directory'. The state may be modified by changes
  3591. to the files introduced manually or by a merge. The repository
  3592. metadata exists in the .hg directory inside the working directory.</dd>
  3593. <dt>Graph</dt>
  3594. <dd>See DAG and <a class="reference external" href="hg.1.html#graphlog"><tt class="docutils literal">hg help graphlog</tt></a>.</dd>
  3595. <dt>Head</dt>
  3596. <dd><p class="first">The term 'head' may be used to refer to both a branch head or a
  3597. repository head, depending on the context. See 'Head, branch' and
  3598. 'Head, repository' for specific definitions.</p>
  3599. <p class="last">Heads are where development generally takes place and are the
  3600. usual targets for update and merge operations.</p>
  3601. </dd>
  3602. <dt>Head, branch</dt>
  3603. <dd>A changeset with no descendants on the same named branch.</dd>
  3604. <dt>Head, closed branch</dt>
  3605. <dd>A changeset that marks a head as no longer interesting. The closed
  3606. 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
  3607. closed when all its heads are closed and consequently is not
  3608. listed by <a class="reference external" href="hg.1.html#branches"><tt class="docutils literal">hg branches</tt></a>.</dd>
  3609. <dt>Head, repository</dt>
  3610. <dd>A topological head which has not been closed.</dd>
  3611. <dt>Head, topological</dt>
  3612. <dd>A changeset with no children in the repository.</dd>
  3613. <dt>History, immutable</dt>
  3614. <dd>Once committed, changesets cannot be altered.  Extensions which
  3615. appear to change history actually create new changesets that
  3616. replace existing ones, and then destroy the old changesets. Doing
  3617. so in public repositories can result in old changesets being
  3618. reintroduced to the repository.</dd>
  3619. <dt>History, rewriting</dt>
  3620. <dd>The changesets in a repository are immutable. However, extensions
  3621. to Mercurial can be used to alter the repository, usually in such
  3622. a way as to preserve changeset contents.</dd>
  3623. <dt>Immutable history</dt>
  3624. <dd>See 'History, immutable'.</dd>
  3625. <dt>Merge changeset</dt>
  3626. <dd>See 'Changeset, merge'.</dd>
  3627. <dt>Manifest</dt>
  3628. <dd>Each changeset has a manifest, which is the list of files that are
  3629. tracked by the changeset.</dd>
  3630. <dt>Merge</dt>
  3631. <dd>Used to bring together divergent branches of work. When you update
  3632. to a changeset and then merge another changeset, you bring the
  3633. history of the latter changeset into your working directory. Once
  3634. conflicts are resolved (and marked), this merge may be committed
  3635. as a merge changeset, bringing two branches together in the DAG.</dd>
  3636. <dt>Named branch</dt>
  3637. <dd>See 'Branch, named'.</dd>
  3638. <dt>Null changeset</dt>
  3639. <dd>The empty changeset. It is the parent state of newly-initialized
  3640. repositories and repositories with no checked out revision. It is
  3641. thus the parent of root changesets and the effective ancestor when
  3642. merging unrelated changesets. Can be specified by the alias 'null'
  3643. or by the changeset ID '000000000000'.</dd>
  3644. <dt>Parent</dt>
  3645. <dd>See 'Changeset, parent'.</dd>
  3646. <dt>Parent changeset</dt>
  3647. <dd>See 'Changeset, parent'.</dd>
  3648. <dt>Parent, working directory</dt>
  3649. <dd>The working directory parent reflects a virtual revision which is
  3650. the child of the changeset (or two changesets with an uncommitted
  3651. merge) shown by <a class="reference external" href="hg.1.html#parents"><tt class="docutils literal">hg parents</tt></a>. This is changed with
  3652. <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
  3653. 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>
  3654. <dt>Patch</dt>
  3655. <dd><p class="first">(Noun) The product of a diff operation.</p>
  3656. <p>Example: &quot;I've sent you my patch.&quot;</p>
  3657. <p>(Verb) The process of using a patch file to transform one
  3658. changeset into another.</p>
  3659. <p class="last">Example: &quot;You will need to patch that revision.&quot;</p>
  3660. </dd>
  3661. <dt>Pull</dt>
  3662. <dd>An operation in which changesets in a remote repository which are
  3663. not in the local repository are brought into the local
  3664. repository. Note that this operation without special arguments
  3665. only updates the repository, it does not update the files in the
  3666. working directory. See <a class="reference external" href="hg.1.html#pull"><tt class="docutils literal">hg help pull</tt></a>.</dd>
  3667. <dt>Push</dt>
  3668. <dd>An operation in which changesets in a local repository which are
  3669. not in a remote repository are sent to the remote repository. Note
  3670. that this operation only adds changesets which have been committed
  3671. locally to the remote repository. Uncommitted changes are not
  3672. sent. See <a class="reference external" href="hg.1.html#push"><tt class="docutils literal">hg help push</tt></a>.</dd>
  3673. <dt>Repository</dt>
  3674. <dd>The metadata describing all recorded states of a collection of
  3675. files. Each recorded state is represented by a changeset. A
  3676. repository is usually (but not always) found in the <tt class="docutils literal">.hg</tt>
  3677. subdirectory of a working directory. Any recorded state can be
  3678. recreated by &quot;updating&quot; a working directory to a specific
  3679. changeset.</dd>
  3680. <dt>Repository head</dt>
  3681. <dd>See 'Head, repository'.</dd>
  3682. <dt>Revision</dt>
  3683. <dd>A state of the repository at some point in time. Earlier revisions
  3684. 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
  3685. number'; See also 'Changeset'.</dd>
  3686. <dt>Revision number</dt>
  3687. <dd>This integer uniquely identifies a changeset in a specific
  3688. repository. It represents the order in which changesets were added
  3689. to a repository, starting with revision number 0. Note that the
  3690. revision number may be different in each clone of a repository. To
  3691. identify changesets uniquely between different clones, see
  3692. 'Changeset id'.</dd>
  3693. <dt>Revlog</dt>
  3694. <dd>History storage mechanism used by Mercurial. It is a form of delta
  3695. encoding, with occasional full revision of data followed by delta
  3696. of each successive revision. It includes data and an index
  3697. pointing to the data.</dd>
  3698. <dt>Rewriting history</dt>
  3699. <dd>See 'History, rewriting'.</dd>
  3700. <dt>Root</dt>
  3701. <dd>A changeset that has only the null changeset as its parent. Most
  3702. repositories have only a single root changeset.</dd>
  3703. <dt>Tip</dt>
  3704. <dd>The changeset with the highest revision number. It is the changeset
  3705. most recently added in a repository.</dd>
  3706. <dt>Tip, branch</dt>
  3707. <dd>The head of a given branch with the highest revision number. When
  3708. a branch name is used as a revision identifier, it refers to the
  3709. branch tip. See also 'Branch, head'. Note that because revision
  3710. numbers may be different in different repository clones, the
  3711. branch tip may be different in different cloned repositories.</dd>
  3712. <dt>Update</dt>
  3713. <dd><p class="first">(Noun) Another synonym of changeset.</p>
  3714. <p>Example: &quot;I've pushed an update&quot;.</p>
  3715. <p>(Verb) This term is usually used to describe updating the state of
  3716. the working directory to that of a specific changeset. See
  3717. <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg help update</tt></a>.</p>
  3718. <p class="last">Example: &quot;You should update&quot;.</p>
  3719. </dd>
  3720. <dt>Working directory</dt>
  3721. <dd>See 'Directory, working'.</dd>
  3722. <dt>Working directory parent</dt>
  3723. <dd>See 'Parent, working directory'.</dd>
  3724. </dl>
  3725. </div>
  3726. <div class="section" id="id3">
  3727. <h1><a class="toc-backref" href="#contents">Extensions</a></h1>
  3728. <p>This section contains help for extensions that are distributed together with Mercurial. Help for other extensions is available in the help system.</p>
  3729. <div class="contents htmlonly local topic" id="id4">
  3730. <ul class="simple">
  3731. <li><a class="reference internal" href="#acl" id="id68">acl</a></li>
  3732. <li><a class="reference internal" href="#bookmarks" id="id69">bookmarks</a></li>
  3733. <li><a class="reference internal" href="#bugzilla" id="id70">bugzilla</a></li>
  3734. <li><a class="reference internal" href="#children" id="id71">children</a></li>
  3735. <li><a class="reference internal" href="#churn" id="id72">churn</a></li>
  3736. <li><a class="reference internal" href="#color" id="id73">color</a></li>
  3737. <li><a class="reference internal" href="#convert" id="id74">convert</a></li>
  3738. <li><a class="reference internal" href="#eol" id="id75">eol</a></li>
  3739. <li><a class="reference internal" href="#extdiff" id="id76">extdiff</a></li>
  3740. <li><a class="reference internal" href="#fetch" id="id77">fetch</a></li>
  3741. <li><a class="reference internal" href="#gpg" id="id78">gpg</a></li>
  3742. <li><a class="reference internal" href="#graphlog" id="id79">graphlog</a></li>
  3743. <li><a class="reference internal" href="#hgcia" id="id80">hgcia</a></li>
  3744. <li><a class="reference internal" href="#hgk" id="id81">hgk</a></li>
  3745. <li><a class="reference internal" href="#highlight" id="id82">highlight</a></li>
  3746. <li><a class="reference internal" href="#inotify" id="id83">inotify</a></li>
  3747. <li><a class="reference internal" href="#interhg" id="id84">interhg</a></li>
  3748. <li><a class="reference internal" href="#keyword" id="id85">keyword</a></li>
  3749. <li><a class="reference internal" href="#mq" id="id86">mq</a></li>
  3750. <li><a class="reference internal" href="#notify" id="id87">notify</a></li>
  3751. <li><a class="reference internal" href="#pager" id="id88">pager</a></li>
  3752. <li><a class="reference internal" href="#parentrevspec" id="id89">parentrevspec</a></li>
  3753. <li><a class="reference internal" href="#patchbomb" id="id90">patchbomb</a></li>
  3754. <li><a class="reference internal" href="#progress" id="id91">progress</a></li>
  3755. <li><a class="reference internal" href="#purge" id="id92">purge</a></li>
  3756. <li><a class="reference internal" href="#rebase" id="id93">rebase</a></li>
  3757. <li><a class="reference internal" href="#record" id="id94">record</a></li>
  3758. <li><a class="reference internal" href="#relink" id="id95">relink</a></li>
  3759. <li><a class="reference internal" href="#schemes" id="id96">schemes</a></li>
  3760. <li><a class="reference internal" href="#share" id="id97">share</a></li>
  3761. <li><a class="reference internal" href="#transplant" id="id98">transplant</a></li>
  3762. <li><a class="reference internal" href="#win32mbcs" id="id99">win32mbcs</a></li>
  3763. <li><a class="reference internal" href="#win32text" id="id100">win32text</a></li>
  3764. <li><a class="reference internal" href="#zeroconf" id="id101">zeroconf</a></li>
  3765. </ul>
  3766. </div>
  3767. <div class="section" id="acl">
  3768. <h2><a class="toc-backref" href="#id68">acl</a></h2>
  3769. <p>hooks for controlling repository access</p>
  3770. <p>This hook makes it possible to allow or deny write access to given
  3771. branches and paths of a repository when receiving incoming changesets
  3772. via pretxnchangegroup and pretxncommit.</p>
  3773. <p>The authorization is matched based on the local user name on the
  3774. system where the hook runs, and not the committer of the original
  3775. changeset (since the latter is merely informative).</p>
  3776. <p>The acl hook is best used along with a restricted shell like hgsh,
  3777. preventing authenticating users from doing anything other than pushing
  3778. or pulling. The hook is not safe to use if users have interactive
  3779. shell access, as they can then disable the hook. Nor is it safe if
  3780. remote users share an account, because then there is no way to
  3781. distinguish them.</p>
  3782. <p>The order in which access checks are performed is:</p>
  3783. <ol class="arabic simple">
  3784. <li>Deny  list for branches (section <tt class="docutils literal">acl.deny.branches</tt>)</li>
  3785. <li>Allow list for branches (section <tt class="docutils literal">acl.allow.branches</tt>)</li>
  3786. <li>Deny  list for paths    (section <tt class="docutils literal">acl.deny</tt>)</li>
  3787. <li>Allow list for paths    (section <tt class="docutils literal">acl.allow</tt>)</li>
  3788. </ol>
  3789. <p>The allow and deny sections take key-value pairs.</p>
  3790. <div class="section" id="branch-based-access-control">
  3791. <h3>Branch-based Access Control</h3>
  3792. <p>Use the <tt class="docutils literal">acl.deny.branches</tt> and <tt class="docutils literal">acl.allow.branches</tt> sections to
  3793. have branch-based access control. Keys in these sections can be
  3794. either:</p>
  3795. <ul class="simple">
  3796. <li>a branch name, or</li>
  3797. <li>an asterisk, to match any branch;</li>
  3798. </ul>
  3799. <p>The corresponding values can be either:</p>
  3800. <ul class="simple">
  3801. <li>a comma-separated list containing users and groups, or</li>
  3802. <li>an asterisk, to match anyone;</li>
  3803. </ul>
  3804. </div>
  3805. <div class="section" id="path-based-access-control">
  3806. <h3>Path-based Access Control</h3>
  3807. <p>Use the <tt class="docutils literal">acl.deny</tt> and <tt class="docutils literal">acl.allow</tt> sections to have path-based
  3808. access control. Keys in these sections accept a subtree pattern (with
  3809. a glob syntax by default). The corresponding values follow the same
  3810. syntax as the other sections above.</p>
  3811. </div>
  3812. <div class="section" id="groups">
  3813. <h3>Groups</h3>
  3814. <p>Group names must be prefixed with an <tt class="docutils literal">&#64;</tt> symbol. Specifying a group
  3815. name has the same effect as specifying all the users in that group.</p>
  3816. <p>You can define group members in the <tt class="docutils literal">acl.groups</tt> section.
  3817. If a group name is not defined there, and Mercurial is running under
  3818. a Unix-like system, the list of users will be taken from the OS.
  3819. Otherwise, an exception will be raised.</p>
  3820. </div>
  3821. <div class="section" id="example-configuration">
  3822. <h3>Example Configuration</h3>
  3823. <pre class="literal-block">
  3824. [hooks]
  3825.  
  3826. # Use this if you want to check access restrictions at commit time
  3827. pretxncommit.acl = python:hgext.acl.hook
  3828.  
  3829. # Use this if you want to check access restrictions for pull, push,
  3830. # bundle and serve.
  3831. pretxnchangegroup.acl = python:hgext.acl.hook
  3832.  
  3833. [acl]
  3834. # Allow or deny access for incoming changes only if their source is
  3835. # listed here, let them pass otherwise. Source is &quot;serve&quot; for all
  3836. # remote access (http or ssh), &quot;push&quot;, &quot;pull&quot; or &quot;bundle&quot; when the
  3837. # related commands are run locally.
  3838. # Default: serve
  3839. sources = serve
  3840.  
  3841. [acl.deny.branches]
  3842.  
  3843. # Everyone is denied to the frozen branch:
  3844. frozen-branch = *
  3845.  
  3846. # A bad user is denied on all branches:
  3847. * = bad-user
  3848.  
  3849. [acl.allow.branches]
  3850.  
  3851. # A few users are allowed on branch-a:
  3852. branch-a = user-1, user-2, user-3
  3853.  
  3854. # Only one user is allowed on branch-b:
  3855. branch-b = user-1
  3856.  
  3857. # The super user is allowed on any branch:
  3858. * = super-user
  3859.  
  3860. # Everyone is allowed on branch-for-tests:
  3861. branch-for-tests = *
  3862.  
  3863. [acl.deny]
  3864. # This list is checked first. If a match is found, acl.allow is not
  3865. # checked. All users are granted access if acl.deny is not present.
  3866. # Format for both lists: glob pattern = user, ..., &#64;group, ...
  3867.  
  3868. # To match everyone, use an asterisk for the user:
  3869. # my/glob/pattern = *
  3870.  
  3871. # user6 will not have write access to any file:
  3872. ** = user6
  3873.  
  3874. # Group &quot;hg-denied&quot; will not have write access to any file:
  3875. ** = &#64;hg-denied
  3876.  
  3877. # Nobody will be able to change &quot;DONT-TOUCH-THIS.txt&quot;, despite
  3878. # everyone being able to change all other files. See below.
  3879. src/main/resources/DONT-TOUCH-THIS.txt = *
  3880.  
  3881. [acl.allow]
  3882. # if acl.allow is not present, all users are allowed by default
  3883. # empty acl.allow = no users allowed
  3884.  
  3885. # User &quot;doc_writer&quot; has write access to any file under the &quot;docs&quot;
  3886. # folder:
  3887. docs/** = doc_writer
  3888.  
  3889. # User &quot;jack&quot; and group &quot;designers&quot; have write access to any file
  3890. # under the &quot;images&quot; folder:
  3891. images/** = jack, &#64;designers
  3892.  
  3893. # Everyone (except for &quot;user6&quot; - see acl.deny above) will have write
  3894. # access to any file under the &quot;resources&quot; folder (except for 1
  3895. # file. See acl.deny):
  3896. src/main/resources/** = *
  3897.  
  3898. .hgtags = release_engineer
  3899. </pre>
  3900. </div>
  3901. </div>
  3902. <div class="section" id="bookmarks">
  3903. <h2><a class="toc-backref" href="#id69">bookmarks</a></h2>
  3904. <p>track a line of development with movable markers</p>
  3905. <p>Bookmarks are local movable markers to changesets. Every bookmark
  3906. points to a changeset identified by its hash. If you commit a
  3907. changeset that is based on a changeset that has a bookmark on it, the
  3908. bookmark shifts to the new changeset.</p>
  3909. <p>It is possible to use bookmark names in every revision lookup (e.g.
  3910. <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>).</p>
  3911. <p>By default, when several bookmarks point to the same changeset, they
  3912. will all move forward together. It is possible to obtain a more
  3913. git-like experience by adding the following configuration option to
  3914. your configuration file:</p>
  3915. <pre class="literal-block">
  3916. [bookmarks]
  3917. track.current = True
  3918. </pre>
  3919. <p>This will cause Mercurial to track the bookmark that you are currently
  3920. using, and only update it. This is similar to git's approach to
  3921. branching.</p>
  3922. <div class="section" id="id5">
  3923. <h3>Commands</h3>
  3924. <div class="section" id="id6">
  3925. <h4>bookmarks</h4>
  3926. <pre class="literal-block">
  3927. hg bookmarks [-f] [-d] [-m NAME] [-r REV] [NAME]
  3928. </pre>
  3929. <p>Bookmarks are pointers to certain commits that move when
  3930. committing. Bookmarks are local. They can be renamed, copied and
  3931. deleted. It is possible to use bookmark names in <a class="reference external" href="hg.1.html#merge"><tt class="docutils literal">hg merge</tt></a> and
  3932. <a class="reference external" href="hg.1.html#update"><tt class="docutils literal">hg update</tt></a> to merge and update respectively to a given bookmark.</p>
  3933. <p>You can use <a class="reference external" href="hg.1.html#bookmark"><tt class="docutils literal">hg bookmark NAME</tt></a> to set a bookmark on the working
  3934. directory's parent revision with the given name. If you specify
  3935. a revision using -r REV (where REV may be an existing bookmark),
  3936. the bookmark is assigned to that revision.</p>
  3937. <p>Bookmarks can be pushed and pulled between repositories (see <a class="reference external" href="hg.1.html#push"><tt class="docutils literal">hg help
  3938. push</tt></a> and <a class="reference external" href="hg.1.html#pull"><tt class="docutils literal">hg help pull</tt></a>). This requires the bookmark extension to be
  3939. enabled for both the local and remote repositories.</p>
  3940. <p>options:</p>
  3941. <table class="docutils option-list" frame="void" rules="none">
  3942. <col class="option" />
  3943. <col class="description" />
  3944. <tbody valign="top">
  3945. <tr><td class="option-group">
  3946. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  3947. <td>force</td></tr>
  3948. <tr><td class="option-group">
  3949. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  3950. <td>revision</td></tr>
  3951. <tr><td class="option-group">
  3952. <kbd><span class="option">-d</span>, <span class="option">--delete</span></kbd></td>
  3953. <td>delete a given bookmark</td></tr>
  3954. <tr><td class="option-group">
  3955. <kbd><span class="option">-m</span>, <span class="option">--rename</span></kbd></td>
  3956. <td>rename a given bookmark</td></tr>
  3957. </tbody>
  3958. </table>
  3959. </div>
  3960. </div>
  3961. </div>
  3962. <div class="section" id="bugzilla">
  3963. <h2><a class="toc-backref" href="#id70">bugzilla</a></h2>
  3964. <p>hooks for integrating with the Bugzilla bug tracker</p>
  3965. <p>This hook extension adds comments on bugs in Bugzilla when changesets
  3966. that refer to bugs by Bugzilla ID are seen. The hook does not change
  3967. bug status.</p>
  3968. <p>The hook updates the Bugzilla database directly. Only Bugzilla
  3969. installations using MySQL are supported.</p>
  3970. <p>The hook relies on a Bugzilla script to send bug change notification
  3971. emails. That script changes between Bugzilla versions; the
  3972. 'processmail' script used prior to 2.18 is replaced in 2.18 and
  3973. subsequent versions by 'config/sendbugmail.pl'. Note that these will
  3974. be run by Mercurial as the user pushing the change; you will need to
  3975. ensure the Bugzilla install file permissions are set appropriately.</p>
  3976. <p>The extension is configured through three different configuration
  3977. sections. These keys are recognized in the [bugzilla] section:</p>
  3978. <dl class="docutils">
  3979. <dt>host</dt>
  3980. <dd>Hostname of the MySQL server holding the Bugzilla database.</dd>
  3981. <dt>db</dt>
  3982. <dd>Name of the Bugzilla database in MySQL. Default 'bugs'.</dd>
  3983. <dt>user</dt>
  3984. <dd>Username to use to access MySQL server. Default 'bugs'.</dd>
  3985. <dt>password</dt>
  3986. <dd>Password to use to access MySQL server.</dd>
  3987. <dt>timeout</dt>
  3988. <dd>Database connection timeout (seconds). Default 5.</dd>
  3989. <dt>version</dt>
  3990. <dd>Bugzilla version. Specify '3.0' for Bugzilla versions 3.0 and later,
  3991. '2.18' for Bugzilla versions from 2.18 and '2.16' for versions prior
  3992. to 2.18.</dd>
  3993. <dt>bzuser</dt>
  3994. <dd>Fallback Bugzilla user name to record comments with, if changeset
  3995. committer cannot be found as a Bugzilla user.</dd>
  3996. <dt>bzdir</dt>
  3997. <dd>Bugzilla install directory. Used by default notify. Default
  3998. '/var/www/html/bugzilla'.</dd>
  3999. <dt>notify</dt>
  4000. <dd>The command to run to get Bugzilla to send bug change notification
  4001. emails. Substitutes from a map with 3 keys, 'bzdir', 'id' (bug id)
  4002. and 'user' (committer bugzilla email). Default depends on version;
  4003. from 2.18 it is &quot;cd %(bzdir)s &amp;&amp; perl -T contrib/sendbugmail.pl
  4004. %(id)s %(user)s&quot;.</dd>
  4005. <dt>regexp</dt>
  4006. <dd>Regular expression to match bug IDs in changeset commit message.
  4007. Must contain one &quot;()&quot; group. The default expression matches 'Bug
  4008. 1234', 'Bug no. 1234', 'Bug number 1234', 'Bugs 1234,5678', 'Bug
  4009. 1234 and 5678' and variations thereof. Matching is case insensitive.</dd>
  4010. <dt>style</dt>
  4011. <dd>The style file to use when formatting comments.</dd>
  4012. <dt>template</dt>
  4013. <dd><p class="first">Template to use when formatting comments. Overrides style if
  4014. specified. In addition to the usual Mercurial keywords, the
  4015. extension specifies:</p>
  4016. <pre class="literal-block">
  4017. {bug}       The Bugzilla bug ID.
  4018. {root}      The full pathname of the Mercurial repository.
  4019. {webroot}   Stripped pathname of the Mercurial repository.
  4020. {hgweb}     Base URL for browsing Mercurial repositories.
  4021. </pre>
  4022. <dl class="last docutils">
  4023. <dt>Default 'changeset {node|short} in repo {root} refers '</dt>
  4024. <dd>'to bug {bug}.ndetails:nt{desc|tabindent}'</dd>
  4025. </dl>
  4026. </dd>
  4027. <dt>strip</dt>
  4028. <dd>The number of slashes to strip from the front of {root} to produce
  4029. {webroot}. Default 0.</dd>
  4030. <dt>usermap</dt>
  4031. <dd>Path of file containing Mercurial committer ID to Bugzilla user ID
  4032. mappings. If specified, the file should contain one mapping per
  4033. line, &quot;committer&quot;=&quot;Bugzilla user&quot;. See also the [usermap] section.</dd>
  4034. </dl>
  4035. <p>The [usermap] section is used to specify mappings of Mercurial
  4036. committer ID to Bugzilla user ID. See also [bugzilla].usermap.
  4037. &quot;committer&quot;=&quot;Bugzilla user&quot;</p>
  4038. <p>Finally, the [web] section supports one entry:</p>
  4039. <dl class="docutils">
  4040. <dt>baseurl</dt>
  4041. <dd>Base URL for browsing Mercurial repositories. Reference from
  4042. templates as {hgweb}.</dd>
  4043. </dl>
  4044. <p>Activating the extension:</p>
  4045. <pre class="literal-block">
  4046. [extensions]
  4047. bugzilla =
  4048.  
  4049. [hooks]
  4050. # run bugzilla hook on every change pulled or pushed in here
  4051. incoming.bugzilla = python:hgext.bugzilla.hook
  4052. </pre>
  4053. <p>Example configuration:</p>
  4054. <p>This example configuration is for a collection of Mercurial
  4055. repositories in /var/local/hg/repos/ used with a local Bugzilla 3.2
  4056. installation in /opt/bugzilla-3.2.</p>
  4057. <pre class="literal-block">
  4058. [bugzilla]
  4059. host=localhost
  4060. password=XYZZY
  4061. version=3.0
  4062. bzuser=unknown&#64;domain.com
  4063. bzdir=/opt/bugzilla-3.2
  4064. template=Changeset {node|short} in {root|basename}.
  4065.          {hgweb}/{webroot}/rev/{node|short}\n
  4066.          {desc}\n
  4067. strip=5
  4068.  
  4069. [web]
  4070. baseurl=http://dev.domain.com/hg
  4071.  
  4072. [usermap]
  4073. user&#64;emaildomain.com=user.name&#64;bugzilladomain.com
  4074. </pre>
  4075. <p>Commits add a comment to the Bugzilla bug record of the form:</p>
  4076. <pre class="literal-block">
  4077. Changeset 3b16791d6642 in repository-name.
  4078. http://dev.domain.com/hg/repository-name/rev/3b16791d6642
  4079.  
  4080. Changeset commit comment. Bug 1234.
  4081. </pre>
  4082. </div>
  4083. <div class="section" id="children">
  4084. <h2><a class="toc-backref" href="#id71">children</a></h2>
  4085. <p>command to display child changesets</p>
  4086. <div class="section" id="id7">
  4087. <h3>Commands</h3>
  4088. <div class="section" id="id8">
  4089. <h4>children</h4>
  4090. <pre class="literal-block">
  4091. hg children [-r REV] [FILE]
  4092. </pre>
  4093. <p>Print the children of the working directory's revisions. If a
  4094. revision is given via -r/--rev, the children of that revision will
  4095. be printed. If a file argument is given, revision in which the
  4096. file was last changed (after the working directory revision or the
  4097. argument to --rev if given) is printed.</p>
  4098. <p>options:</p>
  4099. <table class="docutils option-list" frame="void" rules="none">
  4100. <col class="option" />
  4101. <col class="description" />
  4102. <tbody valign="top">
  4103. <tr><td class="option-group">
  4104. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  4105. <td>show children of the specified revision</td></tr>
  4106. <tr><td class="option-group">
  4107. <kbd><span class="option">--style</span></kbd></td>
  4108. <td>display using template map file</td></tr>
  4109. <tr><td class="option-group">
  4110. <kbd><span class="option">--template</span></kbd></td>
  4111. <td>display with template</td></tr>
  4112. </tbody>
  4113. </table>
  4114. </div>
  4115. </div>
  4116. </div>
  4117. <div class="section" id="churn">
  4118. <h2><a class="toc-backref" href="#id72">churn</a></h2>
  4119. <p>command to display statistics about repository history</p>
  4120. <div class="section" id="id9">
  4121. <h3>Commands</h3>
  4122. <div class="section" id="id10">
  4123. <h4>churn</h4>
  4124. <pre class="literal-block">
  4125. hg churn [-d DATE] [-r REV] [--aliases FILE] [FILE]
  4126. </pre>
  4127. <p>This command will display a histogram representing the number
  4128. of changed lines or revisions, grouped according to the given
  4129. template. The default template will group changes by author.
  4130. The --dateformat option may be used to group the results by
  4131. date instead.</p>
  4132. <p>Statistics are based on the number of changed lines, or
  4133. alternatively the number of matching revisions if the
  4134. --changesets option is specified.</p>
  4135. <p>Examples:</p>
  4136. <pre class="literal-block">
  4137. # display count of changed lines for every committer
  4138. hg churn -t '{author|email}'
  4139.  
  4140. # display daily activity graph
  4141. hg churn -f '%H' -s -c
  4142.  
  4143. # display activity of developers by month
  4144. hg churn -f '%Y-%m' -s -c
  4145.  
  4146. # display count of lines changed in every year
  4147. hg churn -f '%Y' -s
  4148. </pre>
  4149. <p>It is possible to map alternate email addresses to a main address
  4150. by providing a file using the following format:</p>
  4151. <pre class="literal-block">
  4152. &lt;alias email&gt; = &lt;actual email&gt;
  4153. </pre>
  4154. <p>Such a file may be specified with the --aliases option, otherwise
  4155. a .hgchurn file will be looked for in the working directory root.</p>
  4156. <p>options:</p>
  4157. <table class="docutils option-list" frame="void" rules="none">
  4158. <col class="option" />
  4159. <col class="description" />
  4160. <tbody valign="top">
  4161. <tr><td class="option-group">
  4162. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  4163. <td>count rate for the specified revision or range</td></tr>
  4164. <tr><td class="option-group">
  4165. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  4166. <td>count rate for revisions matching date spec</td></tr>
  4167. <tr><td class="option-group">
  4168. <kbd><span class="option">-t</span>, <span class="option">--template</span></kbd></td>
  4169. <td>template to group changesets (default: {author|email})</td></tr>
  4170. <tr><td class="option-group" colspan="2">
  4171. <kbd><span class="option">-f</span>, <span class="option">--dateformat</span></kbd></td>
  4172. </tr>
  4173. <tr><td>&nbsp;</td><td>strftime-compatible format for grouping by date</td></tr>
  4174. <tr><td class="option-group" colspan="2">
  4175. <kbd><span class="option">-c</span>, <span class="option">--changesets</span></kbd></td>
  4176. </tr>
  4177. <tr><td>&nbsp;</td><td>count rate by number of changesets</td></tr>
  4178. <tr><td class="option-group">
  4179. <kbd><span class="option">-s</span>, <span class="option">--sort</span></kbd></td>
  4180. <td>sort by key (default: sort by count)</td></tr>
  4181. <tr><td class="option-group">
  4182. <kbd><span class="option">--diffstat</span></kbd></td>
  4183. <td>display added/removed lines separately</td></tr>
  4184. <tr><td class="option-group">
  4185. <kbd><span class="option">--aliases</span></kbd></td>
  4186. <td>file with email aliases</td></tr>
  4187. <tr><td class="option-group">
  4188. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  4189. <td>include names matching the given patterns</td></tr>
  4190. <tr><td class="option-group">
  4191. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  4192. <td>exclude names matching the given patterns</td></tr>
  4193. </tbody>
  4194. </table>
  4195. </div>
  4196. </div>
  4197. </div>
  4198. <div class="section" id="color">
  4199. <h2><a class="toc-backref" href="#id73">color</a></h2>
  4200. <p>colorize output from some commands</p>
  4201. <p>This extension modifies the status and resolve commands to add color to their
  4202. output to reflect file status, the qseries command to add color to reflect
  4203. patch status (applied, unapplied, missing), and to diff-related
  4204. commands to highlight additions, removals, diff headers, and trailing
  4205. whitespace.</p>
  4206. <p>Other effects in addition to color, like bold and underlined text, are
  4207. also available. Effects are rendered with the ECMA-48 SGR control
  4208. function (aka ANSI escape codes). This module also provides the
  4209. render_text function, which can be used to add effects to any text.</p>
  4210. <p>Default effects may be overridden from your configuration file:</p>
  4211. <pre class="literal-block">
  4212. [color]
  4213. status.modified = blue bold underline red_background
  4214. status.added = green bold
  4215. status.removed = red bold blue_background
  4216. status.deleted = cyan bold underline
  4217. status.unknown = magenta bold underline
  4218. status.ignored = black bold
  4219.  
  4220. # 'none' turns off all effects
  4221. status.clean = none
  4222. status.copied = none
  4223.  
  4224. qseries.applied = blue bold underline
  4225. qseries.unapplied = black bold
  4226. qseries.missing = red bold
  4227.  
  4228. diff.diffline = bold
  4229. diff.extended = cyan bold
  4230. diff.file_a = red bold
  4231. diff.file_b = green bold
  4232. diff.hunk = magenta
  4233. diff.deleted = red
  4234. diff.inserted = green
  4235. diff.changed = white
  4236. diff.trailingwhitespace = bold red_background
  4237.  
  4238. resolve.unresolved = red bold
  4239. resolve.resolved = green bold
  4240.  
  4241. bookmarks.current = green
  4242.  
  4243. branches.active = none
  4244. branches.closed = black bold
  4245. branches.current = green
  4246. branches.inactive = none
  4247. </pre>
  4248. <p>The color extension will try to detect whether to use ANSI codes or
  4249. Win32 console APIs, unless it is made explicit:</p>
  4250. <pre class="literal-block">
  4251. [color]
  4252. mode = ansi
  4253. </pre>
  4254. <p>Any value other than 'ansi', 'win32', or 'auto' will disable color.</p>
  4255. </div>
  4256. <div class="section" id="convert">
  4257. <h2><a class="toc-backref" href="#id74">convert</a></h2>
  4258. <p>import revisions from foreign VCS repositories into Mercurial</p>
  4259. <div class="section" id="id11">
  4260. <h3>Commands</h3>
  4261. <div class="section" id="id12">
  4262. <h4>convert</h4>
  4263. <pre class="literal-block">
  4264. hg convert [OPTION]... SOURCE [DEST [REVMAP]]
  4265. </pre>
  4266. <p>Accepted source formats [identifiers]:</p>
  4267. <ul class="simple">
  4268. <li>Mercurial [hg]</li>
  4269. <li>CVS [cvs]</li>
  4270. <li>Darcs [darcs]</li>
  4271. <li>git [git]</li>
  4272. <li>Subversion [svn]</li>
  4273. <li>Monotone [mtn]</li>
  4274. <li>GNU Arch [gnuarch]</li>
  4275. <li>Bazaar [bzr]</li>
  4276. <li>Perforce [p4]</li>
  4277. </ul>
  4278. <p>Accepted destination formats [identifiers]:</p>
  4279. <ul class="simple">
  4280. <li>Mercurial [hg]</li>
  4281. <li>Subversion [svn] (history on branches is not preserved)</li>
  4282. </ul>
  4283. <p>If no revision is given, all revisions will be converted.
  4284. Otherwise, convert will only import up to the named revision
  4285. (given in a format understood by the source).</p>
  4286. <p>If no destination directory name is specified, it defaults to the
  4287. basename of the source with <tt class="docutils literal"><span class="pre">-hg</span></tt> appended. If the destination
  4288. repository doesn't exist, it will be created.</p>
  4289. <p>By default, all sources except Mercurial will use --branchsort.
  4290. Mercurial uses --sourcesort to preserve original revision numbers
  4291. order. Sort modes have the following effects:</p>
  4292. <table class="docutils option-list" frame="void" rules="none">
  4293. <col class="option" />
  4294. <col class="description" />
  4295. <tbody valign="top">
  4296. <tr><td class="option-group">
  4297. <kbd><span class="option">--branchsort</span></kbd></td>
  4298. <td>convert from parent to child revision when possible,
  4299. which means branches are usually converted one after
  4300. the other. It generates more compact repositories.</td></tr>
  4301. <tr><td class="option-group">
  4302. <kbd><span class="option">--datesort</span></kbd></td>
  4303. <td>sort revisions by date. Converted repositories have
  4304. good-looking changelogs but are often an order of
  4305. magnitude larger than the same ones generated by
  4306. --branchsort.</td></tr>
  4307. <tr><td class="option-group">
  4308. <kbd><span class="option">--sourcesort</span></kbd></td>
  4309. <td>try to preserve source revisions order, only
  4310. supported by Mercurial sources.</td></tr>
  4311. </tbody>
  4312. </table>
  4313. <p>If &lt;REVMAP&gt; isn't given, it will be put in a default location
  4314. (&lt;dest&gt;/.hg/shamap by default). The &lt;REVMAP&gt; is a simple text file
  4315. that maps each source commit ID to the destination ID for that
  4316. revision, like so:</p>
  4317. <pre class="literal-block">
  4318. &lt;source ID&gt; &lt;destination ID&gt;
  4319. </pre>
  4320. <p>If the file doesn't exist, it's automatically created. It's
  4321. 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
  4322. and can be run repeatedly to copy new commits.</p>
  4323. <p>The authormap is a simple text file that maps each source commit
  4324. author to a destination commit author. It is handy for source SCMs
  4325. that use unix logins to identify authors (eg: CVS). One line per
  4326. author mapping and the line format is:</p>
  4327. <pre class="literal-block">
  4328. source author = destination author
  4329. </pre>
  4330. <p>Empty lines and lines starting with a <tt class="docutils literal">#</tt> are ignored.</p>
  4331. <p>The filemap is a file that allows filtering and remapping of files
  4332. and directories. Each line can contain one of the following
  4333. directives:</p>
  4334. <pre class="literal-block">
  4335. include path/to/file-or-dir
  4336.  
  4337. exclude path/to/file-or-dir
  4338.  
  4339. rename path/to/source path/to/destination
  4340. </pre>
  4341. <p>Comment lines start with <tt class="docutils literal">#</tt>. A specified path matches if it
  4342. equals the full relative name of a file or one of its parent
  4343. directories. The <tt class="docutils literal">include</tt> or <tt class="docutils literal">exclude</tt> directive with the
  4344. longest matching path applies, so line order does not matter.</p>
  4345. <p>The <tt class="docutils literal">include</tt> directive causes a file, or all files under a
  4346. directory, to be included in the destination repository, and the
  4347. exclusion of all other files and directories not explicitly
  4348. included. The <tt class="docutils literal">exclude</tt> directive causes files or directories to
  4349. be omitted. The <tt class="docutils literal">rename</tt> directive renames a file or directory if
  4350. it is converted. To rename from a subdirectory into the root of
  4351. the repository, use <tt class="docutils literal">.</tt> as the path to rename to.</p>
  4352. <p>The splicemap is a file that allows insertion of synthetic
  4353. history, letting you specify the parents of a revision. This is
  4354. useful if you want to e.g. give a Subversion merge two parents, or
  4355. graft two disconnected series of history together. Each entry
  4356. contains a key, followed by a space, followed by one or two
  4357. comma-separated values:</p>
  4358. <pre class="literal-block">
  4359. key parent1, parent2
  4360. </pre>
  4361. <p>The key is the revision ID in the source
  4362. revision control system whose parents should be modified (same
  4363. format as a key in .hg/shamap). The values are the revision IDs
  4364. (in either the source or destination revision control system) that
  4365. should be used as the new parents for that node. For example, if
  4366. you have merged &quot;release-1.0&quot; into &quot;trunk&quot;, then you should
  4367. specify the revision on &quot;trunk&quot; as the first parent and the one on
  4368. the &quot;release-1.0&quot; branch as the second.</p>
  4369. <p>The branchmap is a file that allows you to rename a branch when it is
  4370. being brought in from whatever external repository. When used in
  4371. conjunction with a splicemap, it allows for a powerful combination
  4372. to help fix even the most badly mismanaged repositories and turn them
  4373. into nicely structured Mercurial repositories. The branchmap contains
  4374. lines of the form:</p>
  4375. <pre class="literal-block">
  4376. original_branch_name new_branch_name
  4377. </pre>
  4378. <p>where &quot;original_branch_name&quot; is the name of the branch in the
  4379. source repository, and &quot;new_branch_name&quot; is the name of the branch
  4380. is the destination repository. No whitespace is allowed in the
  4381. branch names. This can be used to (for instance) move code in one
  4382. repository from &quot;default&quot; to a named branch.</p>
  4383. <div class="section" id="mercurial-source">
  4384. <h5>Mercurial Source</h5>
  4385. <dl class="docutils">
  4386. <dt>--config convert.hg.ignoreerrors=False    (boolean)</dt>
  4387. <dd>ignore integrity errors when reading. Use it to fix Mercurial
  4388. repositories with missing revlogs, by converting from and to
  4389. Mercurial.</dd>
  4390. <dt>--config convert.hg.saverev=False         (boolean)</dt>
  4391. <dd>store original revision ID in changeset (forces target IDs to
  4392. change)</dd>
  4393. <dt>--config convert.hg.startrev=0            (hg revision identifier)</dt>
  4394. <dd>convert start revision and its descendants</dd>
  4395. </dl>
  4396. </div>
  4397. <div class="section" id="cvs-source">
  4398. <h5>CVS Source</h5>
  4399. <p>CVS source will use a sandbox (i.e. a checked-out copy) from CVS
  4400. to indicate the starting point of what will be converted. Direct
  4401. access to the repository files is not needed, unless of course the
  4402. repository is :local:. The conversion uses the top level directory
  4403. in the sandbox to find the CVS repository, and then uses CVS rlog
  4404. commands to find files to convert. This means that unless a
  4405. filemap is given, all files under the starting directory will be
  4406. converted, and that any directory reorganization in the CVS
  4407. sandbox is ignored.</p>
  4408. <p>The options shown are the defaults.</p>
  4409. <dl class="docutils">
  4410. <dt>--config convert.cvsps.cache=True         (boolean)</dt>
  4411. <dd>Set to False to disable remote log caching, for testing and
  4412. debugging purposes.</dd>
  4413. <dt>--config convert.cvsps.fuzz=60            (integer)</dt>
  4414. <dd>Specify the maximum time (in seconds) that is allowed between
  4415. commits with identical user and log message in a single
  4416. changeset. When very large files were checked in as part of a
  4417. changeset then the default may not be long enough.</dd>
  4418. <dt>--config convert.cvsps.mergeto='{{mergetobranch ([-w]+)}}'</dt>
  4419. <dd>Specify a regular expression to which commit log messages are
  4420. matched. If a match occurs, then the conversion process will
  4421. insert a dummy revision merging the branch on which this log
  4422. message occurs to the branch indicated in the regex.</dd>
  4423. <dt>--config convert.cvsps.mergefrom='{{mergefrombranch ([-w]+)}}'</dt>
  4424. <dd>Specify a regular expression to which commit log messages are
  4425. matched. If a match occurs, then the conversion process will
  4426. add the most recent revision on the branch indicated in the
  4427. regex as the second parent of the changeset.</dd>
  4428. <dt>--config hook.cvslog</dt>
  4429. <dd>Specify a Python function to be called at the end of gathering
  4430. the CVS log. The function is passed a list with the log entries,
  4431. and can modify the entries in-place, or add or delete them.</dd>
  4432. <dt>--config hook.cvschangesets</dt>
  4433. <dd>Specify a Python function to be called after the changesets
  4434. are calculated from the the CVS log. The function is passed
  4435. a list with the changeset entries, and can modify the changesets
  4436. in-place, or add or delete them.</dd>
  4437. </dl>
  4438. <p>An additional &quot;debugcvsps&quot; Mercurial command allows the builtin
  4439. changeset merging code to be run without doing a conversion. Its
  4440. parameters and output are similar to that of cvsps 2.1. Please see
  4441. the command help for more details.</p>
  4442. </div>
  4443. <div class="section" id="subversion-source">
  4444. <h5>Subversion Source</h5>
  4445. <p>Subversion source detects classical trunk/branches/tags layouts.
  4446. By default, the supplied &quot;svn://repo/path/&quot; source URL is
  4447. converted as a single branch. If &quot;svn://repo/path/trunk&quot; exists it
  4448. replaces the default branch. If &quot;svn://repo/path/branches&quot; exists,
  4449. its subdirectories are listed as possible branches. If
  4450. &quot;svn://repo/path/tags&quot; exists, it is looked for tags referencing
  4451. converted branches. Default &quot;trunk&quot;, &quot;branches&quot; and &quot;tags&quot; values
  4452. can be overridden with following options. Set them to paths
  4453. relative to the source URL, or leave them blank to disable auto
  4454. detection.</p>
  4455. <dl class="docutils">
  4456. <dt>--config convert.svn.branches=branches    (directory name)</dt>
  4457. <dd>specify the directory containing branches</dd>
  4458. <dt>--config convert.svn.tags=tags            (directory name)</dt>
  4459. <dd>specify the directory containing tags</dd>
  4460. <dt>--config convert.svn.trunk=trunk          (directory name)</dt>
  4461. <dd>specify the name of the trunk branch</dd>
  4462. </dl>
  4463. <p>Source history can be retrieved starting at a specific revision,
  4464. instead of being integrally converted. Only single branch
  4465. conversions are supported.</p>
  4466. <dl class="docutils">
  4467. <dt>--config convert.svn.startrev=0           (svn revision number)</dt>
  4468. <dd>specify start Subversion revision.</dd>
  4469. </dl>
  4470. </div>
  4471. <div class="section" id="perforce-source">
  4472. <h5>Perforce Source</h5>
  4473. <p>The Perforce (P4) importer can be given a p4 depot path or a
  4474. client specification as source. It will convert all files in the
  4475. source to a flat Mercurial repository, ignoring labels, branches
  4476. and integrations. Note that when a depot path is given you then
  4477. usually should specify a target directory, because otherwise the
  4478. target may be named ...-hg.</p>
  4479. <p>It is possible to limit the amount of source history to be
  4480. converted by specifying an initial Perforce revision.</p>
  4481. <dl class="docutils">
  4482. <dt>--config convert.p4.startrev=0            (perforce changelist number)</dt>
  4483. <dd>specify initial Perforce revision.</dd>
  4484. </dl>
  4485. </div>
  4486. <div class="section" id="mercurial-destination">
  4487. <h5>Mercurial Destination</h5>
  4488. <dl class="docutils">
  4489. <dt>--config convert.hg.clonebranches=False   (boolean)</dt>
  4490. <dd>dispatch source branches in separate clones.</dd>
  4491. <dt>--config convert.hg.tagsbranch=default    (branch name)</dt>
  4492. <dd>tag revisions branch name</dd>
  4493. <dt>--config convert.hg.usebranchnames=True   (boolean)</dt>
  4494. <dd>preserve branch names</dd>
  4495. </dl>
  4496. <p>options:</p>
  4497. <table class="docutils option-list" frame="void" rules="none">
  4498. <col class="option" />
  4499. <col class="description" />
  4500. <tbody valign="top">
  4501. <tr><td class="option-group">
  4502. <kbd><span class="option">--authors</span></kbd></td>
  4503. <td>username mapping filename (DEPRECATED, use --authormap instead)</td></tr>
  4504. <tr><td class="option-group" colspan="2">
  4505. <kbd><span class="option">-s</span>, <span class="option">--source-type</span></kbd></td>
  4506. </tr>
  4507. <tr><td>&nbsp;</td><td>source repository type</td></tr>
  4508. <tr><td class="option-group" colspan="2">
  4509. <kbd><span class="option">-d</span>, <span class="option">--dest-type</span></kbd></td>
  4510. </tr>
  4511. <tr><td>&nbsp;</td><td>destination repository type</td></tr>
  4512. <tr><td class="option-group">
  4513. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  4514. <td>import up to target revision REV</td></tr>
  4515. <tr><td class="option-group" colspan="2">
  4516. <kbd><span class="option">-A</span>, <span class="option">--authormap</span></kbd></td>
  4517. </tr>
  4518. <tr><td>&nbsp;</td><td>remap usernames using this file</td></tr>
  4519. <tr><td class="option-group">
  4520. <kbd><span class="option">--filemap</span></kbd></td>
  4521. <td>remap file names using contents of file</td></tr>
  4522. <tr><td class="option-group">
  4523. <kbd><span class="option">--splicemap</span></kbd></td>
  4524. <td>splice synthesized history into place</td></tr>
  4525. <tr><td class="option-group">
  4526. <kbd><span class="option">--branchmap</span></kbd></td>
  4527. <td>change branch names while converting</td></tr>
  4528. <tr><td class="option-group">
  4529. <kbd><span class="option">--branchsort</span></kbd></td>
  4530. <td>try to sort changesets by branches</td></tr>
  4531. <tr><td class="option-group">
  4532. <kbd><span class="option">--datesort</span></kbd></td>
  4533. <td>try to sort changesets by date</td></tr>
  4534. <tr><td class="option-group">
  4535. <kbd><span class="option">--sourcesort</span></kbd></td>
  4536. <td>preserve source changesets order</td></tr>
  4537. </tbody>
  4538. </table>
  4539. </div>
  4540. </div>
  4541. </div>
  4542. </div>
  4543. <div class="section" id="eol">
  4544. <h2><a class="toc-backref" href="#id75">eol</a></h2>
  4545. <p>automatically manage newlines in repository files</p>
  4546. <p>This extension allows you to manage the type of line endings (CRLF or
  4547. LF) that are used in the repository and in the local working
  4548. directory. That way you can get CRLF line endings on Windows and LF on
  4549. Unix/Mac, thereby letting everybody use their OS native line endings.</p>
  4550. <p>The extension reads its configuration from a versioned <tt class="docutils literal">.hgeol</tt>
  4551. configuration file every time you run an <tt class="docutils literal">hg</tt> command. The
  4552. <tt class="docutils literal">.hgeol</tt> file use the same syntax as all other Mercurial
  4553. configuration files. It uses two sections, <tt class="docutils literal">[patterns]</tt> and
  4554. <tt class="docutils literal">[repository]</tt>.</p>
  4555. <p>The <tt class="docutils literal">[patterns]</tt> section specifies how line endings should be
  4556. converted between the working copy and the repository. The format is
  4557. specified by a file pattern. The first match is used, so put more
  4558. specific patterns first. The available line endings are <tt class="docutils literal">LF</tt>,
  4559. <tt class="docutils literal">CRLF</tt>, and <tt class="docutils literal">BIN</tt>.</p>
  4560. <p>Files with the declared format of <tt class="docutils literal">CRLF</tt> or <tt class="docutils literal">LF</tt> are always
  4561. checked out and stored in the repository in that format and files
  4562. declared to be binary (<tt class="docutils literal">BIN</tt>) are left unchanged. Additionally,
  4563. <tt class="docutils literal">native</tt> is an alias for checking out in the platform's default line
  4564. ending: <tt class="docutils literal">LF</tt> on Unix (including Mac OS X) and <tt class="docutils literal">CRLF</tt> on
  4565. Windows. Note that <tt class="docutils literal">BIN</tt> (do nothing to line endings) is Mercurial's
  4566. default behaviour; it is only needed if you need to override a later,
  4567. more general pattern.</p>
  4568. <p>The optional <tt class="docutils literal">[repository]</tt> section specifies the line endings to
  4569. use for files stored in the repository. It has a single setting,
  4570. <tt class="docutils literal">native</tt>, which determines the storage line endings for files
  4571. declared as <tt class="docutils literal">native</tt> in the <tt class="docutils literal">[patterns]</tt> section. It can be set to
  4572. <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
  4573. that on Windows, files configured as <tt class="docutils literal">native</tt> (<tt class="docutils literal">CRLF</tt> by default)
  4574. will be converted to <tt class="docutils literal">LF</tt> when stored in the repository. Files
  4575. 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
  4576. are always stored as-is in the repository.</p>
  4577. <p>Example versioned <tt class="docutils literal">.hgeol</tt> file:</p>
  4578. <pre class="literal-block">
  4579. [patterns]
  4580. **.py = native
  4581. **.vcproj = CRLF
  4582. **.txt = native
  4583. Makefile = LF
  4584. **.jpg = BIN
  4585.  
  4586. [repository]
  4587. native = LF
  4588. </pre>
  4589. <div class="note">
  4590. <p class="first admonition-title">Note</p>
  4591. <p class="last">The rules will first apply when files are touched in the working
  4592. copy, e.g. by updating to null and back to tip to touch all files.</p>
  4593. </div>
  4594. <p>The extension uses an optional <tt class="docutils literal">[eol]</tt> section in your hgrc file
  4595. (not the <tt class="docutils literal">.hgeol</tt> file) for settings that control the overall
  4596. behavior. There are two settings:</p>
  4597. <ul class="simple">
  4598. <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
  4599. <tt class="docutils literal">CRLF</tt> to override the default interpretation of <tt class="docutils literal">native</tt> for
  4600. 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
  4601. generate an archive where files have line endings for Windows.</li>
  4602. <li><tt class="docutils literal"><span class="pre">eol.only-consistent</span></tt> (default True) can be set to False to make
  4603. the extension convert files with inconsistent EOLs. Inconsistent
  4604. means that there is both <tt class="docutils literal">CRLF</tt> and <tt class="docutils literal">LF</tt> present in the file.
  4605. Such files are normally not touched under the assumption that they
  4606. have mixed EOLs on purpose.</li>
  4607. </ul>
  4608. <p>The <tt class="docutils literal">win32text.forbid*</tt> hooks provided by the win32text extension
  4609. have been unified into a single hook named <tt class="docutils literal">eol.hook</tt>. The hook will
  4610. lookup the expected line endings from the <tt class="docutils literal">.hgeol</tt> file, which means
  4611. you must migrate to a <tt class="docutils literal">.hgeol</tt> file first before using the hook.</p>
  4612. <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
  4613. used.</p>
  4614. </div>
  4615. <div class="section" id="extdiff">
  4616. <h2><a class="toc-backref" href="#id76">extdiff</a></h2>
  4617. <p>command to allow external programs to compare revisions</p>
  4618. <p>The extdiff Mercurial extension allows you to use external programs
  4619. to compare revisions, or revision with working directory. The external
  4620. diff programs are called with a configurable set of options and two
  4621. non-option arguments: paths to directories containing snapshots of
  4622. files to compare.</p>
  4623. <p>The extdiff extension also allows to configure new diff commands, so
  4624. 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>
  4625. <pre class="literal-block">
  4626. [extdiff]
  4627. # add new command that runs GNU diff(1) in 'context diff' mode
  4628. cdiff = gdiff -Nprc5
  4629. ## or the old way:
  4630. #cmd.cdiff = gdiff
  4631. #opts.cdiff = -Nprc5
  4632.  
  4633. # add new command called vdiff, runs kdiff3
  4634. vdiff = kdiff3
  4635.  
  4636. # add new command called meld, runs meld (no need to name twice)
  4637. meld =
  4638.  
  4639. # add new command called vimdiff, runs gvimdiff with DirDiff plugin
  4640. # (see http://www.vim.org/scripts/script.php?script_id=102) Non
  4641. # English user, be sure to put &quot;let g:DirDiffDynamicDiffText = 1&quot; in
  4642. # your .vimrc
  4643. vimdiff = gvim -f '+next' '+execute &quot;DirDiff&quot; argv(0) argv(1)'
  4644. </pre>
  4645. <p>Tool arguments can include variables that are expanded at runtime:</p>
  4646. <pre class="literal-block">
  4647. $parent1, $plabel1 - filename, descriptive label of first parent
  4648. $child,   $clabel  - filename, descriptive label of child revision
  4649. $parent2, $plabel2 - filename, descriptive label of second parent
  4650. $parent is an alias for $parent1.
  4651. </pre>
  4652. <p>The extdiff extension will look in your [diff-tools] and [merge-tools]
  4653. sections for diff tool arguments, when none are specified in [extdiff].</p>
  4654. <pre class="literal-block">
  4655. [extdiff]
  4656. kdiff3 =
  4657.  
  4658. [diff-tools]
  4659. kdiff3.diffargs=--L1 '$plabel1' --L2 '$clabel' $parent $child
  4660. </pre>
  4661. <p>You can use -I/-X and list of file or directory names like normal
  4662. <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
  4663. needed files, so running the external diff program will actually be
  4664. pretty fast (at least faster than having to compare the entire tree).</p>
  4665. <div class="section" id="id13">
  4666. <h3>Commands</h3>
  4667. <div class="section" id="id14">
  4668. <h4>extdiff</h4>
  4669. <pre class="literal-block">
  4670. hg extdiff [OPT]... [FILE]...
  4671. </pre>
  4672. <p>Show differences between revisions for the specified files, using
  4673. an external program. The default program used is diff, with
  4674. default options &quot;-Npru&quot;.</p>
  4675. <p>To select a different program, use the -p/--program option. The
  4676. program will be passed the names of two directories to compare. To
  4677. pass additional options to the program, use -o/--option. These
  4678. will be passed before the names of the directories to compare.</p>
  4679. <p>When two revision arguments are given, then changes are shown
  4680. between those revisions. If only one revision is specified then
  4681. that revision is compared to the working directory, and, when no
  4682. revisions are specified, the working directory files are compared
  4683. to its parent.</p>
  4684. <p>options:</p>
  4685. <table class="docutils option-list" frame="void" rules="none">
  4686. <col class="option" />
  4687. <col class="description" />
  4688. <tbody valign="top">
  4689. <tr><td class="option-group">
  4690. <kbd><span class="option">-p</span>, <span class="option">--program</span></kbd></td>
  4691. <td>comparison program to run</td></tr>
  4692. <tr><td class="option-group">
  4693. <kbd><span class="option">-o</span>, <span class="option">--option</span></kbd></td>
  4694. <td>pass option to comparison program</td></tr>
  4695. <tr><td class="option-group">
  4696. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  4697. <td>revision</td></tr>
  4698. <tr><td class="option-group">
  4699. <kbd><span class="option">-c</span>, <span class="option">--change</span></kbd></td>
  4700. <td>change made by revision</td></tr>
  4701. <tr><td class="option-group">
  4702. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  4703. <td>include names matching the given patterns</td></tr>
  4704. <tr><td class="option-group">
  4705. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  4706. <td>exclude names matching the given patterns</td></tr>
  4707. </tbody>
  4708. </table>
  4709. </div>
  4710. </div>
  4711. </div>
  4712. <div class="section" id="fetch">
  4713. <h2><a class="toc-backref" href="#id77">fetch</a></h2>
  4714. <p>pull, update and merge in one command</p>
  4715. <div class="section" id="id15">
  4716. <h3>Commands</h3>
  4717. <div class="section" id="id16">
  4718. <h4>fetch</h4>
  4719. <pre class="literal-block">
  4720. hg fetch [SOURCE]
  4721. </pre>
  4722. <p>This finds all changes from the repository at the specified path
  4723. or URL and adds them to the local repository.</p>
  4724. <p>If the pulled changes add a new branch head, the head is
  4725. automatically merged, and the result of the merge is committed.
  4726. Otherwise, the working directory is updated to include the new
  4727. changes.</p>
  4728. <p>When a merge occurs, the newly pulled changes are assumed to be
  4729. &quot;authoritative&quot;. The head of the new changes is used as the first
  4730. parent, with local changes as the second. To switch the merge
  4731. order, use --switch-parent.</p>
  4732. <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>
  4733. <p>Returns 0 on success.</p>
  4734. <p>options:</p>
  4735. <table class="docutils option-list" frame="void" rules="none">
  4736. <col class="option" />
  4737. <col class="description" />
  4738. <tbody valign="top">
  4739. <tr><td class="option-group">
  4740. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  4741. <td>a specific revision you would like to pull</td></tr>
  4742. <tr><td class="option-group">
  4743. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  4744. <td>edit commit message</td></tr>
  4745. <tr><td class="option-group">
  4746. <kbd><span class="option">--force-editor</span></kbd></td>
  4747. <td>edit commit message (DEPRECATED)</td></tr>
  4748. <tr><td class="option-group" colspan="2">
  4749. <kbd><span class="option">--switch-parent</span></kbd></td>
  4750. </tr>
  4751. <tr><td>&nbsp;</td><td>switch parents when merging</td></tr>
  4752. <tr><td class="option-group">
  4753. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  4754. <td>use text as commit message</td></tr>
  4755. <tr><td class="option-group">
  4756. <kbd><span class="option">-l</span>, <span class="option">--logfile</span></kbd></td>
  4757. <td>read commit message from file</td></tr>
  4758. <tr><td class="option-group">
  4759. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  4760. <td>record datecode as commit date</td></tr>
  4761. <tr><td class="option-group">
  4762. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  4763. <td>record the specified user as committer</td></tr>
  4764. <tr><td class="option-group">
  4765. <kbd><span class="option">-e</span>, <span class="option">--ssh</span></kbd></td>
  4766. <td>specify ssh command to use</td></tr>
  4767. <tr><td class="option-group">
  4768. <kbd><span class="option">--remotecmd</span></kbd></td>
  4769. <td>specify hg command to run on the remote side</td></tr>
  4770. </tbody>
  4771. </table>
  4772. </div>
  4773. </div>
  4774. </div>
  4775. <div class="section" id="gpg">
  4776. <h2><a class="toc-backref" href="#id78">gpg</a></h2>
  4777. <p>commands to sign and verify changesets</p>
  4778. <div class="section" id="id17">
  4779. <h3>Commands</h3>
  4780. <div class="section" id="sigcheck">
  4781. <h4>sigcheck</h4>
  4782. <pre class="literal-block">
  4783. hg sigcheck REVISION
  4784. </pre>
  4785. <p>verify all the signatures there may be for a particular revision</p>
  4786. </div>
  4787. <div class="section" id="sign">
  4788. <h4>sign</h4>
  4789. <pre class="literal-block">
  4790. hg sign [OPTION]... [REVISION]...
  4791. </pre>
  4792. <p>If no revision is given, the parent of the working directory is used,
  4793. or tip if no revision is checked out.</p>
  4794. <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>
  4795. <p>options:</p>
  4796. <table class="docutils option-list" frame="void" rules="none">
  4797. <col class="option" />
  4798. <col class="description" />
  4799. <tbody valign="top">
  4800. <tr><td class="option-group">
  4801. <kbd><span class="option">-l</span>, <span class="option">--local</span></kbd></td>
  4802. <td>make the signature local</td></tr>
  4803. <tr><td class="option-group">
  4804. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  4805. <td>sign even if the sigfile is modified</td></tr>
  4806. <tr><td class="option-group">
  4807. <kbd><span class="option">--no-commit</span></kbd></td>
  4808. <td>do not commit the sigfile after signing</td></tr>
  4809. <tr><td class="option-group">
  4810. <kbd><span class="option">-k</span>, <span class="option">--key</span></kbd></td>
  4811. <td>the key id to sign with</td></tr>
  4812. <tr><td class="option-group">
  4813. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  4814. <td>commit message</td></tr>
  4815. <tr><td class="option-group">
  4816. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  4817. <td>record datecode as commit date</td></tr>
  4818. <tr><td class="option-group">
  4819. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  4820. <td>record the specified user as committer</td></tr>
  4821. </tbody>
  4822. </table>
  4823. </div>
  4824. <div class="section" id="sigs">
  4825. <h4>sigs</h4>
  4826. <pre class="literal-block">
  4827. hg sigs
  4828. </pre>
  4829. <p>list signed changesets</p>
  4830. </div>
  4831. </div>
  4832. </div>
  4833. <div class="section" id="graphlog">
  4834. <h2><a class="toc-backref" href="#id79">graphlog</a></h2>
  4835. <p>command to view revision graphs from a shell</p>
  4836. <p>This extension adds a --graph option to the incoming, outgoing and log
  4837. commands. When this options is given, an ASCII representation of the
  4838. revision graph is also shown.</p>
  4839. <div class="section" id="id18">
  4840. <h3>Commands</h3>
  4841. <div class="section" id="glog">
  4842. <h4>glog</h4>
  4843. <pre class="literal-block">
  4844. hg glog [OPTION]... [FILE]
  4845. </pre>
  4846. <p>Print a revision history alongside a revision graph drawn with
  4847. ASCII characters.</p>
  4848. <p>Nodes printed as an &#64; character are parents of the working
  4849. directory.</p>
  4850. <p>options:</p>
  4851. <table class="docutils option-list" frame="void" rules="none">
  4852. <col class="option" />
  4853. <col class="description" />
  4854. <tbody valign="top">
  4855. <tr><td class="option-group">
  4856. <kbd><span class="option">-l</span>, <span class="option">--limit</span></kbd></td>
  4857. <td>limit number of changes displayed</td></tr>
  4858. <tr><td class="option-group">
  4859. <kbd><span class="option">-p</span>, <span class="option">--patch</span></kbd></td>
  4860. <td>show patch</td></tr>
  4861. <tr><td class="option-group">
  4862. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  4863. <td>show the specified revision or range</td></tr>
  4864. <tr><td class="option-group">
  4865. <kbd><span class="option">--style</span></kbd></td>
  4866. <td>display using template map file</td></tr>
  4867. <tr><td class="option-group">
  4868. <kbd><span class="option">--template</span></kbd></td>
  4869. <td>display with template</td></tr>
  4870. </tbody>
  4871. </table>
  4872. </div>
  4873. </div>
  4874. </div>
  4875. <div class="section" id="hgcia">
  4876. <h2><a class="toc-backref" href="#id80">hgcia</a></h2>
  4877. <p>hooks for integrating with the CIA.vc notification service</p>
  4878. <p>This is meant to be run as a changegroup or incoming hook. To
  4879. configure it, set the following options in your hgrc:</p>
  4880. <pre class="literal-block">
  4881. [cia]
  4882. # your registered CIA user name
  4883. user = foo
  4884. # the name of the project in CIA
  4885. project = foo
  4886. # the module (subproject) (optional)
  4887. #module = foo
  4888. # Append a diffstat to the log message (optional)
  4889. #diffstat = False
  4890. # Template to use for log messages (optional)
  4891. #template = {desc}\n{baseurl}/rev/{node}-- {diffstat}
  4892. # Style to use (optional)
  4893. #style = foo
  4894. # The URL of the CIA notification service (optional)
  4895. # You can use mailto: URLs to send by email, eg
  4896. # mailto:cia&#64;cia.vc
  4897. # Make sure to set email.from if you do this.
  4898. #url = http://cia.vc/
  4899. # print message instead of sending it (optional)
  4900. #test = False
  4901.  
  4902. [hooks]
  4903. # one of these:
  4904. changegroup.cia = python:hgcia.hook
  4905. #incoming.cia = python:hgcia.hook
  4906.  
  4907. [web]
  4908. # If you want hyperlinks (optional)
  4909. baseurl = http://server/path/to/repo
  4910. </pre>
  4911. </div>
  4912. <div class="section" id="hgk">
  4913. <h2><a class="toc-backref" href="#id81">hgk</a></h2>
  4914. <p>browse the repository in a graphical way</p>
  4915. <p>The hgk extension allows browsing the history of a repository in a
  4916. graphical way. It requires Tcl/Tk version 8.4 or later. (Tcl/Tk is not
  4917. distributed with Mercurial.)</p>
  4918. <p>hgk consists of two parts: a Tcl script that does the displaying and
  4919. querying of information, and an extension to Mercurial named hgk.py,
  4920. which provides hooks for hgk to get information. hgk can be found in
  4921. the contrib directory, and the extension is shipped in the hgext
  4922. repository, and needs to be enabled.</p>
  4923. <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
  4924. to work, hgk must be in your search path. Alternately, you can specify
  4925. the path to hgk in your configuration file:</p>
  4926. <pre class="literal-block">
  4927. [hgk]
  4928. path=/location/of/hgk
  4929. </pre>
  4930. <p>hgk can make use of the extdiff extension to visualize revisions.
  4931. Assuming you had already configured extdiff vdiff command, just add:</p>
  4932. <pre class="literal-block">
  4933. [hgk]
  4934. vdiff=vdiff
  4935. </pre>
  4936. <p>Revisions context menu will now display additional entries to fire
  4937. vdiff on hovered and selected revisions.</p>
  4938. <div class="section" id="id19">
  4939. <h3>Commands</h3>
  4940. <div class="section" id="view">
  4941. <h4>view</h4>
  4942. <pre class="literal-block">
  4943. hg view [-l LIMIT] [REVRANGE]
  4944. </pre>
  4945. <p>start interactive history viewer</p>
  4946. <p>options:</p>
  4947. <table class="docutils option-list" frame="void" rules="none">
  4948. <col class="option" />
  4949. <col class="description" />
  4950. <tbody valign="top">
  4951. <tr><td class="option-group">
  4952. <kbd><span class="option">-l</span>, <span class="option">--limit</span></kbd></td>
  4953. <td>limit number of changes displayed</td></tr>
  4954. </tbody>
  4955. </table>
  4956. </div>
  4957. </div>
  4958. </div>
  4959. <div class="section" id="highlight">
  4960. <h2><a class="toc-backref" href="#id82">highlight</a></h2>
  4961. <p>syntax highlighting for hgweb (requires Pygments)</p>
  4962. <p>It depends on the Pygments syntax highlighting library:
  4963. <a class="reference external" href="http://pygments.org/">http://pygments.org/</a></p>
  4964. <p>There is a single configuration option:</p>
  4965. <pre class="literal-block">
  4966. [web]
  4967. pygments_style = &lt;style&gt;
  4968. </pre>
  4969. <p>The default is 'colorful'.</p>
  4970. </div>
  4971. <div class="section" id="inotify">
  4972. <h2><a class="toc-backref" href="#id83">inotify</a></h2>
  4973. <p>accelerate status report using Linux's inotify service</p>
  4974. <div class="section" id="id20">
  4975. <h3>Commands</h3>
  4976. <div class="section" id="inserve">
  4977. <h4>inserve</h4>
  4978. <pre class="literal-block">
  4979. hg inserve [OPTION]...
  4980. </pre>
  4981. <p>start an inotify server for this repository</p>
  4982. <p>options:</p>
  4983. <table class="docutils option-list" frame="void" rules="none">
  4984. <col class="option" />
  4985. <col class="description" />
  4986. <tbody valign="top">
  4987. <tr><td class="option-group">
  4988. <kbd><span class="option">-d</span>, <span class="option">--daemon</span></kbd></td>
  4989. <td>run server in background</td></tr>
  4990. <tr><td class="option-group" colspan="2">
  4991. <kbd><span class="option">--daemon-pipefds</span></kbd></td>
  4992. </tr>
  4993. <tr><td>&nbsp;</td><td>used internally by daemon mode</td></tr>
  4994. <tr><td class="option-group" colspan="2">
  4995. <kbd><span class="option">-t</span>, <span class="option">--idle-timeout</span></kbd></td>
  4996. </tr>
  4997. <tr><td>&nbsp;</td><td>minutes to sit idle before exiting</td></tr>
  4998. <tr><td class="option-group">
  4999. <kbd><span class="option">--pid-file</span></kbd></td>
  5000. <td>name of file to write process ID to</td></tr>
  5001. </tbody>
  5002. </table>
  5003. </div>
  5004. </div>
  5005. </div>
  5006. <div class="section" id="interhg">
  5007. <h2><a class="toc-backref" href="#id84">interhg</a></h2>
  5008. <p>expand expressions into changelog and summaries</p>
  5009. <p>This extension allows the use of a special syntax in summaries, which
  5010. will be automatically expanded into links or any other arbitrary
  5011. expression, much like InterWiki does.</p>
  5012. <p>A few example patterns (link to bug tracking, etc.) that may be used
  5013. in your hgrc:</p>
  5014. <pre class="literal-block">
  5015. [interhg]
  5016. issues = s!issue(\d+)!&lt;a href=&quot;http://bts/issue\1&quot;&gt;issue\1&lt;/a&gt;!
  5017. bugzilla = s!((?:bug|b=|(?=#?\d{4,}))(?:\s*#?)(\d+))!&lt;a..=\2&quot;&gt;\1&lt;/a&gt;!i
  5018. boldify = s!(^|\s)#(\d+)\b! &lt;b&gt;#\2&lt;/b&gt;!
  5019. </pre>
  5020. </div>
  5021. <div class="section" id="keyword">
  5022. <h2><a class="toc-backref" href="#id85">keyword</a></h2>
  5023. <p>expand keywords in tracked files</p>
  5024. <p>This extension expands RCS/CVS-like or self-customized $Keywords$ in
  5025. tracked text files selected by your configuration.</p>
  5026. <p>Keywords are only expanded in local repositories and not stored in the
  5027. change history. The mechanism can be regarded as a convenience for the
  5028. current user or for archive distribution.</p>
  5029. <p>Keywords expand to the changeset data pertaining to the latest change
  5030. relative to the working directory parent of each file.</p>
  5031. <p>Configuration is done in the [keyword], [keywordset] and [keywordmaps]
  5032. sections of hgrc files.</p>
  5033. <p>Example:</p>
  5034. <pre class="literal-block">
  5035. [keyword]
  5036. # expand keywords in every python file except those matching &quot;x*&quot;
  5037. **.py =
  5038. x*    = ignore
  5039.  
  5040. [keywordset]
  5041. # prefer svn- over cvs-like default keywordmaps
  5042. svn = True
  5043. </pre>
  5044. <div class="note">
  5045. <p class="first admonition-title">Note</p>
  5046. <p class="last">The more specific you are in your filename patterns the less you
  5047. lose speed in huge repositories.</p>
  5048. </div>
  5049. <p>For [keywordmaps] template mapping and expansion demonstration and
  5050. 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
  5051. available templates and filters.</p>
  5052. <p>Three additional date template filters are provided:</p>
  5053. <pre class="literal-block">
  5054. utcdate      &quot;2006/09/18 15:13:13&quot;
  5055. svnutcdate   &quot;2006-09-18 15:13:13Z&quot;
  5056. svnisodate   &quot;2006-09-18 08:13:13 -700 (Mon, 18 Sep 2006)&quot;
  5057. </pre>
  5058. <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
  5059. replaced with customized keywords and templates. Again, run
  5060. <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>
  5061. <p>Before changing/disabling active keywords, run <a class="reference external" href="hg.1.html#kwshrink"><tt class="docutils literal">hg kwshrink</tt></a> to avoid
  5062. the risk of inadvertently storing expanded keywords in the change
  5063. history.</p>
  5064. <p>To force expansion after enabling it, or a configuration change, run
  5065. <a class="reference external" href="hg.1.html#kwexpand"><tt class="docutils literal">hg kwexpand</tt></a>.</p>
  5066. <p>Expansions spanning more than one line and incremental expansions,
  5067. like CVS' $Log$, are not supported. A keyword template map &quot;Log =
  5068. {desc}&quot; expands to the first line of the changeset description.</p>
  5069. <div class="section" id="id21">
  5070. <h3>Commands</h3>
  5071. <div class="section" id="kwdemo">
  5072. <h4>kwdemo</h4>
  5073. <pre class="literal-block">
  5074. hg kwdemo [-d] [-f RCFILE] [TEMPLATEMAP]...
  5075. </pre>
  5076. <p>Show current, custom, or default keyword template maps and their
  5077. expansions.</p>
  5078. <p>Extend the current configuration by specifying maps as arguments
  5079. and using -f/--rcfile to source an external hgrc file.</p>
  5080. <p>Use -d/--default to disable current configuration.</p>
  5081. <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>
  5082. <p>options:</p>
  5083. <table class="docutils option-list" frame="void" rules="none">
  5084. <col class="option" />
  5085. <col class="description" />
  5086. <tbody valign="top">
  5087. <tr><td class="option-group">
  5088. <kbd><span class="option">-d</span>, <span class="option">--default</span></kbd></td>
  5089. <td>show default keyword template maps</td></tr>
  5090. <tr><td class="option-group">
  5091. <kbd><span class="option">-f</span>, <span class="option">--rcfile</span></kbd></td>
  5092. <td>read maps from rcfile</td></tr>
  5093. </tbody>
  5094. </table>
  5095. </div>
  5096. <div class="section" id="kwexpand">
  5097. <h4>kwexpand</h4>
  5098. <pre class="literal-block">
  5099. hg kwexpand [OPTION]... [FILE]...
  5100. </pre>
  5101. <p>Run after (re)enabling keyword expansion.</p>
  5102. <p>kwexpand refuses to run if given files contain local changes.</p>
  5103. <p>options:</p>
  5104. <table class="docutils option-list" frame="void" rules="none">
  5105. <col class="option" />
  5106. <col class="description" />
  5107. <tbody valign="top">
  5108. <tr><td class="option-group">
  5109. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  5110. <td>include names matching the given patterns</td></tr>
  5111. <tr><td class="option-group">
  5112. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  5113. <td>exclude names matching the given patterns</td></tr>
  5114. </tbody>
  5115. </table>
  5116. </div>
  5117. <div class="section" id="kwfiles">
  5118. <h4>kwfiles</h4>
  5119. <pre class="literal-block">
  5120. hg kwfiles [OPTION]... [FILE]...
  5121. </pre>
  5122. <p>List which files in the working directory are matched by the
  5123. [keyword] configuration patterns.</p>
  5124. <p>Useful to prevent inadvertent keyword expansion and to speed up
  5125. execution by including only files that are actual candidates for
  5126. expansion.</p>
  5127. <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
  5128. inclusion and exclusion of files.</p>
  5129. <p>With -A/--all and -v/--verbose the codes used to show the status
  5130. of files are:</p>
  5131. <pre class="literal-block">
  5132. K = keyword expansion candidate
  5133. k = keyword expansion candidate (not tracked)
  5134. I = ignored
  5135. i = ignored (not tracked)
  5136. </pre>
  5137. <p>options:</p>
  5138. <table class="docutils option-list" frame="void" rules="none">
  5139. <col class="option" />
  5140. <col class="description" />
  5141. <tbody valign="top">
  5142. <tr><td class="option-group">
  5143. <kbd><span class="option">-A</span>, <span class="option">--all</span></kbd></td>
  5144. <td>show keyword status flags of all files</td></tr>
  5145. <tr><td class="option-group">
  5146. <kbd><span class="option">-i</span>, <span class="option">--ignore</span></kbd></td>
  5147. <td>show files excluded from expansion</td></tr>
  5148. <tr><td class="option-group">
  5149. <kbd><span class="option">-u</span>, <span class="option">--unknown</span></kbd></td>
  5150. <td>only show unknown (not tracked) files</td></tr>
  5151. <tr><td class="option-group">
  5152. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  5153. <td>include names matching the given patterns</td></tr>
  5154. <tr><td class="option-group">
  5155. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  5156. <td>exclude names matching the given patterns</td></tr>
  5157. </tbody>
  5158. </table>
  5159. </div>
  5160. <div class="section" id="kwshrink">
  5161. <h4>kwshrink</h4>
  5162. <pre class="literal-block">
  5163. hg kwshrink [OPTION]... [FILE]...
  5164. </pre>
  5165. <p>Run before changing/disabling active keywords or if you experience
  5166. problems with <a class="reference external" href="hg.1.html#import"><tt class="docutils literal">hg import</tt></a> or <a class="reference external" href="hg.1.html#merge"><tt class="docutils literal">hg merge</tt></a>.</p>
  5167. <p>kwshrink refuses to run if given files contain local changes.</p>
  5168. <p>options:</p>
  5169. <table class="docutils option-list" frame="void" rules="none">
  5170. <col class="option" />
  5171. <col class="description" />
  5172. <tbody valign="top">
  5173. <tr><td class="option-group">
  5174. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  5175. <td>include names matching the given patterns</td></tr>
  5176. <tr><td class="option-group">
  5177. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  5178. <td>exclude names matching the given patterns</td></tr>
  5179. </tbody>
  5180. </table>
  5181. </div>
  5182. </div>
  5183. </div>
  5184. <div class="section" id="mq">
  5185. <h2><a class="toc-backref" href="#id86">mq</a></h2>
  5186. <p>manage a stack of patches</p>
  5187. <p>This extension lets you work with a stack of patches in a Mercurial
  5188. repository. It manages two stacks of patches - all known patches, and
  5189. applied patches (subset of known patches).</p>
  5190. <p>Known patches are represented as patch files in the .hg/patches
  5191. directory. Applied patches are both patch files and changesets.</p>
  5192. <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>
  5193. <pre class="literal-block">
  5194. create new patch                          qnew
  5195. import existing patch                     qimport
  5196.  
  5197. print patch series                        qseries
  5198. print applied patches                     qapplied
  5199.  
  5200. add known patch to applied stack          qpush
  5201. remove patch from applied stack           qpop
  5202. refresh contents of top applied patch     qrefresh
  5203. </pre>
  5204. <p>By default, mq will automatically use git patches when required to
  5205. avoid losing file mode changes, copy records, binary files or empty
  5206. files creations or deletions. This behaviour can be configured with:</p>
  5207. <pre class="literal-block">
  5208. [mq]
  5209. git = auto/keep/yes/no
  5210. </pre>
  5211. <p>If set to 'keep', mq will obey the [diff] section configuration while
  5212. preserving existing git patches upon qrefresh. If set to 'yes' or
  5213. 'no', mq will override the [diff] section and always generate git or
  5214. regular patches, possibly losing data in the second case.</p>
  5215. <p>You will by default be managing a patch queue named &quot;patches&quot;. You can
  5216. 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>
  5217. <div class="section" id="id22">
  5218. <h3>Commands</h3>
  5219. <div class="section" id="qapplied">
  5220. <h4>qapplied</h4>
  5221. <pre class="literal-block">
  5222. hg qapplied [-1] [-s] [PATCH]
  5223. </pre>
  5224. <p>Returns 0 on success.</p>
  5225. <p>options:</p>
  5226. <table class="docutils option-list" frame="void" rules="none">
  5227. <col class="option" />
  5228. <col class="description" />
  5229. <tbody valign="top">
  5230. <tr><td class="option-group">
  5231. <kbd><span class="option">-1</span>, <span class="option">--last</span></kbd></td>
  5232. <td>show only the last patch</td></tr>
  5233. <tr><td class="option-group">
  5234. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  5235. <td>print first line of patch header</td></tr>
  5236. </tbody>
  5237. </table>
  5238. </div>
  5239. <div class="section" id="qclone">
  5240. <h4>qclone</h4>
  5241. <pre class="literal-block">
  5242. hg qclone [OPTION]... SOURCE [DEST]
  5243. </pre>
  5244. <p>If source is local, destination will have no patches applied. If
  5245. source is remote, this command can not check if patches are
  5246. applied in source, so cannot guarantee that patches are not
  5247. applied in destination. If you clone remote repository, be sure
  5248. before that it has no patches applied.</p>
  5249. <p>Source patch repository is looked for in &lt;src&gt;/.hg/patches by
  5250. default. Use -p &lt;url&gt; to change.</p>
  5251. <p>The patch directory must be a nested Mercurial repository, as
  5252. 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>
  5253. <p>Return 0 on success.</p>
  5254. <p>options:</p>
  5255. <table class="docutils option-list" frame="void" rules="none">
  5256. <col class="option" />
  5257. <col class="description" />
  5258. <tbody valign="top">
  5259. <tr><td class="option-group">
  5260. <kbd><span class="option">--pull</span></kbd></td>
  5261. <td>use pull protocol to copy metadata</td></tr>
  5262. <tr><td class="option-group">
  5263. <kbd><span class="option">-U</span>, <span class="option">--noupdate</span></kbd></td>
  5264. <td>do not update the new working directories</td></tr>
  5265. <tr><td class="option-group">
  5266. <kbd><span class="option">--uncompressed</span></kbd></td>
  5267. <td>use uncompressed transfer (fast over LAN)</td></tr>
  5268. <tr><td class="option-group">
  5269. <kbd><span class="option">-p</span>, <span class="option">--patches</span></kbd></td>
  5270. <td>location of source patch repository</td></tr>
  5271. <tr><td class="option-group">
  5272. <kbd><span class="option">-e</span>, <span class="option">--ssh</span></kbd></td>
  5273. <td>specify ssh command to use</td></tr>
  5274. <tr><td class="option-group">
  5275. <kbd><span class="option">--remotecmd</span></kbd></td>
  5276. <td>specify hg command to run on the remote side</td></tr>
  5277. </tbody>
  5278. </table>
  5279. </div>
  5280. <div class="section" id="qcommit">
  5281. <h4>qcommit</h4>
  5282. <pre class="literal-block">
  5283. hg qcommit [OPTION]... [FILE]...
  5284. </pre>
  5285. <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>
  5286. <p>options:</p>
  5287. <table class="docutils option-list" frame="void" rules="none">
  5288. <col class="option" />
  5289. <col class="description" />
  5290. <tbody valign="top">
  5291. <tr><td class="option-group" colspan="2">
  5292. <kbd><span class="option">-A</span>, <span class="option">--addremove</span></kbd></td>
  5293. </tr>
  5294. <tr><td>&nbsp;</td><td>mark new/missing files as added/removed before committing</td></tr>
  5295. <tr><td class="option-group">
  5296. <kbd><span class="option">--close-branch</span></kbd></td>
  5297. <td>mark a branch as closed, hiding it from the branch list</td></tr>
  5298. <tr><td class="option-group">
  5299. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  5300. <td>include names matching the given patterns</td></tr>
  5301. <tr><td class="option-group">
  5302. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  5303. <td>exclude names matching the given patterns</td></tr>
  5304. <tr><td class="option-group">
  5305. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  5306. <td>use text as commit message</td></tr>
  5307. <tr><td class="option-group">
  5308. <kbd><span class="option">-l</span>, <span class="option">--logfile</span></kbd></td>
  5309. <td>read commit message from file</td></tr>
  5310. <tr><td class="option-group">
  5311. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  5312. <td>record datecode as commit date</td></tr>
  5313. <tr><td class="option-group">
  5314. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  5315. <td><p class="first">record the specified user as committer</p>
  5316. <p class="last">aliases: qci</p>
  5317. </td></tr>
  5318. </tbody>
  5319. </table>
  5320. </div>
  5321. <div class="section" id="qdelete">
  5322. <h4>qdelete</h4>
  5323. <pre class="literal-block">
  5324. hg qdelete [-k] [PATCH]...
  5325. </pre>
  5326. <p>The patches must not be applied, and at least one patch is required. With
  5327. -k/--keep, the patch files are preserved in the patch directory.</p>
  5328. <p>To stop managing a patch and move it into permanent history,
  5329. use the <a class="reference external" href="hg.1.html#qfinish"><tt class="docutils literal">hg qfinish</tt></a> command.</p>
  5330. <p>options:</p>
  5331. <table class="docutils option-list" frame="void" rules="none">
  5332. <col class="option" />
  5333. <col class="description" />
  5334. <tbody valign="top">
  5335. <tr><td class="option-group">
  5336. <kbd><span class="option">-k</span>, <span class="option">--keep</span></kbd></td>
  5337. <td>keep patch file</td></tr>
  5338. <tr><td class="option-group">
  5339. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  5340. <td><p class="first">stop managing a revision (DEPRECATED)</p>
  5341. <p class="last">aliases: qremove qrm</p>
  5342. </td></tr>
  5343. </tbody>
  5344. </table>
  5345. </div>
  5346. <div class="section" id="qdiff">
  5347. <h4>qdiff</h4>
  5348. <pre class="literal-block">
  5349. hg qdiff [OPTION]... [FILE]...
  5350. </pre>
  5351. <p>Shows a diff which includes the current patch as well as any
  5352. changes which have been made in the working directory since the
  5353. last refresh (thus showing what the current patch would become
  5354. after a qrefresh).</p>
  5355. <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
  5356. 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
  5357. made by the current patch without including changes made since the
  5358. qrefresh.</p>
  5359. <p>Returns 0 on success.</p>
  5360. <p>options:</p>
  5361. <table class="docutils option-list" frame="void" rules="none">
  5362. <col class="option" />
  5363. <col class="description" />
  5364. <tbody valign="top">
  5365. <tr><td class="option-group">
  5366. <kbd><span class="option">-a</span>, <span class="option">--text</span></kbd></td>
  5367. <td>treat all files as text</td></tr>
  5368. <tr><td class="option-group">
  5369. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  5370. <td>use git extended diff format</td></tr>
  5371. <tr><td class="option-group">
  5372. <kbd><span class="option">--nodates</span></kbd></td>
  5373. <td>omit dates from diff headers</td></tr>
  5374. <tr><td class="option-group" colspan="2">
  5375. <kbd><span class="option">-p</span>, <span class="option">--show-function</span></kbd></td>
  5376. </tr>
  5377. <tr><td>&nbsp;</td><td>show which function each change is in</td></tr>
  5378. <tr><td class="option-group">
  5379. <kbd><span class="option">--reverse</span></kbd></td>
  5380. <td>produce a diff that undoes the changes</td></tr>
  5381. <tr><td class="option-group" colspan="2">
  5382. <kbd><span class="option">-w</span>, <span class="option">--ignore-all-space</span></kbd></td>
  5383. </tr>
  5384. <tr><td>&nbsp;</td><td>ignore white space when comparing lines</td></tr>
  5385. <tr><td class="option-group" colspan="2">
  5386. <kbd><span class="option">-b</span>, <span class="option">--ignore-space-change</span></kbd></td>
  5387. </tr>
  5388. <tr><td>&nbsp;</td><td>ignore changes in the amount of white space</td></tr>
  5389. <tr><td class="option-group" colspan="2">
  5390. <kbd><span class="option">-B</span>, <span class="option">--ignore-blank-lines</span></kbd></td>
  5391. </tr>
  5392. <tr><td>&nbsp;</td><td>ignore changes whose lines are all blank</td></tr>
  5393. <tr><td class="option-group">
  5394. <kbd><span class="option">-U</span>, <span class="option">--unified</span></kbd></td>
  5395. <td>number of lines of context to show</td></tr>
  5396. <tr><td class="option-group">
  5397. <kbd><span class="option">--stat</span></kbd></td>
  5398. <td>output diffstat-style summary of changes</td></tr>
  5399. <tr><td class="option-group">
  5400. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  5401. <td>include names matching the given patterns</td></tr>
  5402. <tr><td class="option-group">
  5403. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  5404. <td>exclude names matching the given patterns</td></tr>
  5405. </tbody>
  5406. </table>
  5407. </div>
  5408. <div class="section" id="qfinish">
  5409. <h4>qfinish</h4>
  5410. <pre class="literal-block">
  5411. hg qfinish [-a] [REV]...
  5412. </pre>
  5413. <p>Finishes the specified revisions (corresponding to applied
  5414. patches) by moving them out of mq control into regular repository
  5415. history.</p>
  5416. <p>Accepts a revision range or the -a/--applied option. If --applied
  5417. is specified, all applied mq revisions are removed from mq
  5418. control. Otherwise, the given revisions must be at the base of the
  5419. stack of applied patches.</p>
  5420. <p>This can be especially useful if your changes have been applied to
  5421. an upstream repository, or if you are about to push your changes
  5422. to upstream.</p>
  5423. <p>Returns 0 on success.</p>
  5424. <p>options:</p>
  5425. <table class="docutils option-list" frame="void" rules="none">
  5426. <col class="option" />
  5427. <col class="description" />
  5428. <tbody valign="top">
  5429. <tr><td class="option-group">
  5430. <kbd><span class="option">-a</span>, <span class="option">--applied</span></kbd></td>
  5431. <td>finish all applied changesets</td></tr>
  5432. </tbody>
  5433. </table>
  5434. </div>
  5435. <div class="section" id="qfold">
  5436. <h4>qfold</h4>
  5437. <pre class="literal-block">
  5438. hg qfold [-e] [-k] [-m TEXT] [-l FILE] PATCH...
  5439. </pre>
  5440. <p>Patches must not yet be applied. Each patch will be successively
  5441. applied to the current patch in the order given. If all the
  5442. patches apply successfully, the current patch will be refreshed
  5443. with the new cumulative patch, and the folded patches will be
  5444. deleted. With -k/--keep, the folded patch files will not be
  5445. removed afterwards.</p>
  5446. <p>The header for each folded patch will be concatenated with the
  5447. current patch header, separated by a line of <tt class="docutils literal">* * *</tt>.</p>
  5448. <p>Returns 0 on success.</p>
  5449. <p>options:</p>
  5450. <table class="docutils option-list" frame="void" rules="none">
  5451. <col class="option" />
  5452. <col class="description" />
  5453. <tbody valign="top">
  5454. <tr><td class="option-group">
  5455. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  5456. <td>edit patch header</td></tr>
  5457. <tr><td class="option-group">
  5458. <kbd><span class="option">-k</span>, <span class="option">--keep</span></kbd></td>
  5459. <td>keep folded patch files</td></tr>
  5460. <tr><td class="option-group">
  5461. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  5462. <td>use text as commit message</td></tr>
  5463. <tr><td class="option-group">
  5464. <kbd><span class="option">-l</span>, <span class="option">--logfile</span></kbd></td>
  5465. <td>read commit message from file</td></tr>
  5466. </tbody>
  5467. </table>
  5468. </div>
  5469. <div class="section" id="qgoto">
  5470. <h4>qgoto</h4>
  5471. <pre class="literal-block">
  5472. hg qgoto [OPTION]... PATCH
  5473. </pre>
  5474. <p>Returns 0 on success.</p>
  5475. <p>options:</p>
  5476. <table class="docutils option-list" frame="void" rules="none">
  5477. <col class="option" />
  5478. <col class="description" />
  5479. <tbody valign="top">
  5480. <tr><td class="option-group">
  5481. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  5482. <td>overwrite any local changes</td></tr>
  5483. </tbody>
  5484. </table>
  5485. </div>
  5486. <div class="section" id="qguard">
  5487. <h4>qguard</h4>
  5488. <pre class="literal-block">
  5489. hg qguard [-l] [-n] [PATCH] [-- [+GUARD]... [-GUARD]...]
  5490. </pre>
  5491. <p>Guards control whether a patch can be pushed. A patch with no
  5492. guards is always pushed. A patch with a positive guard (&quot;+foo&quot;) is
  5493. 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
  5494. 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
  5495. has activated it.</p>
  5496. <p>With no arguments, print the currently active guards.
  5497. With arguments, set guards for the named patch.</p>
  5498. <div class="note">
  5499. <p class="first admonition-title">Note</p>
  5500. <p class="last">Specifying negative guards now requires '--'.</p>
  5501. </div>
  5502. <p>To set guards on another patch:</p>
  5503. <pre class="literal-block">
  5504. hg qguard other.patch -- +2.6.17 -stable
  5505. </pre>
  5506. <p>Returns 0 on success.</p>
  5507. <p>options:</p>
  5508. <table class="docutils option-list" frame="void" rules="none">
  5509. <col class="option" />
  5510. <col class="description" />
  5511. <tbody valign="top">
  5512. <tr><td class="option-group">
  5513. <kbd><span class="option">-l</span>, <span class="option">--list</span></kbd></td>
  5514. <td>list all patches and guards</td></tr>
  5515. <tr><td class="option-group">
  5516. <kbd><span class="option">-n</span>, <span class="option">--none</span></kbd></td>
  5517. <td>drop all guards</td></tr>
  5518. </tbody>
  5519. </table>
  5520. </div>
  5521. <div class="section" id="qheader">
  5522. <h4>qheader</h4>
  5523. <pre class="literal-block">
  5524. hg qheader [PATCH]
  5525. </pre>
  5526. <p>Returns 0 on success.</p>
  5527. </div>
  5528. <div class="section" id="qimport">
  5529. <h4>qimport</h4>
  5530. <pre class="literal-block">
  5531. hg qimport [-e] [-n NAME] [-f] [-g] [-P] [-r REV]... FILE...
  5532. </pre>
  5533. <p>The patch is inserted into the series after the last applied
  5534. patch. If no patches have been applied, qimport prepends the patch
  5535. to the series.</p>
  5536. <p>The patch will have the same name as its source file unless you
  5537. give it a new one with -n/--name.</p>
  5538. <p>You can register an existing patch inside the patch directory with
  5539. the -e/--existing flag.</p>
  5540. <p>With -f/--force, an existing patch of the same name will be
  5541. overwritten.</p>
  5542. <p>An existing changeset may be placed under mq control with -r/--rev
  5543. (e.g. qimport --rev tip -n patch will place tip under mq control).
  5544. With -g/--git, patches imported with --rev will use the git diff
  5545. format. See the diffs help topic for information on why this is
  5546. important for preserving rename/copy information and permission
  5547. changes.</p>
  5548. <p>To import a patch from standard input, pass - as the patch file.
  5549. When importing from standard input, a patch name must be specified
  5550. using the --name flag.</p>
  5551. <p>To import an existing patch while renaming it:</p>
  5552. <pre class="literal-block">
  5553. hg qimport -e existing-patch -n new-name
  5554. </pre>
  5555. <p>Returns 0 if import succeeded.</p>
  5556. <p>options:</p>
  5557. <table class="docutils option-list" frame="void" rules="none">
  5558. <col class="option" />
  5559. <col class="description" />
  5560. <tbody valign="top">
  5561. <tr><td class="option-group">
  5562. <kbd><span class="option">-e</span>, <span class="option">--existing</span></kbd></td>
  5563. <td>import file in patch directory</td></tr>
  5564. <tr><td class="option-group">
  5565. <kbd><span class="option">-n</span>, <span class="option">--name</span></kbd></td>
  5566. <td>name of patch file</td></tr>
  5567. <tr><td class="option-group">
  5568. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  5569. <td>overwrite existing files</td></tr>
  5570. <tr><td class="option-group">
  5571. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  5572. <td>place existing revisions under mq control</td></tr>
  5573. <tr><td class="option-group">
  5574. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  5575. <td>use git extended diff format</td></tr>
  5576. <tr><td class="option-group">
  5577. <kbd><span class="option">-P</span>, <span class="option">--push</span></kbd></td>
  5578. <td>qpush after importing</td></tr>
  5579. </tbody>
  5580. </table>
  5581. </div>
  5582. <div class="section" id="qinit">
  5583. <h4>qinit</h4>
  5584. <pre class="literal-block">
  5585. hg qinit [-c]
  5586. </pre>
  5587. <p>The queue repository is unversioned by default. If
  5588. -c/--create-repo is specified, qinit will create a separate nested
  5589. repository for patches (qinit -c may also be run later to convert
  5590. an unversioned patch repository into a versioned one). You can use
  5591. qcommit to commit changes to this queue repository.</p>
  5592. <p>This command is deprecated. Without -c, it's implied by other relevant
  5593. 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>
  5594. <p>options:</p>
  5595. <table class="docutils option-list" frame="void" rules="none">
  5596. <col class="option" />
  5597. <col class="description" />
  5598. <tbody valign="top">
  5599. <tr><td class="option-group" colspan="2">
  5600. <kbd><span class="option">-c</span>, <span class="option">--create-repo</span></kbd></td>
  5601. </tr>
  5602. <tr><td>&nbsp;</td><td>create queue repository</td></tr>
  5603. </tbody>
  5604. </table>
  5605. </div>
  5606. <div class="section" id="qnew">
  5607. <h4>qnew</h4>
  5608. <pre class="literal-block">
  5609. hg qnew [-e] [-m TEXT] [-l FILE] PATCH [FILE]...
  5610. </pre>
  5611. <p>qnew creates a new patch on top of the currently-applied patch (if
  5612. any). The patch will be initialized with any outstanding changes
  5613. in the working directory. You may also use -I/--include,
  5614. -X/--exclude, and/or a list of files after the patch name to add
  5615. only changes to matching files to the new patch, leaving the rest
  5616. as uncommitted modifications.</p>
  5617. <p>-u/--user and -d/--date can be used to set the (given) user and
  5618. date, respectively. -U/--currentuser and -D/--currentdate set user
  5619. to current user and date to current date.</p>
  5620. <p>-e/--edit, -m/--message or -l/--logfile set the patch header as
  5621. well as the commit message. If none is specified, the header is
  5622. empty and the commit message is '[mq]: PATCH'.</p>
  5623. <p>Use the -g/--git option to keep the patch in the git extended diff
  5624. format. Read the diffs help topic for more information on why this
  5625. is important for preserving permission changes and copy/rename
  5626. information.</p>
  5627. <p>Returns 0 on successful creation of a new patch.</p>
  5628. <p>options:</p>
  5629. <table class="docutils option-list" frame="void" rules="none">
  5630. <col class="option" />
  5631. <col class="description" />
  5632. <tbody valign="top">
  5633. <tr><td class="option-group">
  5634. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  5635. <td>edit commit message</td></tr>
  5636. <tr><td class="option-group">
  5637. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  5638. <td>import uncommitted changes (DEPRECATED)</td></tr>
  5639. <tr><td class="option-group">
  5640. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  5641. <td>use git extended diff format</td></tr>
  5642. <tr><td class="option-group" colspan="2">
  5643. <kbd><span class="option">-U</span>, <span class="option">--currentuser</span></kbd></td>
  5644. </tr>
  5645. <tr><td>&nbsp;</td><td>add &quot;From: &lt;current user&gt;&quot; to patch</td></tr>
  5646. <tr><td class="option-group">
  5647. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  5648. <td>add &quot;From: &lt;USER&gt;&quot; to patch</td></tr>
  5649. <tr><td class="option-group" colspan="2">
  5650. <kbd><span class="option">-D</span>, <span class="option">--currentdate</span></kbd></td>
  5651. </tr>
  5652. <tr><td>&nbsp;</td><td>add &quot;Date: &lt;current date&gt;&quot; to patch</td></tr>
  5653. <tr><td class="option-group">
  5654. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  5655. <td>add &quot;Date: &lt;DATE&gt;&quot; to patch</td></tr>
  5656. <tr><td class="option-group">
  5657. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  5658. <td>include names matching the given patterns</td></tr>
  5659. <tr><td class="option-group">
  5660. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  5661. <td>exclude names matching the given patterns</td></tr>
  5662. <tr><td class="option-group">
  5663. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  5664. <td>use text as commit message</td></tr>
  5665. <tr><td class="option-group">
  5666. <kbd><span class="option">-l</span>, <span class="option">--logfile</span></kbd></td>
  5667. <td>read commit message from file</td></tr>
  5668. </tbody>
  5669. </table>
  5670. </div>
  5671. <div class="section" id="qnext">
  5672. <h4>qnext</h4>
  5673. <pre class="literal-block">
  5674. hg qnext [-s]
  5675. </pre>
  5676. <p>Returns 0 on success.</p>
  5677. <p>options:</p>
  5678. <table class="docutils option-list" frame="void" rules="none">
  5679. <col class="option" />
  5680. <col class="description" />
  5681. <tbody valign="top">
  5682. <tr><td class="option-group">
  5683. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  5684. <td>print first line of patch header</td></tr>
  5685. </tbody>
  5686. </table>
  5687. </div>
  5688. <div class="section" id="qpop">
  5689. <h4>qpop</h4>
  5690. <pre class="literal-block">
  5691. hg qpop [-a] [-f] [PATCH | INDEX]
  5692. </pre>
  5693. <p>By default, pops off the top of the patch stack. If given a patch
  5694. name, keeps popping off patches until the named patch is at the
  5695. top of the stack.</p>
  5696. <p>Return 0 on success.</p>
  5697. <p>options:</p>
  5698. <table class="docutils option-list" frame="void" rules="none">
  5699. <col class="option" />
  5700. <col class="description" />
  5701. <tbody valign="top">
  5702. <tr><td class="option-group">
  5703. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  5704. <td>pop all patches</td></tr>
  5705. <tr><td class="option-group">
  5706. <kbd><span class="option">-n</span>, <span class="option">--name</span></kbd></td>
  5707. <td>queue name to pop (DEPRECATED)</td></tr>
  5708. <tr><td class="option-group">
  5709. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  5710. <td>forget any local changes to patched files</td></tr>
  5711. </tbody>
  5712. </table>
  5713. </div>
  5714. <div class="section" id="qprev">
  5715. <h4>qprev</h4>
  5716. <pre class="literal-block">
  5717. hg qprev [-s]
  5718. </pre>
  5719. <p>Returns 0 on success.</p>
  5720. <p>options:</p>
  5721. <table class="docutils option-list" frame="void" rules="none">
  5722. <col class="option" />
  5723. <col class="description" />
  5724. <tbody valign="top">
  5725. <tr><td class="option-group">
  5726. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  5727. <td>print first line of patch header</td></tr>
  5728. </tbody>
  5729. </table>
  5730. </div>
  5731. <div class="section" id="qpush">
  5732. <h4>qpush</h4>
  5733. <pre class="literal-block">
  5734. hg qpush [-f] [-l] [-a] [--move] [PATCH | INDEX]
  5735. </pre>
  5736. <p>When -f/--force is applied, all local changes in patched files
  5737. will be lost.</p>
  5738. <p>Return 0 on succces.</p>
  5739. <p>options:</p>
  5740. <table class="docutils option-list" frame="void" rules="none">
  5741. <col class="option" />
  5742. <col class="description" />
  5743. <tbody valign="top">
  5744. <tr><td class="option-group">
  5745. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  5746. <td>apply on top of local changes</td></tr>
  5747. <tr><td class="option-group">
  5748. <kbd><span class="option">-l</span>, <span class="option">--list</span></kbd></td>
  5749. <td>list patch name in commit text</td></tr>
  5750. <tr><td class="option-group">
  5751. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  5752. <td>apply all patches</td></tr>
  5753. <tr><td class="option-group">
  5754. <kbd><span class="option">-m</span>, <span class="option">--merge</span></kbd></td>
  5755. <td>merge from another queue (DEPRECATED)</td></tr>
  5756. <tr><td class="option-group">
  5757. <kbd><span class="option">-n</span>, <span class="option">--name</span></kbd></td>
  5758. <td>merge queue name (DEPRECATED)</td></tr>
  5759. <tr><td class="option-group">
  5760. <kbd><span class="option">--move</span></kbd></td>
  5761. <td>reorder patch series and apply only the patch</td></tr>
  5762. </tbody>
  5763. </table>
  5764. </div>
  5765. <div class="section" id="qqueue">
  5766. <h4>qqueue</h4>
  5767. <pre class="literal-block">
  5768. hg qqueue [OPTION] [QUEUE]
  5769. </pre>
  5770. <p>Supports switching between different patch queues, as well as creating
  5771. new patch queues and deleting existing ones.</p>
  5772. <p>Omitting a queue name or specifying -l/--list will show you the registered
  5773. queues - by default the &quot;normal&quot; patches queue is registered. The currently
  5774. active queue will be marked with &quot;(active)&quot;.</p>
  5775. <p>To create a new queue, use -c/--create. The queue is automatically made
  5776. active, except in the case where there are applied patches from the
  5777. currently active queue in the repository. Then the queue will only be
  5778. created and switching will fail.</p>
  5779. <p>To delete an existing queue, use --delete. You cannot delete the currently
  5780. active queue.</p>
  5781. <p>Returns 0 on success.</p>
  5782. <p>options:</p>
  5783. <table class="docutils option-list" frame="void" rules="none">
  5784. <col class="option" />
  5785. <col class="description" />
  5786. <tbody valign="top">
  5787. <tr><td class="option-group">
  5788. <kbd><span class="option">-l</span>, <span class="option">--list</span></kbd></td>
  5789. <td>list all available queues</td></tr>
  5790. <tr><td class="option-group">
  5791. <kbd><span class="option">-c</span>, <span class="option">--create</span></kbd></td>
  5792. <td>create new queue</td></tr>
  5793. <tr><td class="option-group">
  5794. <kbd><span class="option">--rename</span></kbd></td>
  5795. <td>rename active queue</td></tr>
  5796. <tr><td class="option-group">
  5797. <kbd><span class="option">--delete</span></kbd></td>
  5798. <td>delete reference to queue</td></tr>
  5799. <tr><td class="option-group">
  5800. <kbd><span class="option">--purge</span></kbd></td>
  5801. <td>delete queue, and remove patch dir</td></tr>
  5802. </tbody>
  5803. </table>
  5804. </div>
  5805. <div class="section" id="qrefresh">
  5806. <h4>qrefresh</h4>
  5807. <pre class="literal-block">
  5808. hg qrefresh [-I] [-X] [-e] [-m TEXT] [-l FILE] [-s] [FILE]...
  5809. </pre>
  5810. <p>If any file patterns are provided, the refreshed patch will
  5811. contain only the modifications that match those patterns; the
  5812. remaining modifications will remain in the working directory.</p>
  5813. <p>If -s/--short is specified, files currently included in the patch
  5814. will be refreshed just like matched files and remain in the patch.</p>
  5815. <p>If -e/--edit is specified, Mercurial will start your configured editor for
  5816. you to enter a message. In case qrefresh fails, you will find a backup of
  5817. your message in <tt class="docutils literal"><span class="pre">.hg/last-message.txt</span></tt>.</p>
  5818. <p>hg add/remove/copy/rename work as usual, though you might want to
  5819. use git-style patches (-g/--git or [diff] git=1) to track copies
  5820. and renames. See the diffs help topic for more information on the
  5821. git diff format.</p>
  5822. <p>Returns 0 on success.</p>
  5823. <p>options:</p>
  5824. <table class="docutils option-list" frame="void" rules="none">
  5825. <col class="option" />
  5826. <col class="description" />
  5827. <tbody valign="top">
  5828. <tr><td class="option-group">
  5829. <kbd><span class="option">-e</span>, <span class="option">--edit</span></kbd></td>
  5830. <td>edit commit message</td></tr>
  5831. <tr><td class="option-group">
  5832. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  5833. <td>use git extended diff format</td></tr>
  5834. <tr><td class="option-group">
  5835. <kbd><span class="option">-s</span>, <span class="option">--short</span></kbd></td>
  5836. <td>refresh only files already in the patch and specified files</td></tr>
  5837. <tr><td class="option-group" colspan="2">
  5838. <kbd><span class="option">-U</span>, <span class="option">--currentuser</span></kbd></td>
  5839. </tr>
  5840. <tr><td>&nbsp;</td><td>add/update author field in patch with current user</td></tr>
  5841. <tr><td class="option-group">
  5842. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  5843. <td>add/update author field in patch with given user</td></tr>
  5844. <tr><td class="option-group" colspan="2">
  5845. <kbd><span class="option">-D</span>, <span class="option">--currentdate</span></kbd></td>
  5846. </tr>
  5847. <tr><td>&nbsp;</td><td>add/update date field in patch with current date</td></tr>
  5848. <tr><td class="option-group">
  5849. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  5850. <td>add/update date field in patch with given date</td></tr>
  5851. <tr><td class="option-group">
  5852. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  5853. <td>include names matching the given patterns</td></tr>
  5854. <tr><td class="option-group">
  5855. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  5856. <td>exclude names matching the given patterns</td></tr>
  5857. <tr><td class="option-group">
  5858. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  5859. <td>use text as commit message</td></tr>
  5860. <tr><td class="option-group">
  5861. <kbd><span class="option">-l</span>, <span class="option">--logfile</span></kbd></td>
  5862. <td>read commit message from file</td></tr>
  5863. </tbody>
  5864. </table>
  5865. </div>
  5866. <div class="section" id="qrename">
  5867. <h4>qrename</h4>
  5868. <pre class="literal-block">
  5869. hg qrename PATCH1 [PATCH2]
  5870. </pre>
  5871. <p>With one argument, renames the current patch to PATCH1.
  5872. With two arguments, renames PATCH1 to PATCH2.</p>
  5873. <p>Returns 0 on success.</p>
  5874. <blockquote>
  5875. aliases: qmv</blockquote>
  5876. </div>
  5877. <div class="section" id="qrestore">
  5878. <h4>qrestore</h4>
  5879. <pre class="literal-block">
  5880. hg qrestore [-d] [-u] REV
  5881. </pre>
  5882. <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>
  5883. <p>options:</p>
  5884. <table class="docutils option-list" frame="void" rules="none">
  5885. <col class="option" />
  5886. <col class="description" />
  5887. <tbody valign="top">
  5888. <tr><td class="option-group">
  5889. <kbd><span class="option">-d</span>, <span class="option">--delete</span></kbd></td>
  5890. <td>delete save entry</td></tr>
  5891. <tr><td class="option-group">
  5892. <kbd><span class="option">-u</span>, <span class="option">--update</span></kbd></td>
  5893. <td>update queue working directory</td></tr>
  5894. </tbody>
  5895. </table>
  5896. </div>
  5897. <div class="section" id="qsave">
  5898. <h4>qsave</h4>
  5899. <pre class="literal-block">
  5900. hg qsave [-m TEXT] [-l FILE] [-c] [-n NAME] [-e] [-f]
  5901. </pre>
  5902. <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>
  5903. <p>options:</p>
  5904. <table class="docutils option-list" frame="void" rules="none">
  5905. <col class="option" />
  5906. <col class="description" />
  5907. <tbody valign="top">
  5908. <tr><td class="option-group">
  5909. <kbd><span class="option">-c</span>, <span class="option">--copy</span></kbd></td>
  5910. <td>copy patch directory</td></tr>
  5911. <tr><td class="option-group">
  5912. <kbd><span class="option">-n</span>, <span class="option">--name</span></kbd></td>
  5913. <td>copy directory name</td></tr>
  5914. <tr><td class="option-group">
  5915. <kbd><span class="option">-e</span>, <span class="option">--empty</span></kbd></td>
  5916. <td>clear queue status file</td></tr>
  5917. <tr><td class="option-group">
  5918. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  5919. <td>force copy</td></tr>
  5920. <tr><td class="option-group">
  5921. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  5922. <td>use text as commit message</td></tr>
  5923. <tr><td class="option-group">
  5924. <kbd><span class="option">-l</span>, <span class="option">--logfile</span></kbd></td>
  5925. <td>read commit message from file</td></tr>
  5926. </tbody>
  5927. </table>
  5928. </div>
  5929. <div class="section" id="qselect">
  5930. <h4>qselect</h4>
  5931. <pre class="literal-block">
  5932. hg qselect [OPTION]... [GUARD]...
  5933. </pre>
  5934. <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
  5935. qselect to tell mq which guards to use. A patch will be pushed if
  5936. it has no guards or any positive guards match the currently
  5937. selected guard, but will not be pushed if any negative guards
  5938. match the current guard. For example:</p>
  5939. <pre class="literal-block">
  5940. qguard foo.patch -stable    (negative guard)
  5941. qguard bar.patch +stable    (positive guard)
  5942. qselect stable
  5943. </pre>
  5944. <p>This activates the &quot;stable&quot; guard. mq will skip foo.patch (because
  5945. it has a negative match) but push bar.patch (because it has a
  5946. positive match).</p>
  5947. <p>With no arguments, prints the currently active guards.
  5948. With one argument, sets the active guard.</p>
  5949. <p>Use -n/--none to deactivate guards (no other arguments needed).
  5950. When no guards are active, patches with positive guards are
  5951. skipped and patches with negative guards are pushed.</p>
  5952. <p>qselect can change the guards on applied patches. It does not pop
  5953. guarded patches by default. Use --pop to pop back to the last
  5954. applied patch that is not guarded. Use --reapply (which implies
  5955. --pop) to push back to the current patch afterwards, but skip
  5956. guarded patches.</p>
  5957. <p>Use -s/--series to print a list of all guards in the series file
  5958. (no other arguments needed). Use -v for more information.</p>
  5959. <p>Returns 0 on success.</p>
  5960. <p>options:</p>
  5961. <table class="docutils option-list" frame="void" rules="none">
  5962. <col class="option" />
  5963. <col class="description" />
  5964. <tbody valign="top">
  5965. <tr><td class="option-group">
  5966. <kbd><span class="option">-n</span>, <span class="option">--none</span></kbd></td>
  5967. <td>disable all guards</td></tr>
  5968. <tr><td class="option-group">
  5969. <kbd><span class="option">-s</span>, <span class="option">--series</span></kbd></td>
  5970. <td>list all guards in series file</td></tr>
  5971. <tr><td class="option-group">
  5972. <kbd><span class="option">--pop</span></kbd></td>
  5973. <td>pop to before first guarded applied patch</td></tr>
  5974. <tr><td class="option-group">
  5975. <kbd><span class="option">--reapply</span></kbd></td>
  5976. <td>pop, then reapply patches</td></tr>
  5977. </tbody>
  5978. </table>
  5979. </div>
  5980. <div class="section" id="qseries">
  5981. <h4>qseries</h4>
  5982. <pre class="literal-block">
  5983. hg qseries [-ms]
  5984. </pre>
  5985. <p>Returns 0 on success.</p>
  5986. <p>options:</p>
  5987. <table class="docutils option-list" frame="void" rules="none">
  5988. <col class="option" />
  5989. <col class="description" />
  5990. <tbody valign="top">
  5991. <tr><td class="option-group">
  5992. <kbd><span class="option">-m</span>, <span class="option">--missing</span></kbd></td>
  5993. <td>print patches not in series</td></tr>
  5994. <tr><td class="option-group">
  5995. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  5996. <td>print first line of patch header</td></tr>
  5997. </tbody>
  5998. </table>
  5999. </div>
  6000. <div class="section" id="qtop">
  6001. <h4>qtop</h4>
  6002. <pre class="literal-block">
  6003. hg qtop [-s]
  6004. </pre>
  6005. <p>Returns 0 on success.</p>
  6006. <p>options:</p>
  6007. <table class="docutils option-list" frame="void" rules="none">
  6008. <col class="option" />
  6009. <col class="description" />
  6010. <tbody valign="top">
  6011. <tr><td class="option-group">
  6012. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  6013. <td>print first line of patch header</td></tr>
  6014. </tbody>
  6015. </table>
  6016. </div>
  6017. <div class="section" id="qunapplied">
  6018. <h4>qunapplied</h4>
  6019. <pre class="literal-block">
  6020. hg qunapplied [-1] [-s] [PATCH]
  6021. </pre>
  6022. <p>Returns 0 on success.</p>
  6023. <p>options:</p>
  6024. <table class="docutils option-list" frame="void" rules="none">
  6025. <col class="option" />
  6026. <col class="description" />
  6027. <tbody valign="top">
  6028. <tr><td class="option-group">
  6029. <kbd><span class="option">-1</span>, <span class="option">--first</span></kbd></td>
  6030. <td>show only the first patch</td></tr>
  6031. <tr><td class="option-group">
  6032. <kbd><span class="option">-s</span>, <span class="option">--summary</span></kbd></td>
  6033. <td>print first line of patch header</td></tr>
  6034. </tbody>
  6035. </table>
  6036. </div>
  6037. <div class="section" id="strip">
  6038. <h4>strip</h4>
  6039. <pre class="literal-block">
  6040. hg strip [-k] [-f] [-n] REV...
  6041. </pre>
  6042. <p>The strip command removes the specified changesets and all their
  6043. descendants. If the working directory has uncommitted changes,
  6044. the operation is aborted unless the --force flag is supplied.</p>
  6045. <p>If a parent of the working directory is stripped, then the working
  6046. directory will automatically be updated to the most recent
  6047. available ancestor of the stripped parent after the operation
  6048. completes.</p>
  6049. <p>Any stripped changesets are stored in <tt class="docutils literal"><span class="pre">.hg/strip-backup</span></tt> as a
  6050. 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
  6051. 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>,
  6052. where BUNDLE is the bundle file created by the strip. Note that
  6053. the local revision numbers will in general be different after the
  6054. restore.</p>
  6055. <p>Use the --no-backup option to discard the backup bundle once the
  6056. operation completes.</p>
  6057. <p>Return 0 on success.</p>
  6058. <p>options:</p>
  6059. <table class="docutils option-list" frame="void" rules="none">
  6060. <col class="option" />
  6061. <col class="description" />
  6062. <tbody valign="top">
  6063. <tr><td class="option-group">
  6064. <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
  6065. <td>force removal of changesets even if the working directory has uncommitted changes</td></tr>
  6066. <tr><td class="option-group">
  6067. <kbd><span class="option">-b</span>, <span class="option">--backup</span></kbd></td>
  6068. <td>bundle only changesets with local revision number greater than REV which are not descendants of REV (DEPRECATED)</td></tr>
  6069. <tr><td class="option-group" colspan="2">
  6070. <kbd><span class="option">-n</span>, <span class="option">--no-backup</span></kbd></td>
  6071. </tr>
  6072. <tr><td>&nbsp;</td><td>no backups</td></tr>
  6073. <tr><td class="option-group">
  6074. <kbd><span class="option">--nobackup</span></kbd></td>
  6075. <td>no backups (DEPRECATED)</td></tr>
  6076. <tr><td class="option-group">
  6077. <kbd><span class="option">-k</span>, <span class="option">--keep</span></kbd></td>
  6078. <td>do not modify working copy during strip</td></tr>
  6079. </tbody>
  6080. </table>
  6081. </div>
  6082. </div>
  6083. </div>
  6084. <div class="section" id="notify">
  6085. <h2><a class="toc-backref" href="#id87">notify</a></h2>
  6086. <p>hooks for sending email notifications at commit/push time</p>
  6087. <p>Subscriptions can be managed through a hgrc file. Default mode is to
  6088. print messages to stdout, for testing and configuring.</p>
  6089. <p>To use, configure the notify extension and enable it in hgrc like
  6090. this:</p>
  6091. <pre class="literal-block">
  6092. [extensions]
  6093. notify =
  6094.  
  6095. [hooks]
  6096. # one email for each incoming changeset
  6097. incoming.notify = python:hgext.notify.hook
  6098. # batch emails when many changesets incoming at one time
  6099. changegroup.notify = python:hgext.notify.hook
  6100.  
  6101. [notify]
  6102. # config items go here
  6103. </pre>
  6104. <p>Required configuration items:</p>
  6105. <pre class="literal-block">
  6106. config = /path/to/file # file containing subscriptions
  6107. </pre>
  6108. <p>Optional configuration items:</p>
  6109. <pre class="literal-block">
  6110. test = True            # print messages to stdout for testing
  6111. strip = 3              # number of slashes to strip for url paths
  6112. domain = example.com   # domain to use if committer missing domain
  6113. style = ...            # style file to use when formatting email
  6114. template = ...         # template to use when formatting email
  6115. incoming = ...         # template to use when run as incoming hook
  6116. changegroup = ...      # template when run as changegroup hook
  6117. maxdiff = 300          # max lines of diffs to include (0=none, -1=all)
  6118. maxsubject = 67        # truncate subject line longer than this
  6119. diffstat = True        # add a diffstat before the diff content
  6120. sources = serve        # notify if source of incoming changes in this list
  6121.                        # (serve == ssh or http, push, pull, bundle)
  6122. merge = False          # send notification for merges (default True)
  6123. [email]
  6124. from = user&#64;host.com   # email address to send as if none given
  6125. [web]
  6126. baseurl = http://hgserver/... # root of hg web site for browsing commits
  6127. </pre>
  6128. <p>The notify config file has same format as a regular hgrc file. It has
  6129. two sections so you can express subscriptions in whatever way is
  6130. handier for you.</p>
  6131. <pre class="literal-block">
  6132. [usersubs]
  6133. # key is subscriber email, value is &quot;,&quot;-separated list of glob patterns
  6134. user&#64;host = pattern
  6135.  
  6136. [reposubs]
  6137. # key is glob pattern, value is &quot;,&quot;-separated list of subscriber emails
  6138. pattern = user&#64;host
  6139. </pre>
  6140. <p>Glob patterns are matched against path to repository root.</p>
  6141. <p>If you like, you can put notify config file in repository that users
  6142. can push changes to, they can manage their own subscriptions.</p>
  6143. </div>
  6144. <div class="section" id="pager">
  6145. <h2><a class="toc-backref" href="#id88">pager</a></h2>
  6146. <p>browse command output with an external pager</p>
  6147. <p>To set the pager that should be used, set the application variable:</p>
  6148. <pre class="literal-block">
  6149. [pager]
  6150. pager = less -FRSX
  6151. </pre>
  6152. <p>If no pager is set, the pager extensions uses the environment variable
  6153. $PAGER. If neither pager.pager, nor $PAGER is set, no pager is used.</p>
  6154. <p>If you notice &quot;BROKEN PIPE&quot; error messages, you can disable them by
  6155. setting:</p>
  6156. <pre class="literal-block">
  6157. [pager]
  6158. quiet = True
  6159. </pre>
  6160. <p>You can disable the pager for certain commands by adding them to the
  6161. pager.ignore list:</p>
  6162. <pre class="literal-block">
  6163. [pager]
  6164. ignore = version, help, update
  6165. </pre>
  6166. <p>You can also enable the pager only for certain commands using
  6167. pager.attend. Below is the default list of commands to be paged:</p>
  6168. <pre class="literal-block">
  6169. [pager]
  6170. attend = annotate, cat, diff, export, glog, log, qdiff
  6171. </pre>
  6172. <p>Setting pager.attend to an empty value will cause all commands to be
  6173. paged.</p>
  6174. <p>If pager.attend is present, pager.ignore will be ignored.</p>
  6175. <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
  6176. to specify them in your user configuration file.</p>
  6177. <p>The --pager=... option can also be used to control when the pager is
  6178. used. Use a boolean value like yes, no, on, off, or use auto for
  6179. normal behavior.</p>
  6180. </div>
  6181. <div class="section" id="parentrevspec">
  6182. <h2><a class="toc-backref" href="#id89">parentrevspec</a></h2>
  6183. <p>interpret suffixes to refer to ancestor revisions</p>
  6184. <p>This extension allows you to use git-style suffixes to refer to the
  6185. ancestors of a specific revision.</p>
  6186. <p>For example, if you can refer to a revision as &quot;foo&quot;, then:</p>
  6187. <pre class="literal-block">
  6188. foo^N = Nth parent of foo
  6189. foo^0 = foo
  6190. foo^1 = first parent of foo
  6191. foo^2 = second parent of foo
  6192. foo^  = foo^1
  6193.  
  6194. foo~N = Nth first grandparent of foo
  6195. foo~0 = foo
  6196. foo~1 = foo^1 = foo^ = first parent of foo
  6197. foo~2 = foo^1^1 = foo^^ = first parent of first parent of foo
  6198. </pre>
  6199. </div>
  6200. <div class="section" id="patchbomb">
  6201. <h2><a class="toc-backref" href="#id90">patchbomb</a></h2>
  6202. <p>command to send changesets as (a series of) patch emails</p>
  6203. <p>The series is started off with a &quot;[PATCH 0 of N]&quot; introduction, which
  6204. describes the series as a whole.</p>
  6205. <p>Each patch email has a Subject line of &quot;[PATCH M of N] ...&quot;, using the
  6206. first line of the changeset description as the subject text. The
  6207. message contains two or three body parts:</p>
  6208. <ul class="simple">
  6209. <li>The changeset description.</li>
  6210. <li>[Optional] The result of running diffstat on the patch.</li>
  6211. <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>
  6212. </ul>
  6213. <p>Each message refers to the first in the series using the In-Reply-To
  6214. and References headers, so they will show up as a sequence in threaded
  6215. mail and news readers, and in mail archives.</p>
  6216. <p>To configure other defaults, add a section like this to your hgrc
  6217. file:</p>
  6218. <pre class="literal-block">
  6219. [email]
  6220. from = My Name &lt;my&#64;email&gt;
  6221. to = recipient1, recipient2, ...
  6222. cc = cc1, cc2, ...
  6223. bcc = bcc1, bcc2, ...
  6224. reply-to = address1, address2, ...
  6225. </pre>
  6226. <p>Use <tt class="docutils literal">[patchbomb]</tt> as configuration section name if you need to
  6227. override global <tt class="docutils literal">[email]</tt> address settings.</p>
  6228. <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
  6229. changesets as a patchbomb.</p>
  6230. <p>You can also either configure the method option in the email section
  6231. to be a sendmail compatible mailer or fill out the [smtp] section so
  6232. that the patchbomb extension can automatically send patchbombs
  6233. directly from the commandline. See the [email] and [smtp] sections in
  6234. hgrc(5) for details.</p>
  6235. <div class="section" id="id23">
  6236. <h3>Commands</h3>
  6237. <div class="section" id="email">
  6238. <h4>email</h4>
  6239. <pre class="literal-block">
  6240. hg email [OPTION]... [DEST]...
  6241. </pre>
  6242. <p>By default, diffs are sent in the format generated by
  6243. <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
  6244. of N]&quot; introduction, which describes the series as a whole.</p>
  6245. <p>Each patch email has a Subject line of &quot;[PATCH M of N] ...&quot;, using
  6246. the first line of the changeset description as the subject text.
  6247. The message contains two or three parts. First, the changeset
  6248. description.</p>
  6249. <p>With the -d/--diffstat option, if the diffstat program is
  6250. installed, the result of running diffstat on the patch is inserted.</p>
  6251. <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>
  6252. <p>With the -d/--diffstat or -c/--confirm options, you will be presented
  6253. with a final summary of all messages and asked for confirmation before
  6254. the messages are sent.</p>
  6255. <p>By default the patch is included as text in the email body for
  6256. easy reviewing. Using the -a/--attach option will instead create
  6257. an attachment for the patch. With -i/--inline an inline attachment
  6258. will be created.</p>
  6259. <p>With -o/--outgoing, emails will be generated for patches not found
  6260. in the destination repository (or only those which are ancestors
  6261. of the specified revisions if any are provided)</p>
  6262. <p>With -b/--bundle, changesets are selected as for --outgoing, but a
  6263. single email containing a binary Mercurial bundle as an attachment
  6264. will be sent.</p>
  6265. <p>With -m/--mbox, instead of previewing each patchbomb message in a
  6266. pager or sending the messages directly, it will create a UNIX
  6267. mailbox file with the patch emails. This mailbox file can be
  6268. previewed with any mail user agent which supports UNIX mbox
  6269. files.</p>
  6270. <p>With -n/--test, all steps will run, but mail will not be sent.
  6271. You will be prompted for an email recipient address, a subject and
  6272. an introductory message describing the patches of your patchbomb.
  6273. Then when all is done, patchbomb messages are displayed. If the
  6274. PAGER environment variable is set, your pager will be fired up once
  6275. for each patchbomb message, so you can verify everything is alright.</p>
  6276. <p>Examples:</p>
  6277. <pre class="literal-block">
  6278. hg email -r 3000          # send patch 3000 only
  6279. hg email -r 3000 -r 3001  # send patches 3000 and 3001
  6280. hg email -r 3000:3005     # send patches 3000 through 3005
  6281. hg email 3000             # send patch 3000 (deprecated)
  6282.  
  6283. hg email -o               # send all patches not in default
  6284. hg email -o DEST          # send all patches not in DEST
  6285. hg email -o -r 3000       # send all ancestors of 3000 not in default
  6286. hg email -o -r 3000 DEST  # send all ancestors of 3000 not in DEST
  6287.  
  6288. hg email -b               # send bundle of all patches not in default
  6289. hg email -b DEST          # send bundle of all patches not in DEST
  6290. hg email -b -r 3000       # bundle of all ancestors of 3000 not in default
  6291. hg email -b -r 3000 DEST  # bundle of all ancestors of 3000 not in DEST
  6292.  
  6293. hg email -o -m mbox &amp;&amp;    # generate an mbox file...
  6294.   mutt -R -f mbox         # ... and view it with mutt
  6295. hg email -o -m mbox &amp;&amp;    # generate an mbox file ...
  6296.   formail -s sendmail \   # ... and use formail to send from the mbox
  6297.     -bm -t &lt; mbox         # ... using sendmail
  6298. </pre>
  6299. <p>Before using this command, you will need to enable email in your
  6300. hgrc. See the [email] section in hgrc(5) for details.</p>
  6301. <p>options:</p>
  6302. <table class="docutils option-list" frame="void" rules="none">
  6303. <col class="option" />
  6304. <col class="description" />
  6305. <tbody valign="top">
  6306. <tr><td class="option-group">
  6307. <kbd><span class="option">-g</span>, <span class="option">--git</span></kbd></td>
  6308. <td>use git extended diff format</td></tr>
  6309. <tr><td class="option-group">
  6310. <kbd><span class="option">--plain</span></kbd></td>
  6311. <td>omit hg patch header</td></tr>
  6312. <tr><td class="option-group">
  6313. <kbd><span class="option">-o</span>, <span class="option">--outgoing</span></kbd></td>
  6314. <td>send changes not found in the target repository</td></tr>
  6315. <tr><td class="option-group">
  6316. <kbd><span class="option">-b</span>, <span class="option">--bundle</span></kbd></td>
  6317. <td>send changes not in target as a binary bundle</td></tr>
  6318. <tr><td class="option-group">
  6319. <kbd><span class="option">--bundlename</span></kbd></td>
  6320. <td>name of the bundle attachment file (default: bundle)</td></tr>
  6321. <tr><td class="option-group">
  6322. <kbd><span class="option">-r</span>, <span class="option">--rev</span></kbd></td>
  6323. <td>a revision to send</td></tr>
  6324. <tr><td class="option-group">
  6325. <kbd><span class="option">--force</span></kbd></td>
  6326. <td>run even when remote repository is unrelated (with -b/--bundle)</td></tr>
  6327. <tr><td class="option-group">
  6328. <kbd><span class="option">--base</span></kbd></td>
  6329. <td>a base changeset to specify instead of a destination (with -b/--bundle)</td></tr>
  6330. <tr><td class="option-group">
  6331. <kbd><span class="option">--intro</span></kbd></td>
  6332. <td>send an introduction email for a single patch</td></tr>
  6333. <tr><td class="option-group">
  6334. <kbd><span class="option">-a</span>, <span class="option">--attach</span></kbd></td>
  6335. <td>send patches as attachments</td></tr>
  6336. <tr><td class="option-group">
  6337. <kbd><span class="option">-i</span>, <span class="option">--inline</span></kbd></td>
  6338. <td>send patches as inline attachments</td></tr>
  6339. <tr><td class="option-group">
  6340. <kbd><span class="option">--bcc</span></kbd></td>
  6341. <td>email addresses of blind carbon copy recipients</td></tr>
  6342. <tr><td class="option-group">
  6343. <kbd><span class="option">-c</span>, <span class="option">--cc</span></kbd></td>
  6344. <td>email addresses of copy recipients</td></tr>
  6345. <tr><td class="option-group">
  6346. <kbd><span class="option">--confirm</span></kbd></td>
  6347. <td>ask for confirmation before sending</td></tr>
  6348. <tr><td class="option-group">
  6349. <kbd><span class="option">-d</span>, <span class="option">--diffstat</span></kbd></td>
  6350. <td>add diffstat output to messages</td></tr>
  6351. <tr><td class="option-group">
  6352. <kbd><span class="option">--date</span></kbd></td>
  6353. <td>use the given date as the sending date</td></tr>
  6354. <tr><td class="option-group">
  6355. <kbd><span class="option">--desc</span></kbd></td>
  6356. <td>use the given file as the series description</td></tr>
  6357. <tr><td class="option-group">
  6358. <kbd><span class="option">-f</span>, <span class="option">--from</span></kbd></td>
  6359. <td>email address of sender</td></tr>
  6360. <tr><td class="option-group">
  6361. <kbd><span class="option">-n</span>, <span class="option">--test</span></kbd></td>
  6362. <td>print messages that would be sent</td></tr>
  6363. <tr><td class="option-group">
  6364. <kbd><span class="option">-m</span>, <span class="option">--mbox</span></kbd></td>
  6365. <td>write messages to mbox file instead of sending them</td></tr>
  6366. <tr><td class="option-group">
  6367. <kbd><span class="option">--reply-to</span></kbd></td>
  6368. <td>email addresses replies should be sent to</td></tr>
  6369. <tr><td class="option-group">
  6370. <kbd><span class="option">-s</span>, <span class="option">--subject</span></kbd></td>
  6371. <td>subject of first message (intro or single patch)</td></tr>
  6372. <tr><td class="option-group">
  6373. <kbd><span class="option">--in-reply-to</span></kbd></td>
  6374. <td>message identifier to reply to</td></tr>
  6375. <tr><td class="option-group">
  6376. <kbd><span class="option">--flag</span></kbd></td>
  6377. <td>flags to add in subject prefixes</td></tr>
  6378. <tr><td class="option-group">
  6379. <kbd><span class="option">-t</span>, <span class="option">--to</span></kbd></td>
  6380. <td>email addresses of recipients</td></tr>
  6381. <tr><td class="option-group">
  6382. <kbd><span class="option">-e</span>, <span class="option">--ssh</span></kbd></td>
  6383. <td>specify ssh command to use</td></tr>
  6384. <tr><td class="option-group">
  6385. <kbd><span class="option">--remotecmd</span></kbd></td>
  6386. <td>specify hg command to run on the remote side</td></tr>
  6387. </tbody>
  6388. </table>
  6389. </div>
  6390. </div>
  6391. </div>
  6392. <div class="section" id="progress">
  6393. <h2><a class="toc-backref" href="#id91">progress</a></h2>
  6394. <p>show progress bars for some actions</p>
  6395. <p>This extension uses the progress information logged by hg commands
  6396. to draw progress bars that are as informative as possible. Some progress
  6397. bars only offer indeterminate information, while others have a definite
  6398. end point.</p>
  6399. <p>The following settings are available:</p>
  6400. <pre class="literal-block">
  6401. [progress]
  6402. delay = 3 # number of seconds (float) before showing the progress bar
  6403. refresh = 0.1 # time in seconds between refreshes of the progress bar
  6404. format = topic bar number # format of the progress bar
  6405. width = &lt;none&gt; # if set, the maximum width of the progress information
  6406.                # (that is, min(width, term width) will be used)
  6407. clear-complete = True # clear the progress bar after it's done
  6408. disable = False # if true, don't show a progress bar
  6409. assume-tty = False # if true, ALWAYS show a progress bar, unless
  6410.                    # disable is given
  6411. </pre>
  6412. <p>Valid entries for the format field are topic, bar, number, unit, and
  6413. item. item defaults to the last 20 characters of the item, but this
  6414. can be changed by adding either <tt class="docutils literal"><span class="pre">-&lt;num&gt;</span></tt> which would take the last
  6415. num characters, or <tt class="docutils literal">+&lt;num&gt;</tt> for the first num characters.</p>
  6416. </div>
  6417. <div class="section" id="purge">
  6418. <h2><a class="toc-backref" href="#id92">purge</a></h2>
  6419. <p>command to delete untracked files from the working directory</p>
  6420. <div class="section" id="id24">
  6421. <h3>Commands</h3>
  6422. <div class="section" id="id25">
  6423. <h4>purge</h4>
  6424. <pre class="literal-block">
  6425. hg purge [OPTION]... [DIR]...
  6426. </pre>
  6427. <p>Delete files not known to Mercurial. This is useful to test local
  6428. and uncommitted changes in an otherwise-clean source tree.</p>
  6429. <p>This means that purge will delete:</p>
  6430. <ul class="simple">
  6431. <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>
  6432. <li>Empty directories: in fact Mercurial ignores directories unless
  6433. they contain files under source control management</li>
  6434. </ul>
  6435. <p>But it will leave untouched:</p>
  6436. <ul class="simple">
  6437. <li>Modified and unmodified tracked files</li>
  6438. <li>Ignored files (unless --all is specified)</li>
  6439. <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>
  6440. </ul>
  6441. <p>If directories are given on the command line, only files in these
  6442. directories are considered.</p>
  6443. <p>Be careful with purge, as you could irreversibly delete some files
  6444. you forgot to add to the repository. If you only want to print the
  6445. list of files that this program would delete, use the --print
  6446. option.</p>
  6447. <p>options:</p>
  6448. <table class="docutils option-list" frame="void" rules="none">
  6449. <col class="option" />
  6450. <col class="description" />
  6451. <tbody valign="top">
  6452. <tr><td class="option-group" colspan="2">
  6453. <kbd><span class="option">-a</span>, <span class="option">--abort-on-err</span></kbd></td>
  6454. </tr>
  6455. <tr><td>&nbsp;</td><td>abort if an error occurs</td></tr>
  6456. <tr><td class="option-group">
  6457. <kbd><span class="option">--all</span></kbd></td>
  6458. <td>purge ignored files too</td></tr>
  6459. <tr><td class="option-group">
  6460. <kbd><span class="option">-p</span>, <span class="option">--print</span></kbd></td>
  6461. <td>print filenames instead of deleting them</td></tr>
  6462. <tr><td class="option-group">
  6463. <kbd><span class="option">-0</span>, <span class="option">--print0</span></kbd></td>
  6464. <td>end filenames with NUL, for use with xargs (implies -p/--print)</td></tr>
  6465. <tr><td class="option-group">
  6466. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  6467. <td>include names matching the given patterns</td></tr>
  6468. <tr><td class="option-group">
  6469. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  6470. <td><p class="first">exclude names matching the given patterns</p>
  6471. <p class="last">aliases: clean</p>
  6472. </td></tr>
  6473. </tbody>
  6474. </table>
  6475. </div>
  6476. </div>
  6477. </div>
  6478. <div class="section" id="rebase">
  6479. <h2><a class="toc-backref" href="#id93">rebase</a></h2>
  6480. <p>command to move sets of revisions to a different ancestor</p>
  6481. <p>This extension lets you rebase changesets in an existing Mercurial
  6482. repository.</p>
  6483. <p>For more information:
  6484. <a class="reference external" href="http://mercurial.selenic.com/wiki/RebaseExtension">http://mercurial.selenic.com/wiki/RebaseExtension</a></p>
  6485. <div class="section" id="id26">
  6486. <h3>Commands</h3>
  6487. <div class="section" id="id27">
  6488. <h4>rebase</h4>
  6489. <pre class="literal-block">
  6490. hg rebase [-s REV | -b REV] [-d REV] [options]
  6491. hg rebase {-a|-c}
  6492. </pre>
  6493. <p>Rebase uses repeated merging to graft changesets from one part of
  6494. history (the source) onto another (the destination). This can be
  6495. useful for linearizing <em>local</em> changes relative to a master
  6496. development tree.</p>
  6497. <p>You should not rebase changesets that have already been shared
  6498. with others. Doing so will force everybody else to perform the
  6499. same rebase or they will end up with duplicated changesets after
  6500. pulling in your rebased changesets.</p>
  6501. <p>If you don't specify a destination changeset (<tt class="docutils literal"><span class="pre">-d/--dest</span></tt>),
  6502. rebase uses the tipmost head of the current named branch as the
  6503. destination. (The destination changeset is not modified by
  6504. rebasing, but new changesets are added as its descendants.)</p>
  6505. <p>You can specify which changesets to rebase in two ways: as a
  6506. &quot;source&quot; changeset or as a &quot;base&quot; changeset. Both are shorthand
  6507. for a topologically related set of changesets (the &quot;source
  6508. branch&quot;). If you specify source (<tt class="docutils literal"><span class="pre">-s/--source</span></tt>), rebase will
  6509. rebase that changeset and all of its descendants onto dest. If you
  6510. specify base (<tt class="docutils literal"><span class="pre">-b/--base</span></tt>), rebase will select ancestors of base
  6511. back to but not including the common ancestor with dest. Thus,
  6512. <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
  6513. specify any changeset in the source branch, and rebase will select
  6514. 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
  6515. uses the parent of the working directory as the base.</p>
  6516. <p>By default, rebase recreates the changesets in the source branch
  6517. as descendants of dest and then destroys the originals. Use
  6518. <tt class="docutils literal"><span class="pre">--keep</span></tt> to preserve the original source changesets. Some
  6519. changesets in the source branch (e.g. merges from the destination
  6520. branch) may be dropped if they no longer contribute any change.</p>
  6521. <p>One result of the rules for selecting the destination changeset
  6522. and source branch is that, unlike <tt class="docutils literal">merge</tt>, rebase will do
  6523. nothing if you are at the latest (tipmost) head of a named branch
  6524. with two heads. You need to explicitly specify source and/or
  6525. destination (or <tt class="docutils literal">update</tt> to the other head, if it's the head of
  6526. the intended source branch).</p>
  6527. <p>If a rebase is interrupted to manually resolve a merge, it can be
  6528. continued with --continue/-c or aborted with --abort/-a.</p>
  6529. <p>Returns 0 on success, 1 if nothing to rebase.</p>
  6530. <p>options:</p>
  6531. <table class="docutils option-list" frame="void" rules="none">
  6532. <col class="option" />
  6533. <col class="description" />
  6534. <tbody valign="top">
  6535. <tr><td class="option-group">
  6536. <kbd><span class="option">-s</span>, <span class="option">--source</span></kbd></td>
  6537. <td>rebase from the specified changeset</td></tr>
  6538. <tr><td class="option-group">
  6539. <kbd><span class="option">-b</span>, <span class="option">--base</span></kbd></td>
  6540. <td>rebase from the base of the specified changeset (up to greatest common ancestor of base and dest)</td></tr>
  6541. <tr><td class="option-group">
  6542. <kbd><span class="option">-d</span>, <span class="option">--dest</span></kbd></td>
  6543. <td>rebase onto the specified changeset</td></tr>
  6544. <tr><td class="option-group">
  6545. <kbd><span class="option">--collapse</span></kbd></td>
  6546. <td>collapse the rebased changesets</td></tr>
  6547. <tr><td class="option-group">
  6548. <kbd><span class="option">--keep</span></kbd></td>
  6549. <td>keep original changesets</td></tr>
  6550. <tr><td class="option-group">
  6551. <kbd><span class="option">--keepbranches</span></kbd></td>
  6552. <td>keep original branch names</td></tr>
  6553. <tr><td class="option-group">
  6554. <kbd><span class="option">--detach</span></kbd></td>
  6555. <td>force detaching of source from its original branch</td></tr>
  6556. <tr><td class="option-group">
  6557. <kbd><span class="option">-c</span>, <span class="option">--continue</span></kbd></td>
  6558. <td>continue an interrupted rebase</td></tr>
  6559. <tr><td class="option-group">
  6560. <kbd><span class="option">-a</span>, <span class="option">--abort</span></kbd></td>
  6561. <td>abort an interrupted rebase</td></tr>
  6562. <tr><td class="option-group">
  6563. <kbd><span class="option">--style</span></kbd></td>
  6564. <td>display using template map file</td></tr>
  6565. <tr><td class="option-group">
  6566. <kbd><span class="option">--template</span></kbd></td>
  6567. <td>display with template</td></tr>
  6568. </tbody>
  6569. </table>
  6570. </div>
  6571. </div>
  6572. </div>
  6573. <div class="section" id="record">
  6574. <h2><a class="toc-backref" href="#id94">record</a></h2>
  6575. <p>commands to interactively select changes for commit/qrefresh</p>
  6576. <div class="section" id="id28">
  6577. <h3>Commands</h3>
  6578. <div class="section" id="id29">
  6579. <h4>record</h4>
  6580. <pre class="literal-block">
  6581. hg record [OPTION]... [FILE]...
  6582. </pre>
  6583. <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>
  6584. will be candidates for recording.</p>
  6585. <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>
  6586. <p>You will be prompted for whether to record changes to each
  6587. modified file, and for files with multiple changes, for each
  6588. change to use. For each query, the following responses are
  6589. possible:</p>
  6590. <pre class="literal-block">
  6591. y - record this change
  6592. n - skip this change
  6593.  
  6594. s - skip remaining changes to this file
  6595. f - record remaining changes to this file
  6596.  
  6597. d - done, skip remaining changes and files
  6598. a - record all changes to all remaining files
  6599. q - quit, recording no changes
  6600.  
  6601. ? - display help
  6602. </pre>
  6603. <p>This command is not available when committing a merge.</p>
  6604. <p>options:</p>
  6605. <table class="docutils option-list" frame="void" rules="none">
  6606. <col class="option" />
  6607. <col class="description" />
  6608. <tbody valign="top">
  6609. <tr><td class="option-group" colspan="2">
  6610. <kbd><span class="option">-A</span>, <span class="option">--addremove</span></kbd></td>
  6611. </tr>
  6612. <tr><td>&nbsp;</td><td>mark new/missing files as added/removed before committing</td></tr>
  6613. <tr><td class="option-group">
  6614. <kbd><span class="option">--close-branch</span></kbd></td>
  6615. <td>mark a branch as closed, hiding it from the branch list</td></tr>
  6616. <tr><td class="option-group">
  6617. <kbd><span class="option">-I</span>, <span class="option">--include</span></kbd></td>
  6618. <td>include names matching the given patterns</td></tr>
  6619. <tr><td class="option-group">
  6620. <kbd><span class="option">-X</span>, <span class="option">--exclude</span></kbd></td>
  6621. <td>exclude names matching the given patterns</td></tr>
  6622. <tr><td class="option-group">
  6623. <kbd><span class="option">-m</span>, <span class="option">--message</span></kbd></td>
  6624. <td>use text as commit message</td></tr>
  6625. <tr><td class="option-group">
  6626. <kbd><span class="option">-l</span>, <span class="option">--logfile</span></kbd></td>
  6627. <td>read commit message from file</td></tr>
  6628. <tr><td class="option-group">
  6629. <kbd><span class="option">-d</span>, <span class="option">--date</span></kbd></td>
  6630. <td>record datecode as commit date</td></tr>
  6631. <tr><td class="option-group">
  6632. <kbd><span class="option">-u</span>, <span class="option">--user</span></kbd></td>
  6633. <td>record the specified user as committer</td></tr>
  6634. </tbody>
  6635. </table>
  6636. </div>
  6637. </div>
  6638. </div>
  6639. <div class="section" id="relink">
  6640. <h2><a class="toc-backref" href="#id95">relink</a></h2>
  6641. <p>recreates hardlinks between repository clones</p>
  6642. <div class="section" id="id30">
  6643. <h3>Commands</h3>
  6644. <div class="section" id="id31">
  6645. <h4>relink</h4>
  6646. <pre class="literal-block">
  6647. hg relink [ORIGIN]
  6648. </pre>
  6649. <p>When repositories are cloned locally, their data files will be
  6650. hardlinked so that they only use the space of a single repository.</p>
  6651. <p>Unfortunately, subsequent pulls into either repository will break
  6652. hardlinks for any files touched by the new changesets, even if
  6653. both repositories end up pulling the same changes.</p>
  6654. <p>Similarly, passing --rev to &quot;hg clone&quot; will fail to use any
  6655. hardlinks, falling back to a complete copy of the source
  6656. repository.</p>
  6657. <p>This command lets you recreate those hardlinks and reclaim that
  6658. wasted space.</p>
  6659. <p>This repository will be relinked to share space with ORIGIN, which
  6660. must be on the same local disk. If ORIGIN is omitted, looks for
  6661. &quot;default-relink&quot;, then &quot;default&quot;, in [paths].</p>
  6662. <p>Do not attempt any read operations on this repository while the
  6663. command is running. (Both repositories will be locked against
  6664. writes.)</p>
  6665. </div>
  6666. </div>
  6667. </div>
  6668. <div class="section" id="schemes">
  6669. <h2><a class="toc-backref" href="#id96">schemes</a></h2>
  6670. <p>extend schemes with shortcuts to repository swarms</p>
  6671. <p>This extension allows you to specify shortcuts for parent URLs with a
  6672. lot of repositories to act like a scheme, for example:</p>
  6673. <pre class="literal-block">
  6674. [schemes]
  6675. py = http://code.python.org/hg/
  6676. </pre>
  6677. <p>After that you can use it like:</p>
  6678. <pre class="literal-block">
  6679. hg clone py://trunk/
  6680. </pre>
  6681. <p>Additionally there is support for some more complex schemas, for
  6682. example used by Google Code:</p>
  6683. <pre class="literal-block">
  6684. [schemes]
  6685. gcode = http://{1}.googlecode.com/hg/
  6686. </pre>
  6687. <p>The syntax is taken from Mercurial templates, and you have unlimited
  6688. number of variables, starting with <tt class="docutils literal">{1}</tt> and continuing with
  6689. <tt class="docutils literal">{2}</tt>, <tt class="docutils literal">{3}</tt> and so on. This variables will receive parts of URL
  6690. supplied, split by <tt class="docutils literal">/</tt>. Anything not specified as <tt class="docutils literal">{part}</tt> will be
  6691. just appended to an URL.</p>
  6692. <p>For convenience, the extension adds these schemes by default:</p>
  6693. <pre class="literal-block">
  6694. [schemes]
  6695. py = http://hg.python.org/
  6696. bb = https://bitbucket.org/
  6697. bb+ssh = ssh://hg&#64;bitbucket.org/
  6698. gcode = https://{1}.googlecode.com/hg/
  6699. kiln = https://{1}.kilnhg.com/Repo/
  6700. </pre>
  6701. <p>You can override a predefined scheme by defining a new scheme with the
  6702. same name.</p>
  6703. </div>
  6704. <div class="section" id="share">
  6705. <h2><a class="toc-backref" href="#id97">share</a></h2>
  6706. <p>share a common history between several working directories</p>
  6707. <div class="section" id="id32">
  6708. <h3>Commands</h3>
  6709. <div class="section" id="id33">
  6710. <h4>share</h4>
  6711. <pre class="literal-block">
  6712. hg share [-U] SOURCE [DEST]
  6713. </pre>
  6714. <p>Initialize a new repository and working directory that shares its
  6715. history with another repository.</p>
  6716. <div class="note">
  6717. <p class="first admonition-title">Note</p>
  6718. <p class="last">using rollback or extensions that destroy/modify history (mq,
  6719. rebase, etc.) can cause considerable confusion with shared
  6720. clones. In particular, if two shared clones are both updated to
  6721. the same changeset, and one of them destroys that changeset
  6722. with rollback, the other clone will suddenly stop working: all
  6723. operations will fail with &quot;abort: working directory has unknown
  6724. parent&quot;. The only known workaround is to use debugsetparents on
  6725. the broken clone to reset it to a changeset that still exists
  6726. (e.g. tip).</p>
  6727. </div>
  6728. <p>options:</p>
  6729. <table class="docutils option-list" frame="void" rules="none">
  6730. <col class="option" />
  6731. <col class="description" />
  6732. <tbody valign="top">
  6733. <tr><td class="option-group">
  6734. <kbd><span class="option">-U</span>, <span class="option">--noupdate</span></kbd></td>
  6735. <td>do not create a working copy</td></tr>
  6736. </tbody>
  6737. </table>
  6738. </div>
  6739. </div>
  6740. </div>
  6741. <div class="section" id="transplant">
  6742. <h2><a class="toc-backref" href="#id98">transplant</a></h2>
  6743. <p>command to transplant changesets from another branch</p>
  6744. <p>This extension allows you to transplant patches from another branch.</p>
  6745. <p>Transplanted patches are recorded in .hg/transplant/transplants, as a
  6746. map from a changeset hash to its hash in the source repository.</p>
  6747. <div class="section" id="id34">
  6748. <h3>Commands</h3>
  6749. <div class="section" id="id35">
  6750. <h4>transplant</h4>
  6751. <pre class="literal-block">
  6752. hg transplant [-s REPO] [-b BRANCH [-a]] [-p REV] [-m REV] [REV]...
  6753. </pre>
  6754. <p>Selected changesets will be applied on top of the current working
  6755. directory with the log of the original changeset. If --log is
  6756. specified, log messages will have a comment appended of the form:</p>
  6757. <pre class="literal-block">
  6758. (transplanted from CHANGESETHASH)
  6759. </pre>
  6760. <p>You can rewrite the changelog message with the --filter option.
  6761. Its argument will be invoked with the current changelog message as
  6762. $1 and the patch as $2.</p>
  6763. <p>If --source/-s is specified, selects changesets from the named
  6764. repository. If --branch/-b is specified, selects changesets from
  6765. the branch holding the named revision, up to that revision. If
  6766. --all/-a is specified, all changesets on the branch will be
  6767. transplanted, otherwise you will be prompted to select the
  6768. changesets you want.</p>
  6769. <p><a class="reference external" href="hg.1.html#transplant"><tt class="docutils literal">hg transplant <span class="pre">--branch</span> REVISION <span class="pre">--all</span></tt></a> will rebase the selected
  6770. branch (up to the named revision) onto your current working
  6771. directory.</p>
  6772. <p>You can optionally mark selected transplanted changesets as merge
  6773. changesets. You will not be prompted to transplant any ancestors
  6774. of a merged transplant, and you can merge descendants of them
  6775. normally instead of transplanting them.</p>
  6776. <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
  6777. start an interactive changeset browser.</p>
  6778. <p>If a changeset application fails, you can fix the merge by hand
  6779. and then resume where you left off by calling <a class="reference external" href="hg.1.html#transplant"><tt class="docutils literal">hg transplant
  6780. <span class="pre">--continue/-c</span></tt></a>.</p>
  6781. <p>options:</p>
  6782. <table class="docutils option-list" frame="void" rules="none">
  6783. <col class="option" />
  6784. <col class="description" />
  6785. <tbody valign="top">
  6786. <tr><td class="option-group">
  6787. <kbd><span class="option">-s</span>, <span class="option">--source</span></kbd></td>
  6788. <td>pull patches from REPO</td></tr>
  6789. <tr><td class="option-group">
  6790. <kbd><span class="option">-b</span>, <span class="option">--branch</span></kbd></td>
  6791. <td>pull patches from branch BRANCH</td></tr>
  6792. <tr><td class="option-group">
  6793. <kbd><span class="option">-a</span>, <span class="option">--all</span></kbd></td>
  6794. <td>pull all changesets up to BRANCH</td></tr>
  6795. <tr><td class="option-group">
  6796. <kbd><span class="option">-p</span>, <span class="option">--prune</span></kbd></td>
  6797. <td>skip over REV</td></tr>
  6798. <tr><td class="option-group">
  6799. <kbd><span class="option">-m</span>, <span class="option">--merge</span></kbd></td>
  6800. <td>merge at REV</td></tr>
  6801. <tr><td class="option-group">
  6802. <kbd><span class="option">--log</span></kbd></td>
  6803. <td>append transplant info to log message</td></tr>
  6804. <tr><td class="option-group">
  6805. <kbd><span class="option">-c</span>, <span class="option">--continue</span></kbd></td>
  6806. <td>continue last transplant session after repair</td></tr>
  6807. <tr><td class="option-group">
  6808. <kbd><span class="option">--filter</span></kbd></td>
  6809. <td>filter changesets through command</td></tr>
  6810. </tbody>
  6811. </table>
  6812. </div>
  6813. </div>
  6814. </div>
  6815. <div class="section" id="win32mbcs">
  6816. <h2><a class="toc-backref" href="#id99">win32mbcs</a></h2>
  6817. <p>allow the use of MBCS paths with problematic encodings</p>
  6818. <p>Some MBCS encodings are not good for some path operations (i.e.
  6819. splitting path, case conversion, etc.) with its encoded bytes. We call
  6820. such a encoding (i.e. shift_jis and big5) as &quot;problematic encoding&quot;.
  6821. This extension can be used to fix the issue with those encodings by
  6822. wrapping some functions to convert to Unicode string before path
  6823. operation.</p>
  6824. <p>This extension is useful for:</p>
  6825. <ul class="simple">
  6826. <li>Japanese Windows users using shift_jis encoding.</li>
  6827. <li>Chinese Windows users using big5 encoding.</li>
  6828. <li>All users who use a repository with one of problematic encodings on
  6829. case-insensitive file system.</li>
  6830. </ul>
  6831. <p>This extension is not needed for:</p>
  6832. <ul class="simple">
  6833. <li>Any user who use only ASCII chars in path.</li>
  6834. <li>Any user who do not use any of problematic encodings.</li>
  6835. </ul>
  6836. <p>Note that there are some limitations on using this extension:</p>
  6837. <ul class="simple">
  6838. <li>You should use single encoding in one repository.</li>
  6839. <li>If the repository path ends with 0x5c, .hg/hgrc cannot be read.</li>
  6840. <li>win32mbcs is not compatible with fixutf8 extention.</li>
  6841. </ul>
  6842. <p>By default, win32mbcs uses encoding.encoding decided by Mercurial.
  6843. You can specify the encoding by config option:</p>
  6844. <pre class="literal-block">
  6845. [win32mbcs]
  6846. encoding = sjis
  6847. </pre>
  6848. <p>It is useful for the users who want to commit with UTF-8 log message.</p>
  6849. </div>
  6850. <div class="section" id="win32text">
  6851. <h2><a class="toc-backref" href="#id100">win32text</a></h2>
  6852. <p>perform automatic newline conversion</p>
  6853. <blockquote>
  6854. <p>Deprecation: The win32text extension requires each user to configure
  6855. the extension again and again for each clone since the configuration
  6856. is not copied when cloning.</p>
  6857. <p>We have therefore made the <tt class="docutils literal">eol</tt> as an alternative. The <tt class="docutils literal">eol</tt>
  6858. uses a version controlled file for its configuration and each clone
  6859. will therefore use the right settings from the start.</p>
  6860. </blockquote>
  6861. <p>To perform automatic newline conversion, use:</p>
  6862. <pre class="literal-block">
  6863. [extensions]
  6864. win32text =
  6865. [encode]
  6866. ** = cleverencode:
  6867. # or ** = macencode:
  6868.  
  6869. [decode]
  6870. ** = cleverdecode:
  6871. # or ** = macdecode:
  6872. </pre>
  6873. <p>If not doing conversion, to make sure you do not commit CRLF/CR by accident:</p>
  6874. <pre class="literal-block">
  6875. [hooks]
  6876. pretxncommit.crlf = python:hgext.win32text.forbidcrlf
  6877. # or pretxncommit.cr = python:hgext.win32text.forbidcr
  6878. </pre>
  6879. <p>To do the same check on a server to prevent CRLF/CR from being
  6880. pushed or pulled:</p>
  6881. <pre class="literal-block">
  6882. [hooks]
  6883. pretxnchangegroup.crlf = python:hgext.win32text.forbidcrlf
  6884. # or pretxnchangegroup.cr = python:hgext.win32text.forbidcr
  6885. </pre>
  6886. </div>
  6887. <div class="section" id="zeroconf">
  6888. <h2><a class="toc-backref" href="#id101">zeroconf</a></h2>
  6889. <p>discover and advertise repositories on the local network</p>
  6890. <p>Zeroconf-enabled repositories will be announced in a network without
  6891. the need to configure a server or a service. They can be discovered
  6892. without knowing their actual IP address.</p>
  6893. <p>To allow other people to discover your repository using run
  6894. <a class="reference external" href="hg.1.html#serve"><tt class="docutils literal">hg serve</tt></a> in your repository:</p>
  6895. <pre class="literal-block">
  6896. $ cd test
  6897. $ hg serve
  6898. </pre>
  6899. <p>You can discover Zeroconf-enabled repositories by running
  6900. <a class="reference external" href="hg.1.html#paths"><tt class="docutils literal">hg paths</tt></a>:</p>
  6901. <pre class="literal-block">
  6902. $ hg paths
  6903. zc-test = http://example.com:8000/test
  6904. </pre>
  6905. </div>
  6906. </div>
  6907. <div class="section" id="files">
  6908. <h1><a class="toc-backref" href="#contents">Files</a></h1>
  6909. <dl class="docutils">
  6910. <dt><tt class="docutils literal">.hgignore</tt></dt>
  6911. <dd>This file contains regular expressions (one per line) that
  6912. describe file names that should be ignored by <strong>hg</strong>. For details,
  6913. see <a class="reference external" href="hgignore.5.html"><strong>hgignore</strong>(5)</a>.</dd>
  6914. <dt><tt class="docutils literal">.hgtags</tt></dt>
  6915. <dd>This file contains changeset hash values and text tag names (one
  6916. of each separated by spaces) that correspond to tagged versions of
  6917. the repository contents.</dd>
  6918. <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>
  6919. <dd>This file contains defaults and configuration. Values in
  6920. <tt class="docutils literal">.hg/hgrc</tt> override those in <tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt>, and these override
  6921. settings made in the global <tt class="docutils literal">/etc/mercurial/hgrc</tt> configuration.
  6922. See <a class="reference external" href="hgrc.5.html"><strong>hgrc</strong>(5)</a> for details of the contents and format of these
  6923. files.</dd>
  6924. </dl>
  6925. <p>Some commands (e.g. revert) produce backup files ending in <tt class="docutils literal">.orig</tt>,
  6926. if the <tt class="docutils literal">.orig</tt> file already exists and is not tracked by Mercurial,
  6927. it will be overwritten.</p>
  6928. </div>
  6929. <div class="section" id="bugs">
  6930. <h1><a class="toc-backref" href="#contents">Bugs</a></h1>
  6931. <p>Probably lots, please post them to the mailing list (see <a class="reference internal" href="#resources">Resources</a>
  6932. below) when you find them.</p>
  6933. </div>
  6934. <div class="section" id="see-also">
  6935. <h1><a class="toc-backref" href="#contents">See Also</a></h1>
  6936. <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>
  6937. </div>
  6938. <div class="section" id="author">
  6939. <h1><a class="toc-backref" href="#contents">Author</a></h1>
  6940. <p>Written by Matt Mackall &lt;<a class="reference external" href="mailto:mpm&#64;selenic.com">mpm&#64;selenic.com</a>&gt;</p>
  6941. </div>
  6942. <div class="section" id="resources">
  6943. <h1><a class="toc-backref" href="#contents">Resources</a></h1>
  6944. <p>Main Web Site: <a class="reference external" href="http://mercurial.selenic.com/">http://mercurial.selenic.com/</a></p>
  6945. <p>Source code repository: <a class="reference external" href="http://selenic.com/hg">http://selenic.com/hg</a></p>
  6946. <p>Mailing list: <a class="reference external" href="http://selenic.com/mailman/listinfo/mercurial">http://selenic.com/mailman/listinfo/mercurial</a></p>
  6947. </div>
  6948. <div class="section" id="copying">
  6949. <h1><a class="toc-backref" href="#contents">Copying</a></h1>
  6950. <p>Copyright (C) 2005-2010 Matt Mackall.
  6951. Free use of this software is granted under the terms of the GNU General
  6952. Public License version 2 or any later version.</p>
  6953. <!-- Common link and substitution definitions. -->
  6954. </div>
  6955. </div>
  6956. </body>
  6957. </html>
# Change User Description Committed
#1 7918 Sven Erik Knop Added Mercurial Exporter to Perforce Mk 1. 14 years ago