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