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