Debian Codegraph @

doc/html/hg-bookmarks.html

raw
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.21.2: https://docutils.sourceforge.io/" />
7 <title>hg bookmarks</title>
8 <link rel="stylesheet" href="../style.css" type="text/css" />
9 </head>
10 <body>
11 <div class="document" id="hg-bookmarks">
12 <span id="hg-bookmarks-1"></span>
13 <h1 class="title">hg bookmarks</h1>
14 <h2 class="subtitle" id="create-a-new-bookmark-or-list-existing-bookmarks">create a new bookmark or list existing bookmarks</h2>
15
16 <div class="contents htmlonly topic" id="contents">
17 <p class="topic-title"><a class="reference internal" href="#top">Contents</a></p>
18 <ul class="simple">
19 <li><a class="reference internal" href="#synopsis" id="toc-entry-1">Synopsis</a></li>
20 <li><a class="reference internal" href="#description" id="toc-entry-2">Description</a></li>
21 <li><a class="reference internal" href="#options" id="toc-entry-3">Options</a></li>
22 <li><a class="reference internal" href="#aliases" id="toc-entry-4">Aliases</a></li>
23 </ul>
24 </div>
25 <div class="section" id="synopsis">
26 <h1><a class="toc-backref" href="#contents">Synopsis</a></h1>
27 <pre class="literal-block">
28 hg bookmarks [OPTIONS]... [NAME]...
29 </pre>
30 </div>
31 <div class="section" id="description">
32 <h1><a class="toc-backref" href="#contents">Description</a></h1>
33 <p>Bookmarks are labels on changesets to help track lines of development.
34 Bookmarks are unversioned and can be moved, renamed and deleted.
35 Deleting or moving a bookmark has no effect on the associated changesets.</p>
36 <p>Creating or updating to a bookmark causes it to be marked as 'active'.
37 The active bookmark is indicated with a '*'.
38 When a commit is made, the active bookmark will advance to the new commit.
39 A plain <a class="reference external" href="hg-update.html"><tt class="docutils literal">hg update</tt></a> will also advance an active bookmark, if possible.
40 Updating away from a bookmark will cause it to be deactivated.</p>
41 <p>Bookmarks can be pushed and pulled between repositories (see
42 <a class="reference external" href="hg-push.html"><tt class="docutils literal">hg help push</tt></a> and <a class="reference external" href="hg-pull.html"><tt class="docutils literal">hg help pull</tt></a>). If a shared bookmark has
43 diverged, a new 'divergent bookmark' of the form <a class="reference external" href="mailto:'name&#64;path">'name&#64;path</a>' will
44 be created. Using <a class="reference external" href="hg-merge.html"><tt class="docutils literal">hg merge</tt></a> will resolve the divergence.</p>
45 <p>Specifying bookmark as '.' to -m/-d/-l options is equivalent to specifying
46 the active bookmark's name.</p>
47 <p>A bookmark named '&#64;' has the special property that <a class="reference external" href="hg-clone.html"><tt class="docutils literal">hg clone</tt></a> will
48 check it out by default if it exists.</p>
49 <div class="verbose docutils container">
50 <p>Template:</p>
51 <p>The following keywords are supported in addition to the common template
52 keywords and functions such as <tt class="docutils literal">{bookmark}</tt>. See also
53 <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a>.</p>
54 <table class="docutils field-list" frame="void" rules="none">
55 <col class="field-name" />
56 <col class="field-body" />
57 <tbody valign="top">
58 <tr class="field"><th class="field-name">active:</th><td class="field-body">Boolean. True if the bookmark is active.</td>
59 </tr>
60 </tbody>
61 </table>
62 <p>Examples:</p>
63 <ul>
64 <li><p class="first">create an active bookmark for a new line of development:</p>
65 <pre class="literal-block">
66 hg book new-feature
67 </pre>
68 </li>
69 <li><p class="first">create an inactive bookmark as a place marker:</p>
70 <pre class="literal-block">
71 hg book -i reviewed
72 </pre>
73 </li>
74 <li><p class="first">create an inactive bookmark on another changeset:</p>
75 <pre class="literal-block">
76 hg book -r .^ tested
77 </pre>
78 </li>
79 <li><p class="first">rename bookmark turkey to dinner:</p>
80 <pre class="literal-block">
81 hg book -m turkey dinner
82 </pre>
83 </li>
84 <li><p class="first">move the '&#64;' bookmark from another branch:</p>
85 <pre class="literal-block">
86 hg book -f &#64;
87 </pre>
88 </li>
89 <li><p class="first">print only the active bookmark name:</p>
90 <pre class="literal-block">
91 hg book -ql .
92 </pre>
93 </li>
94 </ul>
95 </div>
96 </div>
97 <div class="section" id="options">
98 <h1><a class="toc-backref" href="#contents">Options</a></h1>
99 <table class="docutils option-list" frame="void" rules="none">
100 <col class="option" />
101 <col class="description" />
102 <tbody valign="top">
103 <tr><td class="option-group">
104 <kbd><span class="option">-f</span>, <span class="option">--force</span></kbd></td>
105 <td>force</td></tr>
106 <tr><td class="option-group" colspan="2">
107 <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV&gt;</var></span></kbd></td>
108 </tr>
109 <tr><td>&nbsp;</td><td>revision for bookmark action</td></tr>
110 <tr><td class="option-group">
111 <kbd><span class="option">-d</span>, <span class="option">--delete</span></kbd></td>
112 <td>delete a given bookmark</td></tr>
113 <tr><td class="option-group" colspan="2">
114 <kbd><span class="option">-m</span>, <span class="option">--rename <var>&lt;OLD&gt;</var></span></kbd></td>
115 </tr>
116 <tr><td>&nbsp;</td><td>rename a given bookmark</td></tr>
117 <tr><td class="option-group">
118 <kbd><span class="option">-i</span>, <span class="option">--inactive</span></kbd></td>
119 <td>mark a bookmark inactive</td></tr>
120 <tr><td class="option-group">
121 <kbd><span class="option">-l</span>, <span class="option">--list</span></kbd></td>
122 <td>list existing bookmarks</td></tr>
123 <tr><td class="option-group" colspan="2">
124 <kbd><span class="option">-T</span>, <span class="option">--template <var>&lt;TEMPLATE&gt;</var></span></kbd></td>
125 </tr>
126 <tr><td>&nbsp;</td><td>display with template</td></tr>
127 </tbody>
128 </table>
129 </div>
130 <div class="section" id="aliases">
131 <h1><a class="toc-backref" href="#contents">Aliases</a></h1>
132 <pre class="literal-block">
133 bookmark
134 </pre>
135 </div>
136 </div>
137 </body>
138 </html>