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