##// END OF EJS Templates
tests: port test extension in test-help.t to python 3...
Augie Fackler -
r32545:37863db5 default
parent child Browse files
Show More
@@ -1,3338 +1,3338 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 bundle 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 revision history for a pattern in specified files
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 bundle 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 bundlespec Bundle File Formats
106 106 color Colorizing Outputs
107 107 config Configuration Files
108 108 dates Date Formats
109 109 diffs Diff Formats
110 110 environment Environment Variables
111 111 extensions Using Additional Features
112 112 filesets Specifying File Sets
113 113 glossary Glossary
114 114 hgignore Syntax for Mercurial Ignore Files
115 115 hgweb Configuring hgweb
116 116 internals Technical implementation topics
117 117 merge-tools Merge Tools
118 118 pager Pager Support
119 119 patterns File Name Patterns
120 120 phases Working with Phases
121 121 revisions Specifying Revisions
122 122 scripting Using Mercurial from scripts and automation
123 123 subrepos Subrepositories
124 124 templating Template Usage
125 125 urls URL Paths
126 126
127 127 (use 'hg help -v' to show built-in aliases and global options)
128 128
129 129 $ hg -q help
130 130 add add the specified files on the next commit
131 131 addremove add all new files, delete all missing files
132 132 annotate show changeset information by line for each file
133 133 archive create an unversioned archive of a repository revision
134 134 backout reverse effect of earlier changeset
135 135 bisect subdivision search of changesets
136 136 bookmarks create a new bookmark or list existing bookmarks
137 137 branch set or show the current branch name
138 138 branches list repository named branches
139 139 bundle create a bundle file
140 140 cat output the current or given revision of files
141 141 clone make a copy of an existing repository
142 142 commit commit the specified files or all outstanding changes
143 143 config show combined config settings from all hgrc files
144 144 copy mark files as copied for the next commit
145 145 diff diff repository (or selected files)
146 146 export dump the header and diffs for one or more changesets
147 147 files list tracked files
148 148 forget forget the specified files on the next commit
149 149 graft copy changes from other branches onto the current branch
150 150 grep search revision history for a pattern in specified files
151 151 heads show branch heads
152 152 help show help for a given topic or a help overview
153 153 identify identify the working directory or specified revision
154 154 import import an ordered set of patches
155 155 incoming show new changesets found in source
156 156 init create a new repository in the given directory
157 157 log show revision history of entire repository or files
158 158 manifest output the current or given revision of the project manifest
159 159 merge merge another revision into working directory
160 160 outgoing show changesets not found in the destination
161 161 paths show aliases for remote repositories
162 162 phase set or show the current phase name
163 163 pull pull changes from the specified source
164 164 push push changes to the specified destination
165 165 recover roll back an interrupted transaction
166 166 remove remove the specified files on the next commit
167 167 rename rename files; equivalent of copy + remove
168 168 resolve redo merges or set/view the merge status of files
169 169 revert restore files to their checkout state
170 170 root print the root (top) of the current working directory
171 171 serve start stand-alone webserver
172 172 status show changed files in the working directory
173 173 summary summarize working directory state
174 174 tag add one or more tags for the current or given revision
175 175 tags list repository tags
176 176 unbundle apply one or more bundle files
177 177 update update working directory (or switch revisions)
178 178 verify verify the integrity of the repository
179 179 version output version and copyright information
180 180
181 181 additional help topics:
182 182
183 183 bundlespec Bundle File Formats
184 184 color Colorizing Outputs
185 185 config Configuration Files
186 186 dates Date Formats
187 187 diffs Diff Formats
188 188 environment Environment Variables
189 189 extensions Using Additional Features
190 190 filesets Specifying File Sets
191 191 glossary Glossary
192 192 hgignore Syntax for Mercurial Ignore Files
193 193 hgweb Configuring hgweb
194 194 internals Technical implementation topics
195 195 merge-tools Merge Tools
196 196 pager Pager Support
197 197 patterns File Name Patterns
198 198 phases Working with Phases
199 199 revisions Specifying Revisions
200 200 scripting Using Mercurial from scripts and automation
201 201 subrepos Subrepositories
202 202 templating Template Usage
203 203 urls URL Paths
204 204
205 205 Test extension help:
206 206 $ hg help extensions --config extensions.rebase= --config extensions.children=
207 207 Using Additional Features
208 208 """""""""""""""""""""""""
209 209
210 210 Mercurial has the ability to add new features through the use of
211 211 extensions. Extensions may add new commands, add options to existing
212 212 commands, change the default behavior of commands, or implement hooks.
213 213
214 214 To enable the "foo" extension, either shipped with Mercurial or in the
215 215 Python search path, create an entry for it in your configuration file,
216 216 like this:
217 217
218 218 [extensions]
219 219 foo =
220 220
221 221 You may also specify the full path to an extension:
222 222
223 223 [extensions]
224 224 myfeature = ~/.hgext/myfeature.py
225 225
226 226 See 'hg help config' for more information on configuration files.
227 227
228 228 Extensions are not loaded by default for a variety of reasons: they can
229 229 increase startup overhead; they may be meant for advanced usage only; they
230 230 may provide potentially dangerous abilities (such as letting you destroy
231 231 or modify history); they might not be ready for prime time; or they may
232 232 alter some usual behaviors of stock Mercurial. It is thus up to the user
233 233 to activate extensions as needed.
234 234
235 235 To explicitly disable an extension enabled in a configuration file of
236 236 broader scope, prepend its path with !:
237 237
238 238 [extensions]
239 239 # disabling extension bar residing in /path/to/extension/bar.py
240 240 bar = !/path/to/extension/bar.py
241 241 # ditto, but no path was supplied for extension baz
242 242 baz = !
243 243
244 244 enabled extensions:
245 245
246 246 children command to display child changesets (DEPRECATED)
247 247 rebase command to move sets of revisions to a different ancestor
248 248
249 249 disabled extensions:
250 250
251 251 acl hooks for controlling repository access
252 252 blackbox log repository events to a blackbox for debugging
253 253 bugzilla hooks for integrating with the Bugzilla bug tracker
254 254 censor erase file content at a given revision
255 255 churn command to display statistics about repository history
256 256 clonebundles advertise pre-generated bundles to seed clones
257 257 convert import revisions from foreign VCS repositories into
258 258 Mercurial
259 259 eol automatically manage newlines in repository files
260 260 extdiff command to allow external programs to compare revisions
261 261 factotum http authentication with factotum
262 262 gpg commands to sign and verify changesets
263 263 hgk browse the repository in a graphical way
264 264 highlight syntax highlighting for hgweb (requires Pygments)
265 265 histedit interactive history editing
266 266 keyword expand keywords in tracked files
267 267 largefiles track large binary files
268 268 mq manage a stack of patches
269 269 notify hooks for sending email push notifications
270 270 patchbomb command to send changesets as (a series of) patch emails
271 271 purge command to delete untracked files from the working
272 272 directory
273 273 relink recreates hardlinks between repository clones
274 274 schemes extend schemes with shortcuts to repository swarms
275 275 share share a common history between several working directories
276 276 shelve save and restore changes to the working directory
277 277 strip strip changesets and their descendants from history
278 278 transplant command to transplant changesets from another branch
279 279 win32mbcs allow the use of MBCS paths with problematic encodings
280 280 zeroconf discover and advertise repositories on the local network
281 281
282 282 Verify that extension keywords appear in help templates
283 283
284 284 $ hg help --config extensions.transplant= templating|grep transplant > /dev/null
285 285
286 286 Test short command list with verbose option
287 287
288 288 $ hg -v help shortlist
289 289 Mercurial Distributed SCM
290 290
291 291 basic commands:
292 292
293 293 add add the specified files on the next commit
294 294 annotate, blame
295 295 show changeset information by line for each file
296 296 clone make a copy of an existing repository
297 297 commit, ci commit the specified files or all outstanding changes
298 298 diff diff repository (or selected files)
299 299 export dump the header and diffs for one or more changesets
300 300 forget forget the specified files on the next commit
301 301 init create a new repository in the given directory
302 302 log, history show revision history of entire repository or files
303 303 merge merge another revision into working directory
304 304 pull pull changes from the specified source
305 305 push push changes to the specified destination
306 306 remove, rm remove the specified files on the next commit
307 307 serve start stand-alone webserver
308 308 status, st show changed files in the working directory
309 309 summary, sum summarize working directory state
310 310 update, up, checkout, co
311 311 update working directory (or switch revisions)
312 312
313 313 global options ([+] can be repeated):
314 314
315 315 -R --repository REPO repository root directory or name of overlay bundle
316 316 file
317 317 --cwd DIR change working directory
318 318 -y --noninteractive do not prompt, automatically pick the first choice for
319 319 all prompts
320 320 -q --quiet suppress output
321 321 -v --verbose enable additional output
322 322 --color TYPE when to colorize (boolean, always, auto, never, or
323 323 debug)
324 324 --config CONFIG [+] set/override config option (use 'section.name=value')
325 325 --debug enable debugging output
326 326 --debugger start debugger
327 327 --encoding ENCODE set the charset encoding (default: ascii)
328 328 --encodingmode MODE set the charset encoding mode (default: strict)
329 329 --traceback always print a traceback on exception
330 330 --time time how long the command takes
331 331 --profile print command execution profile
332 332 --version output version information and exit
333 333 -h --help display help and exit
334 334 --hidden consider hidden changesets
335 335 --pager TYPE when to paginate (boolean, always, auto, or never)
336 336 (default: auto)
337 337
338 338 (use 'hg help' for the full list of commands)
339 339
340 340 $ hg add -h
341 341 hg add [OPTION]... [FILE]...
342 342
343 343 add the specified files on the next commit
344 344
345 345 Schedule files to be version controlled and added to the repository.
346 346
347 347 The files will be added to the repository at the next commit. To undo an
348 348 add before that, see 'hg forget'.
349 349
350 350 If no names are given, add all files to the repository (except files
351 351 matching ".hgignore").
352 352
353 353 Returns 0 if all files are successfully added.
354 354
355 355 options ([+] can be repeated):
356 356
357 357 -I --include PATTERN [+] include names matching the given patterns
358 358 -X --exclude PATTERN [+] exclude names matching the given patterns
359 359 -S --subrepos recurse into subrepositories
360 360 -n --dry-run do not perform actions, just print output
361 361
362 362 (some details hidden, use --verbose to show complete help)
363 363
364 364 Verbose help for add
365 365
366 366 $ hg add -hv
367 367 hg add [OPTION]... [FILE]...
368 368
369 369 add the specified files on the next commit
370 370
371 371 Schedule files to be version controlled and added to the repository.
372 372
373 373 The files will be added to the repository at the next commit. To undo an
374 374 add before that, see 'hg forget'.
375 375
376 376 If no names are given, add all files to the repository (except files
377 377 matching ".hgignore").
378 378
379 379 Examples:
380 380
381 381 - New (unknown) files are added automatically by 'hg add':
382 382
383 383 $ ls
384 384 foo.c
385 385 $ hg status
386 386 ? foo.c
387 387 $ hg add
388 388 adding foo.c
389 389 $ hg status
390 390 A foo.c
391 391
392 392 - Specific files to be added can be specified:
393 393
394 394 $ ls
395 395 bar.c foo.c
396 396 $ hg status
397 397 ? bar.c
398 398 ? foo.c
399 399 $ hg add bar.c
400 400 $ hg status
401 401 A bar.c
402 402 ? foo.c
403 403
404 404 Returns 0 if all files are successfully added.
405 405
406 406 options ([+] can be repeated):
407 407
408 408 -I --include PATTERN [+] include names matching the given patterns
409 409 -X --exclude PATTERN [+] exclude names matching the given patterns
410 410 -S --subrepos recurse into subrepositories
411 411 -n --dry-run do not perform actions, just print output
412 412
413 413 global options ([+] can be repeated):
414 414
415 415 -R --repository REPO repository root directory or name of overlay bundle
416 416 file
417 417 --cwd DIR change working directory
418 418 -y --noninteractive do not prompt, automatically pick the first choice for
419 419 all prompts
420 420 -q --quiet suppress output
421 421 -v --verbose enable additional output
422 422 --color TYPE when to colorize (boolean, always, auto, never, or
423 423 debug)
424 424 --config CONFIG [+] set/override config option (use 'section.name=value')
425 425 --debug enable debugging output
426 426 --debugger start debugger
427 427 --encoding ENCODE set the charset encoding (default: ascii)
428 428 --encodingmode MODE set the charset encoding mode (default: strict)
429 429 --traceback always print a traceback on exception
430 430 --time time how long the command takes
431 431 --profile print command execution profile
432 432 --version output version information and exit
433 433 -h --help display help and exit
434 434 --hidden consider hidden changesets
435 435 --pager TYPE when to paginate (boolean, always, auto, or never)
436 436 (default: auto)
437 437
438 438 Test the textwidth config option
439 439
440 440 $ hg root -h --config ui.textwidth=50
441 441 hg root
442 442
443 443 print the root (top) of the current working
444 444 directory
445 445
446 446 Print the root directory of the current
447 447 repository.
448 448
449 449 Returns 0 on success.
450 450
451 451 (some details hidden, use --verbose to show
452 452 complete help)
453 453
454 454 Test help option with version option
455 455
456 456 $ hg add -h --version
457 457 Mercurial Distributed SCM (version *) (glob)
458 458 (see https://mercurial-scm.org for more information)
459 459
460 460 Copyright (C) 2005-* Matt Mackall and others (glob)
461 461 This is free software; see the source for copying conditions. There is NO
462 462 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
463 463
464 464 $ hg add --skjdfks
465 465 hg add: option --skjdfks not recognized
466 466 hg add [OPTION]... [FILE]...
467 467
468 468 add the specified files on the next commit
469 469
470 470 options ([+] can be repeated):
471 471
472 472 -I --include PATTERN [+] include names matching the given patterns
473 473 -X --exclude PATTERN [+] exclude names matching the given patterns
474 474 -S --subrepos recurse into subrepositories
475 475 -n --dry-run do not perform actions, just print output
476 476
477 477 (use 'hg add -h' to show more help)
478 478 [255]
479 479
480 480 Test ambiguous command help
481 481
482 482 $ hg help ad
483 483 list of commands:
484 484
485 485 add add the specified files on the next commit
486 486 addremove add all new files, delete all missing files
487 487
488 488 (use 'hg help -v ad' to show built-in aliases and global options)
489 489
490 490 Test command without options
491 491
492 492 $ hg help verify
493 493 hg verify
494 494
495 495 verify the integrity of the repository
496 496
497 497 Verify the integrity of the current repository.
498 498
499 499 This will perform an extensive check of the repository's integrity,
500 500 validating the hashes and checksums of each entry in the changelog,
501 501 manifest, and tracked files, as well as the integrity of their crosslinks
502 502 and indices.
503 503
504 504 Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more
505 505 information about recovery from corruption of the repository.
506 506
507 507 Returns 0 on success, 1 if errors are encountered.
508 508
509 509 (some details hidden, use --verbose to show complete help)
510 510
511 511 $ hg help diff
512 512 hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
513 513
514 514 diff repository (or selected files)
515 515
516 516 Show differences between revisions for the specified files.
517 517
518 518 Differences between files are shown using the unified diff format.
519 519
520 520 Note:
521 521 'hg diff' may generate unexpected results for merges, as it will
522 522 default to comparing against the working directory's first parent
523 523 changeset if no revisions are specified.
524 524
525 525 When two revision arguments are given, then changes are shown between
526 526 those revisions. If only one revision is specified then that revision is
527 527 compared to the working directory, and, when no revisions are specified,
528 528 the working directory files are compared to its first parent.
529 529
530 530 Alternatively you can specify -c/--change with a revision to see the
531 531 changes in that changeset relative to its first parent.
532 532
533 533 Without the -a/--text option, diff will avoid generating diffs of files it
534 534 detects as binary. With -a, diff will generate a diff anyway, probably
535 535 with undesirable results.
536 536
537 537 Use the -g/--git option to generate diffs in the git extended diff format.
538 538 For more information, read 'hg help diffs'.
539 539
540 540 Returns 0 on success.
541 541
542 542 options ([+] can be repeated):
543 543
544 544 -r --rev REV [+] revision
545 545 -c --change REV change made by revision
546 546 -a --text treat all files as text
547 547 -g --git use git extended diff format
548 548 --binary generate binary diffs in git mode (default)
549 549 --nodates omit dates from diff headers
550 550 --noprefix omit a/ and b/ prefixes from filenames
551 551 -p --show-function show which function each change is in
552 552 --reverse produce a diff that undoes the changes
553 553 -w --ignore-all-space ignore white space when comparing lines
554 554 -b --ignore-space-change ignore changes in the amount of white space
555 555 -B --ignore-blank-lines ignore changes whose lines are all blank
556 556 -U --unified NUM number of lines of context to show
557 557 --stat output diffstat-style summary of changes
558 558 --root DIR produce diffs relative to subdirectory
559 559 -I --include PATTERN [+] include names matching the given patterns
560 560 -X --exclude PATTERN [+] exclude names matching the given patterns
561 561 -S --subrepos recurse into subrepositories
562 562
563 563 (some details hidden, use --verbose to show complete help)
564 564
565 565 $ hg help status
566 566 hg status [OPTION]... [FILE]...
567 567
568 568 aliases: st
569 569
570 570 show changed files in the working directory
571 571
572 572 Show status of files in the repository. If names are given, only files
573 573 that match are shown. Files that are clean or ignored or the source of a
574 574 copy/move operation, are not listed unless -c/--clean, -i/--ignored,
575 575 -C/--copies or -A/--all are given. Unless options described with "show
576 576 only ..." are given, the options -mardu are used.
577 577
578 578 Option -q/--quiet hides untracked (unknown and ignored) files unless
579 579 explicitly requested with -u/--unknown or -i/--ignored.
580 580
581 581 Note:
582 582 'hg status' may appear to disagree with diff if permissions have
583 583 changed or a merge has occurred. The standard diff format does not
584 584 report permission changes and diff only reports changes relative to one
585 585 merge parent.
586 586
587 587 If one revision is given, it is used as the base revision. If two
588 588 revisions are given, the differences between them are shown. The --change
589 589 option can also be used as a shortcut to list the changed files of a
590 590 revision from its first parent.
591 591
592 592 The codes used to show the status of files are:
593 593
594 594 M = modified
595 595 A = added
596 596 R = removed
597 597 C = clean
598 598 ! = missing (deleted by non-hg command, but still tracked)
599 599 ? = not tracked
600 600 I = ignored
601 601 = origin of the previous file (with --copies)
602 602
603 603 Returns 0 on success.
604 604
605 605 options ([+] can be repeated):
606 606
607 607 -A --all show status of all files
608 608 -m --modified show only modified files
609 609 -a --added show only added files
610 610 -r --removed show only removed files
611 611 -d --deleted show only deleted (but tracked) files
612 612 -c --clean show only files without changes
613 613 -u --unknown show only unknown (not tracked) files
614 614 -i --ignored show only ignored files
615 615 -n --no-status hide status prefix
616 616 -C --copies show source of copied files
617 617 -0 --print0 end filenames with NUL, for use with xargs
618 618 --rev REV [+] show difference from revision
619 619 --change REV list the changed files of a revision
620 620 -I --include PATTERN [+] include names matching the given patterns
621 621 -X --exclude PATTERN [+] exclude names matching the given patterns
622 622 -S --subrepos recurse into subrepositories
623 623
624 624 (some details hidden, use --verbose to show complete help)
625 625
626 626 $ hg -q help status
627 627 hg status [OPTION]... [FILE]...
628 628
629 629 show changed files in the working directory
630 630
631 631 $ hg help foo
632 632 abort: no such help topic: foo
633 633 (try 'hg help --keyword foo')
634 634 [255]
635 635
636 636 $ hg skjdfks
637 637 hg: unknown command 'skjdfks'
638 638 Mercurial Distributed SCM
639 639
640 640 basic commands:
641 641
642 642 add add the specified files on the next commit
643 643 annotate show changeset information by line for each file
644 644 clone make a copy of an existing repository
645 645 commit commit the specified files or all outstanding changes
646 646 diff diff repository (or selected files)
647 647 export dump the header and diffs for one or more changesets
648 648 forget forget the specified files on the next commit
649 649 init create a new repository in the given directory
650 650 log show revision history of entire repository or files
651 651 merge merge another revision into working directory
652 652 pull pull changes from the specified source
653 653 push push changes to the specified destination
654 654 remove remove the specified files on the next commit
655 655 serve start stand-alone webserver
656 656 status show changed files in the working directory
657 657 summary summarize working directory state
658 658 update update working directory (or switch revisions)
659 659
660 660 (use 'hg help' for the full list of commands or 'hg -v' for details)
661 661 [255]
662 662
663 663
664 664 Make sure that we don't run afoul of the help system thinking that
665 665 this is a section and erroring out weirdly.
666 666
667 667 $ hg .log
668 668 hg: unknown command '.log'
669 669 (did you mean log?)
670 670 [255]
671 671
672 672 $ hg log.
673 673 hg: unknown command 'log.'
674 674 (did you mean log?)
675 675 [255]
676 676 $ hg pu.lh
677 677 hg: unknown command 'pu.lh'
678 678 (did you mean one of pull, push?)
679 679 [255]
680 680
681 681 $ cat > helpext.py <<EOF
682 682 > import os
683 683 > from mercurial import commands, registrar
684 684 >
685 685 > cmdtable = {}
686 686 > command = registrar.command(cmdtable)
687 687 >
688 > @command('nohelp',
689 > [('', 'longdesc', 3, 'x'*90),
690 > ('n', '', None, 'normal desc'),
691 > ('', 'newline', '', 'line1\nline2')],
692 > 'hg nohelp',
688 > @command(b'nohelp',
689 > [(b'', b'longdesc', 3, b'x'*90),
690 > (b'n', b'', None, b'normal desc'),
691 > (b'', b'newline', b'', b'line1\nline2')],
692 > b'hg nohelp',
693 693 > norepo=True)
694 > @command('debugoptADV', [('', 'aopt', None, 'option is (ADVANCED)')])
695 > @command('debugoptDEP', [('', 'dopt', None, 'option is (DEPRECATED)')])
696 > @command('debugoptEXP', [('', 'eopt', None, 'option is (EXPERIMENTAL)')])
694 > @command(b'debugoptADV', [(b'', b'aopt', None, b'option is (ADVANCED)')])
695 > @command(b'debugoptDEP', [(b'', b'dopt', None, b'option is (DEPRECATED)')])
696 > @command(b'debugoptEXP', [(b'', b'eopt', None, b'option is (EXPERIMENTAL)')])
697 697 > def nohelp(ui, *args, **kwargs):
698 698 > pass
699 699 >
700 700 > def uisetup(ui):
701 > ui.setconfig('alias', 'shellalias', '!echo hi', 'helpext')
702 > ui.setconfig('alias', 'hgalias', 'summary', 'helpext')
701 > ui.setconfig(b'alias', b'shellalias', b'!echo hi', b'helpext')
702 > ui.setconfig(b'alias', b'hgalias', b'summary', b'helpext')
703 703 >
704 704 > EOF
705 705 $ echo '[extensions]' >> $HGRCPATH
706 706 $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
707 707
708 708 Test for aliases
709 709
710 710 $ hg help hgalias
711 711 hg hgalias [--remote]
712 712
713 713 alias for: hg summary
714 714
715 715 summarize working directory state
716 716
717 717 This generates a brief summary of the working directory state, including
718 718 parents, branch, commit status, phase and available updates.
719 719
720 720 With the --remote option, this will check the default paths for incoming
721 721 and outgoing changes. This can be time-consuming.
722 722
723 723 Returns 0 on success.
724 724
725 725 defined by: helpext
726 726
727 727 options:
728 728
729 729 --remote check for push and pull
730 730
731 731 (some details hidden, use --verbose to show complete help)
732 732
733 733 $ hg help shellalias
734 734 hg shellalias
735 735
736 736 shell alias for:
737 737
738 738 echo hi
739 739
740 740 defined by: helpext
741 741
742 742 (some details hidden, use --verbose to show complete help)
743 743
744 744 Test command with no help text
745 745
746 746 $ hg help nohelp
747 747 hg nohelp
748 748
749 749 (no help text available)
750 750
751 751 options:
752 752
753 753 --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
754 754 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (default: 3)
755 755 -n -- normal desc
756 756 --newline VALUE line1 line2
757 757
758 758 (some details hidden, use --verbose to show complete help)
759 759
760 760 $ hg help -k nohelp
761 761 Commands:
762 762
763 763 nohelp hg nohelp
764 764
765 765 Extension Commands:
766 766
767 767 nohelp (no help text available)
768 768
769 769 Test that default list of commands omits extension commands
770 770
771 771 $ hg help
772 772 Mercurial Distributed SCM
773 773
774 774 list of commands:
775 775
776 776 add add the specified files on the next commit
777 777 addremove add all new files, delete all missing files
778 778 annotate show changeset information by line for each file
779 779 archive create an unversioned archive of a repository revision
780 780 backout reverse effect of earlier changeset
781 781 bisect subdivision search of changesets
782 782 bookmarks create a new bookmark or list existing bookmarks
783 783 branch set or show the current branch name
784 784 branches list repository named branches
785 785 bundle create a bundle file
786 786 cat output the current or given revision of files
787 787 clone make a copy of an existing repository
788 788 commit commit the specified files or all outstanding changes
789 789 config show combined config settings from all hgrc files
790 790 copy mark files as copied for the next commit
791 791 diff diff repository (or selected files)
792 792 export dump the header and diffs for one or more changesets
793 793 files list tracked files
794 794 forget forget the specified files on the next commit
795 795 graft copy changes from other branches onto the current branch
796 796 grep search revision history for a pattern in specified files
797 797 heads show branch heads
798 798 help show help for a given topic or a help overview
799 799 identify identify the working directory or specified revision
800 800 import import an ordered set of patches
801 801 incoming show new changesets found in source
802 802 init create a new repository in the given directory
803 803 log show revision history of entire repository or files
804 804 manifest output the current or given revision of the project manifest
805 805 merge merge another revision into working directory
806 806 outgoing show changesets not found in the destination
807 807 paths show aliases for remote repositories
808 808 phase set or show the current phase name
809 809 pull pull changes from the specified source
810 810 push push changes to the specified destination
811 811 recover roll back an interrupted transaction
812 812 remove remove the specified files on the next commit
813 813 rename rename files; equivalent of copy + remove
814 814 resolve redo merges or set/view the merge status of files
815 815 revert restore files to their checkout state
816 816 root print the root (top) of the current working directory
817 817 serve start stand-alone webserver
818 818 status show changed files in the working directory
819 819 summary summarize working directory state
820 820 tag add one or more tags for the current or given revision
821 821 tags list repository tags
822 822 unbundle apply one or more bundle files
823 823 update update working directory (or switch revisions)
824 824 verify verify the integrity of the repository
825 825 version output version and copyright information
826 826
827 827 enabled extensions:
828 828
829 829 helpext (no help text available)
830 830
831 831 additional help topics:
832 832
833 833 bundlespec Bundle File Formats
834 834 color Colorizing Outputs
835 835 config Configuration Files
836 836 dates Date Formats
837 837 diffs Diff Formats
838 838 environment Environment Variables
839 839 extensions Using Additional Features
840 840 filesets Specifying File Sets
841 841 glossary Glossary
842 842 hgignore Syntax for Mercurial Ignore Files
843 843 hgweb Configuring hgweb
844 844 internals Technical implementation topics
845 845 merge-tools Merge Tools
846 846 pager Pager Support
847 847 patterns File Name Patterns
848 848 phases Working with Phases
849 849 revisions Specifying Revisions
850 850 scripting Using Mercurial from scripts and automation
851 851 subrepos Subrepositories
852 852 templating Template Usage
853 853 urls URL Paths
854 854
855 855 (use 'hg help -v' to show built-in aliases and global options)
856 856
857 857
858 858 Test list of internal help commands
859 859
860 860 $ hg help debug
861 861 debug commands (internal and unsupported):
862 862
863 863 debugancestor
864 864 find the ancestor revision of two revisions in a given index
865 865 debugapplystreamclonebundle
866 866 apply a stream clone bundle file
867 867 debugbuilddag
868 868 builds a repo with a given DAG from scratch in the current
869 869 empty repo
870 870 debugbundle lists the contents of a bundle
871 871 debugcheckstate
872 872 validate the correctness of the current dirstate
873 873 debugcolor show available color, effects or style
874 874 debugcommands
875 875 list all available commands and options
876 876 debugcomplete
877 877 returns the completion list associated with the given command
878 878 debugcreatestreamclonebundle
879 879 create a stream clone bundle file
880 880 debugdag format the changelog or an index DAG as a concise textual
881 881 description
882 882 debugdata dump the contents of a data file revision
883 883 debugdate parse and display a date
884 884 debugdeltachain
885 885 dump information about delta chains in a revlog
886 886 debugdirstate
887 887 show the contents of the current dirstate
888 888 debugdiscovery
889 889 runs the changeset discovery protocol in isolation
890 890 debugextensions
891 891 show information about active extensions
892 892 debugfileset parse and apply a fileset specification
893 893 debugfsinfo show information detected about current filesystem
894 894 debuggetbundle
895 895 retrieves a bundle from a repo
896 896 debugignore display the combined ignore pattern and information about
897 897 ignored files
898 898 debugindex dump the contents of an index file
899 899 debugindexdot
900 900 dump an index DAG as a graphviz dot file
901 901 debuginstall test Mercurial installation
902 902 debugknown test whether node ids are known to a repo
903 903 debuglocks show or modify state of locks
904 904 debugmergestate
905 905 print merge state
906 906 debugnamecomplete
907 907 complete "names" - tags, open branch names, bookmark names
908 908 debugobsolete
909 909 create arbitrary obsolete marker
910 910 debugoptADV (no help text available)
911 911 debugoptDEP (no help text available)
912 912 debugoptEXP (no help text available)
913 913 debugpathcomplete
914 914 complete part or all of a tracked path
915 915 debugpickmergetool
916 916 examine which merge tool is chosen for specified file
917 917 debugpushkey access the pushkey key/value protocol
918 918 debugpvec (no help text available)
919 919 debugrebuilddirstate
920 920 rebuild the dirstate as it would look like for the given
921 921 revision
922 922 debugrebuildfncache
923 923 rebuild the fncache file
924 924 debugrename dump rename information
925 925 debugrevlog show data and statistics about a revlog
926 926 debugrevspec parse and apply a revision specification
927 927 debugsetparents
928 928 manually set the parents of the current working directory
929 929 debugsub (no help text available)
930 930 debugsuccessorssets
931 931 show set of successors for revision
932 932 debugtemplate
933 933 parse and apply a template
934 934 debugupdatecaches
935 935 warm all known caches in the repository
936 936 debugupgraderepo
937 937 upgrade a repository to use different features
938 938 debugwalk show how files match on given patterns
939 939 debugwireargs
940 940 (no help text available)
941 941
942 942 (use 'hg help -v debug' to show built-in aliases and global options)
943 943
944 944 internals topic renders index of available sub-topics
945 945
946 946 $ hg help internals
947 947 Technical implementation topics
948 948 """""""""""""""""""""""""""""""
949 949
950 950 To access a subtopic, use "hg help internals.{subtopic-name}"
951 951
952 952 bundles Bundles
953 953 censor Censor
954 954 changegroups Changegroups
955 955 requirements Repository Requirements
956 956 revlogs Revision Logs
957 957 wireprotocol Wire Protocol
958 958
959 959 sub-topics can be accessed
960 960
961 961 $ hg help internals.changegroups
962 962 Changegroups
963 963 """"""""""""
964 964
965 965 Changegroups are representations of repository revlog data, specifically
966 966 the changelog data, root/flat manifest data, treemanifest data, and
967 967 filelogs.
968 968
969 969 There are 3 versions of changegroups: "1", "2", and "3". From a high-
970 970 level, versions "1" and "2" are almost exactly the same, with the only
971 971 difference being an additional item in the *delta header*. Version "3"
972 972 adds support for revlog flags in the *delta header* and optionally
973 973 exchanging treemanifests (enabled by setting an option on the
974 974 "changegroup" part in the bundle2).
975 975
976 976 Changegroups when not exchanging treemanifests consist of 3 logical
977 977 segments:
978 978
979 979 +---------------------------------+
980 980 | | | |
981 981 | changeset | manifest | filelogs |
982 982 | | | |
983 983 | | | |
984 984 +---------------------------------+
985 985
986 986 When exchanging treemanifests, there are 4 logical segments:
987 987
988 988 +-------------------------------------------------+
989 989 | | | | |
990 990 | changeset | root | treemanifests | filelogs |
991 991 | | manifest | | |
992 992 | | | | |
993 993 +-------------------------------------------------+
994 994
995 995 The principle building block of each segment is a *chunk*. A *chunk* is a
996 996 framed piece of data:
997 997
998 998 +---------------------------------------+
999 999 | | |
1000 1000 | length | data |
1001 1001 | (4 bytes) | (<length - 4> bytes) |
1002 1002 | | |
1003 1003 +---------------------------------------+
1004 1004
1005 1005 All integers are big-endian signed integers. Each chunk starts with a
1006 1006 32-bit integer indicating the length of the entire chunk (including the
1007 1007 length field itself).
1008 1008
1009 1009 There is a special case chunk that has a value of 0 for the length
1010 1010 ("0x00000000"). We call this an *empty chunk*.
1011 1011
1012 1012 Delta Groups
1013 1013 ============
1014 1014
1015 1015 A *delta group* expresses the content of a revlog as a series of deltas,
1016 1016 or patches against previous revisions.
1017 1017
1018 1018 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
1019 1019 to signal the end of the delta group:
1020 1020
1021 1021 +------------------------------------------------------------------------+
1022 1022 | | | | | |
1023 1023 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
1024 1024 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
1025 1025 | | | | | |
1026 1026 +------------------------------------------------------------------------+
1027 1027
1028 1028 Each *chunk*'s data consists of the following:
1029 1029
1030 1030 +---------------------------------------+
1031 1031 | | |
1032 1032 | delta header | delta data |
1033 1033 | (various by version) | (various) |
1034 1034 | | |
1035 1035 +---------------------------------------+
1036 1036
1037 1037 The *delta data* is a series of *delta*s that describe a diff from an
1038 1038 existing entry (either that the recipient already has, or previously
1039 1039 specified in the bundle/changegroup).
1040 1040
1041 1041 The *delta header* is different between versions "1", "2", and "3" of the
1042 1042 changegroup format.
1043 1043
1044 1044 Version 1 (headerlen=80):
1045 1045
1046 1046 +------------------------------------------------------+
1047 1047 | | | | |
1048 1048 | node | p1 node | p2 node | link node |
1049 1049 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1050 1050 | | | | |
1051 1051 +------------------------------------------------------+
1052 1052
1053 1053 Version 2 (headerlen=100):
1054 1054
1055 1055 +------------------------------------------------------------------+
1056 1056 | | | | | |
1057 1057 | node | p1 node | p2 node | base node | link node |
1058 1058 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1059 1059 | | | | | |
1060 1060 +------------------------------------------------------------------+
1061 1061
1062 1062 Version 3 (headerlen=102):
1063 1063
1064 1064 +------------------------------------------------------------------------------+
1065 1065 | | | | | | |
1066 1066 | node | p1 node | p2 node | base node | link node | flags |
1067 1067 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
1068 1068 | | | | | | |
1069 1069 +------------------------------------------------------------------------------+
1070 1070
1071 1071 The *delta data* consists of "chunklen - 4 - headerlen" bytes, which
1072 1072 contain a series of *delta*s, densely packed (no separators). These deltas
1073 1073 describe a diff from an existing entry (either that the recipient already
1074 1074 has, or previously specified in the bundle/changegroup). The format is
1075 1075 described more fully in "hg help internals.bdiff", but briefly:
1076 1076
1077 1077 +---------------------------------------------------------------+
1078 1078 | | | | |
1079 1079 | start offset | end offset | new length | content |
1080 1080 | (4 bytes) | (4 bytes) | (4 bytes) | (<new length> bytes) |
1081 1081 | | | | |
1082 1082 +---------------------------------------------------------------+
1083 1083
1084 1084 Please note that the length field in the delta data does *not* include
1085 1085 itself.
1086 1086
1087 1087 In version 1, the delta is always applied against the previous node from
1088 1088 the changegroup or the first parent if this is the first entry in the
1089 1089 changegroup.
1090 1090
1091 1091 In version 2 and up, the delta base node is encoded in the entry in the
1092 1092 changegroup. This allows the delta to be expressed against any parent,
1093 1093 which can result in smaller deltas and more efficient encoding of data.
1094 1094
1095 1095 Changeset Segment
1096 1096 =================
1097 1097
1098 1098 The *changeset segment* consists of a single *delta group* holding
1099 1099 changelog data. The *empty chunk* at the end of the *delta group* denotes
1100 1100 the boundary to the *manifest segment*.
1101 1101
1102 1102 Manifest Segment
1103 1103 ================
1104 1104
1105 1105 The *manifest segment* consists of a single *delta group* holding manifest
1106 1106 data. If treemanifests are in use, it contains only the manifest for the
1107 1107 root directory of the repository. Otherwise, it contains the entire
1108 1108 manifest data. The *empty chunk* at the end of the *delta group* denotes
1109 1109 the boundary to the next segment (either the *treemanifests segment* or
1110 1110 the *filelogs segment*, depending on version and the request options).
1111 1111
1112 1112 Treemanifests Segment
1113 1113 ---------------------
1114 1114
1115 1115 The *treemanifests segment* only exists in changegroup version "3", and
1116 1116 only if the 'treemanifest' param is part of the bundle2 changegroup part
1117 1117 (it is not possible to use changegroup version 3 outside of bundle2).
1118 1118 Aside from the filenames in the *treemanifests segment* containing a
1119 1119 trailing "/" character, it behaves identically to the *filelogs segment*
1120 1120 (see below). The final sub-segment is followed by an *empty chunk*
1121 1121 (logically, a sub-segment with filename size 0). This denotes the boundary
1122 1122 to the *filelogs segment*.
1123 1123
1124 1124 Filelogs Segment
1125 1125 ================
1126 1126
1127 1127 The *filelogs segment* consists of multiple sub-segments, each
1128 1128 corresponding to an individual file whose data is being described:
1129 1129
1130 1130 +--------------------------------------------------+
1131 1131 | | | | | |
1132 1132 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
1133 1133 | | | | | (4 bytes) |
1134 1134 | | | | | |
1135 1135 +--------------------------------------------------+
1136 1136
1137 1137 The final filelog sub-segment is followed by an *empty chunk* (logically,
1138 1138 a sub-segment with filename size 0). This denotes the end of the segment
1139 1139 and of the overall changegroup.
1140 1140
1141 1141 Each filelog sub-segment consists of the following:
1142 1142
1143 1143 +------------------------------------------------------+
1144 1144 | | | |
1145 1145 | filename length | filename | delta group |
1146 1146 | (4 bytes) | (<length - 4> bytes) | (various) |
1147 1147 | | | |
1148 1148 +------------------------------------------------------+
1149 1149
1150 1150 That is, a *chunk* consisting of the filename (not terminated or padded)
1151 1151 followed by N chunks constituting the *delta group* for this file. The
1152 1152 *empty chunk* at the end of each *delta group* denotes the boundary to the
1153 1153 next filelog sub-segment.
1154 1154
1155 1155 Test list of commands with command with no help text
1156 1156
1157 1157 $ hg help helpext
1158 1158 helpext extension - no help text available
1159 1159
1160 1160 list of commands:
1161 1161
1162 1162 nohelp (no help text available)
1163 1163
1164 1164 (use 'hg help -v helpext' to show built-in aliases and global options)
1165 1165
1166 1166
1167 1167 test advanced, deprecated and experimental options are hidden in command help
1168 1168 $ hg help debugoptADV
1169 1169 hg debugoptADV
1170 1170
1171 1171 (no help text available)
1172 1172
1173 1173 options:
1174 1174
1175 1175 (some details hidden, use --verbose to show complete help)
1176 1176 $ hg help debugoptDEP
1177 1177 hg debugoptDEP
1178 1178
1179 1179 (no help text available)
1180 1180
1181 1181 options:
1182 1182
1183 1183 (some details hidden, use --verbose to show complete help)
1184 1184
1185 1185 $ hg help debugoptEXP
1186 1186 hg debugoptEXP
1187 1187
1188 1188 (no help text available)
1189 1189
1190 1190 options:
1191 1191
1192 1192 (some details hidden, use --verbose to show complete help)
1193 1193
1194 1194 test advanced, deprecated and experimental options are shown with -v
1195 1195 $ hg help -v debugoptADV | grep aopt
1196 1196 --aopt option is (ADVANCED)
1197 1197 $ hg help -v debugoptDEP | grep dopt
1198 1198 --dopt option is (DEPRECATED)
1199 1199 $ hg help -v debugoptEXP | grep eopt
1200 1200 --eopt option is (EXPERIMENTAL)
1201 1201
1202 1202 #if gettext
1203 1203 test deprecated option is hidden with translation with untranslated description
1204 1204 (use many globy for not failing on changed transaction)
1205 1205 $ LANGUAGE=sv hg help debugoptDEP
1206 1206 hg debugoptDEP
1207 1207
1208 1208 (*) (glob)
1209 1209
1210 1210 options:
1211 1211
1212 1212 (some details hidden, use --verbose to show complete help)
1213 1213 #endif
1214 1214
1215 1215 Test commands that collide with topics (issue4240)
1216 1216
1217 1217 $ hg config -hq
1218 1218 hg config [-u] [NAME]...
1219 1219
1220 1220 show combined config settings from all hgrc files
1221 1221 $ hg showconfig -hq
1222 1222 hg config [-u] [NAME]...
1223 1223
1224 1224 show combined config settings from all hgrc files
1225 1225
1226 1226 Test a help topic
1227 1227
1228 1228 $ hg help dates
1229 1229 Date Formats
1230 1230 """"""""""""
1231 1231
1232 1232 Some commands allow the user to specify a date, e.g.:
1233 1233
1234 1234 - backout, commit, import, tag: Specify the commit date.
1235 1235 - log, revert, update: Select revision(s) by date.
1236 1236
1237 1237 Many date formats are valid. Here are some examples:
1238 1238
1239 1239 - "Wed Dec 6 13:18:29 2006" (local timezone assumed)
1240 1240 - "Dec 6 13:18 -0600" (year assumed, time offset provided)
1241 1241 - "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
1242 1242 - "Dec 6" (midnight)
1243 1243 - "13:18" (today assumed)
1244 1244 - "3:39" (3:39AM assumed)
1245 1245 - "3:39pm" (15:39)
1246 1246 - "2006-12-06 13:18:29" (ISO 8601 format)
1247 1247 - "2006-12-6 13:18"
1248 1248 - "2006-12-6"
1249 1249 - "12-6"
1250 1250 - "12/6"
1251 1251 - "12/6/6" (Dec 6 2006)
1252 1252 - "today" (midnight)
1253 1253 - "yesterday" (midnight)
1254 1254 - "now" - right now
1255 1255
1256 1256 Lastly, there is Mercurial's internal format:
1257 1257
1258 1258 - "1165411109 0" (Wed Dec 6 13:18:29 2006 UTC)
1259 1259
1260 1260 This is the internal representation format for dates. The first number is
1261 1261 the number of seconds since the epoch (1970-01-01 00:00 UTC). The second
1262 1262 is the offset of the local timezone, in seconds west of UTC (negative if
1263 1263 the timezone is east of UTC).
1264 1264
1265 1265 The log command also accepts date ranges:
1266 1266
1267 1267 - "<DATE" - at or before a given date/time
1268 1268 - ">DATE" - on or after a given date/time
1269 1269 - "DATE to DATE" - a date range, inclusive
1270 1270 - "-DAYS" - within a given number of days of today
1271 1271
1272 1272 Test repeated config section name
1273 1273
1274 1274 $ hg help config.host
1275 1275 "http_proxy.host"
1276 1276 Host name and (optional) port of the proxy server, for example
1277 1277 "myproxy:8000".
1278 1278
1279 1279 "smtp.host"
1280 1280 Host name of mail server, e.g. "mail.example.com".
1281 1281
1282 1282 Unrelated trailing paragraphs shouldn't be included
1283 1283
1284 1284 $ hg help config.extramsg | grep '^$'
1285 1285
1286 1286
1287 1287 Test capitalized section name
1288 1288
1289 1289 $ hg help scripting.HGPLAIN > /dev/null
1290 1290
1291 1291 Help subsection:
1292 1292
1293 1293 $ hg help config.charsets |grep "Email example:" > /dev/null
1294 1294 [1]
1295 1295
1296 1296 Show nested definitions
1297 1297 ("profiling.type"[break]"ls"[break]"stat"[break])
1298 1298
1299 1299 $ hg help config.type | egrep '^$'|wc -l
1300 1300 \s*3 (re)
1301 1301
1302 1302 Separate sections from subsections
1303 1303
1304 1304 $ hg help config.format | egrep '^ ("|-)|^\s*$' | uniq
1305 1305 "format"
1306 1306 --------
1307 1307
1308 1308 "usegeneraldelta"
1309 1309
1310 1310 "dotencode"
1311 1311
1312 1312 "usefncache"
1313 1313
1314 1314 "usestore"
1315 1315
1316 1316 "profiling"
1317 1317 -----------
1318 1318
1319 1319 "format"
1320 1320
1321 1321 "progress"
1322 1322 ----------
1323 1323
1324 1324 "format"
1325 1325
1326 1326
1327 1327 Last item in help config.*:
1328 1328
1329 1329 $ hg help config.`hg help config|grep '^ "'| \
1330 1330 > tail -1|sed 's![ "]*!!g'`| \
1331 1331 > grep 'hg help -c config' > /dev/null
1332 1332 [1]
1333 1333
1334 1334 note to use help -c for general hg help config:
1335 1335
1336 1336 $ hg help config |grep 'hg help -c config' > /dev/null
1337 1337
1338 1338 Test templating help
1339 1339
1340 1340 $ hg help templating | egrep '(desc|diffstat|firstline|nonempty) '
1341 1341 desc String. The text of the changeset description.
1342 1342 diffstat String. Statistics of changes with the following format:
1343 1343 firstline Any text. Returns the first line of text.
1344 1344 nonempty Any text. Returns '(none)' if the string is empty.
1345 1345
1346 1346 Test deprecated items
1347 1347
1348 1348 $ hg help -v templating | grep currentbookmark
1349 1349 currentbookmark
1350 1350 $ hg help templating | (grep currentbookmark || true)
1351 1351
1352 1352 Test help hooks
1353 1353
1354 1354 $ cat > helphook1.py <<EOF
1355 1355 > from mercurial import help
1356 1356 >
1357 1357 > def rewrite(ui, topic, doc):
1358 1358 > return doc + '\nhelphook1\n'
1359 1359 >
1360 1360 > def extsetup(ui):
1361 1361 > help.addtopichook('revisions', rewrite)
1362 1362 > EOF
1363 1363 $ cat > helphook2.py <<EOF
1364 1364 > from mercurial import help
1365 1365 >
1366 1366 > def rewrite(ui, topic, doc):
1367 1367 > return doc + '\nhelphook2\n'
1368 1368 >
1369 1369 > def extsetup(ui):
1370 1370 > help.addtopichook('revisions', rewrite)
1371 1371 > EOF
1372 1372 $ echo '[extensions]' >> $HGRCPATH
1373 1373 $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
1374 1374 $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
1375 1375 $ hg help revsets | grep helphook
1376 1376 helphook1
1377 1377 helphook2
1378 1378
1379 1379 help -c should only show debug --debug
1380 1380
1381 1381 $ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
1382 1382 [1]
1383 1383
1384 1384 help -c should only show deprecated for -v
1385 1385
1386 1386 $ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
1387 1387 [1]
1388 1388
1389 1389 Test -s / --system
1390 1390
1391 1391 $ hg help config.files -s windows |grep 'etc/mercurial' | \
1392 1392 > wc -l | sed -e 's/ //g'
1393 1393 0
1394 1394 $ hg help config.files --system unix | grep 'USER' | \
1395 1395 > wc -l | sed -e 's/ //g'
1396 1396 0
1397 1397
1398 1398 Test -e / -c / -k combinations
1399 1399
1400 1400 $ hg help -c|egrep '^[A-Z].*:|^ debug'
1401 1401 Commands:
1402 1402 $ hg help -e|egrep '^[A-Z].*:|^ debug'
1403 1403 Extensions:
1404 1404 $ hg help -k|egrep '^[A-Z].*:|^ debug'
1405 1405 Topics:
1406 1406 Commands:
1407 1407 Extensions:
1408 1408 Extension Commands:
1409 1409 $ hg help -c schemes
1410 1410 abort: no such help topic: schemes
1411 1411 (try 'hg help --keyword schemes')
1412 1412 [255]
1413 1413 $ hg help -e schemes |head -1
1414 1414 schemes extension - extend schemes with shortcuts to repository swarms
1415 1415 $ hg help -c -k dates |egrep '^(Topics|Extensions|Commands):'
1416 1416 Commands:
1417 1417 $ hg help -e -k a |egrep '^(Topics|Extensions|Commands):'
1418 1418 Extensions:
1419 1419 $ hg help -e -c -k date |egrep '^(Topics|Extensions|Commands):'
1420 1420 Extensions:
1421 1421 Commands:
1422 1422 $ hg help -c commit > /dev/null
1423 1423 $ hg help -e -c commit > /dev/null
1424 1424 $ hg help -e commit > /dev/null
1425 1425 abort: no such help topic: commit
1426 1426 (try 'hg help --keyword commit')
1427 1427 [255]
1428 1428
1429 1429 Test keyword search help
1430 1430
1431 1431 $ cat > prefixedname.py <<EOF
1432 1432 > '''matched against word "clone"
1433 1433 > '''
1434 1434 > EOF
1435 1435 $ echo '[extensions]' >> $HGRCPATH
1436 1436 $ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
1437 1437 $ hg help -k clone
1438 1438 Topics:
1439 1439
1440 1440 config Configuration Files
1441 1441 extensions Using Additional Features
1442 1442 glossary Glossary
1443 1443 phases Working with Phases
1444 1444 subrepos Subrepositories
1445 1445 urls URL Paths
1446 1446
1447 1447 Commands:
1448 1448
1449 1449 bookmarks create a new bookmark or list existing bookmarks
1450 1450 clone make a copy of an existing repository
1451 1451 paths show aliases for remote repositories
1452 1452 update update working directory (or switch revisions)
1453 1453
1454 1454 Extensions:
1455 1455
1456 1456 clonebundles advertise pre-generated bundles to seed clones
1457 1457 prefixedname matched against word "clone"
1458 1458 relink recreates hardlinks between repository clones
1459 1459
1460 1460 Extension Commands:
1461 1461
1462 1462 qclone clone main and patch repository at same time
1463 1463
1464 1464 Test unfound topic
1465 1465
1466 1466 $ hg help nonexistingtopicthatwillneverexisteverever
1467 1467 abort: no such help topic: nonexistingtopicthatwillneverexisteverever
1468 1468 (try 'hg help --keyword nonexistingtopicthatwillneverexisteverever')
1469 1469 [255]
1470 1470
1471 1471 Test unfound keyword
1472 1472
1473 1473 $ hg help --keyword nonexistingwordthatwillneverexisteverever
1474 1474 abort: no matches
1475 1475 (try 'hg help' for a list of topics)
1476 1476 [255]
1477 1477
1478 1478 Test omit indicating for help
1479 1479
1480 1480 $ cat > addverboseitems.py <<EOF
1481 1481 > '''extension to test omit indicating.
1482 1482 >
1483 1483 > This paragraph is never omitted (for extension)
1484 1484 >
1485 1485 > .. container:: verbose
1486 1486 >
1487 1487 > This paragraph is omitted,
1488 1488 > if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
1489 1489 >
1490 1490 > This paragraph is never omitted, too (for extension)
1491 1491 > '''
1492 1492 >
1493 1493 > from mercurial import help, commands
1494 1494 > testtopic = """This paragraph is never omitted (for topic).
1495 1495 >
1496 1496 > .. container:: verbose
1497 1497 >
1498 1498 > This paragraph is omitted,
1499 1499 > if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
1500 1500 >
1501 1501 > This paragraph is never omitted, too (for topic)
1502 1502 > """
1503 1503 > def extsetup(ui):
1504 1504 > help.helptable.append((["topic-containing-verbose"],
1505 1505 > "This is the topic to test omit indicating.",
1506 1506 > lambda ui: testtopic))
1507 1507 > EOF
1508 1508 $ echo '[extensions]' >> $HGRCPATH
1509 1509 $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
1510 1510 $ hg help addverboseitems
1511 1511 addverboseitems extension - extension to test omit indicating.
1512 1512
1513 1513 This paragraph is never omitted (for extension)
1514 1514
1515 1515 This paragraph is never omitted, too (for extension)
1516 1516
1517 1517 (some details hidden, use --verbose to show complete help)
1518 1518
1519 1519 no commands defined
1520 1520 $ hg help -v addverboseitems
1521 1521 addverboseitems extension - extension to test omit indicating.
1522 1522
1523 1523 This paragraph is never omitted (for extension)
1524 1524
1525 1525 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1526 1526 extension)
1527 1527
1528 1528 This paragraph is never omitted, too (for extension)
1529 1529
1530 1530 no commands defined
1531 1531 $ hg help topic-containing-verbose
1532 1532 This is the topic to test omit indicating.
1533 1533 """"""""""""""""""""""""""""""""""""""""""
1534 1534
1535 1535 This paragraph is never omitted (for topic).
1536 1536
1537 1537 This paragraph is never omitted, too (for topic)
1538 1538
1539 1539 (some details hidden, use --verbose to show complete help)
1540 1540 $ hg help -v topic-containing-verbose
1541 1541 This is the topic to test omit indicating.
1542 1542 """"""""""""""""""""""""""""""""""""""""""
1543 1543
1544 1544 This paragraph is never omitted (for topic).
1545 1545
1546 1546 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1547 1547 topic)
1548 1548
1549 1549 This paragraph is never omitted, too (for topic)
1550 1550
1551 1551 Test section lookup
1552 1552
1553 1553 $ hg help revset.merge
1554 1554 "merge()"
1555 1555 Changeset is a merge changeset.
1556 1556
1557 1557 $ hg help glossary.dag
1558 1558 DAG
1559 1559 The repository of changesets of a distributed version control system
1560 1560 (DVCS) can be described as a directed acyclic graph (DAG), consisting
1561 1561 of nodes and edges, where nodes correspond to changesets and edges
1562 1562 imply a parent -> child relation. This graph can be visualized by
1563 1563 graphical tools such as 'hg log --graph'. In Mercurial, the DAG is
1564 1564 limited by the requirement for children to have at most two parents.
1565 1565
1566 1566
1567 1567 $ hg help hgrc.paths
1568 1568 "paths"
1569 1569 -------
1570 1570
1571 1571 Assigns symbolic names and behavior to repositories.
1572 1572
1573 1573 Options are symbolic names defining the URL or directory that is the
1574 1574 location of the repository. Example:
1575 1575
1576 1576 [paths]
1577 1577 my_server = https://example.com/my_repo
1578 1578 local_path = /home/me/repo
1579 1579
1580 1580 These symbolic names can be used from the command line. To pull from
1581 1581 "my_server": 'hg pull my_server'. To push to "local_path": 'hg push
1582 1582 local_path'.
1583 1583
1584 1584 Options containing colons (":") denote sub-options that can influence
1585 1585 behavior for that specific path. Example:
1586 1586
1587 1587 [paths]
1588 1588 my_server = https://example.com/my_path
1589 1589 my_server:pushurl = ssh://example.com/my_path
1590 1590
1591 1591 The following sub-options can be defined:
1592 1592
1593 1593 "pushurl"
1594 1594 The URL to use for push operations. If not defined, the location
1595 1595 defined by the path's main entry is used.
1596 1596
1597 1597 "pushrev"
1598 1598 A revset defining which revisions to push by default.
1599 1599
1600 1600 When 'hg push' is executed without a "-r" argument, the revset defined
1601 1601 by this sub-option is evaluated to determine what to push.
1602 1602
1603 1603 For example, a value of "." will push the working directory's revision
1604 1604 by default.
1605 1605
1606 1606 Revsets specifying bookmarks will not result in the bookmark being
1607 1607 pushed.
1608 1608
1609 1609 The following special named paths exist:
1610 1610
1611 1611 "default"
1612 1612 The URL or directory to use when no source or remote is specified.
1613 1613
1614 1614 'hg clone' will automatically define this path to the location the
1615 1615 repository was cloned from.
1616 1616
1617 1617 "default-push"
1618 1618 (deprecated) The URL or directory for the default 'hg push' location.
1619 1619 "default:pushurl" should be used instead.
1620 1620
1621 1621 $ hg help glossary.mcguffin
1622 1622 abort: help section not found: glossary.mcguffin
1623 1623 [255]
1624 1624
1625 1625 $ hg help glossary.mc.guffin
1626 1626 abort: help section not found: glossary.mc.guffin
1627 1627 [255]
1628 1628
1629 1629 $ hg help template.files
1630 1630 files List of strings. All files modified, added, or removed by
1631 1631 this changeset.
1632 1632 files(pattern)
1633 1633 All files of the current changeset matching the pattern. See
1634 1634 'hg help patterns'.
1635 1635
1636 1636 Test section lookup by translated message
1637 1637
1638 1638 str.lower() instead of encoding.lower(str) on translated message might
1639 1639 make message meaningless, because some encoding uses 0x41(A) - 0x5a(Z)
1640 1640 as the second or later byte of multi-byte character.
1641 1641
1642 1642 For example, "\x8bL\x98^" (translation of "record" in ja_JP.cp932)
1643 1643 contains 0x4c (L). str.lower() replaces 0x4c(L) by 0x6c(l) and this
1644 1644 replacement makes message meaningless.
1645 1645
1646 1646 This tests that section lookup by translated string isn't broken by
1647 1647 such str.lower().
1648 1648
1649 1649 $ python <<EOF
1650 1650 > def escape(s):
1651 1651 > return ''.join('\u%x' % ord(uc) for uc in s.decode('cp932'))
1652 1652 > # translation of "record" in ja_JP.cp932
1653 1653 > upper = "\x8bL\x98^"
1654 1654 > # str.lower()-ed section name should be treated as different one
1655 1655 > lower = "\x8bl\x98^"
1656 1656 > with open('ambiguous.py', 'w') as fp:
1657 1657 > fp.write("""# ambiguous section names in ja_JP.cp932
1658 1658 > u'''summary of extension
1659 1659 >
1660 1660 > %s
1661 1661 > ----
1662 1662 >
1663 1663 > Upper name should show only this message
1664 1664 >
1665 1665 > %s
1666 1666 > ----
1667 1667 >
1668 1668 > Lower name should show only this message
1669 1669 >
1670 1670 > subsequent section
1671 1671 > ------------------
1672 1672 >
1673 1673 > This should be hidden at 'hg help ambiguous' with section name.
1674 1674 > '''
1675 1675 > """ % (escape(upper), escape(lower)))
1676 1676 > EOF
1677 1677
1678 1678 $ cat >> $HGRCPATH <<EOF
1679 1679 > [extensions]
1680 1680 > ambiguous = ./ambiguous.py
1681 1681 > EOF
1682 1682
1683 1683 $ python <<EOF | sh
1684 1684 > upper = "\x8bL\x98^"
1685 1685 > print "hg --encoding cp932 help -e ambiguous.%s" % upper
1686 1686 > EOF
1687 1687 \x8bL\x98^ (esc)
1688 1688 ----
1689 1689
1690 1690 Upper name should show only this message
1691 1691
1692 1692
1693 1693 $ python <<EOF | sh
1694 1694 > lower = "\x8bl\x98^"
1695 1695 > print "hg --encoding cp932 help -e ambiguous.%s" % lower
1696 1696 > EOF
1697 1697 \x8bl\x98^ (esc)
1698 1698 ----
1699 1699
1700 1700 Lower name should show only this message
1701 1701
1702 1702
1703 1703 $ cat >> $HGRCPATH <<EOF
1704 1704 > [extensions]
1705 1705 > ambiguous = !
1706 1706 > EOF
1707 1707
1708 1708 Show help content of disabled extensions
1709 1709
1710 1710 $ cat >> $HGRCPATH <<EOF
1711 1711 > [extensions]
1712 1712 > ambiguous = !./ambiguous.py
1713 1713 > EOF
1714 1714 $ hg help -e ambiguous
1715 1715 ambiguous extension - (no help text available)
1716 1716
1717 1717 (use 'hg help extensions' for information on enabling extensions)
1718 1718
1719 1719 Test dynamic list of merge tools only shows up once
1720 1720 $ hg help merge-tools
1721 1721 Merge Tools
1722 1722 """""""""""
1723 1723
1724 1724 To merge files Mercurial uses merge tools.
1725 1725
1726 1726 A merge tool combines two different versions of a file into a merged file.
1727 1727 Merge tools are given the two files and the greatest common ancestor of
1728 1728 the two file versions, so they can determine the changes made on both
1729 1729 branches.
1730 1730
1731 1731 Merge tools are used both for 'hg resolve', 'hg merge', 'hg update', 'hg
1732 1732 backout' and in several extensions.
1733 1733
1734 1734 Usually, the merge tool tries to automatically reconcile the files by
1735 1735 combining all non-overlapping changes that occurred separately in the two
1736 1736 different evolutions of the same initial base file. Furthermore, some
1737 1737 interactive merge programs make it easier to manually resolve conflicting
1738 1738 merges, either in a graphical way, or by inserting some conflict markers.
1739 1739 Mercurial does not include any interactive merge programs but relies on
1740 1740 external tools for that.
1741 1741
1742 1742 Available merge tools
1743 1743 =====================
1744 1744
1745 1745 External merge tools and their properties are configured in the merge-
1746 1746 tools configuration section - see hgrc(5) - but they can often just be
1747 1747 named by their executable.
1748 1748
1749 1749 A merge tool is generally usable if its executable can be found on the
1750 1750 system and if it can handle the merge. The executable is found if it is an
1751 1751 absolute or relative executable path or the name of an application in the
1752 1752 executable search path. The tool is assumed to be able to handle the merge
1753 1753 if it can handle symlinks if the file is a symlink, if it can handle
1754 1754 binary files if the file is binary, and if a GUI is available if the tool
1755 1755 requires a GUI.
1756 1756
1757 1757 There are some internal merge tools which can be used. The internal merge
1758 1758 tools are:
1759 1759
1760 1760 ":dump"
1761 1761 Creates three versions of the files to merge, containing the contents of
1762 1762 local, other and base. These files can then be used to perform a merge
1763 1763 manually. If the file to be merged is named "a.txt", these files will
1764 1764 accordingly be named "a.txt.local", "a.txt.other" and "a.txt.base" and
1765 1765 they will be placed in the same directory as "a.txt".
1766 1766
1767 1767 This implies permerge. Therefore, files aren't dumped, if premerge runs
1768 1768 successfully. Use :forcedump to forcibly write files out.
1769 1769
1770 1770 ":fail"
1771 1771 Rather than attempting to merge files that were modified on both
1772 1772 branches, it marks them as unresolved. The resolve command must be used
1773 1773 to resolve these conflicts.
1774 1774
1775 1775 ":forcedump"
1776 1776 Creates three versions of the files as same as :dump, but omits
1777 1777 premerge.
1778 1778
1779 1779 ":local"
1780 1780 Uses the local 'p1()' version of files as the merged version.
1781 1781
1782 1782 ":merge"
1783 1783 Uses the internal non-interactive simple merge algorithm for merging
1784 1784 files. It will fail if there are any conflicts and leave markers in the
1785 1785 partially merged file. Markers will have two sections, one for each side
1786 1786 of merge.
1787 1787
1788 1788 ":merge-local"
1789 1789 Like :merge, but resolve all conflicts non-interactively in favor of the
1790 1790 local 'p1()' changes.
1791 1791
1792 1792 ":merge-other"
1793 1793 Like :merge, but resolve all conflicts non-interactively in favor of the
1794 1794 other 'p2()' changes.
1795 1795
1796 1796 ":merge3"
1797 1797 Uses the internal non-interactive simple merge algorithm for merging
1798 1798 files. It will fail if there are any conflicts and leave markers in the
1799 1799 partially merged file. Marker will have three sections, one from each
1800 1800 side of the merge and one for the base content.
1801 1801
1802 1802 ":other"
1803 1803 Uses the other 'p2()' version of files as the merged version.
1804 1804
1805 1805 ":prompt"
1806 1806 Asks the user which of the local 'p1()' or the other 'p2()' version to
1807 1807 keep as the merged version.
1808 1808
1809 1809 ":tagmerge"
1810 1810 Uses the internal tag merge algorithm (experimental).
1811 1811
1812 1812 ":union"
1813 1813 Uses the internal non-interactive simple merge algorithm for merging
1814 1814 files. It will use both left and right sides for conflict regions. No
1815 1815 markers are inserted.
1816 1816
1817 1817 Internal tools are always available and do not require a GUI but will by
1818 1818 default not handle symlinks or binary files.
1819 1819
1820 1820 Choosing a merge tool
1821 1821 =====================
1822 1822
1823 1823 Mercurial uses these rules when deciding which merge tool to use:
1824 1824
1825 1825 1. If a tool has been specified with the --tool option to merge or
1826 1826 resolve, it is used. If it is the name of a tool in the merge-tools
1827 1827 configuration, its configuration is used. Otherwise the specified tool
1828 1828 must be executable by the shell.
1829 1829 2. If the "HGMERGE" environment variable is present, its value is used and
1830 1830 must be executable by the shell.
1831 1831 3. If the filename of the file to be merged matches any of the patterns in
1832 1832 the merge-patterns configuration section, the first usable merge tool
1833 1833 corresponding to a matching pattern is used. Here, binary capabilities
1834 1834 of the merge tool are not considered.
1835 1835 4. If ui.merge is set it will be considered next. If the value is not the
1836 1836 name of a configured tool, the specified value is used and must be
1837 1837 executable by the shell. Otherwise the named tool is used if it is
1838 1838 usable.
1839 1839 5. If any usable merge tools are present in the merge-tools configuration
1840 1840 section, the one with the highest priority is used.
1841 1841 6. If a program named "hgmerge" can be found on the system, it is used -
1842 1842 but it will by default not be used for symlinks and binary files.
1843 1843 7. If the file to be merged is not binary and is not a symlink, then
1844 1844 internal ":merge" is used.
1845 1845 8. Otherwise, ":prompt" is used.
1846 1846
1847 1847 Note:
1848 1848 After selecting a merge program, Mercurial will by default attempt to
1849 1849 merge the files using a simple merge algorithm first. Only if it
1850 1850 doesn't succeed because of conflicting changes Mercurial will actually
1851 1851 execute the merge program. Whether to use the simple merge algorithm
1852 1852 first can be controlled by the premerge setting of the merge tool.
1853 1853 Premerge is enabled by default unless the file is binary or a symlink.
1854 1854
1855 1855 See the merge-tools and ui sections of hgrc(5) for details on the
1856 1856 configuration of merge tools.
1857 1857
1858 1858 Compression engines listed in `hg help bundlespec`
1859 1859
1860 1860 $ hg help bundlespec | grep gzip
1861 1861 "v1" bundles can only use the "gzip", "bzip2", and "none" compression
1862 1862 An algorithm that produces smaller bundles than "gzip".
1863 1863 This engine will likely produce smaller bundles than "gzip" but will be
1864 1864 "gzip"
1865 1865 better compression than "gzip". It also frequently yields better (?)
1866 1866
1867 1867 Test usage of section marks in help documents
1868 1868
1869 1869 $ cd "$TESTDIR"/../doc
1870 1870 $ python check-seclevel.py
1871 1871 $ cd $TESTTMP
1872 1872
1873 1873 #if serve
1874 1874
1875 1875 Test the help pages in hgweb.
1876 1876
1877 1877 Dish up an empty repo; serve it cold.
1878 1878
1879 1879 $ hg init "$TESTTMP/test"
1880 1880 $ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
1881 1881 $ cat hg.pid >> $DAEMON_PIDS
1882 1882
1883 1883 $ get-with-headers.py $LOCALIP:$HGPORT "help"
1884 1884 200 Script output follows
1885 1885
1886 1886 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
1887 1887 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
1888 1888 <head>
1889 1889 <link rel="icon" href="/static/hgicon.png" type="image/png" />
1890 1890 <meta name="robots" content="index, nofollow" />
1891 1891 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
1892 1892 <script type="text/javascript" src="/static/mercurial.js"></script>
1893 1893
1894 1894 <title>Help: Index</title>
1895 1895 </head>
1896 1896 <body>
1897 1897
1898 1898 <div class="container">
1899 1899 <div class="menu">
1900 1900 <div class="logo">
1901 1901 <a href="https://mercurial-scm.org/">
1902 1902 <img src="/static/hglogo.png" alt="mercurial" /></a>
1903 1903 </div>
1904 1904 <ul>
1905 1905 <li><a href="/shortlog">log</a></li>
1906 1906 <li><a href="/graph">graph</a></li>
1907 1907 <li><a href="/tags">tags</a></li>
1908 1908 <li><a href="/bookmarks">bookmarks</a></li>
1909 1909 <li><a href="/branches">branches</a></li>
1910 1910 </ul>
1911 1911 <ul>
1912 1912 <li class="active">help</li>
1913 1913 </ul>
1914 1914 </div>
1915 1915
1916 1916 <div class="main">
1917 1917 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
1918 1918 <form class="search" action="/log">
1919 1919
1920 1920 <p><input name="rev" id="search1" type="text" size="30" /></p>
1921 1921 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
1922 1922 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
1923 1923 </form>
1924 1924 <table class="bigtable">
1925 1925 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
1926 1926
1927 1927 <tr><td>
1928 1928 <a href="/help/bundlespec">
1929 1929 bundlespec
1930 1930 </a>
1931 1931 </td><td>
1932 1932 Bundle File Formats
1933 1933 </td></tr>
1934 1934 <tr><td>
1935 1935 <a href="/help/color">
1936 1936 color
1937 1937 </a>
1938 1938 </td><td>
1939 1939 Colorizing Outputs
1940 1940 </td></tr>
1941 1941 <tr><td>
1942 1942 <a href="/help/config">
1943 1943 config
1944 1944 </a>
1945 1945 </td><td>
1946 1946 Configuration Files
1947 1947 </td></tr>
1948 1948 <tr><td>
1949 1949 <a href="/help/dates">
1950 1950 dates
1951 1951 </a>
1952 1952 </td><td>
1953 1953 Date Formats
1954 1954 </td></tr>
1955 1955 <tr><td>
1956 1956 <a href="/help/diffs">
1957 1957 diffs
1958 1958 </a>
1959 1959 </td><td>
1960 1960 Diff Formats
1961 1961 </td></tr>
1962 1962 <tr><td>
1963 1963 <a href="/help/environment">
1964 1964 environment
1965 1965 </a>
1966 1966 </td><td>
1967 1967 Environment Variables
1968 1968 </td></tr>
1969 1969 <tr><td>
1970 1970 <a href="/help/extensions">
1971 1971 extensions
1972 1972 </a>
1973 1973 </td><td>
1974 1974 Using Additional Features
1975 1975 </td></tr>
1976 1976 <tr><td>
1977 1977 <a href="/help/filesets">
1978 1978 filesets
1979 1979 </a>
1980 1980 </td><td>
1981 1981 Specifying File Sets
1982 1982 </td></tr>
1983 1983 <tr><td>
1984 1984 <a href="/help/glossary">
1985 1985 glossary
1986 1986 </a>
1987 1987 </td><td>
1988 1988 Glossary
1989 1989 </td></tr>
1990 1990 <tr><td>
1991 1991 <a href="/help/hgignore">
1992 1992 hgignore
1993 1993 </a>
1994 1994 </td><td>
1995 1995 Syntax for Mercurial Ignore Files
1996 1996 </td></tr>
1997 1997 <tr><td>
1998 1998 <a href="/help/hgweb">
1999 1999 hgweb
2000 2000 </a>
2001 2001 </td><td>
2002 2002 Configuring hgweb
2003 2003 </td></tr>
2004 2004 <tr><td>
2005 2005 <a href="/help/internals">
2006 2006 internals
2007 2007 </a>
2008 2008 </td><td>
2009 2009 Technical implementation topics
2010 2010 </td></tr>
2011 2011 <tr><td>
2012 2012 <a href="/help/merge-tools">
2013 2013 merge-tools
2014 2014 </a>
2015 2015 </td><td>
2016 2016 Merge Tools
2017 2017 </td></tr>
2018 2018 <tr><td>
2019 2019 <a href="/help/pager">
2020 2020 pager
2021 2021 </a>
2022 2022 </td><td>
2023 2023 Pager Support
2024 2024 </td></tr>
2025 2025 <tr><td>
2026 2026 <a href="/help/patterns">
2027 2027 patterns
2028 2028 </a>
2029 2029 </td><td>
2030 2030 File Name Patterns
2031 2031 </td></tr>
2032 2032 <tr><td>
2033 2033 <a href="/help/phases">
2034 2034 phases
2035 2035 </a>
2036 2036 </td><td>
2037 2037 Working with Phases
2038 2038 </td></tr>
2039 2039 <tr><td>
2040 2040 <a href="/help/revisions">
2041 2041 revisions
2042 2042 </a>
2043 2043 </td><td>
2044 2044 Specifying Revisions
2045 2045 </td></tr>
2046 2046 <tr><td>
2047 2047 <a href="/help/scripting">
2048 2048 scripting
2049 2049 </a>
2050 2050 </td><td>
2051 2051 Using Mercurial from scripts and automation
2052 2052 </td></tr>
2053 2053 <tr><td>
2054 2054 <a href="/help/subrepos">
2055 2055 subrepos
2056 2056 </a>
2057 2057 </td><td>
2058 2058 Subrepositories
2059 2059 </td></tr>
2060 2060 <tr><td>
2061 2061 <a href="/help/templating">
2062 2062 templating
2063 2063 </a>
2064 2064 </td><td>
2065 2065 Template Usage
2066 2066 </td></tr>
2067 2067 <tr><td>
2068 2068 <a href="/help/urls">
2069 2069 urls
2070 2070 </a>
2071 2071 </td><td>
2072 2072 URL Paths
2073 2073 </td></tr>
2074 2074 <tr><td>
2075 2075 <a href="/help/topic-containing-verbose">
2076 2076 topic-containing-verbose
2077 2077 </a>
2078 2078 </td><td>
2079 2079 This is the topic to test omit indicating.
2080 2080 </td></tr>
2081 2081
2082 2082
2083 2083 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
2084 2084
2085 2085 <tr><td>
2086 2086 <a href="/help/add">
2087 2087 add
2088 2088 </a>
2089 2089 </td><td>
2090 2090 add the specified files on the next commit
2091 2091 </td></tr>
2092 2092 <tr><td>
2093 2093 <a href="/help/annotate">
2094 2094 annotate
2095 2095 </a>
2096 2096 </td><td>
2097 2097 show changeset information by line for each file
2098 2098 </td></tr>
2099 2099 <tr><td>
2100 2100 <a href="/help/clone">
2101 2101 clone
2102 2102 </a>
2103 2103 </td><td>
2104 2104 make a copy of an existing repository
2105 2105 </td></tr>
2106 2106 <tr><td>
2107 2107 <a href="/help/commit">
2108 2108 commit
2109 2109 </a>
2110 2110 </td><td>
2111 2111 commit the specified files or all outstanding changes
2112 2112 </td></tr>
2113 2113 <tr><td>
2114 2114 <a href="/help/diff">
2115 2115 diff
2116 2116 </a>
2117 2117 </td><td>
2118 2118 diff repository (or selected files)
2119 2119 </td></tr>
2120 2120 <tr><td>
2121 2121 <a href="/help/export">
2122 2122 export
2123 2123 </a>
2124 2124 </td><td>
2125 2125 dump the header and diffs for one or more changesets
2126 2126 </td></tr>
2127 2127 <tr><td>
2128 2128 <a href="/help/forget">
2129 2129 forget
2130 2130 </a>
2131 2131 </td><td>
2132 2132 forget the specified files on the next commit
2133 2133 </td></tr>
2134 2134 <tr><td>
2135 2135 <a href="/help/init">
2136 2136 init
2137 2137 </a>
2138 2138 </td><td>
2139 2139 create a new repository in the given directory
2140 2140 </td></tr>
2141 2141 <tr><td>
2142 2142 <a href="/help/log">
2143 2143 log
2144 2144 </a>
2145 2145 </td><td>
2146 2146 show revision history of entire repository or files
2147 2147 </td></tr>
2148 2148 <tr><td>
2149 2149 <a href="/help/merge">
2150 2150 merge
2151 2151 </a>
2152 2152 </td><td>
2153 2153 merge another revision into working directory
2154 2154 </td></tr>
2155 2155 <tr><td>
2156 2156 <a href="/help/pull">
2157 2157 pull
2158 2158 </a>
2159 2159 </td><td>
2160 2160 pull changes from the specified source
2161 2161 </td></tr>
2162 2162 <tr><td>
2163 2163 <a href="/help/push">
2164 2164 push
2165 2165 </a>
2166 2166 </td><td>
2167 2167 push changes to the specified destination
2168 2168 </td></tr>
2169 2169 <tr><td>
2170 2170 <a href="/help/remove">
2171 2171 remove
2172 2172 </a>
2173 2173 </td><td>
2174 2174 remove the specified files on the next commit
2175 2175 </td></tr>
2176 2176 <tr><td>
2177 2177 <a href="/help/serve">
2178 2178 serve
2179 2179 </a>
2180 2180 </td><td>
2181 2181 start stand-alone webserver
2182 2182 </td></tr>
2183 2183 <tr><td>
2184 2184 <a href="/help/status">
2185 2185 status
2186 2186 </a>
2187 2187 </td><td>
2188 2188 show changed files in the working directory
2189 2189 </td></tr>
2190 2190 <tr><td>
2191 2191 <a href="/help/summary">
2192 2192 summary
2193 2193 </a>
2194 2194 </td><td>
2195 2195 summarize working directory state
2196 2196 </td></tr>
2197 2197 <tr><td>
2198 2198 <a href="/help/update">
2199 2199 update
2200 2200 </a>
2201 2201 </td><td>
2202 2202 update working directory (or switch revisions)
2203 2203 </td></tr>
2204 2204
2205 2205
2206 2206
2207 2207 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
2208 2208
2209 2209 <tr><td>
2210 2210 <a href="/help/addremove">
2211 2211 addremove
2212 2212 </a>
2213 2213 </td><td>
2214 2214 add all new files, delete all missing files
2215 2215 </td></tr>
2216 2216 <tr><td>
2217 2217 <a href="/help/archive">
2218 2218 archive
2219 2219 </a>
2220 2220 </td><td>
2221 2221 create an unversioned archive of a repository revision
2222 2222 </td></tr>
2223 2223 <tr><td>
2224 2224 <a href="/help/backout">
2225 2225 backout
2226 2226 </a>
2227 2227 </td><td>
2228 2228 reverse effect of earlier changeset
2229 2229 </td></tr>
2230 2230 <tr><td>
2231 2231 <a href="/help/bisect">
2232 2232 bisect
2233 2233 </a>
2234 2234 </td><td>
2235 2235 subdivision search of changesets
2236 2236 </td></tr>
2237 2237 <tr><td>
2238 2238 <a href="/help/bookmarks">
2239 2239 bookmarks
2240 2240 </a>
2241 2241 </td><td>
2242 2242 create a new bookmark or list existing bookmarks
2243 2243 </td></tr>
2244 2244 <tr><td>
2245 2245 <a href="/help/branch">
2246 2246 branch
2247 2247 </a>
2248 2248 </td><td>
2249 2249 set or show the current branch name
2250 2250 </td></tr>
2251 2251 <tr><td>
2252 2252 <a href="/help/branches">
2253 2253 branches
2254 2254 </a>
2255 2255 </td><td>
2256 2256 list repository named branches
2257 2257 </td></tr>
2258 2258 <tr><td>
2259 2259 <a href="/help/bundle">
2260 2260 bundle
2261 2261 </a>
2262 2262 </td><td>
2263 2263 create a bundle file
2264 2264 </td></tr>
2265 2265 <tr><td>
2266 2266 <a href="/help/cat">
2267 2267 cat
2268 2268 </a>
2269 2269 </td><td>
2270 2270 output the current or given revision of files
2271 2271 </td></tr>
2272 2272 <tr><td>
2273 2273 <a href="/help/config">
2274 2274 config
2275 2275 </a>
2276 2276 </td><td>
2277 2277 show combined config settings from all hgrc files
2278 2278 </td></tr>
2279 2279 <tr><td>
2280 2280 <a href="/help/copy">
2281 2281 copy
2282 2282 </a>
2283 2283 </td><td>
2284 2284 mark files as copied for the next commit
2285 2285 </td></tr>
2286 2286 <tr><td>
2287 2287 <a href="/help/files">
2288 2288 files
2289 2289 </a>
2290 2290 </td><td>
2291 2291 list tracked files
2292 2292 </td></tr>
2293 2293 <tr><td>
2294 2294 <a href="/help/graft">
2295 2295 graft
2296 2296 </a>
2297 2297 </td><td>
2298 2298 copy changes from other branches onto the current branch
2299 2299 </td></tr>
2300 2300 <tr><td>
2301 2301 <a href="/help/grep">
2302 2302 grep
2303 2303 </a>
2304 2304 </td><td>
2305 2305 search revision history for a pattern in specified files
2306 2306 </td></tr>
2307 2307 <tr><td>
2308 2308 <a href="/help/heads">
2309 2309 heads
2310 2310 </a>
2311 2311 </td><td>
2312 2312 show branch heads
2313 2313 </td></tr>
2314 2314 <tr><td>
2315 2315 <a href="/help/help">
2316 2316 help
2317 2317 </a>
2318 2318 </td><td>
2319 2319 show help for a given topic or a help overview
2320 2320 </td></tr>
2321 2321 <tr><td>
2322 2322 <a href="/help/hgalias">
2323 2323 hgalias
2324 2324 </a>
2325 2325 </td><td>
2326 2326 summarize working directory state
2327 2327 </td></tr>
2328 2328 <tr><td>
2329 2329 <a href="/help/identify">
2330 2330 identify
2331 2331 </a>
2332 2332 </td><td>
2333 2333 identify the working directory or specified revision
2334 2334 </td></tr>
2335 2335 <tr><td>
2336 2336 <a href="/help/import">
2337 2337 import
2338 2338 </a>
2339 2339 </td><td>
2340 2340 import an ordered set of patches
2341 2341 </td></tr>
2342 2342 <tr><td>
2343 2343 <a href="/help/incoming">
2344 2344 incoming
2345 2345 </a>
2346 2346 </td><td>
2347 2347 show new changesets found in source
2348 2348 </td></tr>
2349 2349 <tr><td>
2350 2350 <a href="/help/manifest">
2351 2351 manifest
2352 2352 </a>
2353 2353 </td><td>
2354 2354 output the current or given revision of the project manifest
2355 2355 </td></tr>
2356 2356 <tr><td>
2357 2357 <a href="/help/nohelp">
2358 2358 nohelp
2359 2359 </a>
2360 2360 </td><td>
2361 2361 (no help text available)
2362 2362 </td></tr>
2363 2363 <tr><td>
2364 2364 <a href="/help/outgoing">
2365 2365 outgoing
2366 2366 </a>
2367 2367 </td><td>
2368 2368 show changesets not found in the destination
2369 2369 </td></tr>
2370 2370 <tr><td>
2371 2371 <a href="/help/paths">
2372 2372 paths
2373 2373 </a>
2374 2374 </td><td>
2375 2375 show aliases for remote repositories
2376 2376 </td></tr>
2377 2377 <tr><td>
2378 2378 <a href="/help/phase">
2379 2379 phase
2380 2380 </a>
2381 2381 </td><td>
2382 2382 set or show the current phase name
2383 2383 </td></tr>
2384 2384 <tr><td>
2385 2385 <a href="/help/recover">
2386 2386 recover
2387 2387 </a>
2388 2388 </td><td>
2389 2389 roll back an interrupted transaction
2390 2390 </td></tr>
2391 2391 <tr><td>
2392 2392 <a href="/help/rename">
2393 2393 rename
2394 2394 </a>
2395 2395 </td><td>
2396 2396 rename files; equivalent of copy + remove
2397 2397 </td></tr>
2398 2398 <tr><td>
2399 2399 <a href="/help/resolve">
2400 2400 resolve
2401 2401 </a>
2402 2402 </td><td>
2403 2403 redo merges or set/view the merge status of files
2404 2404 </td></tr>
2405 2405 <tr><td>
2406 2406 <a href="/help/revert">
2407 2407 revert
2408 2408 </a>
2409 2409 </td><td>
2410 2410 restore files to their checkout state
2411 2411 </td></tr>
2412 2412 <tr><td>
2413 2413 <a href="/help/root">
2414 2414 root
2415 2415 </a>
2416 2416 </td><td>
2417 2417 print the root (top) of the current working directory
2418 2418 </td></tr>
2419 2419 <tr><td>
2420 2420 <a href="/help/shellalias">
2421 2421 shellalias
2422 2422 </a>
2423 2423 </td><td>
2424 2424 (no help text available)
2425 2425 </td></tr>
2426 2426 <tr><td>
2427 2427 <a href="/help/tag">
2428 2428 tag
2429 2429 </a>
2430 2430 </td><td>
2431 2431 add one or more tags for the current or given revision
2432 2432 </td></tr>
2433 2433 <tr><td>
2434 2434 <a href="/help/tags">
2435 2435 tags
2436 2436 </a>
2437 2437 </td><td>
2438 2438 list repository tags
2439 2439 </td></tr>
2440 2440 <tr><td>
2441 2441 <a href="/help/unbundle">
2442 2442 unbundle
2443 2443 </a>
2444 2444 </td><td>
2445 2445 apply one or more bundle files
2446 2446 </td></tr>
2447 2447 <tr><td>
2448 2448 <a href="/help/verify">
2449 2449 verify
2450 2450 </a>
2451 2451 </td><td>
2452 2452 verify the integrity of the repository
2453 2453 </td></tr>
2454 2454 <tr><td>
2455 2455 <a href="/help/version">
2456 2456 version
2457 2457 </a>
2458 2458 </td><td>
2459 2459 output version and copyright information
2460 2460 </td></tr>
2461 2461
2462 2462
2463 2463 </table>
2464 2464 </div>
2465 2465 </div>
2466 2466
2467 2467
2468 2468
2469 2469 </body>
2470 2470 </html>
2471 2471
2472 2472
2473 2473 $ get-with-headers.py $LOCALIP:$HGPORT "help/add"
2474 2474 200 Script output follows
2475 2475
2476 2476 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2477 2477 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2478 2478 <head>
2479 2479 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2480 2480 <meta name="robots" content="index, nofollow" />
2481 2481 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2482 2482 <script type="text/javascript" src="/static/mercurial.js"></script>
2483 2483
2484 2484 <title>Help: add</title>
2485 2485 </head>
2486 2486 <body>
2487 2487
2488 2488 <div class="container">
2489 2489 <div class="menu">
2490 2490 <div class="logo">
2491 2491 <a href="https://mercurial-scm.org/">
2492 2492 <img src="/static/hglogo.png" alt="mercurial" /></a>
2493 2493 </div>
2494 2494 <ul>
2495 2495 <li><a href="/shortlog">log</a></li>
2496 2496 <li><a href="/graph">graph</a></li>
2497 2497 <li><a href="/tags">tags</a></li>
2498 2498 <li><a href="/bookmarks">bookmarks</a></li>
2499 2499 <li><a href="/branches">branches</a></li>
2500 2500 </ul>
2501 2501 <ul>
2502 2502 <li class="active"><a href="/help">help</a></li>
2503 2503 </ul>
2504 2504 </div>
2505 2505
2506 2506 <div class="main">
2507 2507 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2508 2508 <h3>Help: add</h3>
2509 2509
2510 2510 <form class="search" action="/log">
2511 2511
2512 2512 <p><input name="rev" id="search1" type="text" size="30" /></p>
2513 2513 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2514 2514 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2515 2515 </form>
2516 2516 <div id="doc">
2517 2517 <p>
2518 2518 hg add [OPTION]... [FILE]...
2519 2519 </p>
2520 2520 <p>
2521 2521 add the specified files on the next commit
2522 2522 </p>
2523 2523 <p>
2524 2524 Schedule files to be version controlled and added to the
2525 2525 repository.
2526 2526 </p>
2527 2527 <p>
2528 2528 The files will be added to the repository at the next commit. To
2529 2529 undo an add before that, see 'hg forget'.
2530 2530 </p>
2531 2531 <p>
2532 2532 If no names are given, add all files to the repository (except
2533 2533 files matching &quot;.hgignore&quot;).
2534 2534 </p>
2535 2535 <p>
2536 2536 Examples:
2537 2537 </p>
2538 2538 <ul>
2539 2539 <li> New (unknown) files are added automatically by 'hg add':
2540 2540 <pre>
2541 2541 \$ ls (re)
2542 2542 foo.c
2543 2543 \$ hg status (re)
2544 2544 ? foo.c
2545 2545 \$ hg add (re)
2546 2546 adding foo.c
2547 2547 \$ hg status (re)
2548 2548 A foo.c
2549 2549 </pre>
2550 2550 <li> Specific files to be added can be specified:
2551 2551 <pre>
2552 2552 \$ ls (re)
2553 2553 bar.c foo.c
2554 2554 \$ hg status (re)
2555 2555 ? bar.c
2556 2556 ? foo.c
2557 2557 \$ hg add bar.c (re)
2558 2558 \$ hg status (re)
2559 2559 A bar.c
2560 2560 ? foo.c
2561 2561 </pre>
2562 2562 </ul>
2563 2563 <p>
2564 2564 Returns 0 if all files are successfully added.
2565 2565 </p>
2566 2566 <p>
2567 2567 options ([+] can be repeated):
2568 2568 </p>
2569 2569 <table>
2570 2570 <tr><td>-I</td>
2571 2571 <td>--include PATTERN [+]</td>
2572 2572 <td>include names matching the given patterns</td></tr>
2573 2573 <tr><td>-X</td>
2574 2574 <td>--exclude PATTERN [+]</td>
2575 2575 <td>exclude names matching the given patterns</td></tr>
2576 2576 <tr><td>-S</td>
2577 2577 <td>--subrepos</td>
2578 2578 <td>recurse into subrepositories</td></tr>
2579 2579 <tr><td>-n</td>
2580 2580 <td>--dry-run</td>
2581 2581 <td>do not perform actions, just print output</td></tr>
2582 2582 </table>
2583 2583 <p>
2584 2584 global options ([+] can be repeated):
2585 2585 </p>
2586 2586 <table>
2587 2587 <tr><td>-R</td>
2588 2588 <td>--repository REPO</td>
2589 2589 <td>repository root directory or name of overlay bundle file</td></tr>
2590 2590 <tr><td></td>
2591 2591 <td>--cwd DIR</td>
2592 2592 <td>change working directory</td></tr>
2593 2593 <tr><td>-y</td>
2594 2594 <td>--noninteractive</td>
2595 2595 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2596 2596 <tr><td>-q</td>
2597 2597 <td>--quiet</td>
2598 2598 <td>suppress output</td></tr>
2599 2599 <tr><td>-v</td>
2600 2600 <td>--verbose</td>
2601 2601 <td>enable additional output</td></tr>
2602 2602 <tr><td></td>
2603 2603 <td>--color TYPE</td>
2604 2604 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
2605 2605 <tr><td></td>
2606 2606 <td>--config CONFIG [+]</td>
2607 2607 <td>set/override config option (use 'section.name=value')</td></tr>
2608 2608 <tr><td></td>
2609 2609 <td>--debug</td>
2610 2610 <td>enable debugging output</td></tr>
2611 2611 <tr><td></td>
2612 2612 <td>--debugger</td>
2613 2613 <td>start debugger</td></tr>
2614 2614 <tr><td></td>
2615 2615 <td>--encoding ENCODE</td>
2616 2616 <td>set the charset encoding (default: ascii)</td></tr>
2617 2617 <tr><td></td>
2618 2618 <td>--encodingmode MODE</td>
2619 2619 <td>set the charset encoding mode (default: strict)</td></tr>
2620 2620 <tr><td></td>
2621 2621 <td>--traceback</td>
2622 2622 <td>always print a traceback on exception</td></tr>
2623 2623 <tr><td></td>
2624 2624 <td>--time</td>
2625 2625 <td>time how long the command takes</td></tr>
2626 2626 <tr><td></td>
2627 2627 <td>--profile</td>
2628 2628 <td>print command execution profile</td></tr>
2629 2629 <tr><td></td>
2630 2630 <td>--version</td>
2631 2631 <td>output version information and exit</td></tr>
2632 2632 <tr><td>-h</td>
2633 2633 <td>--help</td>
2634 2634 <td>display help and exit</td></tr>
2635 2635 <tr><td></td>
2636 2636 <td>--hidden</td>
2637 2637 <td>consider hidden changesets</td></tr>
2638 2638 <tr><td></td>
2639 2639 <td>--pager TYPE</td>
2640 2640 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
2641 2641 </table>
2642 2642
2643 2643 </div>
2644 2644 </div>
2645 2645 </div>
2646 2646
2647 2647
2648 2648
2649 2649 </body>
2650 2650 </html>
2651 2651
2652 2652
2653 2653 $ get-with-headers.py $LOCALIP:$HGPORT "help/remove"
2654 2654 200 Script output follows
2655 2655
2656 2656 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2657 2657 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2658 2658 <head>
2659 2659 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2660 2660 <meta name="robots" content="index, nofollow" />
2661 2661 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2662 2662 <script type="text/javascript" src="/static/mercurial.js"></script>
2663 2663
2664 2664 <title>Help: remove</title>
2665 2665 </head>
2666 2666 <body>
2667 2667
2668 2668 <div class="container">
2669 2669 <div class="menu">
2670 2670 <div class="logo">
2671 2671 <a href="https://mercurial-scm.org/">
2672 2672 <img src="/static/hglogo.png" alt="mercurial" /></a>
2673 2673 </div>
2674 2674 <ul>
2675 2675 <li><a href="/shortlog">log</a></li>
2676 2676 <li><a href="/graph">graph</a></li>
2677 2677 <li><a href="/tags">tags</a></li>
2678 2678 <li><a href="/bookmarks">bookmarks</a></li>
2679 2679 <li><a href="/branches">branches</a></li>
2680 2680 </ul>
2681 2681 <ul>
2682 2682 <li class="active"><a href="/help">help</a></li>
2683 2683 </ul>
2684 2684 </div>
2685 2685
2686 2686 <div class="main">
2687 2687 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2688 2688 <h3>Help: remove</h3>
2689 2689
2690 2690 <form class="search" action="/log">
2691 2691
2692 2692 <p><input name="rev" id="search1" type="text" size="30" /></p>
2693 2693 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2694 2694 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2695 2695 </form>
2696 2696 <div id="doc">
2697 2697 <p>
2698 2698 hg remove [OPTION]... FILE...
2699 2699 </p>
2700 2700 <p>
2701 2701 aliases: rm
2702 2702 </p>
2703 2703 <p>
2704 2704 remove the specified files on the next commit
2705 2705 </p>
2706 2706 <p>
2707 2707 Schedule the indicated files for removal from the current branch.
2708 2708 </p>
2709 2709 <p>
2710 2710 This command schedules the files to be removed at the next commit.
2711 2711 To undo a remove before that, see 'hg revert'. To undo added
2712 2712 files, see 'hg forget'.
2713 2713 </p>
2714 2714 <p>
2715 2715 -A/--after can be used to remove only files that have already
2716 2716 been deleted, -f/--force can be used to force deletion, and -Af
2717 2717 can be used to remove files from the next revision without
2718 2718 deleting them from the working directory.
2719 2719 </p>
2720 2720 <p>
2721 2721 The following table details the behavior of remove for different
2722 2722 file states (columns) and option combinations (rows). The file
2723 2723 states are Added [A], Clean [C], Modified [M] and Missing [!]
2724 2724 (as reported by 'hg status'). The actions are Warn, Remove
2725 2725 (from branch) and Delete (from disk):
2726 2726 </p>
2727 2727 <table>
2728 2728 <tr><td>opt/state</td>
2729 2729 <td>A</td>
2730 2730 <td>C</td>
2731 2731 <td>M</td>
2732 2732 <td>!</td></tr>
2733 2733 <tr><td>none</td>
2734 2734 <td>W</td>
2735 2735 <td>RD</td>
2736 2736 <td>W</td>
2737 2737 <td>R</td></tr>
2738 2738 <tr><td>-f</td>
2739 2739 <td>R</td>
2740 2740 <td>RD</td>
2741 2741 <td>RD</td>
2742 2742 <td>R</td></tr>
2743 2743 <tr><td>-A</td>
2744 2744 <td>W</td>
2745 2745 <td>W</td>
2746 2746 <td>W</td>
2747 2747 <td>R</td></tr>
2748 2748 <tr><td>-Af</td>
2749 2749 <td>R</td>
2750 2750 <td>R</td>
2751 2751 <td>R</td>
2752 2752 <td>R</td></tr>
2753 2753 </table>
2754 2754 <p>
2755 2755 <b>Note:</b>
2756 2756 </p>
2757 2757 <p>
2758 2758 'hg remove' never deletes files in Added [A] state from the
2759 2759 working directory, not even if &quot;--force&quot; is specified.
2760 2760 </p>
2761 2761 <p>
2762 2762 Returns 0 on success, 1 if any warnings encountered.
2763 2763 </p>
2764 2764 <p>
2765 2765 options ([+] can be repeated):
2766 2766 </p>
2767 2767 <table>
2768 2768 <tr><td>-A</td>
2769 2769 <td>--after</td>
2770 2770 <td>record delete for missing files</td></tr>
2771 2771 <tr><td>-f</td>
2772 2772 <td>--force</td>
2773 2773 <td>forget added files, delete modified files</td></tr>
2774 2774 <tr><td>-S</td>
2775 2775 <td>--subrepos</td>
2776 2776 <td>recurse into subrepositories</td></tr>
2777 2777 <tr><td>-I</td>
2778 2778 <td>--include PATTERN [+]</td>
2779 2779 <td>include names matching the given patterns</td></tr>
2780 2780 <tr><td>-X</td>
2781 2781 <td>--exclude PATTERN [+]</td>
2782 2782 <td>exclude names matching the given patterns</td></tr>
2783 2783 </table>
2784 2784 <p>
2785 2785 global options ([+] can be repeated):
2786 2786 </p>
2787 2787 <table>
2788 2788 <tr><td>-R</td>
2789 2789 <td>--repository REPO</td>
2790 2790 <td>repository root directory or name of overlay bundle file</td></tr>
2791 2791 <tr><td></td>
2792 2792 <td>--cwd DIR</td>
2793 2793 <td>change working directory</td></tr>
2794 2794 <tr><td>-y</td>
2795 2795 <td>--noninteractive</td>
2796 2796 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2797 2797 <tr><td>-q</td>
2798 2798 <td>--quiet</td>
2799 2799 <td>suppress output</td></tr>
2800 2800 <tr><td>-v</td>
2801 2801 <td>--verbose</td>
2802 2802 <td>enable additional output</td></tr>
2803 2803 <tr><td></td>
2804 2804 <td>--color TYPE</td>
2805 2805 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
2806 2806 <tr><td></td>
2807 2807 <td>--config CONFIG [+]</td>
2808 2808 <td>set/override config option (use 'section.name=value')</td></tr>
2809 2809 <tr><td></td>
2810 2810 <td>--debug</td>
2811 2811 <td>enable debugging output</td></tr>
2812 2812 <tr><td></td>
2813 2813 <td>--debugger</td>
2814 2814 <td>start debugger</td></tr>
2815 2815 <tr><td></td>
2816 2816 <td>--encoding ENCODE</td>
2817 2817 <td>set the charset encoding (default: ascii)</td></tr>
2818 2818 <tr><td></td>
2819 2819 <td>--encodingmode MODE</td>
2820 2820 <td>set the charset encoding mode (default: strict)</td></tr>
2821 2821 <tr><td></td>
2822 2822 <td>--traceback</td>
2823 2823 <td>always print a traceback on exception</td></tr>
2824 2824 <tr><td></td>
2825 2825 <td>--time</td>
2826 2826 <td>time how long the command takes</td></tr>
2827 2827 <tr><td></td>
2828 2828 <td>--profile</td>
2829 2829 <td>print command execution profile</td></tr>
2830 2830 <tr><td></td>
2831 2831 <td>--version</td>
2832 2832 <td>output version information and exit</td></tr>
2833 2833 <tr><td>-h</td>
2834 2834 <td>--help</td>
2835 2835 <td>display help and exit</td></tr>
2836 2836 <tr><td></td>
2837 2837 <td>--hidden</td>
2838 2838 <td>consider hidden changesets</td></tr>
2839 2839 <tr><td></td>
2840 2840 <td>--pager TYPE</td>
2841 2841 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
2842 2842 </table>
2843 2843
2844 2844 </div>
2845 2845 </div>
2846 2846 </div>
2847 2847
2848 2848
2849 2849
2850 2850 </body>
2851 2851 </html>
2852 2852
2853 2853
2854 2854 $ get-with-headers.py $LOCALIP:$HGPORT "help/dates"
2855 2855 200 Script output follows
2856 2856
2857 2857 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2858 2858 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2859 2859 <head>
2860 2860 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2861 2861 <meta name="robots" content="index, nofollow" />
2862 2862 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2863 2863 <script type="text/javascript" src="/static/mercurial.js"></script>
2864 2864
2865 2865 <title>Help: dates</title>
2866 2866 </head>
2867 2867 <body>
2868 2868
2869 2869 <div class="container">
2870 2870 <div class="menu">
2871 2871 <div class="logo">
2872 2872 <a href="https://mercurial-scm.org/">
2873 2873 <img src="/static/hglogo.png" alt="mercurial" /></a>
2874 2874 </div>
2875 2875 <ul>
2876 2876 <li><a href="/shortlog">log</a></li>
2877 2877 <li><a href="/graph">graph</a></li>
2878 2878 <li><a href="/tags">tags</a></li>
2879 2879 <li><a href="/bookmarks">bookmarks</a></li>
2880 2880 <li><a href="/branches">branches</a></li>
2881 2881 </ul>
2882 2882 <ul>
2883 2883 <li class="active"><a href="/help">help</a></li>
2884 2884 </ul>
2885 2885 </div>
2886 2886
2887 2887 <div class="main">
2888 2888 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2889 2889 <h3>Help: dates</h3>
2890 2890
2891 2891 <form class="search" action="/log">
2892 2892
2893 2893 <p><input name="rev" id="search1" type="text" size="30" /></p>
2894 2894 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2895 2895 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2896 2896 </form>
2897 2897 <div id="doc">
2898 2898 <h1>Date Formats</h1>
2899 2899 <p>
2900 2900 Some commands allow the user to specify a date, e.g.:
2901 2901 </p>
2902 2902 <ul>
2903 2903 <li> backout, commit, import, tag: Specify the commit date.
2904 2904 <li> log, revert, update: Select revision(s) by date.
2905 2905 </ul>
2906 2906 <p>
2907 2907 Many date formats are valid. Here are some examples:
2908 2908 </p>
2909 2909 <ul>
2910 2910 <li> &quot;Wed Dec 6 13:18:29 2006&quot; (local timezone assumed)
2911 2911 <li> &quot;Dec 6 13:18 -0600&quot; (year assumed, time offset provided)
2912 2912 <li> &quot;Dec 6 13:18 UTC&quot; (UTC and GMT are aliases for +0000)
2913 2913 <li> &quot;Dec 6&quot; (midnight)
2914 2914 <li> &quot;13:18&quot; (today assumed)
2915 2915 <li> &quot;3:39&quot; (3:39AM assumed)
2916 2916 <li> &quot;3:39pm&quot; (15:39)
2917 2917 <li> &quot;2006-12-06 13:18:29&quot; (ISO 8601 format)
2918 2918 <li> &quot;2006-12-6 13:18&quot;
2919 2919 <li> &quot;2006-12-6&quot;
2920 2920 <li> &quot;12-6&quot;
2921 2921 <li> &quot;12/6&quot;
2922 2922 <li> &quot;12/6/6&quot; (Dec 6 2006)
2923 2923 <li> &quot;today&quot; (midnight)
2924 2924 <li> &quot;yesterday&quot; (midnight)
2925 2925 <li> &quot;now&quot; - right now
2926 2926 </ul>
2927 2927 <p>
2928 2928 Lastly, there is Mercurial's internal format:
2929 2929 </p>
2930 2930 <ul>
2931 2931 <li> &quot;1165411109 0&quot; (Wed Dec 6 13:18:29 2006 UTC)
2932 2932 </ul>
2933 2933 <p>
2934 2934 This is the internal representation format for dates. The first number
2935 2935 is the number of seconds since the epoch (1970-01-01 00:00 UTC). The
2936 2936 second is the offset of the local timezone, in seconds west of UTC
2937 2937 (negative if the timezone is east of UTC).
2938 2938 </p>
2939 2939 <p>
2940 2940 The log command also accepts date ranges:
2941 2941 </p>
2942 2942 <ul>
2943 2943 <li> &quot;&lt;DATE&quot; - at or before a given date/time
2944 2944 <li> &quot;&gt;DATE&quot; - on or after a given date/time
2945 2945 <li> &quot;DATE to DATE&quot; - a date range, inclusive
2946 2946 <li> &quot;-DAYS&quot; - within a given number of days of today
2947 2947 </ul>
2948 2948
2949 2949 </div>
2950 2950 </div>
2951 2951 </div>
2952 2952
2953 2953
2954 2954
2955 2955 </body>
2956 2956 </html>
2957 2957
2958 2958
2959 2959 Sub-topic indexes rendered properly
2960 2960
2961 2961 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals"
2962 2962 200 Script output follows
2963 2963
2964 2964 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2965 2965 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2966 2966 <head>
2967 2967 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2968 2968 <meta name="robots" content="index, nofollow" />
2969 2969 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2970 2970 <script type="text/javascript" src="/static/mercurial.js"></script>
2971 2971
2972 2972 <title>Help: internals</title>
2973 2973 </head>
2974 2974 <body>
2975 2975
2976 2976 <div class="container">
2977 2977 <div class="menu">
2978 2978 <div class="logo">
2979 2979 <a href="https://mercurial-scm.org/">
2980 2980 <img src="/static/hglogo.png" alt="mercurial" /></a>
2981 2981 </div>
2982 2982 <ul>
2983 2983 <li><a href="/shortlog">log</a></li>
2984 2984 <li><a href="/graph">graph</a></li>
2985 2985 <li><a href="/tags">tags</a></li>
2986 2986 <li><a href="/bookmarks">bookmarks</a></li>
2987 2987 <li><a href="/branches">branches</a></li>
2988 2988 </ul>
2989 2989 <ul>
2990 2990 <li><a href="/help">help</a></li>
2991 2991 </ul>
2992 2992 </div>
2993 2993
2994 2994 <div class="main">
2995 2995 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2996 2996 <form class="search" action="/log">
2997 2997
2998 2998 <p><input name="rev" id="search1" type="text" size="30" /></p>
2999 2999 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3000 3000 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3001 3001 </form>
3002 3002 <table class="bigtable">
3003 3003 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
3004 3004
3005 3005 <tr><td>
3006 3006 <a href="/help/internals.bundles">
3007 3007 bundles
3008 3008 </a>
3009 3009 </td><td>
3010 3010 Bundles
3011 3011 </td></tr>
3012 3012 <tr><td>
3013 3013 <a href="/help/internals.censor">
3014 3014 censor
3015 3015 </a>
3016 3016 </td><td>
3017 3017 Censor
3018 3018 </td></tr>
3019 3019 <tr><td>
3020 3020 <a href="/help/internals.changegroups">
3021 3021 changegroups
3022 3022 </a>
3023 3023 </td><td>
3024 3024 Changegroups
3025 3025 </td></tr>
3026 3026 <tr><td>
3027 3027 <a href="/help/internals.requirements">
3028 3028 requirements
3029 3029 </a>
3030 3030 </td><td>
3031 3031 Repository Requirements
3032 3032 </td></tr>
3033 3033 <tr><td>
3034 3034 <a href="/help/internals.revlogs">
3035 3035 revlogs
3036 3036 </a>
3037 3037 </td><td>
3038 3038 Revision Logs
3039 3039 </td></tr>
3040 3040 <tr><td>
3041 3041 <a href="/help/internals.wireprotocol">
3042 3042 wireprotocol
3043 3043 </a>
3044 3044 </td><td>
3045 3045 Wire Protocol
3046 3046 </td></tr>
3047 3047
3048 3048
3049 3049
3050 3050
3051 3051
3052 3052 </table>
3053 3053 </div>
3054 3054 </div>
3055 3055
3056 3056
3057 3057
3058 3058 </body>
3059 3059 </html>
3060 3060
3061 3061
3062 3062 Sub-topic topics rendered properly
3063 3063
3064 3064 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals.changegroups"
3065 3065 200 Script output follows
3066 3066
3067 3067 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3068 3068 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3069 3069 <head>
3070 3070 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3071 3071 <meta name="robots" content="index, nofollow" />
3072 3072 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3073 3073 <script type="text/javascript" src="/static/mercurial.js"></script>
3074 3074
3075 3075 <title>Help: internals.changegroups</title>
3076 3076 </head>
3077 3077 <body>
3078 3078
3079 3079 <div class="container">
3080 3080 <div class="menu">
3081 3081 <div class="logo">
3082 3082 <a href="https://mercurial-scm.org/">
3083 3083 <img src="/static/hglogo.png" alt="mercurial" /></a>
3084 3084 </div>
3085 3085 <ul>
3086 3086 <li><a href="/shortlog">log</a></li>
3087 3087 <li><a href="/graph">graph</a></li>
3088 3088 <li><a href="/tags">tags</a></li>
3089 3089 <li><a href="/bookmarks">bookmarks</a></li>
3090 3090 <li><a href="/branches">branches</a></li>
3091 3091 </ul>
3092 3092 <ul>
3093 3093 <li class="active"><a href="/help">help</a></li>
3094 3094 </ul>
3095 3095 </div>
3096 3096
3097 3097 <div class="main">
3098 3098 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3099 3099 <h3>Help: internals.changegroups</h3>
3100 3100
3101 3101 <form class="search" action="/log">
3102 3102
3103 3103 <p><input name="rev" id="search1" type="text" size="30" /></p>
3104 3104 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3105 3105 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3106 3106 </form>
3107 3107 <div id="doc">
3108 3108 <h1>Changegroups</h1>
3109 3109 <p>
3110 3110 Changegroups are representations of repository revlog data, specifically
3111 3111 the changelog data, root/flat manifest data, treemanifest data, and
3112 3112 filelogs.
3113 3113 </p>
3114 3114 <p>
3115 3115 There are 3 versions of changegroups: &quot;1&quot;, &quot;2&quot;, and &quot;3&quot;. From a
3116 3116 high-level, versions &quot;1&quot; and &quot;2&quot; are almost exactly the same, with the
3117 3117 only difference being an additional item in the *delta header*. Version
3118 3118 &quot;3&quot; adds support for revlog flags in the *delta header* and optionally
3119 3119 exchanging treemanifests (enabled by setting an option on the
3120 3120 &quot;changegroup&quot; part in the bundle2).
3121 3121 </p>
3122 3122 <p>
3123 3123 Changegroups when not exchanging treemanifests consist of 3 logical
3124 3124 segments:
3125 3125 </p>
3126 3126 <pre>
3127 3127 +---------------------------------+
3128 3128 | | | |
3129 3129 | changeset | manifest | filelogs |
3130 3130 | | | |
3131 3131 | | | |
3132 3132 +---------------------------------+
3133 3133 </pre>
3134 3134 <p>
3135 3135 When exchanging treemanifests, there are 4 logical segments:
3136 3136 </p>
3137 3137 <pre>
3138 3138 +-------------------------------------------------+
3139 3139 | | | | |
3140 3140 | changeset | root | treemanifests | filelogs |
3141 3141 | | manifest | | |
3142 3142 | | | | |
3143 3143 +-------------------------------------------------+
3144 3144 </pre>
3145 3145 <p>
3146 3146 The principle building block of each segment is a *chunk*. A *chunk*
3147 3147 is a framed piece of data:
3148 3148 </p>
3149 3149 <pre>
3150 3150 +---------------------------------------+
3151 3151 | | |
3152 3152 | length | data |
3153 3153 | (4 bytes) | (&lt;length - 4&gt; bytes) |
3154 3154 | | |
3155 3155 +---------------------------------------+
3156 3156 </pre>
3157 3157 <p>
3158 3158 All integers are big-endian signed integers. Each chunk starts with a 32-bit
3159 3159 integer indicating the length of the entire chunk (including the length field
3160 3160 itself).
3161 3161 </p>
3162 3162 <p>
3163 3163 There is a special case chunk that has a value of 0 for the length
3164 3164 (&quot;0x00000000&quot;). We call this an *empty chunk*.
3165 3165 </p>
3166 3166 <h2>Delta Groups</h2>
3167 3167 <p>
3168 3168 A *delta group* expresses the content of a revlog as a series of deltas,
3169 3169 or patches against previous revisions.
3170 3170 </p>
3171 3171 <p>
3172 3172 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
3173 3173 to signal the end of the delta group:
3174 3174 </p>
3175 3175 <pre>
3176 3176 +------------------------------------------------------------------------+
3177 3177 | | | | | |
3178 3178 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
3179 3179 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
3180 3180 | | | | | |
3181 3181 +------------------------------------------------------------------------+
3182 3182 </pre>
3183 3183 <p>
3184 3184 Each *chunk*'s data consists of the following:
3185 3185 </p>
3186 3186 <pre>
3187 3187 +---------------------------------------+
3188 3188 | | |
3189 3189 | delta header | delta data |
3190 3190 | (various by version) | (various) |
3191 3191 | | |
3192 3192 +---------------------------------------+
3193 3193 </pre>
3194 3194 <p>
3195 3195 The *delta data* is a series of *delta*s that describe a diff from an existing
3196 3196 entry (either that the recipient already has, or previously specified in the
3197 3197 bundle/changegroup).
3198 3198 </p>
3199 3199 <p>
3200 3200 The *delta header* is different between versions &quot;1&quot;, &quot;2&quot;, and
3201 3201 &quot;3&quot; of the changegroup format.
3202 3202 </p>
3203 3203 <p>
3204 3204 Version 1 (headerlen=80):
3205 3205 </p>
3206 3206 <pre>
3207 3207 +------------------------------------------------------+
3208 3208 | | | | |
3209 3209 | node | p1 node | p2 node | link node |
3210 3210 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3211 3211 | | | | |
3212 3212 +------------------------------------------------------+
3213 3213 </pre>
3214 3214 <p>
3215 3215 Version 2 (headerlen=100):
3216 3216 </p>
3217 3217 <pre>
3218 3218 +------------------------------------------------------------------+
3219 3219 | | | | | |
3220 3220 | node | p1 node | p2 node | base node | link node |
3221 3221 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3222 3222 | | | | | |
3223 3223 +------------------------------------------------------------------+
3224 3224 </pre>
3225 3225 <p>
3226 3226 Version 3 (headerlen=102):
3227 3227 </p>
3228 3228 <pre>
3229 3229 +------------------------------------------------------------------------------+
3230 3230 | | | | | | |
3231 3231 | node | p1 node | p2 node | base node | link node | flags |
3232 3232 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
3233 3233 | | | | | | |
3234 3234 +------------------------------------------------------------------------------+
3235 3235 </pre>
3236 3236 <p>
3237 3237 The *delta data* consists of &quot;chunklen - 4 - headerlen&quot; bytes, which contain a
3238 3238 series of *delta*s, densely packed (no separators). These deltas describe a diff
3239 3239 from an existing entry (either that the recipient already has, or previously
3240 3240 specified in the bundle/changegroup). The format is described more fully in
3241 3241 &quot;hg help internals.bdiff&quot;, but briefly:
3242 3242 </p>
3243 3243 <pre>
3244 3244 +---------------------------------------------------------------+
3245 3245 | | | | |
3246 3246 | start offset | end offset | new length | content |
3247 3247 | (4 bytes) | (4 bytes) | (4 bytes) | (&lt;new length&gt; bytes) |
3248 3248 | | | | |
3249 3249 +---------------------------------------------------------------+
3250 3250 </pre>
3251 3251 <p>
3252 3252 Please note that the length field in the delta data does *not* include itself.
3253 3253 </p>
3254 3254 <p>
3255 3255 In version 1, the delta is always applied against the previous node from
3256 3256 the changegroup or the first parent if this is the first entry in the
3257 3257 changegroup.
3258 3258 </p>
3259 3259 <p>
3260 3260 In version 2 and up, the delta base node is encoded in the entry in the
3261 3261 changegroup. This allows the delta to be expressed against any parent,
3262 3262 which can result in smaller deltas and more efficient encoding of data.
3263 3263 </p>
3264 3264 <h2>Changeset Segment</h2>
3265 3265 <p>
3266 3266 The *changeset segment* consists of a single *delta group* holding
3267 3267 changelog data. The *empty chunk* at the end of the *delta group* denotes
3268 3268 the boundary to the *manifest segment*.
3269 3269 </p>
3270 3270 <h2>Manifest Segment</h2>
3271 3271 <p>
3272 3272 The *manifest segment* consists of a single *delta group* holding manifest
3273 3273 data. If treemanifests are in use, it contains only the manifest for the
3274 3274 root directory of the repository. Otherwise, it contains the entire
3275 3275 manifest data. The *empty chunk* at the end of the *delta group* denotes
3276 3276 the boundary to the next segment (either the *treemanifests segment* or the
3277 3277 *filelogs segment*, depending on version and the request options).
3278 3278 </p>
3279 3279 <h3>Treemanifests Segment</h3>
3280 3280 <p>
3281 3281 The *treemanifests segment* only exists in changegroup version &quot;3&quot;, and
3282 3282 only if the 'treemanifest' param is part of the bundle2 changegroup part
3283 3283 (it is not possible to use changegroup version 3 outside of bundle2).
3284 3284 Aside from the filenames in the *treemanifests segment* containing a
3285 3285 trailing &quot;/&quot; character, it behaves identically to the *filelogs segment*
3286 3286 (see below). The final sub-segment is followed by an *empty chunk* (logically,
3287 3287 a sub-segment with filename size 0). This denotes the boundary to the
3288 3288 *filelogs segment*.
3289 3289 </p>
3290 3290 <h2>Filelogs Segment</h2>
3291 3291 <p>
3292 3292 The *filelogs segment* consists of multiple sub-segments, each
3293 3293 corresponding to an individual file whose data is being described:
3294 3294 </p>
3295 3295 <pre>
3296 3296 +--------------------------------------------------+
3297 3297 | | | | | |
3298 3298 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
3299 3299 | | | | | (4 bytes) |
3300 3300 | | | | | |
3301 3301 +--------------------------------------------------+
3302 3302 </pre>
3303 3303 <p>
3304 3304 The final filelog sub-segment is followed by an *empty chunk* (logically,
3305 3305 a sub-segment with filename size 0). This denotes the end of the segment
3306 3306 and of the overall changegroup.
3307 3307 </p>
3308 3308 <p>
3309 3309 Each filelog sub-segment consists of the following:
3310 3310 </p>
3311 3311 <pre>
3312 3312 +------------------------------------------------------+
3313 3313 | | | |
3314 3314 | filename length | filename | delta group |
3315 3315 | (4 bytes) | (&lt;length - 4&gt; bytes) | (various) |
3316 3316 | | | |
3317 3317 +------------------------------------------------------+
3318 3318 </pre>
3319 3319 <p>
3320 3320 That is, a *chunk* consisting of the filename (not terminated or padded)
3321 3321 followed by N chunks constituting the *delta group* for this file. The
3322 3322 *empty chunk* at the end of each *delta group* denotes the boundary to the
3323 3323 next filelog sub-segment.
3324 3324 </p>
3325 3325
3326 3326 </div>
3327 3327 </div>
3328 3328 </div>
3329 3329
3330 3330
3331 3331
3332 3332 </body>
3333 3333 </html>
3334 3334
3335 3335
3336 3336 $ killdaemons.py
3337 3337
3338 3338 #endif
General Comments 0
You need to be logged in to leave comments. Login now