##// END OF EJS Templates
templates: make earlycommands and othercommands optional...
Gregory Szorc -
r27578:d35ff0b0 default
parent child Browse files
Show More
@@ -1,40 +1,45 b''
1 1 {header}
2 2 <title>Help: {title}</title>
3 3 <link rel="alternate" type="application/atom+xml"
4 4 href="{url|urlescape}atom-log" title="Atom feed for {repo|escape}"/>
5 5 <link rel="alternate" type="application/rss+xml"
6 6 href="{url|urlescape}rss-log" title="RSS feed for {repo|escape}"/>
7 7 </head>
8 8 <body>
9 9
10 10 <div class="page_header">
11 11 <a href="{logourl}" title="Mercurial" style="float: right;">Mercurial</a>
12 12 <a href="/">Mercurial</a> {pathdef%breadcrumb} / help
13 13 </div>
14 14
15 15 <div class="page_nav">
16 16 <a href="{url|urlescape}summary{sessionvars%urlparameter}">summary</a> |
17 17 <a href="{url|urlescape}shortlog{sessionvars%urlparameter}">shortlog</a> |
18 18 <a href="{url|urlescape}log{sessionvars%urlparameter}">changelog</a> |
19 19 <a href="{url|urlescape}graph{sessionvars%urlparameter}">graph</a> |
20 20 <a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a> |
21 21 <a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a> |
22 22 <a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a> |
23 23 <a href="{url|urlescape}file{sessionvars%urlparameter}">files</a> |
24 24 help
25 25 <br/>
26 26 </div>
27 27
28 28 <div class="title">&nbsp;</div>
29 29 <table cellspacing="0">
30 30 <tr><td colspan="2"><h2><a name="main" href="#topics">Topics</a></h2></td></tr>
31 31 {topics % helpentry}
32 32
33 {if(earlycommands, '
33 34 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
34 35 {earlycommands % helpentry}
36 ')}
35 37
38 {if(othercommands, '
36 39 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
37 40 {othercommands % helpentry}
41 ')}
42
38 43 </table>
39 44
40 45 {footer}
@@ -1,45 +1,49 b''
1 1 {header}
2 2 <title>Help: {title}</title>
3 3 <link rel="alternate" type="application/atom+xml" href="{url|urlescape}atom-log" title="Atom feed for {repo|escape}"/>
4 4 <link rel="alternate" type="application/rss+xml" href="{url|urlescape}rss-log" title="RSS feed for {repo|escape}"/>
5 5 </head>
6 6
7 7 <body>
8 8 <div id="container">
9 9 <div class="page-header">
10 10 <h1 class="breadcrumb"><a href="/">Mercurial</a> {pathdef%breadcrumb} / help</h1>
11 11
12 12 <form action="{url|urlescape}log">
13 13 {sessionvars%hiddenformentry}
14 14 <dl class="search">
15 15 <dt><label>Search: </label></dt>
16 16 <dd><input type="text" name="rev" /></dd>
17 17 </dl>
18 18 </form>
19 19
20 20 <ul class="page-nav">
21 21 <li><a href="{url|urlescape}summary{sessionvars%urlparameter}">summary</a></li>
22 22 <li><a href="{url|urlescape}shortlog{sessionvars%urlparameter}">shortlog</a></li>
23 23 <li><a href="{url|urlescape}changelog{sessionvars%urlparameter}">changelog</a></li>
24 24 <li><a href="{url|urlescape}graph{sessionvars%urlparameter}">graph</a></li>
25 25 <li><a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a></li>
26 26 <li><a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a></li>
27 27 <li><a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a></li>
28 28 <li><a href="{url|urlescape}file{sessionvars%urlparameter}">files</a></li>
29 29 <li class="current">help</li>
30 30 </ul>
31 31 </div>
32 32
33 33 <h2 class="no-link no-border">help</h2>
34 34 <table cellspacing="0">
35 35 <tr><td colspan="2"><h2><a name="main" href="#topics">Topics</a></h2></td></tr>
36 36 {topics % helpentry}
37 37
38 {if(earlycommands, '
38 39 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
39 40 {earlycommands % helpentry}
41 ')}
40 42
43 {if(othercommands, '
41 44 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
42 45 {othercommands % helpentry}
46 ')}
43 47 </table>
44 48
45 49 {footer}
@@ -1,44 +1,49 b''
1 1 {header}
2 2 <title>Help: {title}</title>
3 3 </head>
4 4 <body>
5 5
6 6 <div class="container">
7 7 <div class="menu">
8 8 <div class="logo">
9 9 <a href="{logourl}">
10 10 <img src="{staticurl|urlescape}{logoimg}" alt="mercurial" /></a>
11 11 </div>
12 12 <ul>
13 13 <li><a href="{url|urlescape}shortlog{sessionvars%urlparameter}">log</a></li>
14 14 <li><a href="{url|urlescape}graph{sessionvars%urlparameter}">graph</a></li>
15 15 <li><a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a></li>
16 16 <li><a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a></li>
17 17 <li><a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a></li>
18 18 </ul>
19 19 <ul>
20 20 <li class="active">help</li>
21 21 </ul>
22 22 </div>
23 23
24 24 <div class="main">
25 25 <h2 class="breadcrumb"><a href="/">Mercurial</a> {pathdef%breadcrumb}</h2>
26 26 <form class="search" action="{url|urlescape}log">
27 27 {sessionvars%hiddenformentry}
28 28 <p><input name="rev" id="search1" type="text" size="30" /></p>
29 29 <div id="hint">{searchhint}</div>
30 30 </form>
31 31 <table class="bigtable">
32 32 <tr><td colspan="2"><h2><a name="main" href="#topics">Topics</a></h2></td></tr>
33 33 {topics % helpentry}
34 34
35 {if(earlycommands, '
35 36 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
36 37 {earlycommands % helpentry}
38 ')}
37 39
40 {if(othercommands, '
38 41 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
39 42 {othercommands % helpentry}
43 ')}
44
40 45 </table>
41 46 </div>
42 47 </div>
43 48
44 49 {footer}
@@ -1,2631 +1,2636 b''
1 1 Short help:
2 2
3 3 $ hg
4 4 Mercurial Distributed SCM
5 5
6 6 basic commands:
7 7
8 8 add add the specified files on the next commit
9 9 annotate show changeset information by line for each file
10 10 clone make a copy of an existing repository
11 11 commit commit the specified files or all outstanding changes
12 12 diff diff repository (or selected files)
13 13 export dump the header and diffs for one or more changesets
14 14 forget forget the specified files on the next commit
15 15 init create a new repository in the given directory
16 16 log show revision history of entire repository or files
17 17 merge merge another revision into working directory
18 18 pull pull changes from the specified source
19 19 push push changes to the specified destination
20 20 remove remove the specified files on the next commit
21 21 serve start stand-alone webserver
22 22 status show changed files in the working directory
23 23 summary summarize working directory state
24 24 update update working directory (or switch revisions)
25 25
26 26 (use "hg help" for the full list of commands or "hg -v" for details)
27 27
28 28 $ hg -q
29 29 add add the specified files on the next commit
30 30 annotate show changeset information by line for each file
31 31 clone make a copy of an existing repository
32 32 commit commit the specified files or all outstanding changes
33 33 diff diff repository (or selected files)
34 34 export dump the header and diffs for one or more changesets
35 35 forget forget the specified files on the next commit
36 36 init create a new repository in the given directory
37 37 log show revision history of entire repository or files
38 38 merge merge another revision into working directory
39 39 pull pull changes from the specified source
40 40 push push changes to the specified destination
41 41 remove remove the specified files on the next commit
42 42 serve start stand-alone webserver
43 43 status show changed files in the working directory
44 44 summary summarize working directory state
45 45 update update working directory (or switch revisions)
46 46
47 47 $ hg help
48 48 Mercurial Distributed SCM
49 49
50 50 list of commands:
51 51
52 52 add add the specified files on the next commit
53 53 addremove add all new files, delete all missing files
54 54 annotate show changeset information by line for each file
55 55 archive create an unversioned archive of a repository revision
56 56 backout reverse effect of earlier changeset
57 57 bisect subdivision search of changesets
58 58 bookmarks create a new bookmark or list existing bookmarks
59 59 branch set or show the current branch name
60 60 branches list repository named branches
61 61 bundle create a changegroup file
62 62 cat output the current or given revision of files
63 63 clone make a copy of an existing repository
64 64 commit commit the specified files or all outstanding changes
65 65 config show combined config settings from all hgrc files
66 66 copy mark files as copied for the next commit
67 67 diff diff repository (or selected files)
68 68 export dump the header and diffs for one or more changesets
69 69 files list tracked files
70 70 forget forget the specified files on the next commit
71 71 graft copy changes from other branches onto the current branch
72 72 grep search for a pattern in specified files and revisions
73 73 heads show branch heads
74 74 help show help for a given topic or a help overview
75 75 identify identify the working directory or specified revision
76 76 import import an ordered set of patches
77 77 incoming show new changesets found in source
78 78 init create a new repository in the given directory
79 79 log show revision history of entire repository or files
80 80 manifest output the current or given revision of the project manifest
81 81 merge merge another revision into working directory
82 82 outgoing show changesets not found in the destination
83 83 paths show aliases for remote repositories
84 84 phase set or show the current phase name
85 85 pull pull changes from the specified source
86 86 push push changes to the specified destination
87 87 recover roll back an interrupted transaction
88 88 remove remove the specified files on the next commit
89 89 rename rename files; equivalent of copy + remove
90 90 resolve redo merges or set/view the merge status of files
91 91 revert restore files to their checkout state
92 92 root print the root (top) of the current working directory
93 93 serve start stand-alone webserver
94 94 status show changed files in the working directory
95 95 summary summarize working directory state
96 96 tag add one or more tags for the current or given revision
97 97 tags list repository tags
98 98 unbundle apply one or more changegroup files
99 99 update update working directory (or switch revisions)
100 100 verify verify the integrity of the repository
101 101 version output version and copyright information
102 102
103 103 additional help topics:
104 104
105 105 config Configuration Files
106 106 dates Date Formats
107 107 diffs Diff Formats
108 108 environment Environment Variables
109 109 extensions Using Additional Features
110 110 filesets Specifying File Sets
111 111 glossary Glossary
112 112 hgignore Syntax for Mercurial Ignore Files
113 113 hgweb Configuring hgweb
114 114 internals Technical implementation topics
115 115 merge-tools Merge Tools
116 116 multirevs Specifying Multiple Revisions
117 117 patterns File Name Patterns
118 118 phases Working with Phases
119 119 revisions Specifying Single Revisions
120 120 revsets Specifying Revision Sets
121 121 scripting Using Mercurial from scripts and automation
122 122 subrepos Subrepositories
123 123 templating Template Usage
124 124 urls URL Paths
125 125
126 126 (use "hg help -v" to show built-in aliases and global options)
127 127
128 128 $ hg -q help
129 129 add add the specified files on the next commit
130 130 addremove add all new files, delete all missing files
131 131 annotate show changeset information by line for each file
132 132 archive create an unversioned archive of a repository revision
133 133 backout reverse effect of earlier changeset
134 134 bisect subdivision search of changesets
135 135 bookmarks create a new bookmark or list existing bookmarks
136 136 branch set or show the current branch name
137 137 branches list repository named branches
138 138 bundle create a changegroup file
139 139 cat output the current or given revision of files
140 140 clone make a copy of an existing repository
141 141 commit commit the specified files or all outstanding changes
142 142 config show combined config settings from all hgrc files
143 143 copy mark files as copied for the next commit
144 144 diff diff repository (or selected files)
145 145 export dump the header and diffs for one or more changesets
146 146 files list tracked files
147 147 forget forget the specified files on the next commit
148 148 graft copy changes from other branches onto the current branch
149 149 grep search for a pattern in specified files and revisions
150 150 heads show branch heads
151 151 help show help for a given topic or a help overview
152 152 identify identify the working directory or specified revision
153 153 import import an ordered set of patches
154 154 incoming show new changesets found in source
155 155 init create a new repository in the given directory
156 156 log show revision history of entire repository or files
157 157 manifest output the current or given revision of the project manifest
158 158 merge merge another revision into working directory
159 159 outgoing show changesets not found in the destination
160 160 paths show aliases for remote repositories
161 161 phase set or show the current phase name
162 162 pull pull changes from the specified source
163 163 push push changes to the specified destination
164 164 recover roll back an interrupted transaction
165 165 remove remove the specified files on the next commit
166 166 rename rename files; equivalent of copy + remove
167 167 resolve redo merges or set/view the merge status of files
168 168 revert restore files to their checkout state
169 169 root print the root (top) of the current working directory
170 170 serve start stand-alone webserver
171 171 status show changed files in the working directory
172 172 summary summarize working directory state
173 173 tag add one or more tags for the current or given revision
174 174 tags list repository tags
175 175 unbundle apply one or more changegroup files
176 176 update update working directory (or switch revisions)
177 177 verify verify the integrity of the repository
178 178 version output version and copyright information
179 179
180 180 additional help topics:
181 181
182 182 config Configuration Files
183 183 dates Date Formats
184 184 diffs Diff Formats
185 185 environment Environment Variables
186 186 extensions Using Additional Features
187 187 filesets Specifying File Sets
188 188 glossary Glossary
189 189 hgignore Syntax for Mercurial Ignore Files
190 190 hgweb Configuring hgweb
191 191 internals Technical implementation topics
192 192 merge-tools Merge Tools
193 193 multirevs Specifying Multiple Revisions
194 194 patterns File Name Patterns
195 195 phases Working with Phases
196 196 revisions Specifying Single Revisions
197 197 revsets Specifying Revision Sets
198 198 scripting Using Mercurial from scripts and automation
199 199 subrepos Subrepositories
200 200 templating Template Usage
201 201 urls URL Paths
202 202
203 203 Test extension help:
204 204 $ hg help extensions --config extensions.rebase= --config extensions.children=
205 205 Using Additional Features
206 206 """""""""""""""""""""""""
207 207
208 208 Mercurial has the ability to add new features through the use of
209 209 extensions. Extensions may add new commands, add options to existing
210 210 commands, change the default behavior of commands, or implement hooks.
211 211
212 212 To enable the "foo" extension, either shipped with Mercurial or in the
213 213 Python search path, create an entry for it in your configuration file,
214 214 like this:
215 215
216 216 [extensions]
217 217 foo =
218 218
219 219 You may also specify the full path to an extension:
220 220
221 221 [extensions]
222 222 myfeature = ~/.hgext/myfeature.py
223 223
224 224 See "hg help config" for more information on configuration files.
225 225
226 226 Extensions are not loaded by default for a variety of reasons: they can
227 227 increase startup overhead; they may be meant for advanced usage only; they
228 228 may provide potentially dangerous abilities (such as letting you destroy
229 229 or modify history); they might not be ready for prime time; or they may
230 230 alter some usual behaviors of stock Mercurial. It is thus up to the user
231 231 to activate extensions as needed.
232 232
233 233 To explicitly disable an extension enabled in a configuration file of
234 234 broader scope, prepend its path with !:
235 235
236 236 [extensions]
237 237 # disabling extension bar residing in /path/to/extension/bar.py
238 238 bar = !/path/to/extension/bar.py
239 239 # ditto, but no path was supplied for extension baz
240 240 baz = !
241 241
242 242 enabled extensions:
243 243
244 244 children command to display child changesets (DEPRECATED)
245 245 rebase command to move sets of revisions to a different ancestor
246 246
247 247 disabled extensions:
248 248
249 249 acl hooks for controlling repository access
250 250 blackbox log repository events to a blackbox for debugging
251 251 bugzilla hooks for integrating with the Bugzilla bug tracker
252 252 censor erase file content at a given revision
253 253 churn command to display statistics about repository history
254 254 clonebundles advertise pre-generated bundles to seed clones
255 255 (experimental)
256 256 color colorize output from some commands
257 257 convert import revisions from foreign VCS repositories into
258 258 Mercurial
259 259 eol automatically manage newlines in repository files
260 260 extdiff command to allow external programs to compare revisions
261 261 factotum http authentication with factotum
262 262 gpg commands to sign and verify changesets
263 263 hgcia hooks for integrating with the CIA.vc notification service
264 264 hgk browse the repository in a graphical way
265 265 highlight syntax highlighting for hgweb (requires Pygments)
266 266 histedit interactive history editing
267 267 keyword expand keywords in tracked files
268 268 largefiles track large binary files
269 269 mq manage a stack of patches
270 270 notify hooks for sending email push notifications
271 271 pager browse command output with an external pager
272 272 patchbomb command to send changesets as (a series of) patch emails
273 273 purge command to delete untracked files from the working
274 274 directory
275 275 record commands to interactively select changes for
276 276 commit/qrefresh
277 277 relink recreates hardlinks between repository clones
278 278 schemes extend schemes with shortcuts to repository swarms
279 279 share share a common history between several working directories
280 280 shelve save and restore changes to the working directory
281 281 strip strip changesets and their descendants from history
282 282 transplant command to transplant changesets from another branch
283 283 win32mbcs allow the use of MBCS paths with problematic encodings
284 284 zeroconf discover and advertise repositories on the local network
285 285
286 286 Verify that extension keywords appear in help templates
287 287
288 288 $ hg help --config extensions.transplant= templating|grep transplant > /dev/null
289 289
290 290 Test short command list with verbose option
291 291
292 292 $ hg -v help shortlist
293 293 Mercurial Distributed SCM
294 294
295 295 basic commands:
296 296
297 297 add add the specified files on the next commit
298 298 annotate, blame
299 299 show changeset information by line for each file
300 300 clone make a copy of an existing repository
301 301 commit, ci commit the specified files or all outstanding changes
302 302 diff diff repository (or selected files)
303 303 export dump the header and diffs for one or more changesets
304 304 forget forget the specified files on the next commit
305 305 init create a new repository in the given directory
306 306 log, history show revision history of entire repository or files
307 307 merge merge another revision into working directory
308 308 pull pull changes from the specified source
309 309 push push changes to the specified destination
310 310 remove, rm remove the specified files on the next commit
311 311 serve start stand-alone webserver
312 312 status, st show changed files in the working directory
313 313 summary, sum summarize working directory state
314 314 update, up, checkout, co
315 315 update working directory (or switch revisions)
316 316
317 317 global options ([+] can be repeated):
318 318
319 319 -R --repository REPO repository root directory or name of overlay bundle
320 320 file
321 321 --cwd DIR change working directory
322 322 -y --noninteractive do not prompt, automatically pick the first choice for
323 323 all prompts
324 324 -q --quiet suppress output
325 325 -v --verbose enable additional output
326 326 --config CONFIG [+] set/override config option (use 'section.name=value')
327 327 --debug enable debugging output
328 328 --debugger start debugger
329 329 --encoding ENCODE set the charset encoding (default: ascii)
330 330 --encodingmode MODE set the charset encoding mode (default: strict)
331 331 --traceback always print a traceback on exception
332 332 --time time how long the command takes
333 333 --profile print command execution profile
334 334 --version output version information and exit
335 335 -h --help display help and exit
336 336 --hidden consider hidden changesets
337 337
338 338 (use "hg help" for the full list of commands)
339 339
340 340 $ hg add -h
341 341 hg add [OPTION]... [FILE]...
342 342
343 343 add the specified files on the next commit
344 344
345 345 Schedule files to be version controlled and added to the repository.
346 346
347 347 The files will be added to the repository at the next commit. To undo an
348 348 add before that, see "hg forget".
349 349
350 350 If no names are given, add all files to the repository (except files
351 351 matching ".hgignore").
352 352
353 353 Returns 0 if all files are successfully added.
354 354
355 355 options ([+] can be repeated):
356 356
357 357 -I --include PATTERN [+] include names matching the given patterns
358 358 -X --exclude PATTERN [+] exclude names matching the given patterns
359 359 -S --subrepos recurse into subrepositories
360 360 -n --dry-run do not perform actions, just print output
361 361
362 362 (some details hidden, use --verbose to show complete help)
363 363
364 364 Verbose help for add
365 365
366 366 $ hg add -hv
367 367 hg add [OPTION]... [FILE]...
368 368
369 369 add the specified files on the next commit
370 370
371 371 Schedule files to be version controlled and added to the repository.
372 372
373 373 The files will be added to the repository at the next commit. To undo an
374 374 add before that, see "hg forget".
375 375
376 376 If no names are given, add all files to the repository (except files
377 377 matching ".hgignore").
378 378
379 379 Examples:
380 380
381 381 - New (unknown) files are added automatically by "hg add":
382 382
383 383 $ ls
384 384 foo.c
385 385 $ hg status
386 386 ? foo.c
387 387 $ hg add
388 388 adding foo.c
389 389 $ hg status
390 390 A foo.c
391 391
392 392 - Specific files to be added can be specified:
393 393
394 394 $ ls
395 395 bar.c foo.c
396 396 $ hg status
397 397 ? bar.c
398 398 ? foo.c
399 399 $ hg add bar.c
400 400 $ hg status
401 401 A bar.c
402 402 ? foo.c
403 403
404 404 Returns 0 if all files are successfully added.
405 405
406 406 options ([+] can be repeated):
407 407
408 408 -I --include PATTERN [+] include names matching the given patterns
409 409 -X --exclude PATTERN [+] exclude names matching the given patterns
410 410 -S --subrepos recurse into subrepositories
411 411 -n --dry-run do not perform actions, just print output
412 412
413 413 global options ([+] can be repeated):
414 414
415 415 -R --repository REPO repository root directory or name of overlay bundle
416 416 file
417 417 --cwd DIR change working directory
418 418 -y --noninteractive do not prompt, automatically pick the first choice for
419 419 all prompts
420 420 -q --quiet suppress output
421 421 -v --verbose enable additional output
422 422 --config CONFIG [+] set/override config option (use 'section.name=value')
423 423 --debug enable debugging output
424 424 --debugger start debugger
425 425 --encoding ENCODE set the charset encoding (default: ascii)
426 426 --encodingmode MODE set the charset encoding mode (default: strict)
427 427 --traceback always print a traceback on exception
428 428 --time time how long the command takes
429 429 --profile print command execution profile
430 430 --version output version information and exit
431 431 -h --help display help and exit
432 432 --hidden consider hidden changesets
433 433
434 434 Test help option with version option
435 435
436 436 $ hg add -h --version
437 437 Mercurial Distributed SCM (version *) (glob)
438 438 (see https://mercurial-scm.org for more information)
439 439
440 440 Copyright (C) 2005-2015 Matt Mackall and others
441 441 This is free software; see the source for copying conditions. There is NO
442 442 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
443 443
444 444 $ hg add --skjdfks
445 445 hg add: option --skjdfks not recognized
446 446 hg add [OPTION]... [FILE]...
447 447
448 448 add the specified files on the next commit
449 449
450 450 options ([+] can be repeated):
451 451
452 452 -I --include PATTERN [+] include names matching the given patterns
453 453 -X --exclude PATTERN [+] exclude names matching the given patterns
454 454 -S --subrepos recurse into subrepositories
455 455 -n --dry-run do not perform actions, just print output
456 456
457 457 (use "hg add -h" to show more help)
458 458 [255]
459 459
460 460 Test ambiguous command help
461 461
462 462 $ hg help ad
463 463 list of commands:
464 464
465 465 add add the specified files on the next commit
466 466 addremove add all new files, delete all missing files
467 467
468 468 (use "hg help -v ad" to show built-in aliases and global options)
469 469
470 470 Test command without options
471 471
472 472 $ hg help verify
473 473 hg verify
474 474
475 475 verify the integrity of the repository
476 476
477 477 Verify the integrity of the current repository.
478 478
479 479 This will perform an extensive check of the repository's integrity,
480 480 validating the hashes and checksums of each entry in the changelog,
481 481 manifest, and tracked files, as well as the integrity of their crosslinks
482 482 and indices.
483 483
484 484 Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more
485 485 information about recovery from corruption of the repository.
486 486
487 487 Returns 0 on success, 1 if errors are encountered.
488 488
489 489 (some details hidden, use --verbose to show complete help)
490 490
491 491 $ hg help diff
492 492 hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
493 493
494 494 diff repository (or selected files)
495 495
496 496 Show differences between revisions for the specified files.
497 497
498 498 Differences between files are shown using the unified diff format.
499 499
500 500 Note:
501 501 "hg diff" may generate unexpected results for merges, as it will
502 502 default to comparing against the working directory's first parent
503 503 changeset if no revisions are specified.
504 504
505 505 When two revision arguments are given, then changes are shown between
506 506 those revisions. If only one revision is specified then that revision is
507 507 compared to the working directory, and, when no revisions are specified,
508 508 the working directory files are compared to its first parent.
509 509
510 510 Alternatively you can specify -c/--change with a revision to see the
511 511 changes in that changeset relative to its first parent.
512 512
513 513 Without the -a/--text option, diff will avoid generating diffs of files it
514 514 detects as binary. With -a, diff will generate a diff anyway, probably
515 515 with undesirable results.
516 516
517 517 Use the -g/--git option to generate diffs in the git extended diff format.
518 518 For more information, read "hg help diffs".
519 519
520 520 Returns 0 on success.
521 521
522 522 options ([+] can be repeated):
523 523
524 524 -r --rev REV [+] revision
525 525 -c --change REV change made by revision
526 526 -a --text treat all files as text
527 527 -g --git use git extended diff format
528 528 --nodates omit dates from diff headers
529 529 --noprefix omit a/ and b/ prefixes from filenames
530 530 -p --show-function show which function each change is in
531 531 --reverse produce a diff that undoes the changes
532 532 -w --ignore-all-space ignore white space when comparing lines
533 533 -b --ignore-space-change ignore changes in the amount of white space
534 534 -B --ignore-blank-lines ignore changes whose lines are all blank
535 535 -U --unified NUM number of lines of context to show
536 536 --stat output diffstat-style summary of changes
537 537 --root DIR produce diffs relative to subdirectory
538 538 -I --include PATTERN [+] include names matching the given patterns
539 539 -X --exclude PATTERN [+] exclude names matching the given patterns
540 540 -S --subrepos recurse into subrepositories
541 541
542 542 (some details hidden, use --verbose to show complete help)
543 543
544 544 $ hg help status
545 545 hg status [OPTION]... [FILE]...
546 546
547 547 aliases: st
548 548
549 549 show changed files in the working directory
550 550
551 551 Show status of files in the repository. If names are given, only files
552 552 that match are shown. Files that are clean or ignored or the source of a
553 553 copy/move operation, are not listed unless -c/--clean, -i/--ignored,
554 554 -C/--copies or -A/--all are given. Unless options described with "show
555 555 only ..." are given, the options -mardu are used.
556 556
557 557 Option -q/--quiet hides untracked (unknown and ignored) files unless
558 558 explicitly requested with -u/--unknown or -i/--ignored.
559 559
560 560 Note:
561 561 "hg status" may appear to disagree with diff if permissions have
562 562 changed or a merge has occurred. The standard diff format does not
563 563 report permission changes and diff only reports changes relative to one
564 564 merge parent.
565 565
566 566 If one revision is given, it is used as the base revision. If two
567 567 revisions are given, the differences between them are shown. The --change
568 568 option can also be used as a shortcut to list the changed files of a
569 569 revision from its first parent.
570 570
571 571 The codes used to show the status of files are:
572 572
573 573 M = modified
574 574 A = added
575 575 R = removed
576 576 C = clean
577 577 ! = missing (deleted by non-hg command, but still tracked)
578 578 ? = not tracked
579 579 I = ignored
580 580 = origin of the previous file (with --copies)
581 581
582 582 Returns 0 on success.
583 583
584 584 options ([+] can be repeated):
585 585
586 586 -A --all show status of all files
587 587 -m --modified show only modified files
588 588 -a --added show only added files
589 589 -r --removed show only removed files
590 590 -d --deleted show only deleted (but tracked) files
591 591 -c --clean show only files without changes
592 592 -u --unknown show only unknown (not tracked) files
593 593 -i --ignored show only ignored files
594 594 -n --no-status hide status prefix
595 595 -C --copies show source of copied files
596 596 -0 --print0 end filenames with NUL, for use with xargs
597 597 --rev REV [+] show difference from revision
598 598 --change REV list the changed files of a revision
599 599 -I --include PATTERN [+] include names matching the given patterns
600 600 -X --exclude PATTERN [+] exclude names matching the given patterns
601 601 -S --subrepos recurse into subrepositories
602 602
603 603 (some details hidden, use --verbose to show complete help)
604 604
605 605 $ hg -q help status
606 606 hg status [OPTION]... [FILE]...
607 607
608 608 show changed files in the working directory
609 609
610 610 $ hg help foo
611 611 abort: no such help topic: foo
612 612 (try "hg help --keyword foo")
613 613 [255]
614 614
615 615 $ hg skjdfks
616 616 hg: unknown command 'skjdfks'
617 617 Mercurial Distributed SCM
618 618
619 619 basic commands:
620 620
621 621 add add the specified files on the next commit
622 622 annotate show changeset information by line for each file
623 623 clone make a copy of an existing repository
624 624 commit commit the specified files or all outstanding changes
625 625 diff diff repository (or selected files)
626 626 export dump the header and diffs for one or more changesets
627 627 forget forget the specified files on the next commit
628 628 init create a new repository in the given directory
629 629 log show revision history of entire repository or files
630 630 merge merge another revision into working directory
631 631 pull pull changes from the specified source
632 632 push push changes to the specified destination
633 633 remove remove the specified files on the next commit
634 634 serve start stand-alone webserver
635 635 status show changed files in the working directory
636 636 summary summarize working directory state
637 637 update update working directory (or switch revisions)
638 638
639 639 (use "hg help" for the full list of commands or "hg -v" for details)
640 640 [255]
641 641
642 642
643 643 Make sure that we don't run afoul of the help system thinking that
644 644 this is a section and erroring out weirdly.
645 645
646 646 $ hg .log
647 647 hg: unknown command '.log'
648 648 (did you mean one of log?)
649 649 [255]
650 650
651 651 $ hg log.
652 652 hg: unknown command 'log.'
653 653 (did you mean one of log?)
654 654 [255]
655 655 $ hg pu.lh
656 656 hg: unknown command 'pu.lh'
657 657 (did you mean one of pull, push?)
658 658 [255]
659 659
660 660 $ cat > helpext.py <<EOF
661 661 > import os
662 662 > from mercurial import cmdutil, commands
663 663 >
664 664 > cmdtable = {}
665 665 > command = cmdutil.command(cmdtable)
666 666 >
667 667 > @command('nohelp',
668 668 > [('', 'longdesc', 3, 'x'*90),
669 669 > ('n', '', None, 'normal desc'),
670 670 > ('', 'newline', '', 'line1\nline2')],
671 671 > 'hg nohelp',
672 672 > norepo=True)
673 673 > @command('debugoptDEP', [('', 'dopt', None, 'option is (DEPRECATED)')])
674 674 > @command('debugoptEXP', [('', 'eopt', None, 'option is (EXPERIMENTAL)')])
675 675 > def nohelp(ui, *args, **kwargs):
676 676 > pass
677 677 >
678 678 > EOF
679 679 $ echo '[extensions]' >> $HGRCPATH
680 680 $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
681 681
682 682 Test command with no help text
683 683
684 684 $ hg help nohelp
685 685 hg nohelp
686 686
687 687 (no help text available)
688 688
689 689 options:
690 690
691 691 --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
692 692 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (default: 3)
693 693 -n -- normal desc
694 694 --newline VALUE line1 line2
695 695
696 696 (some details hidden, use --verbose to show complete help)
697 697
698 698 $ hg help -k nohelp
699 699 Commands:
700 700
701 701 nohelp hg nohelp
702 702
703 703 Extension Commands:
704 704
705 705 nohelp (no help text available)
706 706
707 707 Test that default list of commands omits extension commands
708 708
709 709 $ hg help
710 710 Mercurial Distributed SCM
711 711
712 712 list of commands:
713 713
714 714 add add the specified files on the next commit
715 715 addremove add all new files, delete all missing files
716 716 annotate show changeset information by line for each file
717 717 archive create an unversioned archive of a repository revision
718 718 backout reverse effect of earlier changeset
719 719 bisect subdivision search of changesets
720 720 bookmarks create a new bookmark or list existing bookmarks
721 721 branch set or show the current branch name
722 722 branches list repository named branches
723 723 bundle create a changegroup file
724 724 cat output the current or given revision of files
725 725 clone make a copy of an existing repository
726 726 commit commit the specified files or all outstanding changes
727 727 config show combined config settings from all hgrc files
728 728 copy mark files as copied for the next commit
729 729 diff diff repository (or selected files)
730 730 export dump the header and diffs for one or more changesets
731 731 files list tracked files
732 732 forget forget the specified files on the next commit
733 733 graft copy changes from other branches onto the current branch
734 734 grep search for a pattern in specified files and revisions
735 735 heads show branch heads
736 736 help show help for a given topic or a help overview
737 737 identify identify the working directory or specified revision
738 738 import import an ordered set of patches
739 739 incoming show new changesets found in source
740 740 init create a new repository in the given directory
741 741 log show revision history of entire repository or files
742 742 manifest output the current or given revision of the project manifest
743 743 merge merge another revision into working directory
744 744 outgoing show changesets not found in the destination
745 745 paths show aliases for remote repositories
746 746 phase set or show the current phase name
747 747 pull pull changes from the specified source
748 748 push push changes to the specified destination
749 749 recover roll back an interrupted transaction
750 750 remove remove the specified files on the next commit
751 751 rename rename files; equivalent of copy + remove
752 752 resolve redo merges or set/view the merge status of files
753 753 revert restore files to their checkout state
754 754 root print the root (top) of the current working directory
755 755 serve start stand-alone webserver
756 756 status show changed files in the working directory
757 757 summary summarize working directory state
758 758 tag add one or more tags for the current or given revision
759 759 tags list repository tags
760 760 unbundle apply one or more changegroup files
761 761 update update working directory (or switch revisions)
762 762 verify verify the integrity of the repository
763 763 version output version and copyright information
764 764
765 765 enabled extensions:
766 766
767 767 helpext (no help text available)
768 768
769 769 additional help topics:
770 770
771 771 config Configuration Files
772 772 dates Date Formats
773 773 diffs Diff Formats
774 774 environment Environment Variables
775 775 extensions Using Additional Features
776 776 filesets Specifying File Sets
777 777 glossary Glossary
778 778 hgignore Syntax for Mercurial Ignore Files
779 779 hgweb Configuring hgweb
780 780 internals Technical implementation topics
781 781 merge-tools Merge Tools
782 782 multirevs Specifying Multiple Revisions
783 783 patterns File Name Patterns
784 784 phases Working with Phases
785 785 revisions Specifying Single Revisions
786 786 revsets Specifying Revision Sets
787 787 scripting Using Mercurial from scripts and automation
788 788 subrepos Subrepositories
789 789 templating Template Usage
790 790 urls URL Paths
791 791
792 792 (use "hg help -v" to show built-in aliases and global options)
793 793
794 794
795 795 Test list of internal help commands
796 796
797 797 $ hg help debug
798 798 debug commands (internal and unsupported):
799 799
800 800 debugancestor
801 801 find the ancestor revision of two revisions in a given index
802 802 debugapplystreamclonebundle
803 803 apply a stream clone bundle file
804 804 debugbuilddag
805 805 builds a repo with a given DAG from scratch in the current
806 806 empty repo
807 807 debugbundle lists the contents of a bundle
808 808 debugcheckstate
809 809 validate the correctness of the current dirstate
810 810 debugcommands
811 811 list all available commands and options
812 812 debugcomplete
813 813 returns the completion list associated with the given command
814 814 debugcreatestreamclonebundle
815 815 create a stream clone bundle file
816 816 debugdag format the changelog or an index DAG as a concise textual
817 817 description
818 818 debugdata dump the contents of a data file revision
819 819 debugdate parse and display a date
820 820 debugdeltachain
821 821 dump information about delta chains in a revlog
822 822 debugdirstate
823 823 show the contents of the current dirstate
824 824 debugdiscovery
825 825 runs the changeset discovery protocol in isolation
826 826 debugextensions
827 827 show information about active extensions
828 828 debugfileset parse and apply a fileset specification
829 829 debugfsinfo show information detected about current filesystem
830 830 debuggetbundle
831 831 retrieves a bundle from a repo
832 832 debugignore display the combined ignore pattern
833 833 debugindex dump the contents of an index file
834 834 debugindexdot
835 835 dump an index DAG as a graphviz dot file
836 836 debuginstall test Mercurial installation
837 837 debugknown test whether node ids are known to a repo
838 838 debuglocks show or modify state of locks
839 839 debugmergestate
840 840 print merge state
841 841 debugnamecomplete
842 842 complete "names" - tags, open branch names, bookmark names
843 843 debugobsolete
844 844 create arbitrary obsolete marker
845 845 debugoptDEP (no help text available)
846 846 debugoptEXP (no help text available)
847 847 debugpathcomplete
848 848 complete part or all of a tracked path
849 849 debugpushkey access the pushkey key/value protocol
850 850 debugpvec (no help text available)
851 851 debugrebuilddirstate
852 852 rebuild the dirstate as it would look like for the given
853 853 revision
854 854 debugrebuildfncache
855 855 rebuild the fncache file
856 856 debugrename dump rename information
857 857 debugrevlog show data and statistics about a revlog
858 858 debugrevspec parse and apply a revision specification
859 859 debugsetparents
860 860 manually set the parents of the current working directory
861 861 debugsub (no help text available)
862 862 debugsuccessorssets
863 863 show set of successors for revision
864 864 debugwalk show how files match on given patterns
865 865 debugwireargs
866 866 (no help text available)
867 867
868 868 (use "hg help -v debug" to show built-in aliases and global options)
869 869
870 870 internals topic renders index of available sub-topics
871 871
872 872 $ hg help internals
873 873 Technical implementation topics
874 874 """""""""""""""""""""""""""""""
875 875
876 876 bundles container for exchange of repository data
877 877 changegroups representation of revlog data
878 878
879 879 sub-topics can be accessed
880 880
881 881 $ hg help internals.changegroups
882 882 Changegroups
883 883 ============
884 884
885 885 Changegroups are representations of repository revlog data, specifically
886 886 the changelog, manifest, and filelogs.
887 887
888 888 There are 3 versions of changegroups: "1", "2", and "3". From a high-
889 889 level, versions "1" and "2" are almost exactly the same, with the only
890 890 difference being a header on entries in the changeset segment. Version "3"
891 891 adds support for exchanging treemanifests and includes revlog flags in the
892 892 delta header.
893 893
894 894 Changegroups consists of 3 logical segments:
895 895
896 896 +---------------------------------+
897 897 | | | |
898 898 | changeset | manifest | filelogs |
899 899 | | | |
900 900 +---------------------------------+
901 901
902 902 The principle building block of each segment is a *chunk*. A *chunk* is a
903 903 framed piece of data:
904 904
905 905 +---------------------------------------+
906 906 | | |
907 907 | length | data |
908 908 | (32 bits) | <length> bytes |
909 909 | | |
910 910 +---------------------------------------+
911 911
912 912 Each chunk starts with a 32-bit big-endian signed integer indicating the
913 913 length of the raw data that follows.
914 914
915 915 There is a special case chunk that has 0 length ("0x00000000"). We call
916 916 this an *empty chunk*.
917 917
918 918 Delta Groups
919 919 ------------
920 920
921 921 A *delta group* expresses the content of a revlog as a series of deltas,
922 922 or patches against previous revisions.
923 923
924 924 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
925 925 to signal the end of the delta group:
926 926
927 927 +------------------------------------------------------------------------+
928 928 | | | | | |
929 929 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
930 930 | (32 bits) | (various) | (32 bits) | (various) | (32 bits) |
931 931 | | | | | |
932 932 +------------------------------------------------------------+-----------+
933 933
934 934 Each *chunk*'s data consists of the following:
935 935
936 936 +-----------------------------------------+
937 937 | | | |
938 938 | delta header | mdiff header | delta |
939 939 | (various) | (12 bytes) | (various) |
940 940 | | | |
941 941 +-----------------------------------------+
942 942
943 943 The *length* field is the byte length of the remaining 3 logical pieces of
944 944 data. The *delta* is a diff from an existing entry in the changelog.
945 945
946 946 The *delta header* is different between versions "1", "2", and "3" of the
947 947 changegroup format.
948 948
949 949 Version 1:
950 950
951 951 +------------------------------------------------------+
952 952 | | | | |
953 953 | node | p1 node | p2 node | link node |
954 954 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
955 955 | | | | |
956 956 +------------------------------------------------------+
957 957
958 958 Version 2:
959 959
960 960 +------------------------------------------------------------------+
961 961 | | | | | |
962 962 | node | p1 node | p2 node | base node | link node |
963 963 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
964 964 | | | | | |
965 965 +------------------------------------------------------------------+
966 966
967 967 Version 3:
968 968
969 969 +------------------------------------------------------------------------------+
970 970 | | | | | | |
971 971 | node | p1 node | p2 node | base node | link node | flags |
972 972 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
973 973 | | | | | | |
974 974 +------------------------------------------------------------------------------+
975 975
976 976 The *mdiff header* consists of 3 32-bit big-endian signed integers
977 977 describing offsets at which to apply the following delta content:
978 978
979 979 +-------------------------------------+
980 980 | | | |
981 981 | offset | old length | new length |
982 982 | (32 bits) | (32 bits) | (32 bits) |
983 983 | | | |
984 984 +-------------------------------------+
985 985
986 986 In version 1, the delta is always applied against the previous node from
987 987 the changegroup or the first parent if this is the first entry in the
988 988 changegroup.
989 989
990 990 In version 2, the delta base node is encoded in the entry in the
991 991 changegroup. This allows the delta to be expressed against any parent,
992 992 which can result in smaller deltas and more efficient encoding of data.
993 993
994 994 Changeset Segment
995 995 -----------------
996 996
997 997 The *changeset segment* consists of a single *delta group* holding
998 998 changelog data. It is followed by an *empty chunk* to denote the boundary
999 999 to the *manifests segment*.
1000 1000
1001 1001 Manifest Segment
1002 1002 ----------------
1003 1003
1004 1004 The *manifest segment* consists of a single *delta group* holding manifest
1005 1005 data. It is followed by an *empty chunk* to denote the boundary to the
1006 1006 *filelogs segment*.
1007 1007
1008 1008 Filelogs Segment
1009 1009 ----------------
1010 1010
1011 1011 The *filelogs* segment consists of multiple sub-segments, each
1012 1012 corresponding to an individual file whose data is being described:
1013 1013
1014 1014 +--------------------------------------+
1015 1015 | | | | |
1016 1016 | filelog0 | filelog1 | filelog2 | ... |
1017 1017 | | | | |
1018 1018 +--------------------------------------+
1019 1019
1020 1020 In version "3" of the changegroup format, filelogs may include directory
1021 1021 logs when treemanifests are in use. directory logs are identified by
1022 1022 having a trailing '/' on their filename (see below).
1023 1023
1024 1024 The final filelog sub-segment is followed by an *empty chunk* to denote
1025 1025 the end of the segment and the overall changegroup.
1026 1026
1027 1027 Each filelog sub-segment consists of the following:
1028 1028
1029 1029 +------------------------------------------+
1030 1030 | | | |
1031 1031 | filename size | filename | delta group |
1032 1032 | (32 bits) | (various) | (various) |
1033 1033 | | | |
1034 1034 +------------------------------------------+
1035 1035
1036 1036 That is, a *chunk* consisting of the filename (not terminated or padded)
1037 1037 followed by N chunks constituting the *delta group* for this file.
1038 1038
1039 1039 Test list of commands with command with no help text
1040 1040
1041 1041 $ hg help helpext
1042 1042 helpext extension - no help text available
1043 1043
1044 1044 list of commands:
1045 1045
1046 1046 nohelp (no help text available)
1047 1047
1048 1048 (use "hg help -v helpext" to show built-in aliases and global options)
1049 1049
1050 1050
1051 1051 test deprecated and experimental options are hidden in command help
1052 1052 $ hg help debugoptDEP
1053 1053 hg debugoptDEP
1054 1054
1055 1055 (no help text available)
1056 1056
1057 1057 options:
1058 1058
1059 1059 (some details hidden, use --verbose to show complete help)
1060 1060
1061 1061 $ hg help debugoptEXP
1062 1062 hg debugoptEXP
1063 1063
1064 1064 (no help text available)
1065 1065
1066 1066 options:
1067 1067
1068 1068 (some details hidden, use --verbose to show complete help)
1069 1069
1070 1070 test deprecated and experimental options is shown with -v
1071 1071 $ hg help -v debugoptDEP | grep dopt
1072 1072 --dopt option is (DEPRECATED)
1073 1073 $ hg help -v debugoptEXP | grep eopt
1074 1074 --eopt option is (EXPERIMENTAL)
1075 1075
1076 1076 #if gettext
1077 1077 test deprecated option is hidden with translation with untranslated description
1078 1078 (use many globy for not failing on changed transaction)
1079 1079 $ LANGUAGE=sv hg help debugoptDEP
1080 1080 hg debugoptDEP
1081 1081
1082 1082 (*) (glob)
1083 1083
1084 1084 options:
1085 1085
1086 1086 (some details hidden, use --verbose to show complete help)
1087 1087 #endif
1088 1088
1089 1089 Test commands that collide with topics (issue4240)
1090 1090
1091 1091 $ hg config -hq
1092 1092 hg config [-u] [NAME]...
1093 1093
1094 1094 show combined config settings from all hgrc files
1095 1095 $ hg showconfig -hq
1096 1096 hg config [-u] [NAME]...
1097 1097
1098 1098 show combined config settings from all hgrc files
1099 1099
1100 1100 Test a help topic
1101 1101
1102 1102 $ hg help revs
1103 1103 Specifying Single Revisions
1104 1104 """""""""""""""""""""""""""
1105 1105
1106 1106 Mercurial supports several ways to specify individual revisions.
1107 1107
1108 1108 A plain integer is treated as a revision number. Negative integers are
1109 1109 treated as sequential offsets from the tip, with -1 denoting the tip, -2
1110 1110 denoting the revision prior to the tip, and so forth.
1111 1111
1112 1112 A 40-digit hexadecimal string is treated as a unique revision identifier.
1113 1113
1114 1114 A hexadecimal string less than 40 characters long is treated as a unique
1115 1115 revision identifier and is referred to as a short-form identifier. A
1116 1116 short-form identifier is only valid if it is the prefix of exactly one
1117 1117 full-length identifier.
1118 1118
1119 1119 Any other string is treated as a bookmark, tag, or branch name. A bookmark
1120 1120 is a movable pointer to a revision. A tag is a permanent name associated
1121 1121 with a revision. A branch name denotes the tipmost open branch head of
1122 1122 that branch - or if they are all closed, the tipmost closed head of the
1123 1123 branch. Bookmark, tag, and branch names must not contain the ":"
1124 1124 character.
1125 1125
1126 1126 The reserved name "tip" always identifies the most recent revision.
1127 1127
1128 1128 The reserved name "null" indicates the null revision. This is the revision
1129 1129 of an empty repository, and the parent of revision 0.
1130 1130
1131 1131 The reserved name "." indicates the working directory parent. If no
1132 1132 working directory is checked out, it is equivalent to null. If an
1133 1133 uncommitted merge is in progress, "." is the revision of the first parent.
1134 1134
1135 1135 Test repeated config section name
1136 1136
1137 1137 $ hg help config.host
1138 1138 "http_proxy.host"
1139 1139 Host name and (optional) port of the proxy server, for example
1140 1140 "myproxy:8000".
1141 1141
1142 1142 "smtp.host"
1143 1143 Host name of mail server, e.g. "mail.example.com".
1144 1144
1145 1145 Unrelated trailing paragraphs shouldn't be included
1146 1146
1147 1147 $ hg help config.extramsg | grep '^$'
1148 1148
1149 1149
1150 1150 Test capitalized section name
1151 1151
1152 1152 $ hg help scripting.HGPLAIN > /dev/null
1153 1153
1154 1154 Help subsection:
1155 1155
1156 1156 $ hg help config.charsets |grep "Email example:" > /dev/null
1157 1157 [1]
1158 1158
1159 1159 Show nested definitions
1160 1160 ("profiling.type"[break]"ls"[break]"stat"[break])
1161 1161
1162 1162 $ hg help config.type | egrep '^$'|wc -l
1163 1163 \s*3 (re)
1164 1164
1165 1165 Last item in help config.*:
1166 1166
1167 1167 $ hg help config.`hg help config|grep '^ "'| \
1168 1168 > tail -1|sed 's![ "]*!!g'`| \
1169 1169 > grep "hg help -c config" > /dev/null
1170 1170 [1]
1171 1171
1172 1172 note to use help -c for general hg help config:
1173 1173
1174 1174 $ hg help config |grep "hg help -c config" > /dev/null
1175 1175
1176 1176 Test templating help
1177 1177
1178 1178 $ hg help templating | egrep '(desc|diffstat|firstline|nonempty) '
1179 1179 desc String. The text of the changeset description.
1180 1180 diffstat String. Statistics of changes with the following format:
1181 1181 firstline Any text. Returns the first line of text.
1182 1182 nonempty Any text. Returns '(none)' if the string is empty.
1183 1183
1184 1184 Test deprecated items
1185 1185
1186 1186 $ hg help -v templating | grep currentbookmark
1187 1187 currentbookmark
1188 1188 $ hg help templating | (grep currentbookmark || true)
1189 1189
1190 1190 Test help hooks
1191 1191
1192 1192 $ cat > helphook1.py <<EOF
1193 1193 > from mercurial import help
1194 1194 >
1195 1195 > def rewrite(ui, topic, doc):
1196 1196 > return doc + '\nhelphook1\n'
1197 1197 >
1198 1198 > def extsetup(ui):
1199 1199 > help.addtopichook('revsets', rewrite)
1200 1200 > EOF
1201 1201 $ cat > helphook2.py <<EOF
1202 1202 > from mercurial import help
1203 1203 >
1204 1204 > def rewrite(ui, topic, doc):
1205 1205 > return doc + '\nhelphook2\n'
1206 1206 >
1207 1207 > def extsetup(ui):
1208 1208 > help.addtopichook('revsets', rewrite)
1209 1209 > EOF
1210 1210 $ echo '[extensions]' >> $HGRCPATH
1211 1211 $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
1212 1212 $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
1213 1213 $ hg help revsets | grep helphook
1214 1214 helphook1
1215 1215 helphook2
1216 1216
1217 1217 help -c should only show debug --debug
1218 1218
1219 1219 $ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
1220 1220 [1]
1221 1221
1222 1222 help -c should only show deprecated for -v
1223 1223
1224 1224 $ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
1225 1225 [1]
1226 1226
1227 1227 Test -e / -c / -k combinations
1228 1228
1229 1229 $ hg help -c|egrep '^[A-Z].*:|^ debug'
1230 1230 Commands:
1231 1231 $ hg help -e|egrep '^[A-Z].*:|^ debug'
1232 1232 Extensions:
1233 1233 $ hg help -k|egrep '^[A-Z].*:|^ debug'
1234 1234 Topics:
1235 1235 Commands:
1236 1236 Extensions:
1237 1237 Extension Commands:
1238 1238 $ hg help -c schemes
1239 1239 abort: no such help topic: schemes
1240 1240 (try "hg help --keyword schemes")
1241 1241 [255]
1242 1242 $ hg help -e schemes |head -1
1243 1243 schemes extension - extend schemes with shortcuts to repository swarms
1244 1244 $ hg help -c -k dates |egrep '^(Topics|Extensions|Commands):'
1245 1245 Commands:
1246 1246 $ hg help -e -k a |egrep '^(Topics|Extensions|Commands):'
1247 1247 Extensions:
1248 1248 $ hg help -e -c -k date |egrep '^(Topics|Extensions|Commands):'
1249 1249 Extensions:
1250 1250 Commands:
1251 1251 $ hg help -c commit > /dev/null
1252 1252 $ hg help -e -c commit > /dev/null
1253 1253 $ hg help -e commit > /dev/null
1254 1254 abort: no such help topic: commit
1255 1255 (try "hg help --keyword commit")
1256 1256 [255]
1257 1257
1258 1258 Test keyword search help
1259 1259
1260 1260 $ cat > prefixedname.py <<EOF
1261 1261 > '''matched against word "clone"
1262 1262 > '''
1263 1263 > EOF
1264 1264 $ echo '[extensions]' >> $HGRCPATH
1265 1265 $ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
1266 1266 $ hg help -k clone
1267 1267 Topics:
1268 1268
1269 1269 config Configuration Files
1270 1270 extensions Using Additional Features
1271 1271 glossary Glossary
1272 1272 phases Working with Phases
1273 1273 subrepos Subrepositories
1274 1274 urls URL Paths
1275 1275
1276 1276 Commands:
1277 1277
1278 1278 bookmarks create a new bookmark or list existing bookmarks
1279 1279 clone make a copy of an existing repository
1280 1280 paths show aliases for remote repositories
1281 1281 update update working directory (or switch revisions)
1282 1282
1283 1283 Extensions:
1284 1284
1285 1285 clonebundles advertise pre-generated bundles to seed clones (experimental)
1286 1286 prefixedname matched against word "clone"
1287 1287 relink recreates hardlinks between repository clones
1288 1288
1289 1289 Extension Commands:
1290 1290
1291 1291 qclone clone main and patch repository at same time
1292 1292
1293 1293 Test unfound topic
1294 1294
1295 1295 $ hg help nonexistingtopicthatwillneverexisteverever
1296 1296 abort: no such help topic: nonexistingtopicthatwillneverexisteverever
1297 1297 (try "hg help --keyword nonexistingtopicthatwillneverexisteverever")
1298 1298 [255]
1299 1299
1300 1300 Test unfound keyword
1301 1301
1302 1302 $ hg help --keyword nonexistingwordthatwillneverexisteverever
1303 1303 abort: no matches
1304 1304 (try "hg help" for a list of topics)
1305 1305 [255]
1306 1306
1307 1307 Test omit indicating for help
1308 1308
1309 1309 $ cat > addverboseitems.py <<EOF
1310 1310 > '''extension to test omit indicating.
1311 1311 >
1312 1312 > This paragraph is never omitted (for extension)
1313 1313 >
1314 1314 > .. container:: verbose
1315 1315 >
1316 1316 > This paragraph is omitted,
1317 1317 > if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
1318 1318 >
1319 1319 > This paragraph is never omitted, too (for extension)
1320 1320 > '''
1321 1321 >
1322 1322 > from mercurial import help, commands
1323 1323 > testtopic = """This paragraph is never omitted (for topic).
1324 1324 >
1325 1325 > .. container:: verbose
1326 1326 >
1327 1327 > This paragraph is omitted,
1328 1328 > if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
1329 1329 >
1330 1330 > This paragraph is never omitted, too (for topic)
1331 1331 > """
1332 1332 > def extsetup(ui):
1333 1333 > help.helptable.append((["topic-containing-verbose"],
1334 1334 > "This is the topic to test omit indicating.",
1335 1335 > lambda ui: testtopic))
1336 1336 > EOF
1337 1337 $ echo '[extensions]' >> $HGRCPATH
1338 1338 $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
1339 1339 $ hg help addverboseitems
1340 1340 addverboseitems extension - extension to test omit indicating.
1341 1341
1342 1342 This paragraph is never omitted (for extension)
1343 1343
1344 1344 This paragraph is never omitted, too (for extension)
1345 1345
1346 1346 (some details hidden, use --verbose to show complete help)
1347 1347
1348 1348 no commands defined
1349 1349 $ hg help -v addverboseitems
1350 1350 addverboseitems extension - extension to test omit indicating.
1351 1351
1352 1352 This paragraph is never omitted (for extension)
1353 1353
1354 1354 This paragraph is omitted, if "hg help" is invoked without "-v" (for
1355 1355 extension)
1356 1356
1357 1357 This paragraph is never omitted, too (for extension)
1358 1358
1359 1359 no commands defined
1360 1360 $ hg help topic-containing-verbose
1361 1361 This is the topic to test omit indicating.
1362 1362 """"""""""""""""""""""""""""""""""""""""""
1363 1363
1364 1364 This paragraph is never omitted (for topic).
1365 1365
1366 1366 This paragraph is never omitted, too (for topic)
1367 1367
1368 1368 (some details hidden, use --verbose to show complete help)
1369 1369 $ hg help -v topic-containing-verbose
1370 1370 This is the topic to test omit indicating.
1371 1371 """"""""""""""""""""""""""""""""""""""""""
1372 1372
1373 1373 This paragraph is never omitted (for topic).
1374 1374
1375 1375 This paragraph is omitted, if "hg help" is invoked without "-v" (for
1376 1376 topic)
1377 1377
1378 1378 This paragraph is never omitted, too (for topic)
1379 1379
1380 1380 Test section lookup
1381 1381
1382 1382 $ hg help revset.merge
1383 1383 "merge()"
1384 1384 Changeset is a merge changeset.
1385 1385
1386 1386 $ hg help glossary.dag
1387 1387 DAG
1388 1388 The repository of changesets of a distributed version control system
1389 1389 (DVCS) can be described as a directed acyclic graph (DAG), consisting
1390 1390 of nodes and edges, where nodes correspond to changesets and edges
1391 1391 imply a parent -> child relation. This graph can be visualized by
1392 1392 graphical tools such as "hg log --graph". In Mercurial, the DAG is
1393 1393 limited by the requirement for children to have at most two parents.
1394 1394
1395 1395
1396 1396 $ hg help hgrc.paths
1397 1397 "paths"
1398 1398 -------
1399 1399
1400 1400 Assigns symbolic names and behavior to repositories.
1401 1401
1402 1402 Options are symbolic names defining the URL or directory that is the
1403 1403 location of the repository. Example:
1404 1404
1405 1405 [paths]
1406 1406 my_server = https://example.com/my_repo
1407 1407 local_path = /home/me/repo
1408 1408
1409 1409 These symbolic names can be used from the command line. To pull from
1410 1410 "my_server": "hg pull my_server". To push to "local_path": "hg push
1411 1411 local_path".
1412 1412
1413 1413 Options containing colons (":") denote sub-options that can influence
1414 1414 behavior for that specific path. Example:
1415 1415
1416 1416 [paths]
1417 1417 my_server = https://example.com/my_path
1418 1418 my_server:pushurl = ssh://example.com/my_path
1419 1419
1420 1420 The following sub-options can be defined:
1421 1421
1422 1422 "pushurl"
1423 1423 The URL to use for push operations. If not defined, the location
1424 1424 defined by the path's main entry is used.
1425 1425
1426 1426 The following special named paths exist:
1427 1427
1428 1428 "default"
1429 1429 The URL or directory to use when no source or remote is specified.
1430 1430
1431 1431 "hg clone" will automatically define this path to the location the
1432 1432 repository was cloned from.
1433 1433
1434 1434 "default-push"
1435 1435 (deprecated) The URL or directory for the default "hg push" location.
1436 1436 "default:pushurl" should be used instead.
1437 1437
1438 1438 $ hg help glossary.mcguffin
1439 1439 abort: help section not found
1440 1440 [255]
1441 1441
1442 1442 $ hg help glossary.mc.guffin
1443 1443 abort: help section not found
1444 1444 [255]
1445 1445
1446 1446 $ hg help template.files
1447 1447 files List of strings. All files modified, added, or removed by
1448 1448 this changeset.
1449 1449
1450 1450 Test dynamic list of merge tools only shows up once
1451 1451 $ hg help merge-tools
1452 1452 Merge Tools
1453 1453 """""""""""
1454 1454
1455 1455 To merge files Mercurial uses merge tools.
1456 1456
1457 1457 A merge tool combines two different versions of a file into a merged file.
1458 1458 Merge tools are given the two files and the greatest common ancestor of
1459 1459 the two file versions, so they can determine the changes made on both
1460 1460 branches.
1461 1461
1462 1462 Merge tools are used both for "hg resolve", "hg merge", "hg update", "hg
1463 1463 backout" and in several extensions.
1464 1464
1465 1465 Usually, the merge tool tries to automatically reconcile the files by
1466 1466 combining all non-overlapping changes that occurred separately in the two
1467 1467 different evolutions of the same initial base file. Furthermore, some
1468 1468 interactive merge programs make it easier to manually resolve conflicting
1469 1469 merges, either in a graphical way, or by inserting some conflict markers.
1470 1470 Mercurial does not include any interactive merge programs but relies on
1471 1471 external tools for that.
1472 1472
1473 1473 Available merge tools
1474 1474 =====================
1475 1475
1476 1476 External merge tools and their properties are configured in the merge-
1477 1477 tools configuration section - see hgrc(5) - but they can often just be
1478 1478 named by their executable.
1479 1479
1480 1480 A merge tool is generally usable if its executable can be found on the
1481 1481 system and if it can handle the merge. The executable is found if it is an
1482 1482 absolute or relative executable path or the name of an application in the
1483 1483 executable search path. The tool is assumed to be able to handle the merge
1484 1484 if it can handle symlinks if the file is a symlink, if it can handle
1485 1485 binary files if the file is binary, and if a GUI is available if the tool
1486 1486 requires a GUI.
1487 1487
1488 1488 There are some internal merge tools which can be used. The internal merge
1489 1489 tools are:
1490 1490
1491 1491 ":dump"
1492 1492 Creates three versions of the files to merge, containing the contents of
1493 1493 local, other and base. These files can then be used to perform a merge
1494 1494 manually. If the file to be merged is named "a.txt", these files will
1495 1495 accordingly be named "a.txt.local", "a.txt.other" and "a.txt.base" and
1496 1496 they will be placed in the same directory as "a.txt".
1497 1497
1498 1498 ":fail"
1499 1499 Rather than attempting to merge files that were modified on both
1500 1500 branches, it marks them as unresolved. The resolve command must be used
1501 1501 to resolve these conflicts.
1502 1502
1503 1503 ":local"
1504 1504 Uses the local version of files as the merged version.
1505 1505
1506 1506 ":merge"
1507 1507 Uses the internal non-interactive simple merge algorithm for merging
1508 1508 files. It will fail if there are any conflicts and leave markers in the
1509 1509 partially merged file. Markers will have two sections, one for each side
1510 1510 of merge.
1511 1511
1512 1512 ":merge-local"
1513 1513 Like :merge, but resolve all conflicts non-interactively in favor of the
1514 1514 local changes.
1515 1515
1516 1516 ":merge-other"
1517 1517 Like :merge, but resolve all conflicts non-interactively in favor of the
1518 1518 other changes.
1519 1519
1520 1520 ":merge3"
1521 1521 Uses the internal non-interactive simple merge algorithm for merging
1522 1522 files. It will fail if there are any conflicts and leave markers in the
1523 1523 partially merged file. Marker will have three sections, one from each
1524 1524 side of the merge and one for the base content.
1525 1525
1526 1526 ":other"
1527 1527 Uses the other version of files as the merged version.
1528 1528
1529 1529 ":prompt"
1530 1530 Asks the user which of the local or the other version to keep as the
1531 1531 merged version.
1532 1532
1533 1533 ":tagmerge"
1534 1534 Uses the internal tag merge algorithm (experimental).
1535 1535
1536 1536 ":union"
1537 1537 Uses the internal non-interactive simple merge algorithm for merging
1538 1538 files. It will use both left and right sides for conflict regions. No
1539 1539 markers are inserted.
1540 1540
1541 1541 Internal tools are always available and do not require a GUI but will by
1542 1542 default not handle symlinks or binary files.
1543 1543
1544 1544 Choosing a merge tool
1545 1545 =====================
1546 1546
1547 1547 Mercurial uses these rules when deciding which merge tool to use:
1548 1548
1549 1549 1. If a tool has been specified with the --tool option to merge or
1550 1550 resolve, it is used. If it is the name of a tool in the merge-tools
1551 1551 configuration, its configuration is used. Otherwise the specified tool
1552 1552 must be executable by the shell.
1553 1553 2. If the "HGMERGE" environment variable is present, its value is used and
1554 1554 must be executable by the shell.
1555 1555 3. If the filename of the file to be merged matches any of the patterns in
1556 1556 the merge-patterns configuration section, the first usable merge tool
1557 1557 corresponding to a matching pattern is used. Here, binary capabilities
1558 1558 of the merge tool are not considered.
1559 1559 4. If ui.merge is set it will be considered next. If the value is not the
1560 1560 name of a configured tool, the specified value is used and must be
1561 1561 executable by the shell. Otherwise the named tool is used if it is
1562 1562 usable.
1563 1563 5. If any usable merge tools are present in the merge-tools configuration
1564 1564 section, the one with the highest priority is used.
1565 1565 6. If a program named "hgmerge" can be found on the system, it is used -
1566 1566 but it will by default not be used for symlinks and binary files.
1567 1567 7. If the file to be merged is not binary and is not a symlink, then
1568 1568 internal ":merge" is used.
1569 1569 8. The merge of the file fails and must be resolved before commit.
1570 1570
1571 1571 Note:
1572 1572 After selecting a merge program, Mercurial will by default attempt to
1573 1573 merge the files using a simple merge algorithm first. Only if it
1574 1574 doesn't succeed because of conflicting changes Mercurial will actually
1575 1575 execute the merge program. Whether to use the simple merge algorithm
1576 1576 first can be controlled by the premerge setting of the merge tool.
1577 1577 Premerge is enabled by default unless the file is binary or a symlink.
1578 1578
1579 1579 See the merge-tools and ui sections of hgrc(5) for details on the
1580 1580 configuration of merge tools.
1581 1581
1582 1582 Test usage of section marks in help documents
1583 1583
1584 1584 $ cd "$TESTDIR"/../doc
1585 1585 $ python check-seclevel.py
1586 1586 $ cd $TESTTMP
1587 1587
1588 1588 #if serve
1589 1589
1590 1590 Test the help pages in hgweb.
1591 1591
1592 1592 Dish up an empty repo; serve it cold.
1593 1593
1594 1594 $ hg init "$TESTTMP/test"
1595 1595 $ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
1596 1596 $ cat hg.pid >> $DAEMON_PIDS
1597 1597
1598 1598 $ get-with-headers.py 127.0.0.1:$HGPORT "help"
1599 1599 200 Script output follows
1600 1600
1601 1601 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
1602 1602 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
1603 1603 <head>
1604 1604 <link rel="icon" href="/static/hgicon.png" type="image/png" />
1605 1605 <meta name="robots" content="index, nofollow" />
1606 1606 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
1607 1607 <script type="text/javascript" src="/static/mercurial.js"></script>
1608 1608
1609 1609 <title>Help: Index</title>
1610 1610 </head>
1611 1611 <body>
1612 1612
1613 1613 <div class="container">
1614 1614 <div class="menu">
1615 1615 <div class="logo">
1616 1616 <a href="https://mercurial-scm.org/">
1617 1617 <img src="/static/hglogo.png" alt="mercurial" /></a>
1618 1618 </div>
1619 1619 <ul>
1620 1620 <li><a href="/shortlog">log</a></li>
1621 1621 <li><a href="/graph">graph</a></li>
1622 1622 <li><a href="/tags">tags</a></li>
1623 1623 <li><a href="/bookmarks">bookmarks</a></li>
1624 1624 <li><a href="/branches">branches</a></li>
1625 1625 </ul>
1626 1626 <ul>
1627 1627 <li class="active">help</li>
1628 1628 </ul>
1629 1629 </div>
1630 1630
1631 1631 <div class="main">
1632 1632 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
1633 1633 <form class="search" action="/log">
1634 1634
1635 1635 <p><input name="rev" id="search1" type="text" size="30" /></p>
1636 1636 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
1637 1637 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
1638 1638 </form>
1639 1639 <table class="bigtable">
1640 1640 <tr><td colspan="2"><h2><a name="main" href="#topics">Topics</a></h2></td></tr>
1641 1641
1642 1642 <tr><td>
1643 1643 <a href="/help/config">
1644 1644 config
1645 1645 </a>
1646 1646 </td><td>
1647 1647 Configuration Files
1648 1648 </td></tr>
1649 1649 <tr><td>
1650 1650 <a href="/help/dates">
1651 1651 dates
1652 1652 </a>
1653 1653 </td><td>
1654 1654 Date Formats
1655 1655 </td></tr>
1656 1656 <tr><td>
1657 1657 <a href="/help/diffs">
1658 1658 diffs
1659 1659 </a>
1660 1660 </td><td>
1661 1661 Diff Formats
1662 1662 </td></tr>
1663 1663 <tr><td>
1664 1664 <a href="/help/environment">
1665 1665 environment
1666 1666 </a>
1667 1667 </td><td>
1668 1668 Environment Variables
1669 1669 </td></tr>
1670 1670 <tr><td>
1671 1671 <a href="/help/extensions">
1672 1672 extensions
1673 1673 </a>
1674 1674 </td><td>
1675 1675 Using Additional Features
1676 1676 </td></tr>
1677 1677 <tr><td>
1678 1678 <a href="/help/filesets">
1679 1679 filesets
1680 1680 </a>
1681 1681 </td><td>
1682 1682 Specifying File Sets
1683 1683 </td></tr>
1684 1684 <tr><td>
1685 1685 <a href="/help/glossary">
1686 1686 glossary
1687 1687 </a>
1688 1688 </td><td>
1689 1689 Glossary
1690 1690 </td></tr>
1691 1691 <tr><td>
1692 1692 <a href="/help/hgignore">
1693 1693 hgignore
1694 1694 </a>
1695 1695 </td><td>
1696 1696 Syntax for Mercurial Ignore Files
1697 1697 </td></tr>
1698 1698 <tr><td>
1699 1699 <a href="/help/hgweb">
1700 1700 hgweb
1701 1701 </a>
1702 1702 </td><td>
1703 1703 Configuring hgweb
1704 1704 </td></tr>
1705 1705 <tr><td>
1706 1706 <a href="/help/internals">
1707 1707 internals
1708 1708 </a>
1709 1709 </td><td>
1710 1710 Technical implementation topics
1711 1711 </td></tr>
1712 1712 <tr><td>
1713 1713 <a href="/help/merge-tools">
1714 1714 merge-tools
1715 1715 </a>
1716 1716 </td><td>
1717 1717 Merge Tools
1718 1718 </td></tr>
1719 1719 <tr><td>
1720 1720 <a href="/help/multirevs">
1721 1721 multirevs
1722 1722 </a>
1723 1723 </td><td>
1724 1724 Specifying Multiple Revisions
1725 1725 </td></tr>
1726 1726 <tr><td>
1727 1727 <a href="/help/patterns">
1728 1728 patterns
1729 1729 </a>
1730 1730 </td><td>
1731 1731 File Name Patterns
1732 1732 </td></tr>
1733 1733 <tr><td>
1734 1734 <a href="/help/phases">
1735 1735 phases
1736 1736 </a>
1737 1737 </td><td>
1738 1738 Working with Phases
1739 1739 </td></tr>
1740 1740 <tr><td>
1741 1741 <a href="/help/revisions">
1742 1742 revisions
1743 1743 </a>
1744 1744 </td><td>
1745 1745 Specifying Single Revisions
1746 1746 </td></tr>
1747 1747 <tr><td>
1748 1748 <a href="/help/revsets">
1749 1749 revsets
1750 1750 </a>
1751 1751 </td><td>
1752 1752 Specifying Revision Sets
1753 1753 </td></tr>
1754 1754 <tr><td>
1755 1755 <a href="/help/scripting">
1756 1756 scripting
1757 1757 </a>
1758 1758 </td><td>
1759 1759 Using Mercurial from scripts and automation
1760 1760 </td></tr>
1761 1761 <tr><td>
1762 1762 <a href="/help/subrepos">
1763 1763 subrepos
1764 1764 </a>
1765 1765 </td><td>
1766 1766 Subrepositories
1767 1767 </td></tr>
1768 1768 <tr><td>
1769 1769 <a href="/help/templating">
1770 1770 templating
1771 1771 </a>
1772 1772 </td><td>
1773 1773 Template Usage
1774 1774 </td></tr>
1775 1775 <tr><td>
1776 1776 <a href="/help/urls">
1777 1777 urls
1778 1778 </a>
1779 1779 </td><td>
1780 1780 URL Paths
1781 1781 </td></tr>
1782 1782 <tr><td>
1783 1783 <a href="/help/topic-containing-verbose">
1784 1784 topic-containing-verbose
1785 1785 </a>
1786 1786 </td><td>
1787 1787 This is the topic to test omit indicating.
1788 1788 </td></tr>
1789 1789
1790
1790 1791 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
1791 1792
1792 1793 <tr><td>
1793 1794 <a href="/help/add">
1794 1795 add
1795 1796 </a>
1796 1797 </td><td>
1797 1798 add the specified files on the next commit
1798 1799 </td></tr>
1799 1800 <tr><td>
1800 1801 <a href="/help/annotate">
1801 1802 annotate
1802 1803 </a>
1803 1804 </td><td>
1804 1805 show changeset information by line for each file
1805 1806 </td></tr>
1806 1807 <tr><td>
1807 1808 <a href="/help/clone">
1808 1809 clone
1809 1810 </a>
1810 1811 </td><td>
1811 1812 make a copy of an existing repository
1812 1813 </td></tr>
1813 1814 <tr><td>
1814 1815 <a href="/help/commit">
1815 1816 commit
1816 1817 </a>
1817 1818 </td><td>
1818 1819 commit the specified files or all outstanding changes
1819 1820 </td></tr>
1820 1821 <tr><td>
1821 1822 <a href="/help/diff">
1822 1823 diff
1823 1824 </a>
1824 1825 </td><td>
1825 1826 diff repository (or selected files)
1826 1827 </td></tr>
1827 1828 <tr><td>
1828 1829 <a href="/help/export">
1829 1830 export
1830 1831 </a>
1831 1832 </td><td>
1832 1833 dump the header and diffs for one or more changesets
1833 1834 </td></tr>
1834 1835 <tr><td>
1835 1836 <a href="/help/forget">
1836 1837 forget
1837 1838 </a>
1838 1839 </td><td>
1839 1840 forget the specified files on the next commit
1840 1841 </td></tr>
1841 1842 <tr><td>
1842 1843 <a href="/help/init">
1843 1844 init
1844 1845 </a>
1845 1846 </td><td>
1846 1847 create a new repository in the given directory
1847 1848 </td></tr>
1848 1849 <tr><td>
1849 1850 <a href="/help/log">
1850 1851 log
1851 1852 </a>
1852 1853 </td><td>
1853 1854 show revision history of entire repository or files
1854 1855 </td></tr>
1855 1856 <tr><td>
1856 1857 <a href="/help/merge">
1857 1858 merge
1858 1859 </a>
1859 1860 </td><td>
1860 1861 merge another revision into working directory
1861 1862 </td></tr>
1862 1863 <tr><td>
1863 1864 <a href="/help/pull">
1864 1865 pull
1865 1866 </a>
1866 1867 </td><td>
1867 1868 pull changes from the specified source
1868 1869 </td></tr>
1869 1870 <tr><td>
1870 1871 <a href="/help/push">
1871 1872 push
1872 1873 </a>
1873 1874 </td><td>
1874 1875 push changes to the specified destination
1875 1876 </td></tr>
1876 1877 <tr><td>
1877 1878 <a href="/help/remove">
1878 1879 remove
1879 1880 </a>
1880 1881 </td><td>
1881 1882 remove the specified files on the next commit
1882 1883 </td></tr>
1883 1884 <tr><td>
1884 1885 <a href="/help/serve">
1885 1886 serve
1886 1887 </a>
1887 1888 </td><td>
1888 1889 start stand-alone webserver
1889 1890 </td></tr>
1890 1891 <tr><td>
1891 1892 <a href="/help/status">
1892 1893 status
1893 1894 </a>
1894 1895 </td><td>
1895 1896 show changed files in the working directory
1896 1897 </td></tr>
1897 1898 <tr><td>
1898 1899 <a href="/help/summary">
1899 1900 summary
1900 1901 </a>
1901 1902 </td><td>
1902 1903 summarize working directory state
1903 1904 </td></tr>
1904 1905 <tr><td>
1905 1906 <a href="/help/update">
1906 1907 update
1907 1908 </a>
1908 1909 </td><td>
1909 1910 update working directory (or switch revisions)
1910 1911 </td></tr>
1911 1912
1913
1914
1912 1915 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
1913 1916
1914 1917 <tr><td>
1915 1918 <a href="/help/addremove">
1916 1919 addremove
1917 1920 </a>
1918 1921 </td><td>
1919 1922 add all new files, delete all missing files
1920 1923 </td></tr>
1921 1924 <tr><td>
1922 1925 <a href="/help/archive">
1923 1926 archive
1924 1927 </a>
1925 1928 </td><td>
1926 1929 create an unversioned archive of a repository revision
1927 1930 </td></tr>
1928 1931 <tr><td>
1929 1932 <a href="/help/backout">
1930 1933 backout
1931 1934 </a>
1932 1935 </td><td>
1933 1936 reverse effect of earlier changeset
1934 1937 </td></tr>
1935 1938 <tr><td>
1936 1939 <a href="/help/bisect">
1937 1940 bisect
1938 1941 </a>
1939 1942 </td><td>
1940 1943 subdivision search of changesets
1941 1944 </td></tr>
1942 1945 <tr><td>
1943 1946 <a href="/help/bookmarks">
1944 1947 bookmarks
1945 1948 </a>
1946 1949 </td><td>
1947 1950 create a new bookmark or list existing bookmarks
1948 1951 </td></tr>
1949 1952 <tr><td>
1950 1953 <a href="/help/branch">
1951 1954 branch
1952 1955 </a>
1953 1956 </td><td>
1954 1957 set or show the current branch name
1955 1958 </td></tr>
1956 1959 <tr><td>
1957 1960 <a href="/help/branches">
1958 1961 branches
1959 1962 </a>
1960 1963 </td><td>
1961 1964 list repository named branches
1962 1965 </td></tr>
1963 1966 <tr><td>
1964 1967 <a href="/help/bundle">
1965 1968 bundle
1966 1969 </a>
1967 1970 </td><td>
1968 1971 create a changegroup file
1969 1972 </td></tr>
1970 1973 <tr><td>
1971 1974 <a href="/help/cat">
1972 1975 cat
1973 1976 </a>
1974 1977 </td><td>
1975 1978 output the current or given revision of files
1976 1979 </td></tr>
1977 1980 <tr><td>
1978 1981 <a href="/help/config">
1979 1982 config
1980 1983 </a>
1981 1984 </td><td>
1982 1985 show combined config settings from all hgrc files
1983 1986 </td></tr>
1984 1987 <tr><td>
1985 1988 <a href="/help/copy">
1986 1989 copy
1987 1990 </a>
1988 1991 </td><td>
1989 1992 mark files as copied for the next commit
1990 1993 </td></tr>
1991 1994 <tr><td>
1992 1995 <a href="/help/files">
1993 1996 files
1994 1997 </a>
1995 1998 </td><td>
1996 1999 list tracked files
1997 2000 </td></tr>
1998 2001 <tr><td>
1999 2002 <a href="/help/graft">
2000 2003 graft
2001 2004 </a>
2002 2005 </td><td>
2003 2006 copy changes from other branches onto the current branch
2004 2007 </td></tr>
2005 2008 <tr><td>
2006 2009 <a href="/help/grep">
2007 2010 grep
2008 2011 </a>
2009 2012 </td><td>
2010 2013 search for a pattern in specified files and revisions
2011 2014 </td></tr>
2012 2015 <tr><td>
2013 2016 <a href="/help/heads">
2014 2017 heads
2015 2018 </a>
2016 2019 </td><td>
2017 2020 show branch heads
2018 2021 </td></tr>
2019 2022 <tr><td>
2020 2023 <a href="/help/help">
2021 2024 help
2022 2025 </a>
2023 2026 </td><td>
2024 2027 show help for a given topic or a help overview
2025 2028 </td></tr>
2026 2029 <tr><td>
2027 2030 <a href="/help/identify">
2028 2031 identify
2029 2032 </a>
2030 2033 </td><td>
2031 2034 identify the working directory or specified revision
2032 2035 </td></tr>
2033 2036 <tr><td>
2034 2037 <a href="/help/import">
2035 2038 import
2036 2039 </a>
2037 2040 </td><td>
2038 2041 import an ordered set of patches
2039 2042 </td></tr>
2040 2043 <tr><td>
2041 2044 <a href="/help/incoming">
2042 2045 incoming
2043 2046 </a>
2044 2047 </td><td>
2045 2048 show new changesets found in source
2046 2049 </td></tr>
2047 2050 <tr><td>
2048 2051 <a href="/help/manifest">
2049 2052 manifest
2050 2053 </a>
2051 2054 </td><td>
2052 2055 output the current or given revision of the project manifest
2053 2056 </td></tr>
2054 2057 <tr><td>
2055 2058 <a href="/help/nohelp">
2056 2059 nohelp
2057 2060 </a>
2058 2061 </td><td>
2059 2062 (no help text available)
2060 2063 </td></tr>
2061 2064 <tr><td>
2062 2065 <a href="/help/outgoing">
2063 2066 outgoing
2064 2067 </a>
2065 2068 </td><td>
2066 2069 show changesets not found in the destination
2067 2070 </td></tr>
2068 2071 <tr><td>
2069 2072 <a href="/help/paths">
2070 2073 paths
2071 2074 </a>
2072 2075 </td><td>
2073 2076 show aliases for remote repositories
2074 2077 </td></tr>
2075 2078 <tr><td>
2076 2079 <a href="/help/phase">
2077 2080 phase
2078 2081 </a>
2079 2082 </td><td>
2080 2083 set or show the current phase name
2081 2084 </td></tr>
2082 2085 <tr><td>
2083 2086 <a href="/help/recover">
2084 2087 recover
2085 2088 </a>
2086 2089 </td><td>
2087 2090 roll back an interrupted transaction
2088 2091 </td></tr>
2089 2092 <tr><td>
2090 2093 <a href="/help/rename">
2091 2094 rename
2092 2095 </a>
2093 2096 </td><td>
2094 2097 rename files; equivalent of copy + remove
2095 2098 </td></tr>
2096 2099 <tr><td>
2097 2100 <a href="/help/resolve">
2098 2101 resolve
2099 2102 </a>
2100 2103 </td><td>
2101 2104 redo merges or set/view the merge status of files
2102 2105 </td></tr>
2103 2106 <tr><td>
2104 2107 <a href="/help/revert">
2105 2108 revert
2106 2109 </a>
2107 2110 </td><td>
2108 2111 restore files to their checkout state
2109 2112 </td></tr>
2110 2113 <tr><td>
2111 2114 <a href="/help/root">
2112 2115 root
2113 2116 </a>
2114 2117 </td><td>
2115 2118 print the root (top) of the current working directory
2116 2119 </td></tr>
2117 2120 <tr><td>
2118 2121 <a href="/help/tag">
2119 2122 tag
2120 2123 </a>
2121 2124 </td><td>
2122 2125 add one or more tags for the current or given revision
2123 2126 </td></tr>
2124 2127 <tr><td>
2125 2128 <a href="/help/tags">
2126 2129 tags
2127 2130 </a>
2128 2131 </td><td>
2129 2132 list repository tags
2130 2133 </td></tr>
2131 2134 <tr><td>
2132 2135 <a href="/help/unbundle">
2133 2136 unbundle
2134 2137 </a>
2135 2138 </td><td>
2136 2139 apply one or more changegroup files
2137 2140 </td></tr>
2138 2141 <tr><td>
2139 2142 <a href="/help/verify">
2140 2143 verify
2141 2144 </a>
2142 2145 </td><td>
2143 2146 verify the integrity of the repository
2144 2147 </td></tr>
2145 2148 <tr><td>
2146 2149 <a href="/help/version">
2147 2150 version
2148 2151 </a>
2149 2152 </td><td>
2150 2153 output version and copyright information
2151 2154 </td></tr>
2155
2156
2152 2157 </table>
2153 2158 </div>
2154 2159 </div>
2155 2160
2156 2161 <script type="text/javascript">process_dates()</script>
2157 2162
2158 2163
2159 2164 </body>
2160 2165 </html>
2161 2166
2162 2167
2163 2168 $ get-with-headers.py 127.0.0.1:$HGPORT "help/add"
2164 2169 200 Script output follows
2165 2170
2166 2171 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2167 2172 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2168 2173 <head>
2169 2174 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2170 2175 <meta name="robots" content="index, nofollow" />
2171 2176 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2172 2177 <script type="text/javascript" src="/static/mercurial.js"></script>
2173 2178
2174 2179 <title>Help: add</title>
2175 2180 </head>
2176 2181 <body>
2177 2182
2178 2183 <div class="container">
2179 2184 <div class="menu">
2180 2185 <div class="logo">
2181 2186 <a href="https://mercurial-scm.org/">
2182 2187 <img src="/static/hglogo.png" alt="mercurial" /></a>
2183 2188 </div>
2184 2189 <ul>
2185 2190 <li><a href="/shortlog">log</a></li>
2186 2191 <li><a href="/graph">graph</a></li>
2187 2192 <li><a href="/tags">tags</a></li>
2188 2193 <li><a href="/bookmarks">bookmarks</a></li>
2189 2194 <li><a href="/branches">branches</a></li>
2190 2195 </ul>
2191 2196 <ul>
2192 2197 <li class="active"><a href="/help">help</a></li>
2193 2198 </ul>
2194 2199 </div>
2195 2200
2196 2201 <div class="main">
2197 2202 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2198 2203 <h3>Help: add</h3>
2199 2204
2200 2205 <form class="search" action="/log">
2201 2206
2202 2207 <p><input name="rev" id="search1" type="text" size="30" /></p>
2203 2208 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2204 2209 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2205 2210 </form>
2206 2211 <div id="doc">
2207 2212 <p>
2208 2213 hg add [OPTION]... [FILE]...
2209 2214 </p>
2210 2215 <p>
2211 2216 add the specified files on the next commit
2212 2217 </p>
2213 2218 <p>
2214 2219 Schedule files to be version controlled and added to the
2215 2220 repository.
2216 2221 </p>
2217 2222 <p>
2218 2223 The files will be added to the repository at the next commit. To
2219 2224 undo an add before that, see &quot;hg forget&quot;.
2220 2225 </p>
2221 2226 <p>
2222 2227 If no names are given, add all files to the repository (except
2223 2228 files matching &quot;.hgignore&quot;).
2224 2229 </p>
2225 2230 <p>
2226 2231 Examples:
2227 2232 </p>
2228 2233 <ul>
2229 2234 <li> New (unknown) files are added automatically by &quot;hg add&quot;:
2230 2235 <pre>
2231 2236 \$ ls (re)
2232 2237 foo.c
2233 2238 \$ hg status (re)
2234 2239 ? foo.c
2235 2240 \$ hg add (re)
2236 2241 adding foo.c
2237 2242 \$ hg status (re)
2238 2243 A foo.c
2239 2244 </pre>
2240 2245 <li> Specific files to be added can be specified:
2241 2246 <pre>
2242 2247 \$ ls (re)
2243 2248 bar.c foo.c
2244 2249 \$ hg status (re)
2245 2250 ? bar.c
2246 2251 ? foo.c
2247 2252 \$ hg add bar.c (re)
2248 2253 \$ hg status (re)
2249 2254 A bar.c
2250 2255 ? foo.c
2251 2256 </pre>
2252 2257 </ul>
2253 2258 <p>
2254 2259 Returns 0 if all files are successfully added.
2255 2260 </p>
2256 2261 <p>
2257 2262 options ([+] can be repeated):
2258 2263 </p>
2259 2264 <table>
2260 2265 <tr><td>-I</td>
2261 2266 <td>--include PATTERN [+]</td>
2262 2267 <td>include names matching the given patterns</td></tr>
2263 2268 <tr><td>-X</td>
2264 2269 <td>--exclude PATTERN [+]</td>
2265 2270 <td>exclude names matching the given patterns</td></tr>
2266 2271 <tr><td>-S</td>
2267 2272 <td>--subrepos</td>
2268 2273 <td>recurse into subrepositories</td></tr>
2269 2274 <tr><td>-n</td>
2270 2275 <td>--dry-run</td>
2271 2276 <td>do not perform actions, just print output</td></tr>
2272 2277 </table>
2273 2278 <p>
2274 2279 global options ([+] can be repeated):
2275 2280 </p>
2276 2281 <table>
2277 2282 <tr><td>-R</td>
2278 2283 <td>--repository REPO</td>
2279 2284 <td>repository root directory or name of overlay bundle file</td></tr>
2280 2285 <tr><td></td>
2281 2286 <td>--cwd DIR</td>
2282 2287 <td>change working directory</td></tr>
2283 2288 <tr><td>-y</td>
2284 2289 <td>--noninteractive</td>
2285 2290 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2286 2291 <tr><td>-q</td>
2287 2292 <td>--quiet</td>
2288 2293 <td>suppress output</td></tr>
2289 2294 <tr><td>-v</td>
2290 2295 <td>--verbose</td>
2291 2296 <td>enable additional output</td></tr>
2292 2297 <tr><td></td>
2293 2298 <td>--config CONFIG [+]</td>
2294 2299 <td>set/override config option (use 'section.name=value')</td></tr>
2295 2300 <tr><td></td>
2296 2301 <td>--debug</td>
2297 2302 <td>enable debugging output</td></tr>
2298 2303 <tr><td></td>
2299 2304 <td>--debugger</td>
2300 2305 <td>start debugger</td></tr>
2301 2306 <tr><td></td>
2302 2307 <td>--encoding ENCODE</td>
2303 2308 <td>set the charset encoding (default: ascii)</td></tr>
2304 2309 <tr><td></td>
2305 2310 <td>--encodingmode MODE</td>
2306 2311 <td>set the charset encoding mode (default: strict)</td></tr>
2307 2312 <tr><td></td>
2308 2313 <td>--traceback</td>
2309 2314 <td>always print a traceback on exception</td></tr>
2310 2315 <tr><td></td>
2311 2316 <td>--time</td>
2312 2317 <td>time how long the command takes</td></tr>
2313 2318 <tr><td></td>
2314 2319 <td>--profile</td>
2315 2320 <td>print command execution profile</td></tr>
2316 2321 <tr><td></td>
2317 2322 <td>--version</td>
2318 2323 <td>output version information and exit</td></tr>
2319 2324 <tr><td>-h</td>
2320 2325 <td>--help</td>
2321 2326 <td>display help and exit</td></tr>
2322 2327 <tr><td></td>
2323 2328 <td>--hidden</td>
2324 2329 <td>consider hidden changesets</td></tr>
2325 2330 </table>
2326 2331
2327 2332 </div>
2328 2333 </div>
2329 2334 </div>
2330 2335
2331 2336 <script type="text/javascript">process_dates()</script>
2332 2337
2333 2338
2334 2339 </body>
2335 2340 </html>
2336 2341
2337 2342
2338 2343 $ get-with-headers.py 127.0.0.1:$HGPORT "help/remove"
2339 2344 200 Script output follows
2340 2345
2341 2346 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2342 2347 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2343 2348 <head>
2344 2349 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2345 2350 <meta name="robots" content="index, nofollow" />
2346 2351 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2347 2352 <script type="text/javascript" src="/static/mercurial.js"></script>
2348 2353
2349 2354 <title>Help: remove</title>
2350 2355 </head>
2351 2356 <body>
2352 2357
2353 2358 <div class="container">
2354 2359 <div class="menu">
2355 2360 <div class="logo">
2356 2361 <a href="https://mercurial-scm.org/">
2357 2362 <img src="/static/hglogo.png" alt="mercurial" /></a>
2358 2363 </div>
2359 2364 <ul>
2360 2365 <li><a href="/shortlog">log</a></li>
2361 2366 <li><a href="/graph">graph</a></li>
2362 2367 <li><a href="/tags">tags</a></li>
2363 2368 <li><a href="/bookmarks">bookmarks</a></li>
2364 2369 <li><a href="/branches">branches</a></li>
2365 2370 </ul>
2366 2371 <ul>
2367 2372 <li class="active"><a href="/help">help</a></li>
2368 2373 </ul>
2369 2374 </div>
2370 2375
2371 2376 <div class="main">
2372 2377 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2373 2378 <h3>Help: remove</h3>
2374 2379
2375 2380 <form class="search" action="/log">
2376 2381
2377 2382 <p><input name="rev" id="search1" type="text" size="30" /></p>
2378 2383 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2379 2384 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2380 2385 </form>
2381 2386 <div id="doc">
2382 2387 <p>
2383 2388 hg remove [OPTION]... FILE...
2384 2389 </p>
2385 2390 <p>
2386 2391 aliases: rm
2387 2392 </p>
2388 2393 <p>
2389 2394 remove the specified files on the next commit
2390 2395 </p>
2391 2396 <p>
2392 2397 Schedule the indicated files for removal from the current branch.
2393 2398 </p>
2394 2399 <p>
2395 2400 This command schedules the files to be removed at the next commit.
2396 2401 To undo a remove before that, see &quot;hg revert&quot;. To undo added
2397 2402 files, see &quot;hg forget&quot;.
2398 2403 </p>
2399 2404 <p>
2400 2405 -A/--after can be used to remove only files that have already
2401 2406 been deleted, -f/--force can be used to force deletion, and -Af
2402 2407 can be used to remove files from the next revision without
2403 2408 deleting them from the working directory.
2404 2409 </p>
2405 2410 <p>
2406 2411 The following table details the behavior of remove for different
2407 2412 file states (columns) and option combinations (rows). The file
2408 2413 states are Added [A], Clean [C], Modified [M] and Missing [!]
2409 2414 (as reported by &quot;hg status&quot;). The actions are Warn, Remove
2410 2415 (from branch) and Delete (from disk):
2411 2416 </p>
2412 2417 <table>
2413 2418 <tr><td>opt/state</td>
2414 2419 <td>A</td>
2415 2420 <td>C</td>
2416 2421 <td>M</td>
2417 2422 <td>!</td></tr>
2418 2423 <tr><td>none</td>
2419 2424 <td>W</td>
2420 2425 <td>RD</td>
2421 2426 <td>W</td>
2422 2427 <td>R</td></tr>
2423 2428 <tr><td>-f</td>
2424 2429 <td>R</td>
2425 2430 <td>RD</td>
2426 2431 <td>RD</td>
2427 2432 <td>R</td></tr>
2428 2433 <tr><td>-A</td>
2429 2434 <td>W</td>
2430 2435 <td>W</td>
2431 2436 <td>W</td>
2432 2437 <td>R</td></tr>
2433 2438 <tr><td>-Af</td>
2434 2439 <td>R</td>
2435 2440 <td>R</td>
2436 2441 <td>R</td>
2437 2442 <td>R</td></tr>
2438 2443 </table>
2439 2444 <p>
2440 2445 <b>Note:</b>
2441 2446 </p>
2442 2447 <p>
2443 2448 &quot;hg remove&quot; never deletes files in Added [A] state from the
2444 2449 working directory, not even if &quot;--force&quot; is specified.
2445 2450 </p>
2446 2451 <p>
2447 2452 Returns 0 on success, 1 if any warnings encountered.
2448 2453 </p>
2449 2454 <p>
2450 2455 options ([+] can be repeated):
2451 2456 </p>
2452 2457 <table>
2453 2458 <tr><td>-A</td>
2454 2459 <td>--after</td>
2455 2460 <td>record delete for missing files</td></tr>
2456 2461 <tr><td>-f</td>
2457 2462 <td>--force</td>
2458 2463 <td>remove (and delete) file even if added or modified</td></tr>
2459 2464 <tr><td>-S</td>
2460 2465 <td>--subrepos</td>
2461 2466 <td>recurse into subrepositories</td></tr>
2462 2467 <tr><td>-I</td>
2463 2468 <td>--include PATTERN [+]</td>
2464 2469 <td>include names matching the given patterns</td></tr>
2465 2470 <tr><td>-X</td>
2466 2471 <td>--exclude PATTERN [+]</td>
2467 2472 <td>exclude names matching the given patterns</td></tr>
2468 2473 </table>
2469 2474 <p>
2470 2475 global options ([+] can be repeated):
2471 2476 </p>
2472 2477 <table>
2473 2478 <tr><td>-R</td>
2474 2479 <td>--repository REPO</td>
2475 2480 <td>repository root directory or name of overlay bundle file</td></tr>
2476 2481 <tr><td></td>
2477 2482 <td>--cwd DIR</td>
2478 2483 <td>change working directory</td></tr>
2479 2484 <tr><td>-y</td>
2480 2485 <td>--noninteractive</td>
2481 2486 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2482 2487 <tr><td>-q</td>
2483 2488 <td>--quiet</td>
2484 2489 <td>suppress output</td></tr>
2485 2490 <tr><td>-v</td>
2486 2491 <td>--verbose</td>
2487 2492 <td>enable additional output</td></tr>
2488 2493 <tr><td></td>
2489 2494 <td>--config CONFIG [+]</td>
2490 2495 <td>set/override config option (use 'section.name=value')</td></tr>
2491 2496 <tr><td></td>
2492 2497 <td>--debug</td>
2493 2498 <td>enable debugging output</td></tr>
2494 2499 <tr><td></td>
2495 2500 <td>--debugger</td>
2496 2501 <td>start debugger</td></tr>
2497 2502 <tr><td></td>
2498 2503 <td>--encoding ENCODE</td>
2499 2504 <td>set the charset encoding (default: ascii)</td></tr>
2500 2505 <tr><td></td>
2501 2506 <td>--encodingmode MODE</td>
2502 2507 <td>set the charset encoding mode (default: strict)</td></tr>
2503 2508 <tr><td></td>
2504 2509 <td>--traceback</td>
2505 2510 <td>always print a traceback on exception</td></tr>
2506 2511 <tr><td></td>
2507 2512 <td>--time</td>
2508 2513 <td>time how long the command takes</td></tr>
2509 2514 <tr><td></td>
2510 2515 <td>--profile</td>
2511 2516 <td>print command execution profile</td></tr>
2512 2517 <tr><td></td>
2513 2518 <td>--version</td>
2514 2519 <td>output version information and exit</td></tr>
2515 2520 <tr><td>-h</td>
2516 2521 <td>--help</td>
2517 2522 <td>display help and exit</td></tr>
2518 2523 <tr><td></td>
2519 2524 <td>--hidden</td>
2520 2525 <td>consider hidden changesets</td></tr>
2521 2526 </table>
2522 2527
2523 2528 </div>
2524 2529 </div>
2525 2530 </div>
2526 2531
2527 2532 <script type="text/javascript">process_dates()</script>
2528 2533
2529 2534
2530 2535 </body>
2531 2536 </html>
2532 2537
2533 2538
2534 2539 $ get-with-headers.py 127.0.0.1:$HGPORT "help/revisions"
2535 2540 200 Script output follows
2536 2541
2537 2542 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2538 2543 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2539 2544 <head>
2540 2545 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2541 2546 <meta name="robots" content="index, nofollow" />
2542 2547 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2543 2548 <script type="text/javascript" src="/static/mercurial.js"></script>
2544 2549
2545 2550 <title>Help: revisions</title>
2546 2551 </head>
2547 2552 <body>
2548 2553
2549 2554 <div class="container">
2550 2555 <div class="menu">
2551 2556 <div class="logo">
2552 2557 <a href="https://mercurial-scm.org/">
2553 2558 <img src="/static/hglogo.png" alt="mercurial" /></a>
2554 2559 </div>
2555 2560 <ul>
2556 2561 <li><a href="/shortlog">log</a></li>
2557 2562 <li><a href="/graph">graph</a></li>
2558 2563 <li><a href="/tags">tags</a></li>
2559 2564 <li><a href="/bookmarks">bookmarks</a></li>
2560 2565 <li><a href="/branches">branches</a></li>
2561 2566 </ul>
2562 2567 <ul>
2563 2568 <li class="active"><a href="/help">help</a></li>
2564 2569 </ul>
2565 2570 </div>
2566 2571
2567 2572 <div class="main">
2568 2573 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2569 2574 <h3>Help: revisions</h3>
2570 2575
2571 2576 <form class="search" action="/log">
2572 2577
2573 2578 <p><input name="rev" id="search1" type="text" size="30" /></p>
2574 2579 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2575 2580 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2576 2581 </form>
2577 2582 <div id="doc">
2578 2583 <h1>Specifying Single Revisions</h1>
2579 2584 <p>
2580 2585 Mercurial supports several ways to specify individual revisions.
2581 2586 </p>
2582 2587 <p>
2583 2588 A plain integer is treated as a revision number. Negative integers are
2584 2589 treated as sequential offsets from the tip, with -1 denoting the tip,
2585 2590 -2 denoting the revision prior to the tip, and so forth.
2586 2591 </p>
2587 2592 <p>
2588 2593 A 40-digit hexadecimal string is treated as a unique revision
2589 2594 identifier.
2590 2595 </p>
2591 2596 <p>
2592 2597 A hexadecimal string less than 40 characters long is treated as a
2593 2598 unique revision identifier and is referred to as a short-form
2594 2599 identifier. A short-form identifier is only valid if it is the prefix
2595 2600 of exactly one full-length identifier.
2596 2601 </p>
2597 2602 <p>
2598 2603 Any other string is treated as a bookmark, tag, or branch name. A
2599 2604 bookmark is a movable pointer to a revision. A tag is a permanent name
2600 2605 associated with a revision. A branch name denotes the tipmost open branch head
2601 2606 of that branch - or if they are all closed, the tipmost closed head of the
2602 2607 branch. Bookmark, tag, and branch names must not contain the &quot;:&quot; character.
2603 2608 </p>
2604 2609 <p>
2605 2610 The reserved name &quot;tip&quot; always identifies the most recent revision.
2606 2611 </p>
2607 2612 <p>
2608 2613 The reserved name &quot;null&quot; indicates the null revision. This is the
2609 2614 revision of an empty repository, and the parent of revision 0.
2610 2615 </p>
2611 2616 <p>
2612 2617 The reserved name &quot;.&quot; indicates the working directory parent. If no
2613 2618 working directory is checked out, it is equivalent to null. If an
2614 2619 uncommitted merge is in progress, &quot;.&quot; is the revision of the first
2615 2620 parent.
2616 2621 </p>
2617 2622
2618 2623 </div>
2619 2624 </div>
2620 2625 </div>
2621 2626
2622 2627 <script type="text/javascript">process_dates()</script>
2623 2628
2624 2629
2625 2630 </body>
2626 2631 </html>
2627 2632
2628 2633
2629 2634 $ killdaemons.py
2630 2635
2631 2636 #endif
General Comments 0
You need to be logged in to leave comments. Login now