##// END OF EJS Templates
debugshell: add a simple command for starting an interactive shell...
Joerg Sonnenberger -
r47121:f25c770c default
parent child Browse files
Show More
@@ -1,4661 +1,4678 b''
1 1 # debugcommands.py - command processing for debug* commands
2 2 #
3 3 # Copyright 2005-2016 Matt Mackall <mpm@selenic.com>
4 4 #
5 5 # This software may be used and distributed according to the terms of the
6 6 # GNU General Public License version 2 or any later version.
7 7
8 8 from __future__ import absolute_import
9 9
10 10 import codecs
11 11 import collections
12 12 import difflib
13 13 import errno
14 14 import glob
15 15 import operator
16 16 import os
17 17 import platform
18 18 import random
19 19 import re
20 20 import socket
21 21 import ssl
22 22 import stat
23 23 import string
24 24 import subprocess
25 25 import sys
26 26 import time
27 27
28 28 from .i18n import _
29 29 from .node import (
30 30 bin,
31 31 hex,
32 32 nullid,
33 33 nullrev,
34 34 short,
35 35 )
36 36 from .pycompat import (
37 37 getattr,
38 38 open,
39 39 )
40 40 from . import (
41 41 bundle2,
42 42 bundlerepo,
43 43 changegroup,
44 44 cmdutil,
45 45 color,
46 46 context,
47 47 copies,
48 48 dagparser,
49 49 encoding,
50 50 error,
51 51 exchange,
52 52 extensions,
53 53 filemerge,
54 54 filesetlang,
55 55 formatter,
56 56 hg,
57 57 httppeer,
58 58 localrepo,
59 59 lock as lockmod,
60 60 logcmdutil,
61 61 mergestate as mergestatemod,
62 62 metadata,
63 63 obsolete,
64 64 obsutil,
65 65 pathutil,
66 66 phases,
67 67 policy,
68 68 pvec,
69 69 pycompat,
70 70 registrar,
71 71 repair,
72 72 revlog,
73 73 revset,
74 74 revsetlang,
75 75 scmutil,
76 76 setdiscovery,
77 77 simplemerge,
78 78 sshpeer,
79 79 sslutil,
80 80 streamclone,
81 81 strip,
82 82 tags as tagsmod,
83 83 templater,
84 84 treediscovery,
85 85 upgrade,
86 86 url as urlmod,
87 87 util,
88 88 vfs as vfsmod,
89 89 wireprotoframing,
90 90 wireprotoserver,
91 91 wireprotov2peer,
92 92 )
93 93 from .utils import (
94 94 cborutil,
95 95 compression,
96 96 dateutil,
97 97 procutil,
98 98 stringutil,
99 99 )
100 100
101 101 from .revlogutils import (
102 102 deltas as deltautil,
103 103 nodemap,
104 104 sidedata,
105 105 )
106 106
107 107 release = lockmod.release
108 108
109 109 table = {}
110 110 table.update(strip.command._table)
111 111 command = registrar.command(table)
112 112
113 113
114 114 @command(b'debugancestor', [], _(b'[INDEX] REV1 REV2'), optionalrepo=True)
115 115 def debugancestor(ui, repo, *args):
116 116 """find the ancestor revision of two revisions in a given index"""
117 117 if len(args) == 3:
118 118 index, rev1, rev2 = args
119 119 r = revlog.revlog(vfsmod.vfs(encoding.getcwd(), audit=False), index)
120 120 lookup = r.lookup
121 121 elif len(args) == 2:
122 122 if not repo:
123 123 raise error.Abort(
124 124 _(b'there is no Mercurial repository here (.hg not found)')
125 125 )
126 126 rev1, rev2 = args
127 127 r = repo.changelog
128 128 lookup = repo.lookup
129 129 else:
130 130 raise error.Abort(_(b'either two or three arguments required'))
131 131 a = r.ancestor(lookup(rev1), lookup(rev2))
132 132 ui.write(b'%d:%s\n' % (r.rev(a), hex(a)))
133 133
134 134
135 135 @command(b'debugantivirusrunning', [])
136 136 def debugantivirusrunning(ui, repo):
137 137 """attempt to trigger an antivirus scanner to see if one is active"""
138 138 with repo.cachevfs.open('eicar-test-file.com', b'wb') as f:
139 139 f.write(
140 140 util.b85decode(
141 141 # This is a base85-armored version of the EICAR test file. See
142 142 # https://en.wikipedia.org/wiki/EICAR_test_file for details.
143 143 b'ST#=}P$fV?P+K%yP+C|uG$>GBDK|qyDK~v2MM*<JQY}+dK~6+LQba95P'
144 144 b'E<)&Nm5l)EmTEQR4qnHOhq9iNGnJx'
145 145 )
146 146 )
147 147 # Give an AV engine time to scan the file.
148 148 time.sleep(2)
149 149 util.unlink(repo.cachevfs.join('eicar-test-file.com'))
150 150
151 151
152 152 @command(b'debugapplystreamclonebundle', [], b'FILE')
153 153 def debugapplystreamclonebundle(ui, repo, fname):
154 154 """apply a stream clone bundle file"""
155 155 f = hg.openpath(ui, fname)
156 156 gen = exchange.readbundle(ui, f, fname)
157 157 gen.apply(repo)
158 158
159 159
160 160 @command(
161 161 b'debugbuilddag',
162 162 [
163 163 (
164 164 b'm',
165 165 b'mergeable-file',
166 166 None,
167 167 _(b'add single file mergeable changes'),
168 168 ),
169 169 (
170 170 b'o',
171 171 b'overwritten-file',
172 172 None,
173 173 _(b'add single file all revs overwrite'),
174 174 ),
175 175 (b'n', b'new-file', None, _(b'add new file at each rev')),
176 176 ],
177 177 _(b'[OPTION]... [TEXT]'),
178 178 )
179 179 def debugbuilddag(
180 180 ui,
181 181 repo,
182 182 text=None,
183 183 mergeable_file=False,
184 184 overwritten_file=False,
185 185 new_file=False,
186 186 ):
187 187 """builds a repo with a given DAG from scratch in the current empty repo
188 188
189 189 The description of the DAG is read from stdin if not given on the
190 190 command line.
191 191
192 192 Elements:
193 193
194 194 - "+n" is a linear run of n nodes based on the current default parent
195 195 - "." is a single node based on the current default parent
196 196 - "$" resets the default parent to null (implied at the start);
197 197 otherwise the default parent is always the last node created
198 198 - "<p" sets the default parent to the backref p
199 199 - "*p" is a fork at parent p, which is a backref
200 200 - "*p1/p2" is a merge of parents p1 and p2, which are backrefs
201 201 - "/p2" is a merge of the preceding node and p2
202 202 - ":tag" defines a local tag for the preceding node
203 203 - "@branch" sets the named branch for subsequent nodes
204 204 - "#...\\n" is a comment up to the end of the line
205 205
206 206 Whitespace between the above elements is ignored.
207 207
208 208 A backref is either
209 209
210 210 - a number n, which references the node curr-n, where curr is the current
211 211 node, or
212 212 - the name of a local tag you placed earlier using ":tag", or
213 213 - empty to denote the default parent.
214 214
215 215 All string valued-elements are either strictly alphanumeric, or must
216 216 be enclosed in double quotes ("..."), with "\\" as escape character.
217 217 """
218 218
219 219 if text is None:
220 220 ui.status(_(b"reading DAG from stdin\n"))
221 221 text = ui.fin.read()
222 222
223 223 cl = repo.changelog
224 224 if len(cl) > 0:
225 225 raise error.Abort(_(b'repository is not empty'))
226 226
227 227 # determine number of revs in DAG
228 228 total = 0
229 229 for type, data in dagparser.parsedag(text):
230 230 if type == b'n':
231 231 total += 1
232 232
233 233 if mergeable_file:
234 234 linesperrev = 2
235 235 # make a file with k lines per rev
236 236 initialmergedlines = [
237 237 b'%d' % i for i in pycompat.xrange(0, total * linesperrev)
238 238 ]
239 239 initialmergedlines.append(b"")
240 240
241 241 tags = []
242 242 progress = ui.makeprogress(
243 243 _(b'building'), unit=_(b'revisions'), total=total
244 244 )
245 245 with progress, repo.wlock(), repo.lock(), repo.transaction(b"builddag"):
246 246 at = -1
247 247 atbranch = b'default'
248 248 nodeids = []
249 249 id = 0
250 250 progress.update(id)
251 251 for type, data in dagparser.parsedag(text):
252 252 if type == b'n':
253 253 ui.note((b'node %s\n' % pycompat.bytestr(data)))
254 254 id, ps = data
255 255
256 256 files = []
257 257 filecontent = {}
258 258
259 259 p2 = None
260 260 if mergeable_file:
261 261 fn = b"mf"
262 262 p1 = repo[ps[0]]
263 263 if len(ps) > 1:
264 264 p2 = repo[ps[1]]
265 265 pa = p1.ancestor(p2)
266 266 base, local, other = [
267 267 x[fn].data() for x in (pa, p1, p2)
268 268 ]
269 269 m3 = simplemerge.Merge3Text(base, local, other)
270 270 ml = [l.strip() for l in m3.merge_lines()]
271 271 ml.append(b"")
272 272 elif at > 0:
273 273 ml = p1[fn].data().split(b"\n")
274 274 else:
275 275 ml = initialmergedlines
276 276 ml[id * linesperrev] += b" r%i" % id
277 277 mergedtext = b"\n".join(ml)
278 278 files.append(fn)
279 279 filecontent[fn] = mergedtext
280 280
281 281 if overwritten_file:
282 282 fn = b"of"
283 283 files.append(fn)
284 284 filecontent[fn] = b"r%i\n" % id
285 285
286 286 if new_file:
287 287 fn = b"nf%i" % id
288 288 files.append(fn)
289 289 filecontent[fn] = b"r%i\n" % id
290 290 if len(ps) > 1:
291 291 if not p2:
292 292 p2 = repo[ps[1]]
293 293 for fn in p2:
294 294 if fn.startswith(b"nf"):
295 295 files.append(fn)
296 296 filecontent[fn] = p2[fn].data()
297 297
298 298 def fctxfn(repo, cx, path):
299 299 if path in filecontent:
300 300 return context.memfilectx(
301 301 repo, cx, path, filecontent[path]
302 302 )
303 303 return None
304 304
305 305 if len(ps) == 0 or ps[0] < 0:
306 306 pars = [None, None]
307 307 elif len(ps) == 1:
308 308 pars = [nodeids[ps[0]], None]
309 309 else:
310 310 pars = [nodeids[p] for p in ps]
311 311 cx = context.memctx(
312 312 repo,
313 313 pars,
314 314 b"r%i" % id,
315 315 files,
316 316 fctxfn,
317 317 date=(id, 0),
318 318 user=b"debugbuilddag",
319 319 extra={b'branch': atbranch},
320 320 )
321 321 nodeid = repo.commitctx(cx)
322 322 nodeids.append(nodeid)
323 323 at = id
324 324 elif type == b'l':
325 325 id, name = data
326 326 ui.note((b'tag %s\n' % name))
327 327 tags.append(b"%s %s\n" % (hex(repo.changelog.node(id)), name))
328 328 elif type == b'a':
329 329 ui.note((b'branch %s\n' % data))
330 330 atbranch = data
331 331 progress.update(id)
332 332
333 333 if tags:
334 334 repo.vfs.write(b"localtags", b"".join(tags))
335 335
336 336
337 337 def _debugchangegroup(ui, gen, all=None, indent=0, **opts):
338 338 indent_string = b' ' * indent
339 339 if all:
340 340 ui.writenoi18n(
341 341 b"%sformat: id, p1, p2, cset, delta base, len(delta)\n"
342 342 % indent_string
343 343 )
344 344
345 345 def showchunks(named):
346 346 ui.write(b"\n%s%s\n" % (indent_string, named))
347 347 for deltadata in gen.deltaiter():
348 348 node, p1, p2, cs, deltabase, delta, flags = deltadata
349 349 ui.write(
350 350 b"%s%s %s %s %s %s %d\n"
351 351 % (
352 352 indent_string,
353 353 hex(node),
354 354 hex(p1),
355 355 hex(p2),
356 356 hex(cs),
357 357 hex(deltabase),
358 358 len(delta),
359 359 )
360 360 )
361 361
362 362 gen.changelogheader()
363 363 showchunks(b"changelog")
364 364 gen.manifestheader()
365 365 showchunks(b"manifest")
366 366 for chunkdata in iter(gen.filelogheader, {}):
367 367 fname = chunkdata[b'filename']
368 368 showchunks(fname)
369 369 else:
370 370 if isinstance(gen, bundle2.unbundle20):
371 371 raise error.Abort(_(b'use debugbundle2 for this file'))
372 372 gen.changelogheader()
373 373 for deltadata in gen.deltaiter():
374 374 node, p1, p2, cs, deltabase, delta, flags = deltadata
375 375 ui.write(b"%s%s\n" % (indent_string, hex(node)))
376 376
377 377
378 378 def _debugobsmarkers(ui, part, indent=0, **opts):
379 379 """display version and markers contained in 'data'"""
380 380 opts = pycompat.byteskwargs(opts)
381 381 data = part.read()
382 382 indent_string = b' ' * indent
383 383 try:
384 384 version, markers = obsolete._readmarkers(data)
385 385 except error.UnknownVersion as exc:
386 386 msg = b"%sunsupported version: %s (%d bytes)\n"
387 387 msg %= indent_string, exc.version, len(data)
388 388 ui.write(msg)
389 389 else:
390 390 msg = b"%sversion: %d (%d bytes)\n"
391 391 msg %= indent_string, version, len(data)
392 392 ui.write(msg)
393 393 fm = ui.formatter(b'debugobsolete', opts)
394 394 for rawmarker in sorted(markers):
395 395 m = obsutil.marker(None, rawmarker)
396 396 fm.startitem()
397 397 fm.plain(indent_string)
398 398 cmdutil.showmarker(fm, m)
399 399 fm.end()
400 400
401 401
402 402 def _debugphaseheads(ui, data, indent=0):
403 403 """display version and markers contained in 'data'"""
404 404 indent_string = b' ' * indent
405 405 headsbyphase = phases.binarydecode(data)
406 406 for phase in phases.allphases:
407 407 for head in headsbyphase[phase]:
408 408 ui.write(indent_string)
409 409 ui.write(b'%s %s\n' % (hex(head), phases.phasenames[phase]))
410 410
411 411
412 412 def _quasirepr(thing):
413 413 if isinstance(thing, (dict, util.sortdict, collections.OrderedDict)):
414 414 return b'{%s}' % (
415 415 b', '.join(b'%s: %s' % (k, thing[k]) for k in sorted(thing))
416 416 )
417 417 return pycompat.bytestr(repr(thing))
418 418
419 419
420 420 def _debugbundle2(ui, gen, all=None, **opts):
421 421 """lists the contents of a bundle2"""
422 422 if not isinstance(gen, bundle2.unbundle20):
423 423 raise error.Abort(_(b'not a bundle2 file'))
424 424 ui.write((b'Stream params: %s\n' % _quasirepr(gen.params)))
425 425 parttypes = opts.get('part_type', [])
426 426 for part in gen.iterparts():
427 427 if parttypes and part.type not in parttypes:
428 428 continue
429 429 msg = b'%s -- %s (mandatory: %r)\n'
430 430 ui.write((msg % (part.type, _quasirepr(part.params), part.mandatory)))
431 431 if part.type == b'changegroup':
432 432 version = part.params.get(b'version', b'01')
433 433 cg = changegroup.getunbundler(version, part, b'UN')
434 434 if not ui.quiet:
435 435 _debugchangegroup(ui, cg, all=all, indent=4, **opts)
436 436 if part.type == b'obsmarkers':
437 437 if not ui.quiet:
438 438 _debugobsmarkers(ui, part, indent=4, **opts)
439 439 if part.type == b'phase-heads':
440 440 if not ui.quiet:
441 441 _debugphaseheads(ui, part, indent=4)
442 442
443 443
444 444 @command(
445 445 b'debugbundle',
446 446 [
447 447 (b'a', b'all', None, _(b'show all details')),
448 448 (b'', b'part-type', [], _(b'show only the named part type')),
449 449 (b'', b'spec', None, _(b'print the bundlespec of the bundle')),
450 450 ],
451 451 _(b'FILE'),
452 452 norepo=True,
453 453 )
454 454 def debugbundle(ui, bundlepath, all=None, spec=None, **opts):
455 455 """lists the contents of a bundle"""
456 456 with hg.openpath(ui, bundlepath) as f:
457 457 if spec:
458 458 spec = exchange.getbundlespec(ui, f)
459 459 ui.write(b'%s\n' % spec)
460 460 return
461 461
462 462 gen = exchange.readbundle(ui, f, bundlepath)
463 463 if isinstance(gen, bundle2.unbundle20):
464 464 return _debugbundle2(ui, gen, all=all, **opts)
465 465 _debugchangegroup(ui, gen, all=all, **opts)
466 466
467 467
468 468 @command(b'debugcapabilities', [], _(b'PATH'), norepo=True)
469 469 def debugcapabilities(ui, path, **opts):
470 470 """lists the capabilities of a remote peer"""
471 471 opts = pycompat.byteskwargs(opts)
472 472 peer = hg.peer(ui, opts, path)
473 473 caps = peer.capabilities()
474 474 ui.writenoi18n(b'Main capabilities:\n')
475 475 for c in sorted(caps):
476 476 ui.write(b' %s\n' % c)
477 477 b2caps = bundle2.bundle2caps(peer)
478 478 if b2caps:
479 479 ui.writenoi18n(b'Bundle2 capabilities:\n')
480 480 for key, values in sorted(pycompat.iteritems(b2caps)):
481 481 ui.write(b' %s\n' % key)
482 482 for v in values:
483 483 ui.write(b' %s\n' % v)
484 484
485 485
486 486 @command(b'debugchangedfiles', [], b'REV')
487 487 def debugchangedfiles(ui, repo, rev):
488 488 """list the stored files changes for a revision"""
489 489 ctx = scmutil.revsingle(repo, rev, None)
490 490 sd = repo.changelog.sidedata(ctx.rev())
491 491 files_block = sd.get(sidedata.SD_FILES)
492 492 if files_block is not None:
493 493 files = metadata.decode_files_sidedata(sd)
494 494 for f in sorted(files.touched):
495 495 if f in files.added:
496 496 action = b"added"
497 497 elif f in files.removed:
498 498 action = b"removed"
499 499 elif f in files.merged:
500 500 action = b"merged"
501 501 elif f in files.salvaged:
502 502 action = b"salvaged"
503 503 else:
504 504 action = b"touched"
505 505
506 506 copy_parent = b""
507 507 copy_source = b""
508 508 if f in files.copied_from_p1:
509 509 copy_parent = b"p1"
510 510 copy_source = files.copied_from_p1[f]
511 511 elif f in files.copied_from_p2:
512 512 copy_parent = b"p2"
513 513 copy_source = files.copied_from_p2[f]
514 514
515 515 data = (action, copy_parent, f, copy_source)
516 516 template = b"%-8s %2s: %s, %s;\n"
517 517 ui.write(template % data)
518 518
519 519
520 520 @command(b'debugcheckstate', [], b'')
521 521 def debugcheckstate(ui, repo):
522 522 """validate the correctness of the current dirstate"""
523 523 parent1, parent2 = repo.dirstate.parents()
524 524 m1 = repo[parent1].manifest()
525 525 m2 = repo[parent2].manifest()
526 526 errors = 0
527 527 for f in repo.dirstate:
528 528 state = repo.dirstate[f]
529 529 if state in b"nr" and f not in m1:
530 530 ui.warn(_(b"%s in state %s, but not in manifest1\n") % (f, state))
531 531 errors += 1
532 532 if state in b"a" and f in m1:
533 533 ui.warn(_(b"%s in state %s, but also in manifest1\n") % (f, state))
534 534 errors += 1
535 535 if state in b"m" and f not in m1 and f not in m2:
536 536 ui.warn(
537 537 _(b"%s in state %s, but not in either manifest\n") % (f, state)
538 538 )
539 539 errors += 1
540 540 for f in m1:
541 541 state = repo.dirstate[f]
542 542 if state not in b"nrm":
543 543 ui.warn(_(b"%s in manifest1, but listed as state %s") % (f, state))
544 544 errors += 1
545 545 if errors:
546 546 errstr = _(b".hg/dirstate inconsistent with current parent's manifest")
547 547 raise error.Abort(errstr)
548 548
549 549
550 550 @command(
551 551 b'debugcolor',
552 552 [(b'', b'style', None, _(b'show all configured styles'))],
553 553 b'hg debugcolor',
554 554 )
555 555 def debugcolor(ui, repo, **opts):
556 556 """show available color, effects or style"""
557 557 ui.writenoi18n(b'color mode: %s\n' % stringutil.pprint(ui._colormode))
558 558 if opts.get('style'):
559 559 return _debugdisplaystyle(ui)
560 560 else:
561 561 return _debugdisplaycolor(ui)
562 562
563 563
564 564 def _debugdisplaycolor(ui):
565 565 ui = ui.copy()
566 566 ui._styles.clear()
567 567 for effect in color._activeeffects(ui).keys():
568 568 ui._styles[effect] = effect
569 569 if ui._terminfoparams:
570 570 for k, v in ui.configitems(b'color'):
571 571 if k.startswith(b'color.'):
572 572 ui._styles[k] = k[6:]
573 573 elif k.startswith(b'terminfo.'):
574 574 ui._styles[k] = k[9:]
575 575 ui.write(_(b'available colors:\n'))
576 576 # sort label with a '_' after the other to group '_background' entry.
577 577 items = sorted(ui._styles.items(), key=lambda i: (b'_' in i[0], i[0], i[1]))
578 578 for colorname, label in items:
579 579 ui.write(b'%s\n' % colorname, label=label)
580 580
581 581
582 582 def _debugdisplaystyle(ui):
583 583 ui.write(_(b'available style:\n'))
584 584 if not ui._styles:
585 585 return
586 586 width = max(len(s) for s in ui._styles)
587 587 for label, effects in sorted(ui._styles.items()):
588 588 ui.write(b'%s' % label, label=label)
589 589 if effects:
590 590 # 50
591 591 ui.write(b': ')
592 592 ui.write(b' ' * (max(0, width - len(label))))
593 593 ui.write(b', '.join(ui.label(e, e) for e in effects.split()))
594 594 ui.write(b'\n')
595 595
596 596
597 597 @command(b'debugcreatestreamclonebundle', [], b'FILE')
598 598 def debugcreatestreamclonebundle(ui, repo, fname):
599 599 """create a stream clone bundle file
600 600
601 601 Stream bundles are special bundles that are essentially archives of
602 602 revlog files. They are commonly used for cloning very quickly.
603 603 """
604 604 # TODO we may want to turn this into an abort when this functionality
605 605 # is moved into `hg bundle`.
606 606 if phases.hassecret(repo):
607 607 ui.warn(
608 608 _(
609 609 b'(warning: stream clone bundle will contain secret '
610 610 b'revisions)\n'
611 611 )
612 612 )
613 613
614 614 requirements, gen = streamclone.generatebundlev1(repo)
615 615 changegroup.writechunks(ui, gen, fname)
616 616
617 617 ui.write(_(b'bundle requirements: %s\n') % b', '.join(sorted(requirements)))
618 618
619 619
620 620 @command(
621 621 b'debugdag',
622 622 [
623 623 (b't', b'tags', None, _(b'use tags as labels')),
624 624 (b'b', b'branches', None, _(b'annotate with branch names')),
625 625 (b'', b'dots', None, _(b'use dots for runs')),
626 626 (b's', b'spaces', None, _(b'separate elements by spaces')),
627 627 ],
628 628 _(b'[OPTION]... [FILE [REV]...]'),
629 629 optionalrepo=True,
630 630 )
631 631 def debugdag(ui, repo, file_=None, *revs, **opts):
632 632 """format the changelog or an index DAG as a concise textual description
633 633
634 634 If you pass a revlog index, the revlog's DAG is emitted. If you list
635 635 revision numbers, they get labeled in the output as rN.
636 636
637 637 Otherwise, the changelog DAG of the current repo is emitted.
638 638 """
639 639 spaces = opts.get('spaces')
640 640 dots = opts.get('dots')
641 641 if file_:
642 642 rlog = revlog.revlog(vfsmod.vfs(encoding.getcwd(), audit=False), file_)
643 643 revs = {int(r) for r in revs}
644 644
645 645 def events():
646 646 for r in rlog:
647 647 yield b'n', (r, list(p for p in rlog.parentrevs(r) if p != -1))
648 648 if r in revs:
649 649 yield b'l', (r, b"r%i" % r)
650 650
651 651 elif repo:
652 652 cl = repo.changelog
653 653 tags = opts.get('tags')
654 654 branches = opts.get('branches')
655 655 if tags:
656 656 labels = {}
657 657 for l, n in repo.tags().items():
658 658 labels.setdefault(cl.rev(n), []).append(l)
659 659
660 660 def events():
661 661 b = b"default"
662 662 for r in cl:
663 663 if branches:
664 664 newb = cl.read(cl.node(r))[5][b'branch']
665 665 if newb != b:
666 666 yield b'a', newb
667 667 b = newb
668 668 yield b'n', (r, list(p for p in cl.parentrevs(r) if p != -1))
669 669 if tags:
670 670 ls = labels.get(r)
671 671 if ls:
672 672 for l in ls:
673 673 yield b'l', (r, l)
674 674
675 675 else:
676 676 raise error.Abort(_(b'need repo for changelog dag'))
677 677
678 678 for line in dagparser.dagtextlines(
679 679 events(),
680 680 addspaces=spaces,
681 681 wraplabels=True,
682 682 wrapannotations=True,
683 683 wrapnonlinear=dots,
684 684 usedots=dots,
685 685 maxlinewidth=70,
686 686 ):
687 687 ui.write(line)
688 688 ui.write(b"\n")
689 689
690 690
691 691 @command(b'debugdata', cmdutil.debugrevlogopts, _(b'-c|-m|FILE REV'))
692 692 def debugdata(ui, repo, file_, rev=None, **opts):
693 693 """dump the contents of a data file revision"""
694 694 opts = pycompat.byteskwargs(opts)
695 695 if opts.get(b'changelog') or opts.get(b'manifest') or opts.get(b'dir'):
696 696 if rev is not None:
697 697 raise error.CommandError(b'debugdata', _(b'invalid arguments'))
698 698 file_, rev = None, file_
699 699 elif rev is None:
700 700 raise error.CommandError(b'debugdata', _(b'invalid arguments'))
701 701 r = cmdutil.openstorage(repo, b'debugdata', file_, opts)
702 702 try:
703 703 ui.write(r.rawdata(r.lookup(rev)))
704 704 except KeyError:
705 705 raise error.Abort(_(b'invalid revision identifier %s') % rev)
706 706
707 707
708 708 @command(
709 709 b'debugdate',
710 710 [(b'e', b'extended', None, _(b'try extended date formats'))],
711 711 _(b'[-e] DATE [RANGE]'),
712 712 norepo=True,
713 713 optionalrepo=True,
714 714 )
715 715 def debugdate(ui, date, range=None, **opts):
716 716 """parse and display a date"""
717 717 if opts["extended"]:
718 718 d = dateutil.parsedate(date, dateutil.extendeddateformats)
719 719 else:
720 720 d = dateutil.parsedate(date)
721 721 ui.writenoi18n(b"internal: %d %d\n" % d)
722 722 ui.writenoi18n(b"standard: %s\n" % dateutil.datestr(d))
723 723 if range:
724 724 m = dateutil.matchdate(range)
725 725 ui.writenoi18n(b"match: %s\n" % m(d[0]))
726 726
727 727
728 728 @command(
729 729 b'debugdeltachain',
730 730 cmdutil.debugrevlogopts + cmdutil.formatteropts,
731 731 _(b'-c|-m|FILE'),
732 732 optionalrepo=True,
733 733 )
734 734 def debugdeltachain(ui, repo, file_=None, **opts):
735 735 """dump information about delta chains in a revlog
736 736
737 737 Output can be templatized. Available template keywords are:
738 738
739 739 :``rev``: revision number
740 740 :``chainid``: delta chain identifier (numbered by unique base)
741 741 :``chainlen``: delta chain length to this revision
742 742 :``prevrev``: previous revision in delta chain
743 743 :``deltatype``: role of delta / how it was computed
744 744 :``compsize``: compressed size of revision
745 745 :``uncompsize``: uncompressed size of revision
746 746 :``chainsize``: total size of compressed revisions in chain
747 747 :``chainratio``: total chain size divided by uncompressed revision size
748 748 (new delta chains typically start at ratio 2.00)
749 749 :``lindist``: linear distance from base revision in delta chain to end
750 750 of this revision
751 751 :``extradist``: total size of revisions not part of this delta chain from
752 752 base of delta chain to end of this revision; a measurement
753 753 of how much extra data we need to read/seek across to read
754 754 the delta chain for this revision
755 755 :``extraratio``: extradist divided by chainsize; another representation of
756 756 how much unrelated data is needed to load this delta chain
757 757
758 758 If the repository is configured to use the sparse read, additional keywords
759 759 are available:
760 760
761 761 :``readsize``: total size of data read from the disk for a revision
762 762 (sum of the sizes of all the blocks)
763 763 :``largestblock``: size of the largest block of data read from the disk
764 764 :``readdensity``: density of useful bytes in the data read from the disk
765 765 :``srchunks``: in how many data hunks the whole revision would be read
766 766
767 767 The sparse read can be enabled with experimental.sparse-read = True
768 768 """
769 769 opts = pycompat.byteskwargs(opts)
770 770 r = cmdutil.openrevlog(repo, b'debugdeltachain', file_, opts)
771 771 index = r.index
772 772 start = r.start
773 773 length = r.length
774 774 generaldelta = r.version & revlog.FLAG_GENERALDELTA
775 775 withsparseread = getattr(r, '_withsparseread', False)
776 776
777 777 def revinfo(rev):
778 778 e = index[rev]
779 779 compsize = e[1]
780 780 uncompsize = e[2]
781 781 chainsize = 0
782 782
783 783 if generaldelta:
784 784 if e[3] == e[5]:
785 785 deltatype = b'p1'
786 786 elif e[3] == e[6]:
787 787 deltatype = b'p2'
788 788 elif e[3] == rev - 1:
789 789 deltatype = b'prev'
790 790 elif e[3] == rev:
791 791 deltatype = b'base'
792 792 else:
793 793 deltatype = b'other'
794 794 else:
795 795 if e[3] == rev:
796 796 deltatype = b'base'
797 797 else:
798 798 deltatype = b'prev'
799 799
800 800 chain = r._deltachain(rev)[0]
801 801 for iterrev in chain:
802 802 e = index[iterrev]
803 803 chainsize += e[1]
804 804
805 805 return compsize, uncompsize, deltatype, chain, chainsize
806 806
807 807 fm = ui.formatter(b'debugdeltachain', opts)
808 808
809 809 fm.plain(
810 810 b' rev chain# chainlen prev delta '
811 811 b'size rawsize chainsize ratio lindist extradist '
812 812 b'extraratio'
813 813 )
814 814 if withsparseread:
815 815 fm.plain(b' readsize largestblk rddensity srchunks')
816 816 fm.plain(b'\n')
817 817
818 818 chainbases = {}
819 819 for rev in r:
820 820 comp, uncomp, deltatype, chain, chainsize = revinfo(rev)
821 821 chainbase = chain[0]
822 822 chainid = chainbases.setdefault(chainbase, len(chainbases) + 1)
823 823 basestart = start(chainbase)
824 824 revstart = start(rev)
825 825 lineardist = revstart + comp - basestart
826 826 extradist = lineardist - chainsize
827 827 try:
828 828 prevrev = chain[-2]
829 829 except IndexError:
830 830 prevrev = -1
831 831
832 832 if uncomp != 0:
833 833 chainratio = float(chainsize) / float(uncomp)
834 834 else:
835 835 chainratio = chainsize
836 836
837 837 if chainsize != 0:
838 838 extraratio = float(extradist) / float(chainsize)
839 839 else:
840 840 extraratio = extradist
841 841
842 842 fm.startitem()
843 843 fm.write(
844 844 b'rev chainid chainlen prevrev deltatype compsize '
845 845 b'uncompsize chainsize chainratio lindist extradist '
846 846 b'extraratio',
847 847 b'%7d %7d %8d %8d %7s %10d %10d %10d %9.5f %9d %9d %10.5f',
848 848 rev,
849 849 chainid,
850 850 len(chain),
851 851 prevrev,
852 852 deltatype,
853 853 comp,
854 854 uncomp,
855 855 chainsize,
856 856 chainratio,
857 857 lineardist,
858 858 extradist,
859 859 extraratio,
860 860 rev=rev,
861 861 chainid=chainid,
862 862 chainlen=len(chain),
863 863 prevrev=prevrev,
864 864 deltatype=deltatype,
865 865 compsize=comp,
866 866 uncompsize=uncomp,
867 867 chainsize=chainsize,
868 868 chainratio=chainratio,
869 869 lindist=lineardist,
870 870 extradist=extradist,
871 871 extraratio=extraratio,
872 872 )
873 873 if withsparseread:
874 874 readsize = 0
875 875 largestblock = 0
876 876 srchunks = 0
877 877
878 878 for revschunk in deltautil.slicechunk(r, chain):
879 879 srchunks += 1
880 880 blkend = start(revschunk[-1]) + length(revschunk[-1])
881 881 blksize = blkend - start(revschunk[0])
882 882
883 883 readsize += blksize
884 884 if largestblock < blksize:
885 885 largestblock = blksize
886 886
887 887 if readsize:
888 888 readdensity = float(chainsize) / float(readsize)
889 889 else:
890 890 readdensity = 1
891 891
892 892 fm.write(
893 893 b'readsize largestblock readdensity srchunks',
894 894 b' %10d %10d %9.5f %8d',
895 895 readsize,
896 896 largestblock,
897 897 readdensity,
898 898 srchunks,
899 899 readsize=readsize,
900 900 largestblock=largestblock,
901 901 readdensity=readdensity,
902 902 srchunks=srchunks,
903 903 )
904 904
905 905 fm.plain(b'\n')
906 906
907 907 fm.end()
908 908
909 909
910 910 @command(
911 911 b'debugdirstate|debugstate',
912 912 [
913 913 (
914 914 b'',
915 915 b'nodates',
916 916 None,
917 917 _(b'do not display the saved mtime (DEPRECATED)'),
918 918 ),
919 919 (b'', b'dates', True, _(b'display the saved mtime')),
920 920 (b'', b'datesort', None, _(b'sort by saved mtime')),
921 921 ],
922 922 _(b'[OPTION]...'),
923 923 )
924 924 def debugstate(ui, repo, **opts):
925 925 """show the contents of the current dirstate"""
926 926
927 927 nodates = not opts['dates']
928 928 if opts.get('nodates') is not None:
929 929 nodates = True
930 930 datesort = opts.get('datesort')
931 931
932 932 if datesort:
933 933 keyfunc = lambda x: (x[1][3], x[0]) # sort by mtime, then by filename
934 934 else:
935 935 keyfunc = None # sort by filename
936 936 for file_, ent in sorted(pycompat.iteritems(repo.dirstate), key=keyfunc):
937 937 if ent[3] == -1:
938 938 timestr = b'unset '
939 939 elif nodates:
940 940 timestr = b'set '
941 941 else:
942 942 timestr = time.strftime(
943 943 "%Y-%m-%d %H:%M:%S ", time.localtime(ent[3])
944 944 )
945 945 timestr = encoding.strtolocal(timestr)
946 946 if ent[1] & 0o20000:
947 947 mode = b'lnk'
948 948 else:
949 949 mode = b'%3o' % (ent[1] & 0o777 & ~util.umask)
950 950 ui.write(b"%c %s %10d %s%s\n" % (ent[0], mode, ent[2], timestr, file_))
951 951 for f in repo.dirstate.copies():
952 952 ui.write(_(b"copy: %s -> %s\n") % (repo.dirstate.copied(f), f))
953 953
954 954
955 955 @command(
956 956 b'debugdiscovery',
957 957 [
958 958 (b'', b'old', None, _(b'use old-style discovery')),
959 959 (
960 960 b'',
961 961 b'nonheads',
962 962 None,
963 963 _(b'use old-style discovery with non-heads included'),
964 964 ),
965 965 (b'', b'rev', [], b'restrict discovery to this set of revs'),
966 966 (b'', b'seed', b'12323', b'specify the random seed use for discovery'),
967 967 ]
968 968 + cmdutil.remoteopts,
969 969 _(b'[--rev REV] [OTHER]'),
970 970 )
971 971 def debugdiscovery(ui, repo, remoteurl=b"default", **opts):
972 972 """runs the changeset discovery protocol in isolation"""
973 973 opts = pycompat.byteskwargs(opts)
974 974 remoteurl, branches = hg.parseurl(ui.expandpath(remoteurl))
975 975 remote = hg.peer(repo, opts, remoteurl)
976 976 ui.status(_(b'comparing with %s\n') % util.hidepassword(remoteurl))
977 977
978 978 # make sure tests are repeatable
979 979 random.seed(int(opts[b'seed']))
980 980
981 981 data = {}
982 982 if opts.get(b'old'):
983 983
984 984 def doit(pushedrevs, remoteheads, remote=remote):
985 985 if not util.safehasattr(remote, b'branches'):
986 986 # enable in-client legacy support
987 987 remote = localrepo.locallegacypeer(remote.local())
988 988 common, _in, hds = treediscovery.findcommonincoming(
989 989 repo, remote, force=True, audit=data
990 990 )
991 991 common = set(common)
992 992 if not opts.get(b'nonheads'):
993 993 ui.writenoi18n(
994 994 b"unpruned common: %s\n"
995 995 % b" ".join(sorted(short(n) for n in common))
996 996 )
997 997
998 998 clnode = repo.changelog.node
999 999 common = repo.revs(b'heads(::%ln)', common)
1000 1000 common = {clnode(r) for r in common}
1001 1001 return common, hds
1002 1002
1003 1003 else:
1004 1004
1005 1005 def doit(pushedrevs, remoteheads, remote=remote):
1006 1006 nodes = None
1007 1007 if pushedrevs:
1008 1008 revs = scmutil.revrange(repo, pushedrevs)
1009 1009 nodes = [repo[r].node() for r in revs]
1010 1010 common, any, hds = setdiscovery.findcommonheads(
1011 1011 ui, repo, remote, ancestorsof=nodes, audit=data
1012 1012 )
1013 1013 return common, hds
1014 1014
1015 1015 remoterevs, _checkout = hg.addbranchrevs(repo, remote, branches, revs=None)
1016 1016 localrevs = opts[b'rev']
1017 1017 with util.timedcm('debug-discovery') as t:
1018 1018 common, hds = doit(localrevs, remoterevs)
1019 1019
1020 1020 # compute all statistics
1021 1021 heads_common = set(common)
1022 1022 heads_remote = set(hds)
1023 1023 heads_local = set(repo.heads())
1024 1024 # note: they cannot be a local or remote head that is in common and not
1025 1025 # itself a head of common.
1026 1026 heads_common_local = heads_common & heads_local
1027 1027 heads_common_remote = heads_common & heads_remote
1028 1028 heads_common_both = heads_common & heads_remote & heads_local
1029 1029
1030 1030 all = repo.revs(b'all()')
1031 1031 common = repo.revs(b'::%ln', common)
1032 1032 roots_common = repo.revs(b'roots(::%ld)', common)
1033 1033 missing = repo.revs(b'not ::%ld', common)
1034 1034 heads_missing = repo.revs(b'heads(%ld)', missing)
1035 1035 roots_missing = repo.revs(b'roots(%ld)', missing)
1036 1036 assert len(common) + len(missing) == len(all)
1037 1037
1038 1038 initial_undecided = repo.revs(
1039 1039 b'not (::%ln or %ln::)', heads_common_remote, heads_common_local
1040 1040 )
1041 1041 heads_initial_undecided = repo.revs(b'heads(%ld)', initial_undecided)
1042 1042 roots_initial_undecided = repo.revs(b'roots(%ld)', initial_undecided)
1043 1043 common_initial_undecided = initial_undecided & common
1044 1044 missing_initial_undecided = initial_undecided & missing
1045 1045
1046 1046 data[b'elapsed'] = t.elapsed
1047 1047 data[b'nb-common-heads'] = len(heads_common)
1048 1048 data[b'nb-common-heads-local'] = len(heads_common_local)
1049 1049 data[b'nb-common-heads-remote'] = len(heads_common_remote)
1050 1050 data[b'nb-common-heads-both'] = len(heads_common_both)
1051 1051 data[b'nb-common-roots'] = len(roots_common)
1052 1052 data[b'nb-head-local'] = len(heads_local)
1053 1053 data[b'nb-head-local-missing'] = len(heads_local) - len(heads_common_local)
1054 1054 data[b'nb-head-remote'] = len(heads_remote)
1055 1055 data[b'nb-head-remote-unknown'] = len(heads_remote) - len(
1056 1056 heads_common_remote
1057 1057 )
1058 1058 data[b'nb-revs'] = len(all)
1059 1059 data[b'nb-revs-common'] = len(common)
1060 1060 data[b'nb-revs-missing'] = len(missing)
1061 1061 data[b'nb-missing-heads'] = len(heads_missing)
1062 1062 data[b'nb-missing-roots'] = len(roots_missing)
1063 1063 data[b'nb-ini_und'] = len(initial_undecided)
1064 1064 data[b'nb-ini_und-heads'] = len(heads_initial_undecided)
1065 1065 data[b'nb-ini_und-roots'] = len(roots_initial_undecided)
1066 1066 data[b'nb-ini_und-common'] = len(common_initial_undecided)
1067 1067 data[b'nb-ini_und-missing'] = len(missing_initial_undecided)
1068 1068
1069 1069 # display discovery summary
1070 1070 ui.writenoi18n(b"elapsed time: %(elapsed)f seconds\n" % data)
1071 1071 ui.writenoi18n(b"round-trips: %(total-roundtrips)9d\n" % data)
1072 1072 ui.writenoi18n(b"heads summary:\n")
1073 1073 ui.writenoi18n(b" total common heads: %(nb-common-heads)9d\n" % data)
1074 1074 ui.writenoi18n(
1075 1075 b" also local heads: %(nb-common-heads-local)9d\n" % data
1076 1076 )
1077 1077 ui.writenoi18n(
1078 1078 b" also remote heads: %(nb-common-heads-remote)9d\n" % data
1079 1079 )
1080 1080 ui.writenoi18n(b" both: %(nb-common-heads-both)9d\n" % data)
1081 1081 ui.writenoi18n(b" local heads: %(nb-head-local)9d\n" % data)
1082 1082 ui.writenoi18n(
1083 1083 b" common: %(nb-common-heads-local)9d\n" % data
1084 1084 )
1085 1085 ui.writenoi18n(
1086 1086 b" missing: %(nb-head-local-missing)9d\n" % data
1087 1087 )
1088 1088 ui.writenoi18n(b" remote heads: %(nb-head-remote)9d\n" % data)
1089 1089 ui.writenoi18n(
1090 1090 b" common: %(nb-common-heads-remote)9d\n" % data
1091 1091 )
1092 1092 ui.writenoi18n(
1093 1093 b" unknown: %(nb-head-remote-unknown)9d\n" % data
1094 1094 )
1095 1095 ui.writenoi18n(b"local changesets: %(nb-revs)9d\n" % data)
1096 1096 ui.writenoi18n(b" common: %(nb-revs-common)9d\n" % data)
1097 1097 ui.writenoi18n(b" heads: %(nb-common-heads)9d\n" % data)
1098 1098 ui.writenoi18n(b" roots: %(nb-common-roots)9d\n" % data)
1099 1099 ui.writenoi18n(b" missing: %(nb-revs-missing)9d\n" % data)
1100 1100 ui.writenoi18n(b" heads: %(nb-missing-heads)9d\n" % data)
1101 1101 ui.writenoi18n(b" roots: %(nb-missing-roots)9d\n" % data)
1102 1102 ui.writenoi18n(b" first undecided set: %(nb-ini_und)9d\n" % data)
1103 1103 ui.writenoi18n(b" heads: %(nb-ini_und-heads)9d\n" % data)
1104 1104 ui.writenoi18n(b" roots: %(nb-ini_und-roots)9d\n" % data)
1105 1105 ui.writenoi18n(b" common: %(nb-ini_und-common)9d\n" % data)
1106 1106 ui.writenoi18n(b" missing: %(nb-ini_und-missing)9d\n" % data)
1107 1107
1108 1108 if ui.verbose:
1109 1109 ui.writenoi18n(
1110 1110 b"common heads: %s\n"
1111 1111 % b" ".join(sorted(short(n) for n in heads_common))
1112 1112 )
1113 1113
1114 1114
1115 1115 _chunksize = 4 << 10
1116 1116
1117 1117
1118 1118 @command(
1119 1119 b'debugdownload',
1120 1120 [
1121 1121 (b'o', b'output', b'', _(b'path')),
1122 1122 ],
1123 1123 optionalrepo=True,
1124 1124 )
1125 1125 def debugdownload(ui, repo, url, output=None, **opts):
1126 1126 """download a resource using Mercurial logic and config"""
1127 1127 fh = urlmod.open(ui, url, output)
1128 1128
1129 1129 dest = ui
1130 1130 if output:
1131 1131 dest = open(output, b"wb", _chunksize)
1132 1132 try:
1133 1133 data = fh.read(_chunksize)
1134 1134 while data:
1135 1135 dest.write(data)
1136 1136 data = fh.read(_chunksize)
1137 1137 finally:
1138 1138 if output:
1139 1139 dest.close()
1140 1140
1141 1141
1142 1142 @command(b'debugextensions', cmdutil.formatteropts, [], optionalrepo=True)
1143 1143 def debugextensions(ui, repo, **opts):
1144 1144 '''show information about active extensions'''
1145 1145 opts = pycompat.byteskwargs(opts)
1146 1146 exts = extensions.extensions(ui)
1147 1147 hgver = util.version()
1148 1148 fm = ui.formatter(b'debugextensions', opts)
1149 1149 for extname, extmod in sorted(exts, key=operator.itemgetter(0)):
1150 1150 isinternal = extensions.ismoduleinternal(extmod)
1151 1151 extsource = None
1152 1152
1153 1153 if util.safehasattr(extmod, '__file__'):
1154 1154 extsource = pycompat.fsencode(extmod.__file__)
1155 1155 elif getattr(sys, 'oxidized', False):
1156 1156 extsource = pycompat.sysexecutable
1157 1157 if isinternal:
1158 1158 exttestedwith = [] # never expose magic string to users
1159 1159 else:
1160 1160 exttestedwith = getattr(extmod, 'testedwith', b'').split()
1161 1161 extbuglink = getattr(extmod, 'buglink', None)
1162 1162
1163 1163 fm.startitem()
1164 1164
1165 1165 if ui.quiet or ui.verbose:
1166 1166 fm.write(b'name', b'%s\n', extname)
1167 1167 else:
1168 1168 fm.write(b'name', b'%s', extname)
1169 1169 if isinternal or hgver in exttestedwith:
1170 1170 fm.plain(b'\n')
1171 1171 elif not exttestedwith:
1172 1172 fm.plain(_(b' (untested!)\n'))
1173 1173 else:
1174 1174 lasttestedversion = exttestedwith[-1]
1175 1175 fm.plain(b' (%s!)\n' % lasttestedversion)
1176 1176
1177 1177 fm.condwrite(
1178 1178 ui.verbose and extsource,
1179 1179 b'source',
1180 1180 _(b' location: %s\n'),
1181 1181 extsource or b"",
1182 1182 )
1183 1183
1184 1184 if ui.verbose:
1185 1185 fm.plain(_(b' bundled: %s\n') % [b'no', b'yes'][isinternal])
1186 1186 fm.data(bundled=isinternal)
1187 1187
1188 1188 fm.condwrite(
1189 1189 ui.verbose and exttestedwith,
1190 1190 b'testedwith',
1191 1191 _(b' tested with: %s\n'),
1192 1192 fm.formatlist(exttestedwith, name=b'ver'),
1193 1193 )
1194 1194
1195 1195 fm.condwrite(
1196 1196 ui.verbose and extbuglink,
1197 1197 b'buglink',
1198 1198 _(b' bug reporting: %s\n'),
1199 1199 extbuglink or b"",
1200 1200 )
1201 1201
1202 1202 fm.end()
1203 1203
1204 1204
1205 1205 @command(
1206 1206 b'debugfileset',
1207 1207 [
1208 1208 (
1209 1209 b'r',
1210 1210 b'rev',
1211 1211 b'',
1212 1212 _(b'apply the filespec on this revision'),
1213 1213 _(b'REV'),
1214 1214 ),
1215 1215 (
1216 1216 b'',
1217 1217 b'all-files',
1218 1218 False,
1219 1219 _(b'test files from all revisions and working directory'),
1220 1220 ),
1221 1221 (
1222 1222 b's',
1223 1223 b'show-matcher',
1224 1224 None,
1225 1225 _(b'print internal representation of matcher'),
1226 1226 ),
1227 1227 (
1228 1228 b'p',
1229 1229 b'show-stage',
1230 1230 [],
1231 1231 _(b'print parsed tree at the given stage'),
1232 1232 _(b'NAME'),
1233 1233 ),
1234 1234 ],
1235 1235 _(b'[-r REV] [--all-files] [OPTION]... FILESPEC'),
1236 1236 )
1237 1237 def debugfileset(ui, repo, expr, **opts):
1238 1238 '''parse and apply a fileset specification'''
1239 1239 from . import fileset
1240 1240
1241 1241 fileset.symbols # force import of fileset so we have predicates to optimize
1242 1242 opts = pycompat.byteskwargs(opts)
1243 1243 ctx = scmutil.revsingle(repo, opts.get(b'rev'), None)
1244 1244
1245 1245 stages = [
1246 1246 (b'parsed', pycompat.identity),
1247 1247 (b'analyzed', filesetlang.analyze),
1248 1248 (b'optimized', filesetlang.optimize),
1249 1249 ]
1250 1250 stagenames = {n for n, f in stages}
1251 1251
1252 1252 showalways = set()
1253 1253 if ui.verbose and not opts[b'show_stage']:
1254 1254 # show parsed tree by --verbose (deprecated)
1255 1255 showalways.add(b'parsed')
1256 1256 if opts[b'show_stage'] == [b'all']:
1257 1257 showalways.update(stagenames)
1258 1258 else:
1259 1259 for n in opts[b'show_stage']:
1260 1260 if n not in stagenames:
1261 1261 raise error.Abort(_(b'invalid stage name: %s') % n)
1262 1262 showalways.update(opts[b'show_stage'])
1263 1263
1264 1264 tree = filesetlang.parse(expr)
1265 1265 for n, f in stages:
1266 1266 tree = f(tree)
1267 1267 if n in showalways:
1268 1268 if opts[b'show_stage'] or n != b'parsed':
1269 1269 ui.write(b"* %s:\n" % n)
1270 1270 ui.write(filesetlang.prettyformat(tree), b"\n")
1271 1271
1272 1272 files = set()
1273 1273 if opts[b'all_files']:
1274 1274 for r in repo:
1275 1275 c = repo[r]
1276 1276 files.update(c.files())
1277 1277 files.update(c.substate)
1278 1278 if opts[b'all_files'] or ctx.rev() is None:
1279 1279 wctx = repo[None]
1280 1280 files.update(
1281 1281 repo.dirstate.walk(
1282 1282 scmutil.matchall(repo),
1283 1283 subrepos=list(wctx.substate),
1284 1284 unknown=True,
1285 1285 ignored=True,
1286 1286 )
1287 1287 )
1288 1288 files.update(wctx.substate)
1289 1289 else:
1290 1290 files.update(ctx.files())
1291 1291 files.update(ctx.substate)
1292 1292
1293 1293 m = ctx.matchfileset(repo.getcwd(), expr)
1294 1294 if opts[b'show_matcher'] or (opts[b'show_matcher'] is None and ui.verbose):
1295 1295 ui.writenoi18n(b'* matcher:\n', stringutil.prettyrepr(m), b'\n')
1296 1296 for f in sorted(files):
1297 1297 if not m(f):
1298 1298 continue
1299 1299 ui.write(b"%s\n" % f)
1300 1300
1301 1301
1302 1302 @command(b'debugformat', [] + cmdutil.formatteropts)
1303 1303 def debugformat(ui, repo, **opts):
1304 1304 """display format information about the current repository
1305 1305
1306 1306 Use --verbose to get extra information about current config value and
1307 1307 Mercurial default."""
1308 1308 opts = pycompat.byteskwargs(opts)
1309 1309 maxvariantlength = max(len(fv.name) for fv in upgrade.allformatvariant)
1310 1310 maxvariantlength = max(len(b'format-variant'), maxvariantlength)
1311 1311
1312 1312 def makeformatname(name):
1313 1313 return b'%s:' + (b' ' * (maxvariantlength - len(name)))
1314 1314
1315 1315 fm = ui.formatter(b'debugformat', opts)
1316 1316 if fm.isplain():
1317 1317
1318 1318 def formatvalue(value):
1319 1319 if util.safehasattr(value, b'startswith'):
1320 1320 return value
1321 1321 if value:
1322 1322 return b'yes'
1323 1323 else:
1324 1324 return b'no'
1325 1325
1326 1326 else:
1327 1327 formatvalue = pycompat.identity
1328 1328
1329 1329 fm.plain(b'format-variant')
1330 1330 fm.plain(b' ' * (maxvariantlength - len(b'format-variant')))
1331 1331 fm.plain(b' repo')
1332 1332 if ui.verbose:
1333 1333 fm.plain(b' config default')
1334 1334 fm.plain(b'\n')
1335 1335 for fv in upgrade.allformatvariant:
1336 1336 fm.startitem()
1337 1337 repovalue = fv.fromrepo(repo)
1338 1338 configvalue = fv.fromconfig(repo)
1339 1339
1340 1340 if repovalue != configvalue:
1341 1341 namelabel = b'formatvariant.name.mismatchconfig'
1342 1342 repolabel = b'formatvariant.repo.mismatchconfig'
1343 1343 elif repovalue != fv.default:
1344 1344 namelabel = b'formatvariant.name.mismatchdefault'
1345 1345 repolabel = b'formatvariant.repo.mismatchdefault'
1346 1346 else:
1347 1347 namelabel = b'formatvariant.name.uptodate'
1348 1348 repolabel = b'formatvariant.repo.uptodate'
1349 1349
1350 1350 fm.write(b'name', makeformatname(fv.name), fv.name, label=namelabel)
1351 1351 fm.write(b'repo', b' %3s', formatvalue(repovalue), label=repolabel)
1352 1352 if fv.default != configvalue:
1353 1353 configlabel = b'formatvariant.config.special'
1354 1354 else:
1355 1355 configlabel = b'formatvariant.config.default'
1356 1356 fm.condwrite(
1357 1357 ui.verbose,
1358 1358 b'config',
1359 1359 b' %6s',
1360 1360 formatvalue(configvalue),
1361 1361 label=configlabel,
1362 1362 )
1363 1363 fm.condwrite(
1364 1364 ui.verbose,
1365 1365 b'default',
1366 1366 b' %7s',
1367 1367 formatvalue(fv.default),
1368 1368 label=b'formatvariant.default',
1369 1369 )
1370 1370 fm.plain(b'\n')
1371 1371 fm.end()
1372 1372
1373 1373
1374 1374 @command(b'debugfsinfo', [], _(b'[PATH]'), norepo=True)
1375 1375 def debugfsinfo(ui, path=b"."):
1376 1376 """show information detected about current filesystem"""
1377 1377 ui.writenoi18n(b'path: %s\n' % path)
1378 1378 ui.writenoi18n(
1379 1379 b'mounted on: %s\n' % (util.getfsmountpoint(path) or b'(unknown)')
1380 1380 )
1381 1381 ui.writenoi18n(b'exec: %s\n' % (util.checkexec(path) and b'yes' or b'no'))
1382 1382 ui.writenoi18n(b'fstype: %s\n' % (util.getfstype(path) or b'(unknown)'))
1383 1383 ui.writenoi18n(
1384 1384 b'symlink: %s\n' % (util.checklink(path) and b'yes' or b'no')
1385 1385 )
1386 1386 ui.writenoi18n(
1387 1387 b'hardlink: %s\n' % (util.checknlink(path) and b'yes' or b'no')
1388 1388 )
1389 1389 casesensitive = b'(unknown)'
1390 1390 try:
1391 1391 with pycompat.namedtempfile(prefix=b'.debugfsinfo', dir=path) as f:
1392 1392 casesensitive = util.fscasesensitive(f.name) and b'yes' or b'no'
1393 1393 except OSError:
1394 1394 pass
1395 1395 ui.writenoi18n(b'case-sensitive: %s\n' % casesensitive)
1396 1396
1397 1397
1398 1398 @command(
1399 1399 b'debuggetbundle',
1400 1400 [
1401 1401 (b'H', b'head', [], _(b'id of head node'), _(b'ID')),
1402 1402 (b'C', b'common', [], _(b'id of common node'), _(b'ID')),
1403 1403 (
1404 1404 b't',
1405 1405 b'type',
1406 1406 b'bzip2',
1407 1407 _(b'bundle compression type to use'),
1408 1408 _(b'TYPE'),
1409 1409 ),
1410 1410 ],
1411 1411 _(b'REPO FILE [-H|-C ID]...'),
1412 1412 norepo=True,
1413 1413 )
1414 1414 def debuggetbundle(ui, repopath, bundlepath, head=None, common=None, **opts):
1415 1415 """retrieves a bundle from a repo
1416 1416
1417 1417 Every ID must be a full-length hex node id string. Saves the bundle to the
1418 1418 given file.
1419 1419 """
1420 1420 opts = pycompat.byteskwargs(opts)
1421 1421 repo = hg.peer(ui, opts, repopath)
1422 1422 if not repo.capable(b'getbundle'):
1423 1423 raise error.Abort(b"getbundle() not supported by target repository")
1424 1424 args = {}
1425 1425 if common:
1426 1426 args['common'] = [bin(s) for s in common]
1427 1427 if head:
1428 1428 args['heads'] = [bin(s) for s in head]
1429 1429 # TODO: get desired bundlecaps from command line.
1430 1430 args['bundlecaps'] = None
1431 1431 bundle = repo.getbundle(b'debug', **args)
1432 1432
1433 1433 bundletype = opts.get(b'type', b'bzip2').lower()
1434 1434 btypes = {
1435 1435 b'none': b'HG10UN',
1436 1436 b'bzip2': b'HG10BZ',
1437 1437 b'gzip': b'HG10GZ',
1438 1438 b'bundle2': b'HG20',
1439 1439 }
1440 1440 bundletype = btypes.get(bundletype)
1441 1441 if bundletype not in bundle2.bundletypes:
1442 1442 raise error.Abort(_(b'unknown bundle type specified with --type'))
1443 1443 bundle2.writebundle(ui, bundle, bundlepath, bundletype)
1444 1444
1445 1445
1446 1446 @command(b'debugignore', [], b'[FILE]')
1447 1447 def debugignore(ui, repo, *files, **opts):
1448 1448 """display the combined ignore pattern and information about ignored files
1449 1449
1450 1450 With no argument display the combined ignore pattern.
1451 1451
1452 1452 Given space separated file names, shows if the given file is ignored and
1453 1453 if so, show the ignore rule (file and line number) that matched it.
1454 1454 """
1455 1455 ignore = repo.dirstate._ignore
1456 1456 if not files:
1457 1457 # Show all the patterns
1458 1458 ui.write(b"%s\n" % pycompat.byterepr(ignore))
1459 1459 else:
1460 1460 m = scmutil.match(repo[None], pats=files)
1461 1461 uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
1462 1462 for f in m.files():
1463 1463 nf = util.normpath(f)
1464 1464 ignored = None
1465 1465 ignoredata = None
1466 1466 if nf != b'.':
1467 1467 if ignore(nf):
1468 1468 ignored = nf
1469 1469 ignoredata = repo.dirstate._ignorefileandline(nf)
1470 1470 else:
1471 1471 for p in pathutil.finddirs(nf):
1472 1472 if ignore(p):
1473 1473 ignored = p
1474 1474 ignoredata = repo.dirstate._ignorefileandline(p)
1475 1475 break
1476 1476 if ignored:
1477 1477 if ignored == nf:
1478 1478 ui.write(_(b"%s is ignored\n") % uipathfn(f))
1479 1479 else:
1480 1480 ui.write(
1481 1481 _(
1482 1482 b"%s is ignored because of "
1483 1483 b"containing directory %s\n"
1484 1484 )
1485 1485 % (uipathfn(f), ignored)
1486 1486 )
1487 1487 ignorefile, lineno, line = ignoredata
1488 1488 ui.write(
1489 1489 _(b"(ignore rule in %s, line %d: '%s')\n")
1490 1490 % (ignorefile, lineno, line)
1491 1491 )
1492 1492 else:
1493 1493 ui.write(_(b"%s is not ignored\n") % uipathfn(f))
1494 1494
1495 1495
1496 1496 @command(
1497 1497 b'debugindex',
1498 1498 cmdutil.debugrevlogopts + cmdutil.formatteropts,
1499 1499 _(b'-c|-m|FILE'),
1500 1500 )
1501 1501 def debugindex(ui, repo, file_=None, **opts):
1502 1502 """dump index data for a storage primitive"""
1503 1503 opts = pycompat.byteskwargs(opts)
1504 1504 store = cmdutil.openstorage(repo, b'debugindex', file_, opts)
1505 1505
1506 1506 if ui.debugflag:
1507 1507 shortfn = hex
1508 1508 else:
1509 1509 shortfn = short
1510 1510
1511 1511 idlen = 12
1512 1512 for i in store:
1513 1513 idlen = len(shortfn(store.node(i)))
1514 1514 break
1515 1515
1516 1516 fm = ui.formatter(b'debugindex', opts)
1517 1517 fm.plain(
1518 1518 b' rev linkrev %s %s p2\n'
1519 1519 % (b'nodeid'.ljust(idlen), b'p1'.ljust(idlen))
1520 1520 )
1521 1521
1522 1522 for rev in store:
1523 1523 node = store.node(rev)
1524 1524 parents = store.parents(node)
1525 1525
1526 1526 fm.startitem()
1527 1527 fm.write(b'rev', b'%6d ', rev)
1528 1528 fm.write(b'linkrev', b'%7d ', store.linkrev(rev))
1529 1529 fm.write(b'node', b'%s ', shortfn(node))
1530 1530 fm.write(b'p1', b'%s ', shortfn(parents[0]))
1531 1531 fm.write(b'p2', b'%s', shortfn(parents[1]))
1532 1532 fm.plain(b'\n')
1533 1533
1534 1534 fm.end()
1535 1535
1536 1536
1537 1537 @command(
1538 1538 b'debugindexdot',
1539 1539 cmdutil.debugrevlogopts,
1540 1540 _(b'-c|-m|FILE'),
1541 1541 optionalrepo=True,
1542 1542 )
1543 1543 def debugindexdot(ui, repo, file_=None, **opts):
1544 1544 """dump an index DAG as a graphviz dot file"""
1545 1545 opts = pycompat.byteskwargs(opts)
1546 1546 r = cmdutil.openstorage(repo, b'debugindexdot', file_, opts)
1547 1547 ui.writenoi18n(b"digraph G {\n")
1548 1548 for i in r:
1549 1549 node = r.node(i)
1550 1550 pp = r.parents(node)
1551 1551 ui.write(b"\t%d -> %d\n" % (r.rev(pp[0]), i))
1552 1552 if pp[1] != nullid:
1553 1553 ui.write(b"\t%d -> %d\n" % (r.rev(pp[1]), i))
1554 1554 ui.write(b"}\n")
1555 1555
1556 1556
1557 1557 @command(b'debugindexstats', [])
1558 1558 def debugindexstats(ui, repo):
1559 1559 """show stats related to the changelog index"""
1560 1560 repo.changelog.shortest(nullid, 1)
1561 1561 index = repo.changelog.index
1562 1562 if not util.safehasattr(index, b'stats'):
1563 1563 raise error.Abort(_(b'debugindexstats only works with native code'))
1564 1564 for k, v in sorted(index.stats().items()):
1565 1565 ui.write(b'%s: %d\n' % (k, v))
1566 1566
1567 1567
1568 1568 @command(b'debuginstall', [] + cmdutil.formatteropts, b'', norepo=True)
1569 1569 def debuginstall(ui, **opts):
1570 1570 """test Mercurial installation
1571 1571
1572 1572 Returns 0 on success.
1573 1573 """
1574 1574 opts = pycompat.byteskwargs(opts)
1575 1575
1576 1576 problems = 0
1577 1577
1578 1578 fm = ui.formatter(b'debuginstall', opts)
1579 1579 fm.startitem()
1580 1580
1581 1581 # encoding might be unknown or wrong. don't translate these messages.
1582 1582 fm.write(b'encoding', b"checking encoding (%s)...\n", encoding.encoding)
1583 1583 err = None
1584 1584 try:
1585 1585 codecs.lookup(pycompat.sysstr(encoding.encoding))
1586 1586 except LookupError as inst:
1587 1587 err = stringutil.forcebytestr(inst)
1588 1588 problems += 1
1589 1589 fm.condwrite(
1590 1590 err,
1591 1591 b'encodingerror',
1592 1592 b" %s\n (check that your locale is properly set)\n",
1593 1593 err,
1594 1594 )
1595 1595
1596 1596 # Python
1597 1597 pythonlib = None
1598 1598 if util.safehasattr(os, '__file__'):
1599 1599 pythonlib = os.path.dirname(pycompat.fsencode(os.__file__))
1600 1600 elif getattr(sys, 'oxidized', False):
1601 1601 pythonlib = pycompat.sysexecutable
1602 1602
1603 1603 fm.write(
1604 1604 b'pythonexe',
1605 1605 _(b"checking Python executable (%s)\n"),
1606 1606 pycompat.sysexecutable or _(b"unknown"),
1607 1607 )
1608 1608 fm.write(
1609 1609 b'pythonimplementation',
1610 1610 _(b"checking Python implementation (%s)\n"),
1611 1611 pycompat.sysbytes(platform.python_implementation()),
1612 1612 )
1613 1613 fm.write(
1614 1614 b'pythonver',
1615 1615 _(b"checking Python version (%s)\n"),
1616 1616 (b"%d.%d.%d" % sys.version_info[:3]),
1617 1617 )
1618 1618 fm.write(
1619 1619 b'pythonlib',
1620 1620 _(b"checking Python lib (%s)...\n"),
1621 1621 pythonlib or _(b"unknown"),
1622 1622 )
1623 1623
1624 1624 try:
1625 1625 from . import rustext
1626 1626
1627 1627 rustext.__doc__ # trigger lazy import
1628 1628 except ImportError:
1629 1629 rustext = None
1630 1630
1631 1631 security = set(sslutil.supportedprotocols)
1632 1632 if sslutil.hassni:
1633 1633 security.add(b'sni')
1634 1634
1635 1635 fm.write(
1636 1636 b'pythonsecurity',
1637 1637 _(b"checking Python security support (%s)\n"),
1638 1638 fm.formatlist(sorted(security), name=b'protocol', fmt=b'%s', sep=b','),
1639 1639 )
1640 1640
1641 1641 # These are warnings, not errors. So don't increment problem count. This
1642 1642 # may change in the future.
1643 1643 if b'tls1.2' not in security:
1644 1644 fm.plain(
1645 1645 _(
1646 1646 b' TLS 1.2 not supported by Python install; '
1647 1647 b'network connections lack modern security\n'
1648 1648 )
1649 1649 )
1650 1650 if b'sni' not in security:
1651 1651 fm.plain(
1652 1652 _(
1653 1653 b' SNI not supported by Python install; may have '
1654 1654 b'connectivity issues with some servers\n'
1655 1655 )
1656 1656 )
1657 1657
1658 1658 fm.plain(
1659 1659 _(
1660 1660 b"checking Rust extensions (%s)\n"
1661 1661 % (b'missing' if rustext is None else b'installed')
1662 1662 ),
1663 1663 )
1664 1664
1665 1665 # TODO print CA cert info
1666 1666
1667 1667 # hg version
1668 1668 hgver = util.version()
1669 1669 fm.write(
1670 1670 b'hgver', _(b"checking Mercurial version (%s)\n"), hgver.split(b'+')[0]
1671 1671 )
1672 1672 fm.write(
1673 1673 b'hgverextra',
1674 1674 _(b"checking Mercurial custom build (%s)\n"),
1675 1675 b'+'.join(hgver.split(b'+')[1:]),
1676 1676 )
1677 1677
1678 1678 # compiled modules
1679 1679 hgmodules = None
1680 1680 if util.safehasattr(sys.modules[__name__], '__file__'):
1681 1681 hgmodules = os.path.dirname(pycompat.fsencode(__file__))
1682 1682 elif getattr(sys, 'oxidized', False):
1683 1683 hgmodules = pycompat.sysexecutable
1684 1684
1685 1685 fm.write(
1686 1686 b'hgmodulepolicy', _(b"checking module policy (%s)\n"), policy.policy
1687 1687 )
1688 1688 fm.write(
1689 1689 b'hgmodules',
1690 1690 _(b"checking installed modules (%s)...\n"),
1691 1691 hgmodules or _(b"unknown"),
1692 1692 )
1693 1693
1694 1694 rustandc = policy.policy in (b'rust+c', b'rust+c-allow')
1695 1695 rustext = rustandc # for now, that's the only case
1696 1696 cext = policy.policy in (b'c', b'allow') or rustandc
1697 1697 nopure = cext or rustext
1698 1698 if nopure:
1699 1699 err = None
1700 1700 try:
1701 1701 if cext:
1702 1702 from .cext import ( # pytype: disable=import-error
1703 1703 base85,
1704 1704 bdiff,
1705 1705 mpatch,
1706 1706 osutil,
1707 1707 )
1708 1708
1709 1709 # quiet pyflakes
1710 1710 dir(bdiff), dir(mpatch), dir(base85), dir(osutil)
1711 1711 if rustext:
1712 1712 from .rustext import ( # pytype: disable=import-error
1713 1713 ancestor,
1714 1714 dirstate,
1715 1715 )
1716 1716
1717 1717 dir(ancestor), dir(dirstate) # quiet pyflakes
1718 1718 except Exception as inst:
1719 1719 err = stringutil.forcebytestr(inst)
1720 1720 problems += 1
1721 1721 fm.condwrite(err, b'extensionserror', b" %s\n", err)
1722 1722
1723 1723 compengines = util.compengines._engines.values()
1724 1724 fm.write(
1725 1725 b'compengines',
1726 1726 _(b'checking registered compression engines (%s)\n'),
1727 1727 fm.formatlist(
1728 1728 sorted(e.name() for e in compengines),
1729 1729 name=b'compengine',
1730 1730 fmt=b'%s',
1731 1731 sep=b', ',
1732 1732 ),
1733 1733 )
1734 1734 fm.write(
1735 1735 b'compenginesavail',
1736 1736 _(b'checking available compression engines (%s)\n'),
1737 1737 fm.formatlist(
1738 1738 sorted(e.name() for e in compengines if e.available()),
1739 1739 name=b'compengine',
1740 1740 fmt=b'%s',
1741 1741 sep=b', ',
1742 1742 ),
1743 1743 )
1744 1744 wirecompengines = compression.compengines.supportedwireengines(
1745 1745 compression.SERVERROLE
1746 1746 )
1747 1747 fm.write(
1748 1748 b'compenginesserver',
1749 1749 _(
1750 1750 b'checking available compression engines '
1751 1751 b'for wire protocol (%s)\n'
1752 1752 ),
1753 1753 fm.formatlist(
1754 1754 [e.name() for e in wirecompengines if e.wireprotosupport()],
1755 1755 name=b'compengine',
1756 1756 fmt=b'%s',
1757 1757 sep=b', ',
1758 1758 ),
1759 1759 )
1760 1760 re2 = b'missing'
1761 1761 if util._re2:
1762 1762 re2 = b'available'
1763 1763 fm.plain(_(b'checking "re2" regexp engine (%s)\n') % re2)
1764 1764 fm.data(re2=bool(util._re2))
1765 1765
1766 1766 # templates
1767 1767 p = templater.templatedir()
1768 1768 fm.write(b'templatedirs', b'checking templates (%s)...\n', p or b'')
1769 1769 fm.condwrite(not p, b'', _(b" no template directories found\n"))
1770 1770 if p:
1771 1771 (m, fp) = templater.try_open_template(b"map-cmdline.default")
1772 1772 if m:
1773 1773 # template found, check if it is working
1774 1774 err = None
1775 1775 try:
1776 1776 templater.templater.frommapfile(m)
1777 1777 except Exception as inst:
1778 1778 err = stringutil.forcebytestr(inst)
1779 1779 p = None
1780 1780 fm.condwrite(err, b'defaulttemplateerror', b" %s\n", err)
1781 1781 else:
1782 1782 p = None
1783 1783 fm.condwrite(
1784 1784 p, b'defaulttemplate', _(b"checking default template (%s)\n"), m
1785 1785 )
1786 1786 fm.condwrite(
1787 1787 not m,
1788 1788 b'defaulttemplatenotfound',
1789 1789 _(b" template '%s' not found\n"),
1790 1790 b"default",
1791 1791 )
1792 1792 if not p:
1793 1793 problems += 1
1794 1794 fm.condwrite(
1795 1795 not p, b'', _(b" (templates seem to have been installed incorrectly)\n")
1796 1796 )
1797 1797
1798 1798 # editor
1799 1799 editor = ui.geteditor()
1800 1800 editor = util.expandpath(editor)
1801 1801 editorbin = procutil.shellsplit(editor)[0]
1802 1802 fm.write(b'editor', _(b"checking commit editor... (%s)\n"), editorbin)
1803 1803 cmdpath = procutil.findexe(editorbin)
1804 1804 fm.condwrite(
1805 1805 not cmdpath and editor == b'vi',
1806 1806 b'vinotfound',
1807 1807 _(
1808 1808 b" No commit editor set and can't find %s in PATH\n"
1809 1809 b" (specify a commit editor in your configuration"
1810 1810 b" file)\n"
1811 1811 ),
1812 1812 not cmdpath and editor == b'vi' and editorbin,
1813 1813 )
1814 1814 fm.condwrite(
1815 1815 not cmdpath and editor != b'vi',
1816 1816 b'editornotfound',
1817 1817 _(
1818 1818 b" Can't find editor '%s' in PATH\n"
1819 1819 b" (specify a commit editor in your configuration"
1820 1820 b" file)\n"
1821 1821 ),
1822 1822 not cmdpath and editorbin,
1823 1823 )
1824 1824 if not cmdpath and editor != b'vi':
1825 1825 problems += 1
1826 1826
1827 1827 # check username
1828 1828 username = None
1829 1829 err = None
1830 1830 try:
1831 1831 username = ui.username()
1832 1832 except error.Abort as e:
1833 1833 err = e.message
1834 1834 problems += 1
1835 1835
1836 1836 fm.condwrite(
1837 1837 username, b'username', _(b"checking username (%s)\n"), username
1838 1838 )
1839 1839 fm.condwrite(
1840 1840 err,
1841 1841 b'usernameerror',
1842 1842 _(
1843 1843 b"checking username...\n %s\n"
1844 1844 b" (specify a username in your configuration file)\n"
1845 1845 ),
1846 1846 err,
1847 1847 )
1848 1848
1849 1849 for name, mod in extensions.extensions():
1850 1850 handler = getattr(mod, 'debuginstall', None)
1851 1851 if handler is not None:
1852 1852 problems += handler(ui, fm)
1853 1853
1854 1854 fm.condwrite(not problems, b'', _(b"no problems detected\n"))
1855 1855 if not problems:
1856 1856 fm.data(problems=problems)
1857 1857 fm.condwrite(
1858 1858 problems,
1859 1859 b'problems',
1860 1860 _(b"%d problems detected, please check your install!\n"),
1861 1861 problems,
1862 1862 )
1863 1863 fm.end()
1864 1864
1865 1865 return problems
1866 1866
1867 1867
1868 1868 @command(b'debugknown', [], _(b'REPO ID...'), norepo=True)
1869 1869 def debugknown(ui, repopath, *ids, **opts):
1870 1870 """test whether node ids are known to a repo
1871 1871
1872 1872 Every ID must be a full-length hex node id string. Returns a list of 0s
1873 1873 and 1s indicating unknown/known.
1874 1874 """
1875 1875 opts = pycompat.byteskwargs(opts)
1876 1876 repo = hg.peer(ui, opts, repopath)
1877 1877 if not repo.capable(b'known'):
1878 1878 raise error.Abort(b"known() not supported by target repository")
1879 1879 flags = repo.known([bin(s) for s in ids])
1880 1880 ui.write(b"%s\n" % (b"".join([f and b"1" or b"0" for f in flags])))
1881 1881
1882 1882
1883 1883 @command(b'debuglabelcomplete', [], _(b'LABEL...'))
1884 1884 def debuglabelcomplete(ui, repo, *args):
1885 1885 '''backwards compatibility with old bash completion scripts (DEPRECATED)'''
1886 1886 debugnamecomplete(ui, repo, *args)
1887 1887
1888 1888
1889 1889 @command(
1890 1890 b'debuglocks',
1891 1891 [
1892 1892 (b'L', b'force-free-lock', None, _(b'free the store lock (DANGEROUS)')),
1893 1893 (
1894 1894 b'W',
1895 1895 b'force-free-wlock',
1896 1896 None,
1897 1897 _(b'free the working state lock (DANGEROUS)'),
1898 1898 ),
1899 1899 (b's', b'set-lock', None, _(b'set the store lock until stopped')),
1900 1900 (
1901 1901 b'S',
1902 1902 b'set-wlock',
1903 1903 None,
1904 1904 _(b'set the working state lock until stopped'),
1905 1905 ),
1906 1906 ],
1907 1907 _(b'[OPTION]...'),
1908 1908 )
1909 1909 def debuglocks(ui, repo, **opts):
1910 1910 """show or modify state of locks
1911 1911
1912 1912 By default, this command will show which locks are held. This
1913 1913 includes the user and process holding the lock, the amount of time
1914 1914 the lock has been held, and the machine name where the process is
1915 1915 running if it's not local.
1916 1916
1917 1917 Locks protect the integrity of Mercurial's data, so should be
1918 1918 treated with care. System crashes or other interruptions may cause
1919 1919 locks to not be properly released, though Mercurial will usually
1920 1920 detect and remove such stale locks automatically.
1921 1921
1922 1922 However, detecting stale locks may not always be possible (for
1923 1923 instance, on a shared filesystem). Removing locks may also be
1924 1924 blocked by filesystem permissions.
1925 1925
1926 1926 Setting a lock will prevent other commands from changing the data.
1927 1927 The command will wait until an interruption (SIGINT, SIGTERM, ...) occurs.
1928 1928 The set locks are removed when the command exits.
1929 1929
1930 1930 Returns 0 if no locks are held.
1931 1931
1932 1932 """
1933 1933
1934 1934 if opts.get('force_free_lock'):
1935 1935 repo.svfs.unlink(b'lock')
1936 1936 if opts.get('force_free_wlock'):
1937 1937 repo.vfs.unlink(b'wlock')
1938 1938 if opts.get('force_free_lock') or opts.get('force_free_wlock'):
1939 1939 return 0
1940 1940
1941 1941 locks = []
1942 1942 try:
1943 1943 if opts.get('set_wlock'):
1944 1944 try:
1945 1945 locks.append(repo.wlock(False))
1946 1946 except error.LockHeld:
1947 1947 raise error.Abort(_(b'wlock is already held'))
1948 1948 if opts.get('set_lock'):
1949 1949 try:
1950 1950 locks.append(repo.lock(False))
1951 1951 except error.LockHeld:
1952 1952 raise error.Abort(_(b'lock is already held'))
1953 1953 if len(locks):
1954 1954 ui.promptchoice(_(b"ready to release the lock (y)? $$ &Yes"))
1955 1955 return 0
1956 1956 finally:
1957 1957 release(*locks)
1958 1958
1959 1959 now = time.time()
1960 1960 held = 0
1961 1961
1962 1962 def report(vfs, name, method):
1963 1963 # this causes stale locks to get reaped for more accurate reporting
1964 1964 try:
1965 1965 l = method(False)
1966 1966 except error.LockHeld:
1967 1967 l = None
1968 1968
1969 1969 if l:
1970 1970 l.release()
1971 1971 else:
1972 1972 try:
1973 1973 st = vfs.lstat(name)
1974 1974 age = now - st[stat.ST_MTIME]
1975 1975 user = util.username(st.st_uid)
1976 1976 locker = vfs.readlock(name)
1977 1977 if b":" in locker:
1978 1978 host, pid = locker.split(b':')
1979 1979 if host == socket.gethostname():
1980 1980 locker = b'user %s, process %s' % (user or b'None', pid)
1981 1981 else:
1982 1982 locker = b'user %s, process %s, host %s' % (
1983 1983 user or b'None',
1984 1984 pid,
1985 1985 host,
1986 1986 )
1987 1987 ui.writenoi18n(b"%-6s %s (%ds)\n" % (name + b":", locker, age))
1988 1988 return 1
1989 1989 except OSError as e:
1990 1990 if e.errno != errno.ENOENT:
1991 1991 raise
1992 1992
1993 1993 ui.writenoi18n(b"%-6s free\n" % (name + b":"))
1994 1994 return 0
1995 1995
1996 1996 held += report(repo.svfs, b"lock", repo.lock)
1997 1997 held += report(repo.vfs, b"wlock", repo.wlock)
1998 1998
1999 1999 return held
2000 2000
2001 2001
2002 2002 @command(
2003 2003 b'debugmanifestfulltextcache',
2004 2004 [
2005 2005 (b'', b'clear', False, _(b'clear the cache')),
2006 2006 (
2007 2007 b'a',
2008 2008 b'add',
2009 2009 [],
2010 2010 _(b'add the given manifest nodes to the cache'),
2011 2011 _(b'NODE'),
2012 2012 ),
2013 2013 ],
2014 2014 b'',
2015 2015 )
2016 2016 def debugmanifestfulltextcache(ui, repo, add=(), **opts):
2017 2017 """show, clear or amend the contents of the manifest fulltext cache"""
2018 2018
2019 2019 def getcache():
2020 2020 r = repo.manifestlog.getstorage(b'')
2021 2021 try:
2022 2022 return r._fulltextcache
2023 2023 except AttributeError:
2024 2024 msg = _(
2025 2025 b"Current revlog implementation doesn't appear to have a "
2026 2026 b"manifest fulltext cache\n"
2027 2027 )
2028 2028 raise error.Abort(msg)
2029 2029
2030 2030 if opts.get('clear'):
2031 2031 with repo.wlock():
2032 2032 cache = getcache()
2033 2033 cache.clear(clear_persisted_data=True)
2034 2034 return
2035 2035
2036 2036 if add:
2037 2037 with repo.wlock():
2038 2038 m = repo.manifestlog
2039 2039 store = m.getstorage(b'')
2040 2040 for n in add:
2041 2041 try:
2042 2042 manifest = m[store.lookup(n)]
2043 2043 except error.LookupError as e:
2044 2044 raise error.Abort(e, hint=b"Check your manifest node id")
2045 2045 manifest.read() # stores revisision in cache too
2046 2046 return
2047 2047
2048 2048 cache = getcache()
2049 2049 if not len(cache):
2050 2050 ui.write(_(b'cache empty\n'))
2051 2051 else:
2052 2052 ui.write(
2053 2053 _(
2054 2054 b'cache contains %d manifest entries, in order of most to '
2055 2055 b'least recent:\n'
2056 2056 )
2057 2057 % (len(cache),)
2058 2058 )
2059 2059 totalsize = 0
2060 2060 for nodeid in cache:
2061 2061 # Use cache.get to not update the LRU order
2062 2062 data = cache.peek(nodeid)
2063 2063 size = len(data)
2064 2064 totalsize += size + 24 # 20 bytes nodeid, 4 bytes size
2065 2065 ui.write(
2066 2066 _(b'id: %s, size %s\n') % (hex(nodeid), util.bytecount(size))
2067 2067 )
2068 2068 ondisk = cache._opener.stat(b'manifestfulltextcache').st_size
2069 2069 ui.write(
2070 2070 _(b'total cache data size %s, on-disk %s\n')
2071 2071 % (util.bytecount(totalsize), util.bytecount(ondisk))
2072 2072 )
2073 2073
2074 2074
2075 2075 @command(b'debugmergestate', [] + cmdutil.templateopts, b'')
2076 2076 def debugmergestate(ui, repo, *args, **opts):
2077 2077 """print merge state
2078 2078
2079 2079 Use --verbose to print out information about whether v1 or v2 merge state
2080 2080 was chosen."""
2081 2081
2082 2082 if ui.verbose:
2083 2083 ms = mergestatemod.mergestate(repo)
2084 2084
2085 2085 # sort so that reasonable information is on top
2086 2086 v1records = ms._readrecordsv1()
2087 2087 v2records = ms._readrecordsv2()
2088 2088
2089 2089 if not v1records and not v2records:
2090 2090 pass
2091 2091 elif not v2records:
2092 2092 ui.writenoi18n(b'no version 2 merge state\n')
2093 2093 elif ms._v1v2match(v1records, v2records):
2094 2094 ui.writenoi18n(b'v1 and v2 states match: using v2\n')
2095 2095 else:
2096 2096 ui.writenoi18n(b'v1 and v2 states mismatch: using v1\n')
2097 2097
2098 2098 opts = pycompat.byteskwargs(opts)
2099 2099 if not opts[b'template']:
2100 2100 opts[b'template'] = (
2101 2101 b'{if(commits, "", "no merge state found\n")}'
2102 2102 b'{commits % "{name}{if(label, " ({label})")}: {node}\n"}'
2103 2103 b'{files % "file: {path} (state \\"{state}\\")\n'
2104 2104 b'{if(local_path, "'
2105 2105 b' local path: {local_path} (hash {local_key}, flags \\"{local_flags}\\")\n'
2106 2106 b' ancestor path: {ancestor_path} (node {ancestor_node})\n'
2107 2107 b' other path: {other_path} (node {other_node})\n'
2108 2108 b'")}'
2109 2109 b'{if(rename_side, "'
2110 2110 b' rename side: {rename_side}\n'
2111 2111 b' renamed path: {renamed_path}\n'
2112 2112 b'")}'
2113 2113 b'{extras % " extra: {key} = {value}\n"}'
2114 2114 b'"}'
2115 2115 b'{extras % "extra: {file} ({key} = {value})\n"}'
2116 2116 )
2117 2117
2118 2118 ms = mergestatemod.mergestate.read(repo)
2119 2119
2120 2120 fm = ui.formatter(b'debugmergestate', opts)
2121 2121 fm.startitem()
2122 2122
2123 2123 fm_commits = fm.nested(b'commits')
2124 2124 if ms.active():
2125 2125 for name, node, label_index in (
2126 2126 (b'local', ms.local, 0),
2127 2127 (b'other', ms.other, 1),
2128 2128 ):
2129 2129 fm_commits.startitem()
2130 2130 fm_commits.data(name=name)
2131 2131 fm_commits.data(node=hex(node))
2132 2132 if ms._labels and len(ms._labels) > label_index:
2133 2133 fm_commits.data(label=ms._labels[label_index])
2134 2134 fm_commits.end()
2135 2135
2136 2136 fm_files = fm.nested(b'files')
2137 2137 if ms.active():
2138 2138 for f in ms:
2139 2139 fm_files.startitem()
2140 2140 fm_files.data(path=f)
2141 2141 state = ms._state[f]
2142 2142 fm_files.data(state=state[0])
2143 2143 if state[0] in (
2144 2144 mergestatemod.MERGE_RECORD_UNRESOLVED,
2145 2145 mergestatemod.MERGE_RECORD_RESOLVED,
2146 2146 ):
2147 2147 fm_files.data(local_key=state[1])
2148 2148 fm_files.data(local_path=state[2])
2149 2149 fm_files.data(ancestor_path=state[3])
2150 2150 fm_files.data(ancestor_node=state[4])
2151 2151 fm_files.data(other_path=state[5])
2152 2152 fm_files.data(other_node=state[6])
2153 2153 fm_files.data(local_flags=state[7])
2154 2154 elif state[0] in (
2155 2155 mergestatemod.MERGE_RECORD_UNRESOLVED_PATH,
2156 2156 mergestatemod.MERGE_RECORD_RESOLVED_PATH,
2157 2157 ):
2158 2158 fm_files.data(renamed_path=state[1])
2159 2159 fm_files.data(rename_side=state[2])
2160 2160 fm_extras = fm_files.nested(b'extras')
2161 2161 for k, v in sorted(ms.extras(f).items()):
2162 2162 fm_extras.startitem()
2163 2163 fm_extras.data(key=k)
2164 2164 fm_extras.data(value=v)
2165 2165 fm_extras.end()
2166 2166
2167 2167 fm_files.end()
2168 2168
2169 2169 fm_extras = fm.nested(b'extras')
2170 2170 for f, d in sorted(pycompat.iteritems(ms.allextras())):
2171 2171 if f in ms:
2172 2172 # If file is in mergestate, we have already processed it's extras
2173 2173 continue
2174 2174 for k, v in pycompat.iteritems(d):
2175 2175 fm_extras.startitem()
2176 2176 fm_extras.data(file=f)
2177 2177 fm_extras.data(key=k)
2178 2178 fm_extras.data(value=v)
2179 2179 fm_extras.end()
2180 2180
2181 2181 fm.end()
2182 2182
2183 2183
2184 2184 @command(b'debugnamecomplete', [], _(b'NAME...'))
2185 2185 def debugnamecomplete(ui, repo, *args):
2186 2186 '''complete "names" - tags, open branch names, bookmark names'''
2187 2187
2188 2188 names = set()
2189 2189 # since we previously only listed open branches, we will handle that
2190 2190 # specially (after this for loop)
2191 2191 for name, ns in pycompat.iteritems(repo.names):
2192 2192 if name != b'branches':
2193 2193 names.update(ns.listnames(repo))
2194 2194 names.update(
2195 2195 tag
2196 2196 for (tag, heads, tip, closed) in repo.branchmap().iterbranches()
2197 2197 if not closed
2198 2198 )
2199 2199 completions = set()
2200 2200 if not args:
2201 2201 args = [b'']
2202 2202 for a in args:
2203 2203 completions.update(n for n in names if n.startswith(a))
2204 2204 ui.write(b'\n'.join(sorted(completions)))
2205 2205 ui.write(b'\n')
2206 2206
2207 2207
2208 2208 @command(
2209 2209 b'debugnodemap',
2210 2210 [
2211 2211 (
2212 2212 b'',
2213 2213 b'dump-new',
2214 2214 False,
2215 2215 _(b'write a (new) persistent binary nodemap on stdin'),
2216 2216 ),
2217 2217 (b'', b'dump-disk', False, _(b'dump on-disk data on stdin')),
2218 2218 (
2219 2219 b'',
2220 2220 b'check',
2221 2221 False,
2222 2222 _(b'check that the data on disk data are correct.'),
2223 2223 ),
2224 2224 (
2225 2225 b'',
2226 2226 b'metadata',
2227 2227 False,
2228 2228 _(b'display the on disk meta data for the nodemap'),
2229 2229 ),
2230 2230 ],
2231 2231 )
2232 2232 def debugnodemap(ui, repo, **opts):
2233 2233 """write and inspect on disk nodemap"""
2234 2234 if opts['dump_new']:
2235 2235 unfi = repo.unfiltered()
2236 2236 cl = unfi.changelog
2237 2237 if util.safehasattr(cl.index, "nodemap_data_all"):
2238 2238 data = cl.index.nodemap_data_all()
2239 2239 else:
2240 2240 data = nodemap.persistent_data(cl.index)
2241 2241 ui.write(data)
2242 2242 elif opts['dump_disk']:
2243 2243 unfi = repo.unfiltered()
2244 2244 cl = unfi.changelog
2245 2245 nm_data = nodemap.persisted_data(cl)
2246 2246 if nm_data is not None:
2247 2247 docket, data = nm_data
2248 2248 ui.write(data[:])
2249 2249 elif opts['check']:
2250 2250 unfi = repo.unfiltered()
2251 2251 cl = unfi.changelog
2252 2252 nm_data = nodemap.persisted_data(cl)
2253 2253 if nm_data is not None:
2254 2254 docket, data = nm_data
2255 2255 return nodemap.check_data(ui, cl.index, data)
2256 2256 elif opts['metadata']:
2257 2257 unfi = repo.unfiltered()
2258 2258 cl = unfi.changelog
2259 2259 nm_data = nodemap.persisted_data(cl)
2260 2260 if nm_data is not None:
2261 2261 docket, data = nm_data
2262 2262 ui.write((b"uid: %s\n") % docket.uid)
2263 2263 ui.write((b"tip-rev: %d\n") % docket.tip_rev)
2264 2264 ui.write((b"tip-node: %s\n") % hex(docket.tip_node))
2265 2265 ui.write((b"data-length: %d\n") % docket.data_length)
2266 2266 ui.write((b"data-unused: %d\n") % docket.data_unused)
2267 2267 unused_perc = docket.data_unused * 100.0 / docket.data_length
2268 2268 ui.write((b"data-unused: %2.3f%%\n") % unused_perc)
2269 2269
2270 2270
2271 2271 @command(
2272 2272 b'debugobsolete',
2273 2273 [
2274 2274 (b'', b'flags', 0, _(b'markers flag')),
2275 2275 (
2276 2276 b'',
2277 2277 b'record-parents',
2278 2278 False,
2279 2279 _(b'record parent information for the precursor'),
2280 2280 ),
2281 2281 (b'r', b'rev', [], _(b'display markers relevant to REV')),
2282 2282 (
2283 2283 b'',
2284 2284 b'exclusive',
2285 2285 False,
2286 2286 _(b'restrict display to markers only relevant to REV'),
2287 2287 ),
2288 2288 (b'', b'index', False, _(b'display index of the marker')),
2289 2289 (b'', b'delete', [], _(b'delete markers specified by indices')),
2290 2290 ]
2291 2291 + cmdutil.commitopts2
2292 2292 + cmdutil.formatteropts,
2293 2293 _(b'[OBSOLETED [REPLACEMENT ...]]'),
2294 2294 )
2295 2295 def debugobsolete(ui, repo, precursor=None, *successors, **opts):
2296 2296 """create arbitrary obsolete marker
2297 2297
2298 2298 With no arguments, displays the list of obsolescence markers."""
2299 2299
2300 2300 opts = pycompat.byteskwargs(opts)
2301 2301
2302 2302 def parsenodeid(s):
2303 2303 try:
2304 2304 # We do not use revsingle/revrange functions here to accept
2305 2305 # arbitrary node identifiers, possibly not present in the
2306 2306 # local repository.
2307 2307 n = bin(s)
2308 2308 if len(n) != len(nullid):
2309 2309 raise TypeError()
2310 2310 return n
2311 2311 except TypeError:
2312 2312 raise error.InputError(
2313 2313 b'changeset references must be full hexadecimal '
2314 2314 b'node identifiers'
2315 2315 )
2316 2316
2317 2317 if opts.get(b'delete'):
2318 2318 indices = []
2319 2319 for v in opts.get(b'delete'):
2320 2320 try:
2321 2321 indices.append(int(v))
2322 2322 except ValueError:
2323 2323 raise error.InputError(
2324 2324 _(b'invalid index value: %r') % v,
2325 2325 hint=_(b'use integers for indices'),
2326 2326 )
2327 2327
2328 2328 if repo.currenttransaction():
2329 2329 raise error.Abort(
2330 2330 _(b'cannot delete obsmarkers in the middle of transaction.')
2331 2331 )
2332 2332
2333 2333 with repo.lock():
2334 2334 n = repair.deleteobsmarkers(repo.obsstore, indices)
2335 2335 ui.write(_(b'deleted %i obsolescence markers\n') % n)
2336 2336
2337 2337 return
2338 2338
2339 2339 if precursor is not None:
2340 2340 if opts[b'rev']:
2341 2341 raise error.InputError(
2342 2342 b'cannot select revision when creating marker'
2343 2343 )
2344 2344 metadata = {}
2345 2345 metadata[b'user'] = encoding.fromlocal(opts[b'user'] or ui.username())
2346 2346 succs = tuple(parsenodeid(succ) for succ in successors)
2347 2347 l = repo.lock()
2348 2348 try:
2349 2349 tr = repo.transaction(b'debugobsolete')
2350 2350 try:
2351 2351 date = opts.get(b'date')
2352 2352 if date:
2353 2353 date = dateutil.parsedate(date)
2354 2354 else:
2355 2355 date = None
2356 2356 prec = parsenodeid(precursor)
2357 2357 parents = None
2358 2358 if opts[b'record_parents']:
2359 2359 if prec not in repo.unfiltered():
2360 2360 raise error.Abort(
2361 2361 b'cannot used --record-parents on '
2362 2362 b'unknown changesets'
2363 2363 )
2364 2364 parents = repo.unfiltered()[prec].parents()
2365 2365 parents = tuple(p.node() for p in parents)
2366 2366 repo.obsstore.create(
2367 2367 tr,
2368 2368 prec,
2369 2369 succs,
2370 2370 opts[b'flags'],
2371 2371 parents=parents,
2372 2372 date=date,
2373 2373 metadata=metadata,
2374 2374 ui=ui,
2375 2375 )
2376 2376 tr.close()
2377 2377 except ValueError as exc:
2378 2378 raise error.Abort(
2379 2379 _(b'bad obsmarker input: %s') % pycompat.bytestr(exc)
2380 2380 )
2381 2381 finally:
2382 2382 tr.release()
2383 2383 finally:
2384 2384 l.release()
2385 2385 else:
2386 2386 if opts[b'rev']:
2387 2387 revs = scmutil.revrange(repo, opts[b'rev'])
2388 2388 nodes = [repo[r].node() for r in revs]
2389 2389 markers = list(
2390 2390 obsutil.getmarkers(
2391 2391 repo, nodes=nodes, exclusive=opts[b'exclusive']
2392 2392 )
2393 2393 )
2394 2394 markers.sort(key=lambda x: x._data)
2395 2395 else:
2396 2396 markers = obsutil.getmarkers(repo)
2397 2397
2398 2398 markerstoiter = markers
2399 2399 isrelevant = lambda m: True
2400 2400 if opts.get(b'rev') and opts.get(b'index'):
2401 2401 markerstoiter = obsutil.getmarkers(repo)
2402 2402 markerset = set(markers)
2403 2403 isrelevant = lambda m: m in markerset
2404 2404
2405 2405 fm = ui.formatter(b'debugobsolete', opts)
2406 2406 for i, m in enumerate(markerstoiter):
2407 2407 if not isrelevant(m):
2408 2408 # marker can be irrelevant when we're iterating over a set
2409 2409 # of markers (markerstoiter) which is bigger than the set
2410 2410 # of markers we want to display (markers)
2411 2411 # this can happen if both --index and --rev options are
2412 2412 # provided and thus we need to iterate over all of the markers
2413 2413 # to get the correct indices, but only display the ones that
2414 2414 # are relevant to --rev value
2415 2415 continue
2416 2416 fm.startitem()
2417 2417 ind = i if opts.get(b'index') else None
2418 2418 cmdutil.showmarker(fm, m, index=ind)
2419 2419 fm.end()
2420 2420
2421 2421
2422 2422 @command(
2423 2423 b'debugp1copies',
2424 2424 [(b'r', b'rev', b'', _(b'revision to debug'), _(b'REV'))],
2425 2425 _(b'[-r REV]'),
2426 2426 )
2427 2427 def debugp1copies(ui, repo, **opts):
2428 2428 """dump copy information compared to p1"""
2429 2429
2430 2430 opts = pycompat.byteskwargs(opts)
2431 2431 ctx = scmutil.revsingle(repo, opts.get(b'rev'), default=None)
2432 2432 for dst, src in ctx.p1copies().items():
2433 2433 ui.write(b'%s -> %s\n' % (src, dst))
2434 2434
2435 2435
2436 2436 @command(
2437 2437 b'debugp2copies',
2438 2438 [(b'r', b'rev', b'', _(b'revision to debug'), _(b'REV'))],
2439 2439 _(b'[-r REV]'),
2440 2440 )
2441 2441 def debugp1copies(ui, repo, **opts):
2442 2442 """dump copy information compared to p2"""
2443 2443
2444 2444 opts = pycompat.byteskwargs(opts)
2445 2445 ctx = scmutil.revsingle(repo, opts.get(b'rev'), default=None)
2446 2446 for dst, src in ctx.p2copies().items():
2447 2447 ui.write(b'%s -> %s\n' % (src, dst))
2448 2448
2449 2449
2450 2450 @command(
2451 2451 b'debugpathcomplete',
2452 2452 [
2453 2453 (b'f', b'full', None, _(b'complete an entire path')),
2454 2454 (b'n', b'normal', None, _(b'show only normal files')),
2455 2455 (b'a', b'added', None, _(b'show only added files')),
2456 2456 (b'r', b'removed', None, _(b'show only removed files')),
2457 2457 ],
2458 2458 _(b'FILESPEC...'),
2459 2459 )
2460 2460 def debugpathcomplete(ui, repo, *specs, **opts):
2461 2461 """complete part or all of a tracked path
2462 2462
2463 2463 This command supports shells that offer path name completion. It
2464 2464 currently completes only files already known to the dirstate.
2465 2465
2466 2466 Completion extends only to the next path segment unless
2467 2467 --full is specified, in which case entire paths are used."""
2468 2468
2469 2469 def complete(path, acceptable):
2470 2470 dirstate = repo.dirstate
2471 2471 spec = os.path.normpath(os.path.join(encoding.getcwd(), path))
2472 2472 rootdir = repo.root + pycompat.ossep
2473 2473 if spec != repo.root and not spec.startswith(rootdir):
2474 2474 return [], []
2475 2475 if os.path.isdir(spec):
2476 2476 spec += b'/'
2477 2477 spec = spec[len(rootdir) :]
2478 2478 fixpaths = pycompat.ossep != b'/'
2479 2479 if fixpaths:
2480 2480 spec = spec.replace(pycompat.ossep, b'/')
2481 2481 speclen = len(spec)
2482 2482 fullpaths = opts['full']
2483 2483 files, dirs = set(), set()
2484 2484 adddir, addfile = dirs.add, files.add
2485 2485 for f, st in pycompat.iteritems(dirstate):
2486 2486 if f.startswith(spec) and st[0] in acceptable:
2487 2487 if fixpaths:
2488 2488 f = f.replace(b'/', pycompat.ossep)
2489 2489 if fullpaths:
2490 2490 addfile(f)
2491 2491 continue
2492 2492 s = f.find(pycompat.ossep, speclen)
2493 2493 if s >= 0:
2494 2494 adddir(f[:s])
2495 2495 else:
2496 2496 addfile(f)
2497 2497 return files, dirs
2498 2498
2499 2499 acceptable = b''
2500 2500 if opts['normal']:
2501 2501 acceptable += b'nm'
2502 2502 if opts['added']:
2503 2503 acceptable += b'a'
2504 2504 if opts['removed']:
2505 2505 acceptable += b'r'
2506 2506 cwd = repo.getcwd()
2507 2507 if not specs:
2508 2508 specs = [b'.']
2509 2509
2510 2510 files, dirs = set(), set()
2511 2511 for spec in specs:
2512 2512 f, d = complete(spec, acceptable or b'nmar')
2513 2513 files.update(f)
2514 2514 dirs.update(d)
2515 2515 files.update(dirs)
2516 2516 ui.write(b'\n'.join(repo.pathto(p, cwd) for p in sorted(files)))
2517 2517 ui.write(b'\n')
2518 2518
2519 2519
2520 2520 @command(
2521 2521 b'debugpathcopies',
2522 2522 cmdutil.walkopts,
2523 2523 b'hg debugpathcopies REV1 REV2 [FILE]',
2524 2524 inferrepo=True,
2525 2525 )
2526 2526 def debugpathcopies(ui, repo, rev1, rev2, *pats, **opts):
2527 2527 """show copies between two revisions"""
2528 2528 ctx1 = scmutil.revsingle(repo, rev1)
2529 2529 ctx2 = scmutil.revsingle(repo, rev2)
2530 2530 m = scmutil.match(ctx1, pats, opts)
2531 2531 for dst, src in sorted(copies.pathcopies(ctx1, ctx2, m).items()):
2532 2532 ui.write(b'%s -> %s\n' % (src, dst))
2533 2533
2534 2534
2535 2535 @command(b'debugpeer', [], _(b'PATH'), norepo=True)
2536 2536 def debugpeer(ui, path):
2537 2537 """establish a connection to a peer repository"""
2538 2538 # Always enable peer request logging. Requires --debug to display
2539 2539 # though.
2540 2540 overrides = {
2541 2541 (b'devel', b'debug.peer-request'): True,
2542 2542 }
2543 2543
2544 2544 with ui.configoverride(overrides):
2545 2545 peer = hg.peer(ui, {}, path)
2546 2546
2547 2547 local = peer.local() is not None
2548 2548 canpush = peer.canpush()
2549 2549
2550 2550 ui.write(_(b'url: %s\n') % peer.url())
2551 2551 ui.write(_(b'local: %s\n') % (_(b'yes') if local else _(b'no')))
2552 2552 ui.write(_(b'pushable: %s\n') % (_(b'yes') if canpush else _(b'no')))
2553 2553
2554 2554
2555 2555 @command(
2556 2556 b'debugpickmergetool',
2557 2557 [
2558 2558 (b'r', b'rev', b'', _(b'check for files in this revision'), _(b'REV')),
2559 2559 (b'', b'changedelete', None, _(b'emulate merging change and delete')),
2560 2560 ]
2561 2561 + cmdutil.walkopts
2562 2562 + cmdutil.mergetoolopts,
2563 2563 _(b'[PATTERN]...'),
2564 2564 inferrepo=True,
2565 2565 )
2566 2566 def debugpickmergetool(ui, repo, *pats, **opts):
2567 2567 """examine which merge tool is chosen for specified file
2568 2568
2569 2569 As described in :hg:`help merge-tools`, Mercurial examines
2570 2570 configurations below in this order to decide which merge tool is
2571 2571 chosen for specified file.
2572 2572
2573 2573 1. ``--tool`` option
2574 2574 2. ``HGMERGE`` environment variable
2575 2575 3. configurations in ``merge-patterns`` section
2576 2576 4. configuration of ``ui.merge``
2577 2577 5. configurations in ``merge-tools`` section
2578 2578 6. ``hgmerge`` tool (for historical reason only)
2579 2579 7. default tool for fallback (``:merge`` or ``:prompt``)
2580 2580
2581 2581 This command writes out examination result in the style below::
2582 2582
2583 2583 FILE = MERGETOOL
2584 2584
2585 2585 By default, all files known in the first parent context of the
2586 2586 working directory are examined. Use file patterns and/or -I/-X
2587 2587 options to limit target files. -r/--rev is also useful to examine
2588 2588 files in another context without actual updating to it.
2589 2589
2590 2590 With --debug, this command shows warning messages while matching
2591 2591 against ``merge-patterns`` and so on, too. It is recommended to
2592 2592 use this option with explicit file patterns and/or -I/-X options,
2593 2593 because this option increases amount of output per file according
2594 2594 to configurations in hgrc.
2595 2595
2596 2596 With -v/--verbose, this command shows configurations below at
2597 2597 first (only if specified).
2598 2598
2599 2599 - ``--tool`` option
2600 2600 - ``HGMERGE`` environment variable
2601 2601 - configuration of ``ui.merge``
2602 2602
2603 2603 If merge tool is chosen before matching against
2604 2604 ``merge-patterns``, this command can't show any helpful
2605 2605 information, even with --debug. In such case, information above is
2606 2606 useful to know why a merge tool is chosen.
2607 2607 """
2608 2608 opts = pycompat.byteskwargs(opts)
2609 2609 overrides = {}
2610 2610 if opts[b'tool']:
2611 2611 overrides[(b'ui', b'forcemerge')] = opts[b'tool']
2612 2612 ui.notenoi18n(b'with --tool %r\n' % (pycompat.bytestr(opts[b'tool'])))
2613 2613
2614 2614 with ui.configoverride(overrides, b'debugmergepatterns'):
2615 2615 hgmerge = encoding.environ.get(b"HGMERGE")
2616 2616 if hgmerge is not None:
2617 2617 ui.notenoi18n(b'with HGMERGE=%r\n' % (pycompat.bytestr(hgmerge)))
2618 2618 uimerge = ui.config(b"ui", b"merge")
2619 2619 if uimerge:
2620 2620 ui.notenoi18n(b'with ui.merge=%r\n' % (pycompat.bytestr(uimerge)))
2621 2621
2622 2622 ctx = scmutil.revsingle(repo, opts.get(b'rev'))
2623 2623 m = scmutil.match(ctx, pats, opts)
2624 2624 changedelete = opts[b'changedelete']
2625 2625 for path in ctx.walk(m):
2626 2626 fctx = ctx[path]
2627 2627 try:
2628 2628 if not ui.debugflag:
2629 2629 ui.pushbuffer(error=True)
2630 2630 tool, toolpath = filemerge._picktool(
2631 2631 repo,
2632 2632 ui,
2633 2633 path,
2634 2634 fctx.isbinary(),
2635 2635 b'l' in fctx.flags(),
2636 2636 changedelete,
2637 2637 )
2638 2638 finally:
2639 2639 if not ui.debugflag:
2640 2640 ui.popbuffer()
2641 2641 ui.write(b'%s = %s\n' % (path, tool))
2642 2642
2643 2643
2644 2644 @command(b'debugpushkey', [], _(b'REPO NAMESPACE [KEY OLD NEW]'), norepo=True)
2645 2645 def debugpushkey(ui, repopath, namespace, *keyinfo, **opts):
2646 2646 """access the pushkey key/value protocol
2647 2647
2648 2648 With two args, list the keys in the given namespace.
2649 2649
2650 2650 With five args, set a key to new if it currently is set to old.
2651 2651 Reports success or failure.
2652 2652 """
2653 2653
2654 2654 target = hg.peer(ui, {}, repopath)
2655 2655 if keyinfo:
2656 2656 key, old, new = keyinfo
2657 2657 with target.commandexecutor() as e:
2658 2658 r = e.callcommand(
2659 2659 b'pushkey',
2660 2660 {
2661 2661 b'namespace': namespace,
2662 2662 b'key': key,
2663 2663 b'old': old,
2664 2664 b'new': new,
2665 2665 },
2666 2666 ).result()
2667 2667
2668 2668 ui.status(pycompat.bytestr(r) + b'\n')
2669 2669 return not r
2670 2670 else:
2671 2671 for k, v in sorted(pycompat.iteritems(target.listkeys(namespace))):
2672 2672 ui.write(
2673 2673 b"%s\t%s\n" % (stringutil.escapestr(k), stringutil.escapestr(v))
2674 2674 )
2675 2675
2676 2676
2677 2677 @command(b'debugpvec', [], _(b'A B'))
2678 2678 def debugpvec(ui, repo, a, b=None):
2679 2679 ca = scmutil.revsingle(repo, a)
2680 2680 cb = scmutil.revsingle(repo, b)
2681 2681 pa = pvec.ctxpvec(ca)
2682 2682 pb = pvec.ctxpvec(cb)
2683 2683 if pa == pb:
2684 2684 rel = b"="
2685 2685 elif pa > pb:
2686 2686 rel = b">"
2687 2687 elif pa < pb:
2688 2688 rel = b"<"
2689 2689 elif pa | pb:
2690 2690 rel = b"|"
2691 2691 ui.write(_(b"a: %s\n") % pa)
2692 2692 ui.write(_(b"b: %s\n") % pb)
2693 2693 ui.write(_(b"depth(a): %d depth(b): %d\n") % (pa._depth, pb._depth))
2694 2694 ui.write(
2695 2695 _(b"delta: %d hdist: %d distance: %d relation: %s\n")
2696 2696 % (
2697 2697 abs(pa._depth - pb._depth),
2698 2698 pvec._hamming(pa._vec, pb._vec),
2699 2699 pa.distance(pb),
2700 2700 rel,
2701 2701 )
2702 2702 )
2703 2703
2704 2704
2705 2705 @command(
2706 2706 b'debugrebuilddirstate|debugrebuildstate',
2707 2707 [
2708 2708 (b'r', b'rev', b'', _(b'revision to rebuild to'), _(b'REV')),
2709 2709 (
2710 2710 b'',
2711 2711 b'minimal',
2712 2712 None,
2713 2713 _(
2714 2714 b'only rebuild files that are inconsistent with '
2715 2715 b'the working copy parent'
2716 2716 ),
2717 2717 ),
2718 2718 ],
2719 2719 _(b'[-r REV]'),
2720 2720 )
2721 2721 def debugrebuilddirstate(ui, repo, rev, **opts):
2722 2722 """rebuild the dirstate as it would look like for the given revision
2723 2723
2724 2724 If no revision is specified the first current parent will be used.
2725 2725
2726 2726 The dirstate will be set to the files of the given revision.
2727 2727 The actual working directory content or existing dirstate
2728 2728 information such as adds or removes is not considered.
2729 2729
2730 2730 ``minimal`` will only rebuild the dirstate status for files that claim to be
2731 2731 tracked but are not in the parent manifest, or that exist in the parent
2732 2732 manifest but are not in the dirstate. It will not change adds, removes, or
2733 2733 modified files that are in the working copy parent.
2734 2734
2735 2735 One use of this command is to make the next :hg:`status` invocation
2736 2736 check the actual file content.
2737 2737 """
2738 2738 ctx = scmutil.revsingle(repo, rev)
2739 2739 with repo.wlock():
2740 2740 dirstate = repo.dirstate
2741 2741 changedfiles = None
2742 2742 # See command doc for what minimal does.
2743 2743 if opts.get('minimal'):
2744 2744 manifestfiles = set(ctx.manifest().keys())
2745 2745 dirstatefiles = set(dirstate)
2746 2746 manifestonly = manifestfiles - dirstatefiles
2747 2747 dsonly = dirstatefiles - manifestfiles
2748 2748 dsnotadded = {f for f in dsonly if dirstate[f] != b'a'}
2749 2749 changedfiles = manifestonly | dsnotadded
2750 2750
2751 2751 dirstate.rebuild(ctx.node(), ctx.manifest(), changedfiles)
2752 2752
2753 2753
2754 2754 @command(b'debugrebuildfncache', [], b'')
2755 2755 def debugrebuildfncache(ui, repo):
2756 2756 """rebuild the fncache file"""
2757 2757 repair.rebuildfncache(ui, repo)
2758 2758
2759 2759
2760 2760 @command(
2761 2761 b'debugrename',
2762 2762 [(b'r', b'rev', b'', _(b'revision to debug'), _(b'REV'))],
2763 2763 _(b'[-r REV] [FILE]...'),
2764 2764 )
2765 2765 def debugrename(ui, repo, *pats, **opts):
2766 2766 """dump rename information"""
2767 2767
2768 2768 opts = pycompat.byteskwargs(opts)
2769 2769 ctx = scmutil.revsingle(repo, opts.get(b'rev'))
2770 2770 m = scmutil.match(ctx, pats, opts)
2771 2771 for abs in ctx.walk(m):
2772 2772 fctx = ctx[abs]
2773 2773 o = fctx.filelog().renamed(fctx.filenode())
2774 2774 rel = repo.pathto(abs)
2775 2775 if o:
2776 2776 ui.write(_(b"%s renamed from %s:%s\n") % (rel, o[0], hex(o[1])))
2777 2777 else:
2778 2778 ui.write(_(b"%s not renamed\n") % rel)
2779 2779
2780 2780
2781 2781 @command(b'debugrequires|debugrequirements', [], b'')
2782 2782 def debugrequirements(ui, repo):
2783 2783 """ print the current repo requirements """
2784 2784 for r in sorted(repo.requirements):
2785 2785 ui.write(b"%s\n" % r)
2786 2786
2787 2787
2788 2788 @command(
2789 2789 b'debugrevlog',
2790 2790 cmdutil.debugrevlogopts + [(b'd', b'dump', False, _(b'dump index data'))],
2791 2791 _(b'-c|-m|FILE'),
2792 2792 optionalrepo=True,
2793 2793 )
2794 2794 def debugrevlog(ui, repo, file_=None, **opts):
2795 2795 """show data and statistics about a revlog"""
2796 2796 opts = pycompat.byteskwargs(opts)
2797 2797 r = cmdutil.openrevlog(repo, b'debugrevlog', file_, opts)
2798 2798
2799 2799 if opts.get(b"dump"):
2800 2800 numrevs = len(r)
2801 2801 ui.write(
2802 2802 (
2803 2803 b"# rev p1rev p2rev start end deltastart base p1 p2"
2804 2804 b" rawsize totalsize compression heads chainlen\n"
2805 2805 )
2806 2806 )
2807 2807 ts = 0
2808 2808 heads = set()
2809 2809
2810 2810 for rev in pycompat.xrange(numrevs):
2811 2811 dbase = r.deltaparent(rev)
2812 2812 if dbase == -1:
2813 2813 dbase = rev
2814 2814 cbase = r.chainbase(rev)
2815 2815 clen = r.chainlen(rev)
2816 2816 p1, p2 = r.parentrevs(rev)
2817 2817 rs = r.rawsize(rev)
2818 2818 ts = ts + rs
2819 2819 heads -= set(r.parentrevs(rev))
2820 2820 heads.add(rev)
2821 2821 try:
2822 2822 compression = ts / r.end(rev)
2823 2823 except ZeroDivisionError:
2824 2824 compression = 0
2825 2825 ui.write(
2826 2826 b"%5d %5d %5d %5d %5d %10d %4d %4d %4d %7d %9d "
2827 2827 b"%11d %5d %8d\n"
2828 2828 % (
2829 2829 rev,
2830 2830 p1,
2831 2831 p2,
2832 2832 r.start(rev),
2833 2833 r.end(rev),
2834 2834 r.start(dbase),
2835 2835 r.start(cbase),
2836 2836 r.start(p1),
2837 2837 r.start(p2),
2838 2838 rs,
2839 2839 ts,
2840 2840 compression,
2841 2841 len(heads),
2842 2842 clen,
2843 2843 )
2844 2844 )
2845 2845 return 0
2846 2846
2847 2847 v = r.version
2848 2848 format = v & 0xFFFF
2849 2849 flags = []
2850 2850 gdelta = False
2851 2851 if v & revlog.FLAG_INLINE_DATA:
2852 2852 flags.append(b'inline')
2853 2853 if v & revlog.FLAG_GENERALDELTA:
2854 2854 gdelta = True
2855 2855 flags.append(b'generaldelta')
2856 2856 if not flags:
2857 2857 flags = [b'(none)']
2858 2858
2859 2859 ### tracks merge vs single parent
2860 2860 nummerges = 0
2861 2861
2862 2862 ### tracks ways the "delta" are build
2863 2863 # nodelta
2864 2864 numempty = 0
2865 2865 numemptytext = 0
2866 2866 numemptydelta = 0
2867 2867 # full file content
2868 2868 numfull = 0
2869 2869 # intermediate snapshot against a prior snapshot
2870 2870 numsemi = 0
2871 2871 # snapshot count per depth
2872 2872 numsnapdepth = collections.defaultdict(lambda: 0)
2873 2873 # delta against previous revision
2874 2874 numprev = 0
2875 2875 # delta against first or second parent (not prev)
2876 2876 nump1 = 0
2877 2877 nump2 = 0
2878 2878 # delta against neither prev nor parents
2879 2879 numother = 0
2880 2880 # delta against prev that are also first or second parent
2881 2881 # (details of `numprev`)
2882 2882 nump1prev = 0
2883 2883 nump2prev = 0
2884 2884
2885 2885 # data about delta chain of each revs
2886 2886 chainlengths = []
2887 2887 chainbases = []
2888 2888 chainspans = []
2889 2889
2890 2890 # data about each revision
2891 2891 datasize = [None, 0, 0]
2892 2892 fullsize = [None, 0, 0]
2893 2893 semisize = [None, 0, 0]
2894 2894 # snapshot count per depth
2895 2895 snapsizedepth = collections.defaultdict(lambda: [None, 0, 0])
2896 2896 deltasize = [None, 0, 0]
2897 2897 chunktypecounts = {}
2898 2898 chunktypesizes = {}
2899 2899
2900 2900 def addsize(size, l):
2901 2901 if l[0] is None or size < l[0]:
2902 2902 l[0] = size
2903 2903 if size > l[1]:
2904 2904 l[1] = size
2905 2905 l[2] += size
2906 2906
2907 2907 numrevs = len(r)
2908 2908 for rev in pycompat.xrange(numrevs):
2909 2909 p1, p2 = r.parentrevs(rev)
2910 2910 delta = r.deltaparent(rev)
2911 2911 if format > 0:
2912 2912 addsize(r.rawsize(rev), datasize)
2913 2913 if p2 != nullrev:
2914 2914 nummerges += 1
2915 2915 size = r.length(rev)
2916 2916 if delta == nullrev:
2917 2917 chainlengths.append(0)
2918 2918 chainbases.append(r.start(rev))
2919 2919 chainspans.append(size)
2920 2920 if size == 0:
2921 2921 numempty += 1
2922 2922 numemptytext += 1
2923 2923 else:
2924 2924 numfull += 1
2925 2925 numsnapdepth[0] += 1
2926 2926 addsize(size, fullsize)
2927 2927 addsize(size, snapsizedepth[0])
2928 2928 else:
2929 2929 chainlengths.append(chainlengths[delta] + 1)
2930 2930 baseaddr = chainbases[delta]
2931 2931 revaddr = r.start(rev)
2932 2932 chainbases.append(baseaddr)
2933 2933 chainspans.append((revaddr - baseaddr) + size)
2934 2934 if size == 0:
2935 2935 numempty += 1
2936 2936 numemptydelta += 1
2937 2937 elif r.issnapshot(rev):
2938 2938 addsize(size, semisize)
2939 2939 numsemi += 1
2940 2940 depth = r.snapshotdepth(rev)
2941 2941 numsnapdepth[depth] += 1
2942 2942 addsize(size, snapsizedepth[depth])
2943 2943 else:
2944 2944 addsize(size, deltasize)
2945 2945 if delta == rev - 1:
2946 2946 numprev += 1
2947 2947 if delta == p1:
2948 2948 nump1prev += 1
2949 2949 elif delta == p2:
2950 2950 nump2prev += 1
2951 2951 elif delta == p1:
2952 2952 nump1 += 1
2953 2953 elif delta == p2:
2954 2954 nump2 += 1
2955 2955 elif delta != nullrev:
2956 2956 numother += 1
2957 2957
2958 2958 # Obtain data on the raw chunks in the revlog.
2959 2959 if util.safehasattr(r, b'_getsegmentforrevs'):
2960 2960 segment = r._getsegmentforrevs(rev, rev)[1]
2961 2961 else:
2962 2962 segment = r._revlog._getsegmentforrevs(rev, rev)[1]
2963 2963 if segment:
2964 2964 chunktype = bytes(segment[0:1])
2965 2965 else:
2966 2966 chunktype = b'empty'
2967 2967
2968 2968 if chunktype not in chunktypecounts:
2969 2969 chunktypecounts[chunktype] = 0
2970 2970 chunktypesizes[chunktype] = 0
2971 2971
2972 2972 chunktypecounts[chunktype] += 1
2973 2973 chunktypesizes[chunktype] += size
2974 2974
2975 2975 # Adjust size min value for empty cases
2976 2976 for size in (datasize, fullsize, semisize, deltasize):
2977 2977 if size[0] is None:
2978 2978 size[0] = 0
2979 2979
2980 2980 numdeltas = numrevs - numfull - numempty - numsemi
2981 2981 numoprev = numprev - nump1prev - nump2prev
2982 2982 totalrawsize = datasize[2]
2983 2983 datasize[2] /= numrevs
2984 2984 fulltotal = fullsize[2]
2985 2985 if numfull == 0:
2986 2986 fullsize[2] = 0
2987 2987 else:
2988 2988 fullsize[2] /= numfull
2989 2989 semitotal = semisize[2]
2990 2990 snaptotal = {}
2991 2991 if numsemi > 0:
2992 2992 semisize[2] /= numsemi
2993 2993 for depth in snapsizedepth:
2994 2994 snaptotal[depth] = snapsizedepth[depth][2]
2995 2995 snapsizedepth[depth][2] /= numsnapdepth[depth]
2996 2996
2997 2997 deltatotal = deltasize[2]
2998 2998 if numdeltas > 0:
2999 2999 deltasize[2] /= numdeltas
3000 3000 totalsize = fulltotal + semitotal + deltatotal
3001 3001 avgchainlen = sum(chainlengths) / numrevs
3002 3002 maxchainlen = max(chainlengths)
3003 3003 maxchainspan = max(chainspans)
3004 3004 compratio = 1
3005 3005 if totalsize:
3006 3006 compratio = totalrawsize / totalsize
3007 3007
3008 3008 basedfmtstr = b'%%%dd\n'
3009 3009 basepcfmtstr = b'%%%dd %s(%%5.2f%%%%)\n'
3010 3010
3011 3011 def dfmtstr(max):
3012 3012 return basedfmtstr % len(str(max))
3013 3013
3014 3014 def pcfmtstr(max, padding=0):
3015 3015 return basepcfmtstr % (len(str(max)), b' ' * padding)
3016 3016
3017 3017 def pcfmt(value, total):
3018 3018 if total:
3019 3019 return (value, 100 * float(value) / total)
3020 3020 else:
3021 3021 return value, 100.0
3022 3022
3023 3023 ui.writenoi18n(b'format : %d\n' % format)
3024 3024 ui.writenoi18n(b'flags : %s\n' % b', '.join(flags))
3025 3025
3026 3026 ui.write(b'\n')
3027 3027 fmt = pcfmtstr(totalsize)
3028 3028 fmt2 = dfmtstr(totalsize)
3029 3029 ui.writenoi18n(b'revisions : ' + fmt2 % numrevs)
3030 3030 ui.writenoi18n(b' merges : ' + fmt % pcfmt(nummerges, numrevs))
3031 3031 ui.writenoi18n(
3032 3032 b' normal : ' + fmt % pcfmt(numrevs - nummerges, numrevs)
3033 3033 )
3034 3034 ui.writenoi18n(b'revisions : ' + fmt2 % numrevs)
3035 3035 ui.writenoi18n(b' empty : ' + fmt % pcfmt(numempty, numrevs))
3036 3036 ui.writenoi18n(
3037 3037 b' text : '
3038 3038 + fmt % pcfmt(numemptytext, numemptytext + numemptydelta)
3039 3039 )
3040 3040 ui.writenoi18n(
3041 3041 b' delta : '
3042 3042 + fmt % pcfmt(numemptydelta, numemptytext + numemptydelta)
3043 3043 )
3044 3044 ui.writenoi18n(
3045 3045 b' snapshot : ' + fmt % pcfmt(numfull + numsemi, numrevs)
3046 3046 )
3047 3047 for depth in sorted(numsnapdepth):
3048 3048 ui.write(
3049 3049 (b' lvl-%-3d : ' % depth)
3050 3050 + fmt % pcfmt(numsnapdepth[depth], numrevs)
3051 3051 )
3052 3052 ui.writenoi18n(b' deltas : ' + fmt % pcfmt(numdeltas, numrevs))
3053 3053 ui.writenoi18n(b'revision size : ' + fmt2 % totalsize)
3054 3054 ui.writenoi18n(
3055 3055 b' snapshot : ' + fmt % pcfmt(fulltotal + semitotal, totalsize)
3056 3056 )
3057 3057 for depth in sorted(numsnapdepth):
3058 3058 ui.write(
3059 3059 (b' lvl-%-3d : ' % depth)
3060 3060 + fmt % pcfmt(snaptotal[depth], totalsize)
3061 3061 )
3062 3062 ui.writenoi18n(b' deltas : ' + fmt % pcfmt(deltatotal, totalsize))
3063 3063
3064 3064 def fmtchunktype(chunktype):
3065 3065 if chunktype == b'empty':
3066 3066 return b' %s : ' % chunktype
3067 3067 elif chunktype in pycompat.bytestr(string.ascii_letters):
3068 3068 return b' 0x%s (%s) : ' % (hex(chunktype), chunktype)
3069 3069 else:
3070 3070 return b' 0x%s : ' % hex(chunktype)
3071 3071
3072 3072 ui.write(b'\n')
3073 3073 ui.writenoi18n(b'chunks : ' + fmt2 % numrevs)
3074 3074 for chunktype in sorted(chunktypecounts):
3075 3075 ui.write(fmtchunktype(chunktype))
3076 3076 ui.write(fmt % pcfmt(chunktypecounts[chunktype], numrevs))
3077 3077 ui.writenoi18n(b'chunks size : ' + fmt2 % totalsize)
3078 3078 for chunktype in sorted(chunktypecounts):
3079 3079 ui.write(fmtchunktype(chunktype))
3080 3080 ui.write(fmt % pcfmt(chunktypesizes[chunktype], totalsize))
3081 3081
3082 3082 ui.write(b'\n')
3083 3083 fmt = dfmtstr(max(avgchainlen, maxchainlen, maxchainspan, compratio))
3084 3084 ui.writenoi18n(b'avg chain length : ' + fmt % avgchainlen)
3085 3085 ui.writenoi18n(b'max chain length : ' + fmt % maxchainlen)
3086 3086 ui.writenoi18n(b'max chain reach : ' + fmt % maxchainspan)
3087 3087 ui.writenoi18n(b'compression ratio : ' + fmt % compratio)
3088 3088
3089 3089 if format > 0:
3090 3090 ui.write(b'\n')
3091 3091 ui.writenoi18n(
3092 3092 b'uncompressed data size (min/max/avg) : %d / %d / %d\n'
3093 3093 % tuple(datasize)
3094 3094 )
3095 3095 ui.writenoi18n(
3096 3096 b'full revision size (min/max/avg) : %d / %d / %d\n'
3097 3097 % tuple(fullsize)
3098 3098 )
3099 3099 ui.writenoi18n(
3100 3100 b'inter-snapshot size (min/max/avg) : %d / %d / %d\n'
3101 3101 % tuple(semisize)
3102 3102 )
3103 3103 for depth in sorted(snapsizedepth):
3104 3104 if depth == 0:
3105 3105 continue
3106 3106 ui.writenoi18n(
3107 3107 b' level-%-3d (min/max/avg) : %d / %d / %d\n'
3108 3108 % ((depth,) + tuple(snapsizedepth[depth]))
3109 3109 )
3110 3110 ui.writenoi18n(
3111 3111 b'delta size (min/max/avg) : %d / %d / %d\n'
3112 3112 % tuple(deltasize)
3113 3113 )
3114 3114
3115 3115 if numdeltas > 0:
3116 3116 ui.write(b'\n')
3117 3117 fmt = pcfmtstr(numdeltas)
3118 3118 fmt2 = pcfmtstr(numdeltas, 4)
3119 3119 ui.writenoi18n(
3120 3120 b'deltas against prev : ' + fmt % pcfmt(numprev, numdeltas)
3121 3121 )
3122 3122 if numprev > 0:
3123 3123 ui.writenoi18n(
3124 3124 b' where prev = p1 : ' + fmt2 % pcfmt(nump1prev, numprev)
3125 3125 )
3126 3126 ui.writenoi18n(
3127 3127 b' where prev = p2 : ' + fmt2 % pcfmt(nump2prev, numprev)
3128 3128 )
3129 3129 ui.writenoi18n(
3130 3130 b' other : ' + fmt2 % pcfmt(numoprev, numprev)
3131 3131 )
3132 3132 if gdelta:
3133 3133 ui.writenoi18n(
3134 3134 b'deltas against p1 : ' + fmt % pcfmt(nump1, numdeltas)
3135 3135 )
3136 3136 ui.writenoi18n(
3137 3137 b'deltas against p2 : ' + fmt % pcfmt(nump2, numdeltas)
3138 3138 )
3139 3139 ui.writenoi18n(
3140 3140 b'deltas against other : ' + fmt % pcfmt(numother, numdeltas)
3141 3141 )
3142 3142
3143 3143
3144 3144 @command(
3145 3145 b'debugrevlogindex',
3146 3146 cmdutil.debugrevlogopts
3147 3147 + [(b'f', b'format', 0, _(b'revlog format'), _(b'FORMAT'))],
3148 3148 _(b'[-f FORMAT] -c|-m|FILE'),
3149 3149 optionalrepo=True,
3150 3150 )
3151 3151 def debugrevlogindex(ui, repo, file_=None, **opts):
3152 3152 """dump the contents of a revlog index"""
3153 3153 opts = pycompat.byteskwargs(opts)
3154 3154 r = cmdutil.openrevlog(repo, b'debugrevlogindex', file_, opts)
3155 3155 format = opts.get(b'format', 0)
3156 3156 if format not in (0, 1):
3157 3157 raise error.Abort(_(b"unknown format %d") % format)
3158 3158
3159 3159 if ui.debugflag:
3160 3160 shortfn = hex
3161 3161 else:
3162 3162 shortfn = short
3163 3163
3164 3164 # There might not be anything in r, so have a sane default
3165 3165 idlen = 12
3166 3166 for i in r:
3167 3167 idlen = len(shortfn(r.node(i)))
3168 3168 break
3169 3169
3170 3170 if format == 0:
3171 3171 if ui.verbose:
3172 3172 ui.writenoi18n(
3173 3173 b" rev offset length linkrev %s %s p2\n"
3174 3174 % (b"nodeid".ljust(idlen), b"p1".ljust(idlen))
3175 3175 )
3176 3176 else:
3177 3177 ui.writenoi18n(
3178 3178 b" rev linkrev %s %s p2\n"
3179 3179 % (b"nodeid".ljust(idlen), b"p1".ljust(idlen))
3180 3180 )
3181 3181 elif format == 1:
3182 3182 if ui.verbose:
3183 3183 ui.writenoi18n(
3184 3184 (
3185 3185 b" rev flag offset length size link p1"
3186 3186 b" p2 %s\n"
3187 3187 )
3188 3188 % b"nodeid".rjust(idlen)
3189 3189 )
3190 3190 else:
3191 3191 ui.writenoi18n(
3192 3192 b" rev flag size link p1 p2 %s\n"
3193 3193 % b"nodeid".rjust(idlen)
3194 3194 )
3195 3195
3196 3196 for i in r:
3197 3197 node = r.node(i)
3198 3198 if format == 0:
3199 3199 try:
3200 3200 pp = r.parents(node)
3201 3201 except Exception:
3202 3202 pp = [nullid, nullid]
3203 3203 if ui.verbose:
3204 3204 ui.write(
3205 3205 b"% 6d % 9d % 7d % 7d %s %s %s\n"
3206 3206 % (
3207 3207 i,
3208 3208 r.start(i),
3209 3209 r.length(i),
3210 3210 r.linkrev(i),
3211 3211 shortfn(node),
3212 3212 shortfn(pp[0]),
3213 3213 shortfn(pp[1]),
3214 3214 )
3215 3215 )
3216 3216 else:
3217 3217 ui.write(
3218 3218 b"% 6d % 7d %s %s %s\n"
3219 3219 % (
3220 3220 i,
3221 3221 r.linkrev(i),
3222 3222 shortfn(node),
3223 3223 shortfn(pp[0]),
3224 3224 shortfn(pp[1]),
3225 3225 )
3226 3226 )
3227 3227 elif format == 1:
3228 3228 pr = r.parentrevs(i)
3229 3229 if ui.verbose:
3230 3230 ui.write(
3231 3231 b"% 6d %04x % 8d % 8d % 8d % 6d % 6d % 6d %s\n"
3232 3232 % (
3233 3233 i,
3234 3234 r.flags(i),
3235 3235 r.start(i),
3236 3236 r.length(i),
3237 3237 r.rawsize(i),
3238 3238 r.linkrev(i),
3239 3239 pr[0],
3240 3240 pr[1],
3241 3241 shortfn(node),
3242 3242 )
3243 3243 )
3244 3244 else:
3245 3245 ui.write(
3246 3246 b"% 6d %04x % 8d % 6d % 6d % 6d %s\n"
3247 3247 % (
3248 3248 i,
3249 3249 r.flags(i),
3250 3250 r.rawsize(i),
3251 3251 r.linkrev(i),
3252 3252 pr[0],
3253 3253 pr[1],
3254 3254 shortfn(node),
3255 3255 )
3256 3256 )
3257 3257
3258 3258
3259 3259 @command(
3260 3260 b'debugrevspec',
3261 3261 [
3262 3262 (
3263 3263 b'',
3264 3264 b'optimize',
3265 3265 None,
3266 3266 _(b'print parsed tree after optimizing (DEPRECATED)'),
3267 3267 ),
3268 3268 (
3269 3269 b'',
3270 3270 b'show-revs',
3271 3271 True,
3272 3272 _(b'print list of result revisions (default)'),
3273 3273 ),
3274 3274 (
3275 3275 b's',
3276 3276 b'show-set',
3277 3277 None,
3278 3278 _(b'print internal representation of result set'),
3279 3279 ),
3280 3280 (
3281 3281 b'p',
3282 3282 b'show-stage',
3283 3283 [],
3284 3284 _(b'print parsed tree at the given stage'),
3285 3285 _(b'NAME'),
3286 3286 ),
3287 3287 (b'', b'no-optimized', False, _(b'evaluate tree without optimization')),
3288 3288 (b'', b'verify-optimized', False, _(b'verify optimized result')),
3289 3289 ],
3290 3290 b'REVSPEC',
3291 3291 )
3292 3292 def debugrevspec(ui, repo, expr, **opts):
3293 3293 """parse and apply a revision specification
3294 3294
3295 3295 Use -p/--show-stage option to print the parsed tree at the given stages.
3296 3296 Use -p all to print tree at every stage.
3297 3297
3298 3298 Use --no-show-revs option with -s or -p to print only the set
3299 3299 representation or the parsed tree respectively.
3300 3300
3301 3301 Use --verify-optimized to compare the optimized result with the unoptimized
3302 3302 one. Returns 1 if the optimized result differs.
3303 3303 """
3304 3304 opts = pycompat.byteskwargs(opts)
3305 3305 aliases = ui.configitems(b'revsetalias')
3306 3306 stages = [
3307 3307 (b'parsed', lambda tree: tree),
3308 3308 (
3309 3309 b'expanded',
3310 3310 lambda tree: revsetlang.expandaliases(tree, aliases, ui.warn),
3311 3311 ),
3312 3312 (b'concatenated', revsetlang.foldconcat),
3313 3313 (b'analyzed', revsetlang.analyze),
3314 3314 (b'optimized', revsetlang.optimize),
3315 3315 ]
3316 3316 if opts[b'no_optimized']:
3317 3317 stages = stages[:-1]
3318 3318 if opts[b'verify_optimized'] and opts[b'no_optimized']:
3319 3319 raise error.Abort(
3320 3320 _(b'cannot use --verify-optimized with --no-optimized')
3321 3321 )
3322 3322 stagenames = {n for n, f in stages}
3323 3323
3324 3324 showalways = set()
3325 3325 showchanged = set()
3326 3326 if ui.verbose and not opts[b'show_stage']:
3327 3327 # show parsed tree by --verbose (deprecated)
3328 3328 showalways.add(b'parsed')
3329 3329 showchanged.update([b'expanded', b'concatenated'])
3330 3330 if opts[b'optimize']:
3331 3331 showalways.add(b'optimized')
3332 3332 if opts[b'show_stage'] and opts[b'optimize']:
3333 3333 raise error.Abort(_(b'cannot use --optimize with --show-stage'))
3334 3334 if opts[b'show_stage'] == [b'all']:
3335 3335 showalways.update(stagenames)
3336 3336 else:
3337 3337 for n in opts[b'show_stage']:
3338 3338 if n not in stagenames:
3339 3339 raise error.Abort(_(b'invalid stage name: %s') % n)
3340 3340 showalways.update(opts[b'show_stage'])
3341 3341
3342 3342 treebystage = {}
3343 3343 printedtree = None
3344 3344 tree = revsetlang.parse(expr, lookup=revset.lookupfn(repo))
3345 3345 for n, f in stages:
3346 3346 treebystage[n] = tree = f(tree)
3347 3347 if n in showalways or (n in showchanged and tree != printedtree):
3348 3348 if opts[b'show_stage'] or n != b'parsed':
3349 3349 ui.write(b"* %s:\n" % n)
3350 3350 ui.write(revsetlang.prettyformat(tree), b"\n")
3351 3351 printedtree = tree
3352 3352
3353 3353 if opts[b'verify_optimized']:
3354 3354 arevs = revset.makematcher(treebystage[b'analyzed'])(repo)
3355 3355 brevs = revset.makematcher(treebystage[b'optimized'])(repo)
3356 3356 if opts[b'show_set'] or (opts[b'show_set'] is None and ui.verbose):
3357 3357 ui.writenoi18n(
3358 3358 b"* analyzed set:\n", stringutil.prettyrepr(arevs), b"\n"
3359 3359 )
3360 3360 ui.writenoi18n(
3361 3361 b"* optimized set:\n", stringutil.prettyrepr(brevs), b"\n"
3362 3362 )
3363 3363 arevs = list(arevs)
3364 3364 brevs = list(brevs)
3365 3365 if arevs == brevs:
3366 3366 return 0
3367 3367 ui.writenoi18n(b'--- analyzed\n', label=b'diff.file_a')
3368 3368 ui.writenoi18n(b'+++ optimized\n', label=b'diff.file_b')
3369 3369 sm = difflib.SequenceMatcher(None, arevs, brevs)
3370 3370 for tag, alo, ahi, blo, bhi in sm.get_opcodes():
3371 3371 if tag in ('delete', 'replace'):
3372 3372 for c in arevs[alo:ahi]:
3373 3373 ui.write(b'-%d\n' % c, label=b'diff.deleted')
3374 3374 if tag in ('insert', 'replace'):
3375 3375 for c in brevs[blo:bhi]:
3376 3376 ui.write(b'+%d\n' % c, label=b'diff.inserted')
3377 3377 if tag == 'equal':
3378 3378 for c in arevs[alo:ahi]:
3379 3379 ui.write(b' %d\n' % c)
3380 3380 return 1
3381 3381
3382 3382 func = revset.makematcher(tree)
3383 3383 revs = func(repo)
3384 3384 if opts[b'show_set'] or (opts[b'show_set'] is None and ui.verbose):
3385 3385 ui.writenoi18n(b"* set:\n", stringutil.prettyrepr(revs), b"\n")
3386 3386 if not opts[b'show_revs']:
3387 3387 return
3388 3388 for c in revs:
3389 3389 ui.write(b"%d\n" % c)
3390 3390
3391 3391
3392 3392 @command(
3393 3393 b'debugserve',
3394 3394 [
3395 3395 (
3396 3396 b'',
3397 3397 b'sshstdio',
3398 3398 False,
3399 3399 _(b'run an SSH server bound to process handles'),
3400 3400 ),
3401 3401 (b'', b'logiofd', b'', _(b'file descriptor to log server I/O to')),
3402 3402 (b'', b'logiofile', b'', _(b'file to log server I/O to')),
3403 3403 ],
3404 3404 b'',
3405 3405 )
3406 3406 def debugserve(ui, repo, **opts):
3407 3407 """run a server with advanced settings
3408 3408
3409 3409 This command is similar to :hg:`serve`. It exists partially as a
3410 3410 workaround to the fact that ``hg serve --stdio`` must have specific
3411 3411 arguments for security reasons.
3412 3412 """
3413 3413 opts = pycompat.byteskwargs(opts)
3414 3414
3415 3415 if not opts[b'sshstdio']:
3416 3416 raise error.Abort(_(b'only --sshstdio is currently supported'))
3417 3417
3418 3418 logfh = None
3419 3419
3420 3420 if opts[b'logiofd'] and opts[b'logiofile']:
3421 3421 raise error.Abort(_(b'cannot use both --logiofd and --logiofile'))
3422 3422
3423 3423 if opts[b'logiofd']:
3424 3424 # Ideally we would be line buffered. But line buffering in binary
3425 3425 # mode isn't supported and emits a warning in Python 3.8+. Disabling
3426 3426 # buffering could have performance impacts. But since this isn't
3427 3427 # performance critical code, it should be fine.
3428 3428 try:
3429 3429 logfh = os.fdopen(int(opts[b'logiofd']), 'ab', 0)
3430 3430 except OSError as e:
3431 3431 if e.errno != errno.ESPIPE:
3432 3432 raise
3433 3433 # can't seek a pipe, so `ab` mode fails on py3
3434 3434 logfh = os.fdopen(int(opts[b'logiofd']), 'wb', 0)
3435 3435 elif opts[b'logiofile']:
3436 3436 logfh = open(opts[b'logiofile'], b'ab', 0)
3437 3437
3438 3438 s = wireprotoserver.sshserver(ui, repo, logfh=logfh)
3439 3439 s.serve_forever()
3440 3440
3441 3441
3442 3442 @command(b'debugsetparents', [], _(b'REV1 [REV2]'))
3443 3443 def debugsetparents(ui, repo, rev1, rev2=None):
3444 3444 """manually set the parents of the current working directory (DANGEROUS)
3445 3445
3446 3446 This command is not what you are looking for and should not be used. Using
3447 3447 this command will most certainly results in slight corruption of the file
3448 3448 level histories withing your repository. DO NOT USE THIS COMMAND.
3449 3449
3450 3450 The command update the p1 and p2 field in the dirstate, and not touching
3451 3451 anything else. This useful for writing repository conversion tools, but
3452 3452 should be used with extreme care. For example, neither the working
3453 3453 directory nor the dirstate is updated, so file status may be incorrect
3454 3454 after running this command. Only used if you are one of the few people that
3455 3455 deeply unstand both conversion tools and file level histories. If you are
3456 3456 reading this help, you are not one of this people (most of them sailed west
3457 3457 from Mithlond anyway.
3458 3458
3459 3459 So one last time DO NOT USE THIS COMMAND.
3460 3460
3461 3461 Returns 0 on success.
3462 3462 """
3463 3463
3464 3464 node1 = scmutil.revsingle(repo, rev1).node()
3465 3465 node2 = scmutil.revsingle(repo, rev2, b'null').node()
3466 3466
3467 3467 with repo.wlock():
3468 3468 repo.setparents(node1, node2)
3469 3469
3470 3470
3471 3471 @command(b'debugsidedata', cmdutil.debugrevlogopts, _(b'-c|-m|FILE REV'))
3472 3472 def debugsidedata(ui, repo, file_, rev=None, **opts):
3473 3473 """dump the side data for a cl/manifest/file revision
3474 3474
3475 3475 Use --verbose to dump the sidedata content."""
3476 3476 opts = pycompat.byteskwargs(opts)
3477 3477 if opts.get(b'changelog') or opts.get(b'manifest') or opts.get(b'dir'):
3478 3478 if rev is not None:
3479 3479 raise error.CommandError(b'debugdata', _(b'invalid arguments'))
3480 3480 file_, rev = None, file_
3481 3481 elif rev is None:
3482 3482 raise error.CommandError(b'debugdata', _(b'invalid arguments'))
3483 3483 r = cmdutil.openstorage(repo, b'debugdata', file_, opts)
3484 3484 r = getattr(r, '_revlog', r)
3485 3485 try:
3486 3486 sidedata = r.sidedata(r.lookup(rev))
3487 3487 except KeyError:
3488 3488 raise error.Abort(_(b'invalid revision identifier %s') % rev)
3489 3489 if sidedata:
3490 3490 sidedata = list(sidedata.items())
3491 3491 sidedata.sort()
3492 3492 ui.writenoi18n(b'%d sidedata entries\n' % len(sidedata))
3493 3493 for key, value in sidedata:
3494 3494 ui.writenoi18n(b' entry-%04o size %d\n' % (key, len(value)))
3495 3495 if ui.verbose:
3496 3496 ui.writenoi18n(b' %s\n' % stringutil.pprint(value))
3497 3497
3498 3498
3499 3499 @command(b'debugssl', [], b'[SOURCE]', optionalrepo=True)
3500 3500 def debugssl(ui, repo, source=None, **opts):
3501 3501 """test a secure connection to a server
3502 3502
3503 3503 This builds the certificate chain for the server on Windows, installing the
3504 3504 missing intermediates and trusted root via Windows Update if necessary. It
3505 3505 does nothing on other platforms.
3506 3506
3507 3507 If SOURCE is omitted, the 'default' path will be used. If a URL is given,
3508 3508 that server is used. See :hg:`help urls` for more information.
3509 3509
3510 3510 If the update succeeds, retry the original operation. Otherwise, the cause
3511 3511 of the SSL error is likely another issue.
3512 3512 """
3513 3513 if not pycompat.iswindows:
3514 3514 raise error.Abort(
3515 3515 _(b'certificate chain building is only possible on Windows')
3516 3516 )
3517 3517
3518 3518 if not source:
3519 3519 if not repo:
3520 3520 raise error.Abort(
3521 3521 _(
3522 3522 b"there is no Mercurial repository here, and no "
3523 3523 b"server specified"
3524 3524 )
3525 3525 )
3526 3526 source = b"default"
3527 3527
3528 3528 source, branches = hg.parseurl(ui.expandpath(source))
3529 3529 url = util.url(source)
3530 3530
3531 3531 defaultport = {b'https': 443, b'ssh': 22}
3532 3532 if url.scheme in defaultport:
3533 3533 try:
3534 3534 addr = (url.host, int(url.port or defaultport[url.scheme]))
3535 3535 except ValueError:
3536 3536 raise error.Abort(_(b"malformed port number in URL"))
3537 3537 else:
3538 3538 raise error.Abort(_(b"only https and ssh connections are supported"))
3539 3539
3540 3540 from . import win32
3541 3541
3542 3542 s = ssl.wrap_socket(
3543 3543 socket.socket(),
3544 3544 ssl_version=ssl.PROTOCOL_TLS,
3545 3545 cert_reqs=ssl.CERT_NONE,
3546 3546 ca_certs=None,
3547 3547 )
3548 3548
3549 3549 try:
3550 3550 s.connect(addr)
3551 3551 cert = s.getpeercert(True)
3552 3552
3553 3553 ui.status(_(b'checking the certificate chain for %s\n') % url.host)
3554 3554
3555 3555 complete = win32.checkcertificatechain(cert, build=False)
3556 3556
3557 3557 if not complete:
3558 3558 ui.status(_(b'certificate chain is incomplete, updating... '))
3559 3559
3560 3560 if not win32.checkcertificatechain(cert):
3561 3561 ui.status(_(b'failed.\n'))
3562 3562 else:
3563 3563 ui.status(_(b'done.\n'))
3564 3564 else:
3565 3565 ui.status(_(b'full certificate chain is available\n'))
3566 3566 finally:
3567 3567 s.close()
3568 3568
3569 3569
3570 3570 @command(
3571 3571 b"debugbackupbundle",
3572 3572 [
3573 3573 (
3574 3574 b"",
3575 3575 b"recover",
3576 3576 b"",
3577 3577 b"brings the specified changeset back into the repository",
3578 3578 )
3579 3579 ]
3580 3580 + cmdutil.logopts,
3581 3581 _(b"hg debugbackupbundle [--recover HASH]"),
3582 3582 )
3583 3583 def debugbackupbundle(ui, repo, *pats, **opts):
3584 3584 """lists the changesets available in backup bundles
3585 3585
3586 3586 Without any arguments, this command prints a list of the changesets in each
3587 3587 backup bundle.
3588 3588
3589 3589 --recover takes a changeset hash and unbundles the first bundle that
3590 3590 contains that hash, which puts that changeset back in your repository.
3591 3591
3592 3592 --verbose will print the entire commit message and the bundle path for that
3593 3593 backup.
3594 3594 """
3595 3595 backups = list(
3596 3596 filter(
3597 3597 os.path.isfile, glob.glob(repo.vfs.join(b"strip-backup") + b"/*.hg")
3598 3598 )
3599 3599 )
3600 3600 backups.sort(key=lambda x: os.path.getmtime(x), reverse=True)
3601 3601
3602 3602 opts = pycompat.byteskwargs(opts)
3603 3603 opts[b"bundle"] = b""
3604 3604 opts[b"force"] = None
3605 3605 limit = logcmdutil.getlimit(opts)
3606 3606
3607 3607 def display(other, chlist, displayer):
3608 3608 if opts.get(b"newest_first"):
3609 3609 chlist.reverse()
3610 3610 count = 0
3611 3611 for n in chlist:
3612 3612 if limit is not None and count >= limit:
3613 3613 break
3614 3614 parents = [True for p in other.changelog.parents(n) if p != nullid]
3615 3615 if opts.get(b"no_merges") and len(parents) == 2:
3616 3616 continue
3617 3617 count += 1
3618 3618 displayer.show(other[n])
3619 3619
3620 3620 recovernode = opts.get(b"recover")
3621 3621 if recovernode:
3622 3622 if scmutil.isrevsymbol(repo, recovernode):
3623 3623 ui.warn(_(b"%s already exists in the repo\n") % recovernode)
3624 3624 return
3625 3625 elif backups:
3626 3626 msg = _(
3627 3627 b"Recover changesets using: hg debugbackupbundle --recover "
3628 3628 b"<changeset hash>\n\nAvailable backup changesets:"
3629 3629 )
3630 3630 ui.status(msg, label=b"status.removed")
3631 3631 else:
3632 3632 ui.status(_(b"no backup changesets found\n"))
3633 3633 return
3634 3634
3635 3635 for backup in backups:
3636 3636 # Much of this is copied from the hg incoming logic
3637 3637 source = ui.expandpath(os.path.relpath(backup, encoding.getcwd()))
3638 3638 source, branches = hg.parseurl(source, opts.get(b"branch"))
3639 3639 try:
3640 3640 other = hg.peer(repo, opts, source)
3641 3641 except error.LookupError as ex:
3642 3642 msg = _(b"\nwarning: unable to open bundle %s") % source
3643 3643 hint = _(b"\n(missing parent rev %s)\n") % short(ex.name)
3644 3644 ui.warn(msg, hint=hint)
3645 3645 continue
3646 3646 revs, checkout = hg.addbranchrevs(
3647 3647 repo, other, branches, opts.get(b"rev")
3648 3648 )
3649 3649
3650 3650 if revs:
3651 3651 revs = [other.lookup(rev) for rev in revs]
3652 3652
3653 3653 quiet = ui.quiet
3654 3654 try:
3655 3655 ui.quiet = True
3656 3656 other, chlist, cleanupfn = bundlerepo.getremotechanges(
3657 3657 ui, repo, other, revs, opts[b"bundle"], opts[b"force"]
3658 3658 )
3659 3659 except error.LookupError:
3660 3660 continue
3661 3661 finally:
3662 3662 ui.quiet = quiet
3663 3663
3664 3664 try:
3665 3665 if not chlist:
3666 3666 continue
3667 3667 if recovernode:
3668 3668 with repo.lock(), repo.transaction(b"unbundle") as tr:
3669 3669 if scmutil.isrevsymbol(other, recovernode):
3670 3670 ui.status(_(b"Unbundling %s\n") % (recovernode))
3671 3671 f = hg.openpath(ui, source)
3672 3672 gen = exchange.readbundle(ui, f, source)
3673 3673 if isinstance(gen, bundle2.unbundle20):
3674 3674 bundle2.applybundle(
3675 3675 repo,
3676 3676 gen,
3677 3677 tr,
3678 3678 source=b"unbundle",
3679 3679 url=b"bundle:" + source,
3680 3680 )
3681 3681 else:
3682 3682 gen.apply(repo, b"unbundle", b"bundle:" + source)
3683 3683 break
3684 3684 else:
3685 3685 backupdate = encoding.strtolocal(
3686 3686 time.strftime(
3687 3687 "%a %H:%M, %Y-%m-%d",
3688 3688 time.localtime(os.path.getmtime(source)),
3689 3689 )
3690 3690 )
3691 3691 ui.status(b"\n%s\n" % (backupdate.ljust(50)))
3692 3692 if ui.verbose:
3693 3693 ui.status(b"%s%s\n" % (b"bundle:".ljust(13), source))
3694 3694 else:
3695 3695 opts[
3696 3696 b"template"
3697 3697 ] = b"{label('status.modified', node|short)} {desc|firstline}\n"
3698 3698 displayer = logcmdutil.changesetdisplayer(
3699 3699 ui, other, opts, False
3700 3700 )
3701 3701 display(other, chlist, displayer)
3702 3702 displayer.close()
3703 3703 finally:
3704 3704 cleanupfn()
3705 3705
3706 3706
3707 3707 @command(
3708 3708 b'debugsub',
3709 3709 [(b'r', b'rev', b'', _(b'revision to check'), _(b'REV'))],
3710 3710 _(b'[-r REV] [REV]'),
3711 3711 )
3712 3712 def debugsub(ui, repo, rev=None):
3713 3713 ctx = scmutil.revsingle(repo, rev, None)
3714 3714 for k, v in sorted(ctx.substate.items()):
3715 3715 ui.writenoi18n(b'path %s\n' % k)
3716 3716 ui.writenoi18n(b' source %s\n' % v[0])
3717 3717 ui.writenoi18n(b' revision %s\n' % v[1])
3718 3718
3719 3719
3720 @command(b'debugshell', optionalrepo=True)
3721 def debugshell(ui, repo):
3722 """run an interactive Python interpreter
3723
3724 The local namespace is provided with a reference to the ui and
3725 the repo instance (if available).
3726 """
3727 import code
3728
3729 imported_objects = {
3730 'ui': ui,
3731 'repo': repo,
3732 }
3733
3734 code.interact(local=imported_objects)
3735
3736
3720 3737 @command(
3721 3738 b'debugsuccessorssets',
3722 3739 [(b'', b'closest', False, _(b'return closest successors sets only'))],
3723 3740 _(b'[REV]'),
3724 3741 )
3725 3742 def debugsuccessorssets(ui, repo, *revs, **opts):
3726 3743 """show set of successors for revision
3727 3744
3728 3745 A successors set of changeset A is a consistent group of revisions that
3729 3746 succeed A. It contains non-obsolete changesets only unless closests
3730 3747 successors set is set.
3731 3748
3732 3749 In most cases a changeset A has a single successors set containing a single
3733 3750 successor (changeset A replaced by A').
3734 3751
3735 3752 A changeset that is made obsolete with no successors are called "pruned".
3736 3753 Such changesets have no successors sets at all.
3737 3754
3738 3755 A changeset that has been "split" will have a successors set containing
3739 3756 more than one successor.
3740 3757
3741 3758 A changeset that has been rewritten in multiple different ways is called
3742 3759 "divergent". Such changesets have multiple successor sets (each of which
3743 3760 may also be split, i.e. have multiple successors).
3744 3761
3745 3762 Results are displayed as follows::
3746 3763
3747 3764 <rev1>
3748 3765 <successors-1A>
3749 3766 <rev2>
3750 3767 <successors-2A>
3751 3768 <successors-2B1> <successors-2B2> <successors-2B3>
3752 3769
3753 3770 Here rev2 has two possible (i.e. divergent) successors sets. The first
3754 3771 holds one element, whereas the second holds three (i.e. the changeset has
3755 3772 been split).
3756 3773 """
3757 3774 # passed to successorssets caching computation from one call to another
3758 3775 cache = {}
3759 3776 ctx2str = bytes
3760 3777 node2str = short
3761 3778 for rev in scmutil.revrange(repo, revs):
3762 3779 ctx = repo[rev]
3763 3780 ui.write(b'%s\n' % ctx2str(ctx))
3764 3781 for succsset in obsutil.successorssets(
3765 3782 repo, ctx.node(), closest=opts['closest'], cache=cache
3766 3783 ):
3767 3784 if succsset:
3768 3785 ui.write(b' ')
3769 3786 ui.write(node2str(succsset[0]))
3770 3787 for node in succsset[1:]:
3771 3788 ui.write(b' ')
3772 3789 ui.write(node2str(node))
3773 3790 ui.write(b'\n')
3774 3791
3775 3792
3776 3793 @command(b'debugtagscache', [])
3777 3794 def debugtagscache(ui, repo):
3778 3795 """display the contents of .hg/cache/hgtagsfnodes1"""
3779 3796 cache = tagsmod.hgtagsfnodescache(repo.unfiltered())
3780 3797 for r in repo:
3781 3798 node = repo[r].node()
3782 3799 tagsnode = cache.getfnode(node, computemissing=False)
3783 3800 tagsnodedisplay = hex(tagsnode) if tagsnode else b'missing/invalid'
3784 3801 ui.write(b'%d %s %s\n' % (r, hex(node), tagsnodedisplay))
3785 3802
3786 3803
3787 3804 @command(
3788 3805 b'debugtemplate',
3789 3806 [
3790 3807 (b'r', b'rev', [], _(b'apply template on changesets'), _(b'REV')),
3791 3808 (b'D', b'define', [], _(b'define template keyword'), _(b'KEY=VALUE')),
3792 3809 ],
3793 3810 _(b'[-r REV]... [-D KEY=VALUE]... TEMPLATE'),
3794 3811 optionalrepo=True,
3795 3812 )
3796 3813 def debugtemplate(ui, repo, tmpl, **opts):
3797 3814 """parse and apply a template
3798 3815
3799 3816 If -r/--rev is given, the template is processed as a log template and
3800 3817 applied to the given changesets. Otherwise, it is processed as a generic
3801 3818 template.
3802 3819
3803 3820 Use --verbose to print the parsed tree.
3804 3821 """
3805 3822 revs = None
3806 3823 if opts['rev']:
3807 3824 if repo is None:
3808 3825 raise error.RepoError(
3809 3826 _(b'there is no Mercurial repository here (.hg not found)')
3810 3827 )
3811 3828 revs = scmutil.revrange(repo, opts['rev'])
3812 3829
3813 3830 props = {}
3814 3831 for d in opts['define']:
3815 3832 try:
3816 3833 k, v = (e.strip() for e in d.split(b'=', 1))
3817 3834 if not k or k == b'ui':
3818 3835 raise ValueError
3819 3836 props[k] = v
3820 3837 except ValueError:
3821 3838 raise error.Abort(_(b'malformed keyword definition: %s') % d)
3822 3839
3823 3840 if ui.verbose:
3824 3841 aliases = ui.configitems(b'templatealias')
3825 3842 tree = templater.parse(tmpl)
3826 3843 ui.note(templater.prettyformat(tree), b'\n')
3827 3844 newtree = templater.expandaliases(tree, aliases)
3828 3845 if newtree != tree:
3829 3846 ui.notenoi18n(
3830 3847 b"* expanded:\n", templater.prettyformat(newtree), b'\n'
3831 3848 )
3832 3849
3833 3850 if revs is None:
3834 3851 tres = formatter.templateresources(ui, repo)
3835 3852 t = formatter.maketemplater(ui, tmpl, resources=tres)
3836 3853 if ui.verbose:
3837 3854 kwds, funcs = t.symbolsuseddefault()
3838 3855 ui.writenoi18n(b"* keywords: %s\n" % b', '.join(sorted(kwds)))
3839 3856 ui.writenoi18n(b"* functions: %s\n" % b', '.join(sorted(funcs)))
3840 3857 ui.write(t.renderdefault(props))
3841 3858 else:
3842 3859 displayer = logcmdutil.maketemplater(ui, repo, tmpl)
3843 3860 if ui.verbose:
3844 3861 kwds, funcs = displayer.t.symbolsuseddefault()
3845 3862 ui.writenoi18n(b"* keywords: %s\n" % b', '.join(sorted(kwds)))
3846 3863 ui.writenoi18n(b"* functions: %s\n" % b', '.join(sorted(funcs)))
3847 3864 for r in revs:
3848 3865 displayer.show(repo[r], **pycompat.strkwargs(props))
3849 3866 displayer.close()
3850 3867
3851 3868
3852 3869 @command(
3853 3870 b'debuguigetpass',
3854 3871 [
3855 3872 (b'p', b'prompt', b'', _(b'prompt text'), _(b'TEXT')),
3856 3873 ],
3857 3874 _(b'[-p TEXT]'),
3858 3875 norepo=True,
3859 3876 )
3860 3877 def debuguigetpass(ui, prompt=b''):
3861 3878 """show prompt to type password"""
3862 3879 r = ui.getpass(prompt)
3863 3880 if r is None:
3864 3881 r = b"<default response>"
3865 3882 ui.writenoi18n(b'response: %s\n' % r)
3866 3883
3867 3884
3868 3885 @command(
3869 3886 b'debuguiprompt',
3870 3887 [
3871 3888 (b'p', b'prompt', b'', _(b'prompt text'), _(b'TEXT')),
3872 3889 ],
3873 3890 _(b'[-p TEXT]'),
3874 3891 norepo=True,
3875 3892 )
3876 3893 def debuguiprompt(ui, prompt=b''):
3877 3894 """show plain prompt"""
3878 3895 r = ui.prompt(prompt)
3879 3896 ui.writenoi18n(b'response: %s\n' % r)
3880 3897
3881 3898
3882 3899 @command(b'debugupdatecaches', [])
3883 3900 def debugupdatecaches(ui, repo, *pats, **opts):
3884 3901 """warm all known caches in the repository"""
3885 3902 with repo.wlock(), repo.lock():
3886 3903 repo.updatecaches(full=True)
3887 3904
3888 3905
3889 3906 @command(
3890 3907 b'debugupgraderepo',
3891 3908 [
3892 3909 (
3893 3910 b'o',
3894 3911 b'optimize',
3895 3912 [],
3896 3913 _(b'extra optimization to perform'),
3897 3914 _(b'NAME'),
3898 3915 ),
3899 3916 (b'', b'run', False, _(b'performs an upgrade')),
3900 3917 (b'', b'backup', True, _(b'keep the old repository content around')),
3901 3918 (b'', b'changelog', None, _(b'select the changelog for upgrade')),
3902 3919 (b'', b'manifest', None, _(b'select the manifest for upgrade')),
3903 3920 (b'', b'filelogs', None, _(b'select all filelogs for upgrade')),
3904 3921 ],
3905 3922 )
3906 3923 def debugupgraderepo(ui, repo, run=False, optimize=None, backup=True, **opts):
3907 3924 """upgrade a repository to use different features
3908 3925
3909 3926 If no arguments are specified, the repository is evaluated for upgrade
3910 3927 and a list of problems and potential optimizations is printed.
3911 3928
3912 3929 With ``--run``, a repository upgrade is performed. Behavior of the upgrade
3913 3930 can be influenced via additional arguments. More details will be provided
3914 3931 by the command output when run without ``--run``.
3915 3932
3916 3933 During the upgrade, the repository will be locked and no writes will be
3917 3934 allowed.
3918 3935
3919 3936 At the end of the upgrade, the repository may not be readable while new
3920 3937 repository data is swapped in. This window will be as long as it takes to
3921 3938 rename some directories inside the ``.hg`` directory. On most machines, this
3922 3939 should complete almost instantaneously and the chances of a consumer being
3923 3940 unable to access the repository should be low.
3924 3941
3925 3942 By default, all revlog will be upgraded. You can restrict this using flag
3926 3943 such as `--manifest`:
3927 3944
3928 3945 * `--manifest`: only optimize the manifest
3929 3946 * `--no-manifest`: optimize all revlog but the manifest
3930 3947 * `--changelog`: optimize the changelog only
3931 3948 * `--no-changelog --no-manifest`: optimize filelogs only
3932 3949 * `--filelogs`: optimize the filelogs only
3933 3950 * `--no-changelog --no-manifest --no-filelogs`: skip all revlog optimizations
3934 3951 """
3935 3952 return upgrade.upgraderepo(
3936 3953 ui, repo, run=run, optimize=set(optimize), backup=backup, **opts
3937 3954 )
3938 3955
3939 3956
3940 3957 @command(
3941 3958 b'debugwalk', cmdutil.walkopts, _(b'[OPTION]... [FILE]...'), inferrepo=True
3942 3959 )
3943 3960 def debugwalk(ui, repo, *pats, **opts):
3944 3961 """show how files match on given patterns"""
3945 3962 opts = pycompat.byteskwargs(opts)
3946 3963 m = scmutil.match(repo[None], pats, opts)
3947 3964 if ui.verbose:
3948 3965 ui.writenoi18n(b'* matcher:\n', stringutil.prettyrepr(m), b'\n')
3949 3966 items = list(repo[None].walk(m))
3950 3967 if not items:
3951 3968 return
3952 3969 f = lambda fn: fn
3953 3970 if ui.configbool(b'ui', b'slash') and pycompat.ossep != b'/':
3954 3971 f = lambda fn: util.normpath(fn)
3955 3972 fmt = b'f %%-%ds %%-%ds %%s' % (
3956 3973 max([len(abs) for abs in items]),
3957 3974 max([len(repo.pathto(abs)) for abs in items]),
3958 3975 )
3959 3976 for abs in items:
3960 3977 line = fmt % (
3961 3978 abs,
3962 3979 f(repo.pathto(abs)),
3963 3980 m.exact(abs) and b'exact' or b'',
3964 3981 )
3965 3982 ui.write(b"%s\n" % line.rstrip())
3966 3983
3967 3984
3968 3985 @command(b'debugwhyunstable', [], _(b'REV'))
3969 3986 def debugwhyunstable(ui, repo, rev):
3970 3987 """explain instabilities of a changeset"""
3971 3988 for entry in obsutil.whyunstable(repo, scmutil.revsingle(repo, rev)):
3972 3989 dnodes = b''
3973 3990 if entry.get(b'divergentnodes'):
3974 3991 dnodes = (
3975 3992 b' '.join(
3976 3993 b'%s (%s)' % (ctx.hex(), ctx.phasestr())
3977 3994 for ctx in entry[b'divergentnodes']
3978 3995 )
3979 3996 + b' '
3980 3997 )
3981 3998 ui.write(
3982 3999 b'%s: %s%s %s\n'
3983 4000 % (entry[b'instability'], dnodes, entry[b'reason'], entry[b'node'])
3984 4001 )
3985 4002
3986 4003
3987 4004 @command(
3988 4005 b'debugwireargs',
3989 4006 [
3990 4007 (b'', b'three', b'', b'three'),
3991 4008 (b'', b'four', b'', b'four'),
3992 4009 (b'', b'five', b'', b'five'),
3993 4010 ]
3994 4011 + cmdutil.remoteopts,
3995 4012 _(b'REPO [OPTIONS]... [ONE [TWO]]'),
3996 4013 norepo=True,
3997 4014 )
3998 4015 def debugwireargs(ui, repopath, *vals, **opts):
3999 4016 opts = pycompat.byteskwargs(opts)
4000 4017 repo = hg.peer(ui, opts, repopath)
4001 4018 for opt in cmdutil.remoteopts:
4002 4019 del opts[opt[1]]
4003 4020 args = {}
4004 4021 for k, v in pycompat.iteritems(opts):
4005 4022 if v:
4006 4023 args[k] = v
4007 4024 args = pycompat.strkwargs(args)
4008 4025 # run twice to check that we don't mess up the stream for the next command
4009 4026 res1 = repo.debugwireargs(*vals, **args)
4010 4027 res2 = repo.debugwireargs(*vals, **args)
4011 4028 ui.write(b"%s\n" % res1)
4012 4029 if res1 != res2:
4013 4030 ui.warn(b"%s\n" % res2)
4014 4031
4015 4032
4016 4033 def _parsewirelangblocks(fh):
4017 4034 activeaction = None
4018 4035 blocklines = []
4019 4036 lastindent = 0
4020 4037
4021 4038 for line in fh:
4022 4039 line = line.rstrip()
4023 4040 if not line:
4024 4041 continue
4025 4042
4026 4043 if line.startswith(b'#'):
4027 4044 continue
4028 4045
4029 4046 if not line.startswith(b' '):
4030 4047 # New block. Flush previous one.
4031 4048 if activeaction:
4032 4049 yield activeaction, blocklines
4033 4050
4034 4051 activeaction = line
4035 4052 blocklines = []
4036 4053 lastindent = 0
4037 4054 continue
4038 4055
4039 4056 # Else we start with an indent.
4040 4057
4041 4058 if not activeaction:
4042 4059 raise error.Abort(_(b'indented line outside of block'))
4043 4060
4044 4061 indent = len(line) - len(line.lstrip())
4045 4062
4046 4063 # If this line is indented more than the last line, concatenate it.
4047 4064 if indent > lastindent and blocklines:
4048 4065 blocklines[-1] += line.lstrip()
4049 4066 else:
4050 4067 blocklines.append(line)
4051 4068 lastindent = indent
4052 4069
4053 4070 # Flush last block.
4054 4071 if activeaction:
4055 4072 yield activeaction, blocklines
4056 4073
4057 4074
4058 4075 @command(
4059 4076 b'debugwireproto',
4060 4077 [
4061 4078 (b'', b'localssh', False, _(b'start an SSH server for this repo')),
4062 4079 (b'', b'peer', b'', _(b'construct a specific version of the peer')),
4063 4080 (
4064 4081 b'',
4065 4082 b'noreadstderr',
4066 4083 False,
4067 4084 _(b'do not read from stderr of the remote'),
4068 4085 ),
4069 4086 (
4070 4087 b'',
4071 4088 b'nologhandshake',
4072 4089 False,
4073 4090 _(b'do not log I/O related to the peer handshake'),
4074 4091 ),
4075 4092 ]
4076 4093 + cmdutil.remoteopts,
4077 4094 _(b'[PATH]'),
4078 4095 optionalrepo=True,
4079 4096 )
4080 4097 def debugwireproto(ui, repo, path=None, **opts):
4081 4098 """send wire protocol commands to a server
4082 4099
4083 4100 This command can be used to issue wire protocol commands to remote
4084 4101 peers and to debug the raw data being exchanged.
4085 4102
4086 4103 ``--localssh`` will start an SSH server against the current repository
4087 4104 and connect to that. By default, the connection will perform a handshake
4088 4105 and establish an appropriate peer instance.
4089 4106
4090 4107 ``--peer`` can be used to bypass the handshake protocol and construct a
4091 4108 peer instance using the specified class type. Valid values are ``raw``,
4092 4109 ``http2``, ``ssh1``, and ``ssh2``. ``raw`` instances only allow sending
4093 4110 raw data payloads and don't support higher-level command actions.
4094 4111
4095 4112 ``--noreadstderr`` can be used to disable automatic reading from stderr
4096 4113 of the peer (for SSH connections only). Disabling automatic reading of
4097 4114 stderr is useful for making output more deterministic.
4098 4115
4099 4116 Commands are issued via a mini language which is specified via stdin.
4100 4117 The language consists of individual actions to perform. An action is
4101 4118 defined by a block. A block is defined as a line with no leading
4102 4119 space followed by 0 or more lines with leading space. Blocks are
4103 4120 effectively a high-level command with additional metadata.
4104 4121
4105 4122 Lines beginning with ``#`` are ignored.
4106 4123
4107 4124 The following sections denote available actions.
4108 4125
4109 4126 raw
4110 4127 ---
4111 4128
4112 4129 Send raw data to the server.
4113 4130
4114 4131 The block payload contains the raw data to send as one atomic send
4115 4132 operation. The data may not actually be delivered in a single system
4116 4133 call: it depends on the abilities of the transport being used.
4117 4134
4118 4135 Each line in the block is de-indented and concatenated. Then, that
4119 4136 value is evaluated as a Python b'' literal. This allows the use of
4120 4137 backslash escaping, etc.
4121 4138
4122 4139 raw+
4123 4140 ----
4124 4141
4125 4142 Behaves like ``raw`` except flushes output afterwards.
4126 4143
4127 4144 command <X>
4128 4145 -----------
4129 4146
4130 4147 Send a request to run a named command, whose name follows the ``command``
4131 4148 string.
4132 4149
4133 4150 Arguments to the command are defined as lines in this block. The format of
4134 4151 each line is ``<key> <value>``. e.g.::
4135 4152
4136 4153 command listkeys
4137 4154 namespace bookmarks
4138 4155
4139 4156 If the value begins with ``eval:``, it will be interpreted as a Python
4140 4157 literal expression. Otherwise values are interpreted as Python b'' literals.
4141 4158 This allows sending complex types and encoding special byte sequences via
4142 4159 backslash escaping.
4143 4160
4144 4161 The following arguments have special meaning:
4145 4162
4146 4163 ``PUSHFILE``
4147 4164 When defined, the *push* mechanism of the peer will be used instead
4148 4165 of the static request-response mechanism and the content of the
4149 4166 file specified in the value of this argument will be sent as the
4150 4167 command payload.
4151 4168
4152 4169 This can be used to submit a local bundle file to the remote.
4153 4170
4154 4171 batchbegin
4155 4172 ----------
4156 4173
4157 4174 Instruct the peer to begin a batched send.
4158 4175
4159 4176 All ``command`` blocks are queued for execution until the next
4160 4177 ``batchsubmit`` block.
4161 4178
4162 4179 batchsubmit
4163 4180 -----------
4164 4181
4165 4182 Submit previously queued ``command`` blocks as a batch request.
4166 4183
4167 4184 This action MUST be paired with a ``batchbegin`` action.
4168 4185
4169 4186 httprequest <method> <path>
4170 4187 ---------------------------
4171 4188
4172 4189 (HTTP peer only)
4173 4190
4174 4191 Send an HTTP request to the peer.
4175 4192
4176 4193 The HTTP request line follows the ``httprequest`` action. e.g. ``GET /foo``.
4177 4194
4178 4195 Arguments of the form ``<key>: <value>`` are interpreted as HTTP request
4179 4196 headers to add to the request. e.g. ``Accept: foo``.
4180 4197
4181 4198 The following arguments are special:
4182 4199
4183 4200 ``BODYFILE``
4184 4201 The content of the file defined as the value to this argument will be
4185 4202 transferred verbatim as the HTTP request body.
4186 4203
4187 4204 ``frame <type> <flags> <payload>``
4188 4205 Send a unified protocol frame as part of the request body.
4189 4206
4190 4207 All frames will be collected and sent as the body to the HTTP
4191 4208 request.
4192 4209
4193 4210 close
4194 4211 -----
4195 4212
4196 4213 Close the connection to the server.
4197 4214
4198 4215 flush
4199 4216 -----
4200 4217
4201 4218 Flush data written to the server.
4202 4219
4203 4220 readavailable
4204 4221 -------------
4205 4222
4206 4223 Close the write end of the connection and read all available data from
4207 4224 the server.
4208 4225
4209 4226 If the connection to the server encompasses multiple pipes, we poll both
4210 4227 pipes and read available data.
4211 4228
4212 4229 readline
4213 4230 --------
4214 4231
4215 4232 Read a line of output from the server. If there are multiple output
4216 4233 pipes, reads only the main pipe.
4217 4234
4218 4235 ereadline
4219 4236 ---------
4220 4237
4221 4238 Like ``readline``, but read from the stderr pipe, if available.
4222 4239
4223 4240 read <X>
4224 4241 --------
4225 4242
4226 4243 ``read()`` N bytes from the server's main output pipe.
4227 4244
4228 4245 eread <X>
4229 4246 ---------
4230 4247
4231 4248 ``read()`` N bytes from the server's stderr pipe, if available.
4232 4249
4233 4250 Specifying Unified Frame-Based Protocol Frames
4234 4251 ----------------------------------------------
4235 4252
4236 4253 It is possible to emit a *Unified Frame-Based Protocol* by using special
4237 4254 syntax.
4238 4255
4239 4256 A frame is composed as a type, flags, and payload. These can be parsed
4240 4257 from a string of the form:
4241 4258
4242 4259 <request-id> <stream-id> <stream-flags> <type> <flags> <payload>
4243 4260
4244 4261 ``request-id`` and ``stream-id`` are integers defining the request and
4245 4262 stream identifiers.
4246 4263
4247 4264 ``type`` can be an integer value for the frame type or the string name
4248 4265 of the type. The strings are defined in ``wireprotoframing.py``. e.g.
4249 4266 ``command-name``.
4250 4267
4251 4268 ``stream-flags`` and ``flags`` are a ``|`` delimited list of flag
4252 4269 components. Each component (and there can be just one) can be an integer
4253 4270 or a flag name for stream flags or frame flags, respectively. Values are
4254 4271 resolved to integers and then bitwise OR'd together.
4255 4272
4256 4273 ``payload`` represents the raw frame payload. If it begins with
4257 4274 ``cbor:``, the following string is evaluated as Python code and the
4258 4275 resulting object is fed into a CBOR encoder. Otherwise it is interpreted
4259 4276 as a Python byte string literal.
4260 4277 """
4261 4278 opts = pycompat.byteskwargs(opts)
4262 4279
4263 4280 if opts[b'localssh'] and not repo:
4264 4281 raise error.Abort(_(b'--localssh requires a repository'))
4265 4282
4266 4283 if opts[b'peer'] and opts[b'peer'] not in (
4267 4284 b'raw',
4268 4285 b'http2',
4269 4286 b'ssh1',
4270 4287 b'ssh2',
4271 4288 ):
4272 4289 raise error.Abort(
4273 4290 _(b'invalid value for --peer'),
4274 4291 hint=_(b'valid values are "raw", "ssh1", and "ssh2"'),
4275 4292 )
4276 4293
4277 4294 if path and opts[b'localssh']:
4278 4295 raise error.Abort(_(b'cannot specify --localssh with an explicit path'))
4279 4296
4280 4297 if ui.interactive():
4281 4298 ui.write(_(b'(waiting for commands on stdin)\n'))
4282 4299
4283 4300 blocks = list(_parsewirelangblocks(ui.fin))
4284 4301
4285 4302 proc = None
4286 4303 stdin = None
4287 4304 stdout = None
4288 4305 stderr = None
4289 4306 opener = None
4290 4307
4291 4308 if opts[b'localssh']:
4292 4309 # We start the SSH server in its own process so there is process
4293 4310 # separation. This prevents a whole class of potential bugs around
4294 4311 # shared state from interfering with server operation.
4295 4312 args = procutil.hgcmd() + [
4296 4313 b'-R',
4297 4314 repo.root,
4298 4315 b'debugserve',
4299 4316 b'--sshstdio',
4300 4317 ]
4301 4318 proc = subprocess.Popen(
4302 4319 pycompat.rapply(procutil.tonativestr, args),
4303 4320 stdin=subprocess.PIPE,
4304 4321 stdout=subprocess.PIPE,
4305 4322 stderr=subprocess.PIPE,
4306 4323 bufsize=0,
4307 4324 )
4308 4325
4309 4326 stdin = proc.stdin
4310 4327 stdout = proc.stdout
4311 4328 stderr = proc.stderr
4312 4329
4313 4330 # We turn the pipes into observers so we can log I/O.
4314 4331 if ui.verbose or opts[b'peer'] == b'raw':
4315 4332 stdin = util.makeloggingfileobject(
4316 4333 ui, proc.stdin, b'i', logdata=True
4317 4334 )
4318 4335 stdout = util.makeloggingfileobject(
4319 4336 ui, proc.stdout, b'o', logdata=True
4320 4337 )
4321 4338 stderr = util.makeloggingfileobject(
4322 4339 ui, proc.stderr, b'e', logdata=True
4323 4340 )
4324 4341
4325 4342 # --localssh also implies the peer connection settings.
4326 4343
4327 4344 url = b'ssh://localserver'
4328 4345 autoreadstderr = not opts[b'noreadstderr']
4329 4346
4330 4347 if opts[b'peer'] == b'ssh1':
4331 4348 ui.write(_(b'creating ssh peer for wire protocol version 1\n'))
4332 4349 peer = sshpeer.sshv1peer(
4333 4350 ui,
4334 4351 url,
4335 4352 proc,
4336 4353 stdin,
4337 4354 stdout,
4338 4355 stderr,
4339 4356 None,
4340 4357 autoreadstderr=autoreadstderr,
4341 4358 )
4342 4359 elif opts[b'peer'] == b'ssh2':
4343 4360 ui.write(_(b'creating ssh peer for wire protocol version 2\n'))
4344 4361 peer = sshpeer.sshv2peer(
4345 4362 ui,
4346 4363 url,
4347 4364 proc,
4348 4365 stdin,
4349 4366 stdout,
4350 4367 stderr,
4351 4368 None,
4352 4369 autoreadstderr=autoreadstderr,
4353 4370 )
4354 4371 elif opts[b'peer'] == b'raw':
4355 4372 ui.write(_(b'using raw connection to peer\n'))
4356 4373 peer = None
4357 4374 else:
4358 4375 ui.write(_(b'creating ssh peer from handshake results\n'))
4359 4376 peer = sshpeer.makepeer(
4360 4377 ui,
4361 4378 url,
4362 4379 proc,
4363 4380 stdin,
4364 4381 stdout,
4365 4382 stderr,
4366 4383 autoreadstderr=autoreadstderr,
4367 4384 )
4368 4385
4369 4386 elif path:
4370 4387 # We bypass hg.peer() so we can proxy the sockets.
4371 4388 # TODO consider not doing this because we skip
4372 4389 # ``hg.wirepeersetupfuncs`` and potentially other useful functionality.
4373 4390 u = util.url(path)
4374 4391 if u.scheme != b'http':
4375 4392 raise error.Abort(_(b'only http:// paths are currently supported'))
4376 4393
4377 4394 url, authinfo = u.authinfo()
4378 4395 openerargs = {
4379 4396 'useragent': b'Mercurial debugwireproto',
4380 4397 }
4381 4398
4382 4399 # Turn pipes/sockets into observers so we can log I/O.
4383 4400 if ui.verbose:
4384 4401 openerargs.update(
4385 4402 {
4386 4403 'loggingfh': ui,
4387 4404 'loggingname': b's',
4388 4405 'loggingopts': {
4389 4406 'logdata': True,
4390 4407 'logdataapis': False,
4391 4408 },
4392 4409 }
4393 4410 )
4394 4411
4395 4412 if ui.debugflag:
4396 4413 openerargs['loggingopts']['logdataapis'] = True
4397 4414
4398 4415 # Don't send default headers when in raw mode. This allows us to
4399 4416 # bypass most of the behavior of our URL handling code so we can
4400 4417 # have near complete control over what's sent on the wire.
4401 4418 if opts[b'peer'] == b'raw':
4402 4419 openerargs['sendaccept'] = False
4403 4420
4404 4421 opener = urlmod.opener(ui, authinfo, **openerargs)
4405 4422
4406 4423 if opts[b'peer'] == b'http2':
4407 4424 ui.write(_(b'creating http peer for wire protocol version 2\n'))
4408 4425 # We go through makepeer() because we need an API descriptor for
4409 4426 # the peer instance to be useful.
4410 4427 with ui.configoverride(
4411 4428 {(b'experimental', b'httppeer.advertise-v2'): True}
4412 4429 ):
4413 4430 if opts[b'nologhandshake']:
4414 4431 ui.pushbuffer()
4415 4432
4416 4433 peer = httppeer.makepeer(ui, path, opener=opener)
4417 4434
4418 4435 if opts[b'nologhandshake']:
4419 4436 ui.popbuffer()
4420 4437
4421 4438 if not isinstance(peer, httppeer.httpv2peer):
4422 4439 raise error.Abort(
4423 4440 _(
4424 4441 b'could not instantiate HTTP peer for '
4425 4442 b'wire protocol version 2'
4426 4443 ),
4427 4444 hint=_(
4428 4445 b'the server may not have the feature '
4429 4446 b'enabled or is not allowing this '
4430 4447 b'client version'
4431 4448 ),
4432 4449 )
4433 4450
4434 4451 elif opts[b'peer'] == b'raw':
4435 4452 ui.write(_(b'using raw connection to peer\n'))
4436 4453 peer = None
4437 4454 elif opts[b'peer']:
4438 4455 raise error.Abort(
4439 4456 _(b'--peer %s not supported with HTTP peers') % opts[b'peer']
4440 4457 )
4441 4458 else:
4442 4459 peer = httppeer.makepeer(ui, path, opener=opener)
4443 4460
4444 4461 # We /could/ populate stdin/stdout with sock.makefile()...
4445 4462 else:
4446 4463 raise error.Abort(_(b'unsupported connection configuration'))
4447 4464
4448 4465 batchedcommands = None
4449 4466
4450 4467 # Now perform actions based on the parsed wire language instructions.
4451 4468 for action, lines in blocks:
4452 4469 if action in (b'raw', b'raw+'):
4453 4470 if not stdin:
4454 4471 raise error.Abort(_(b'cannot call raw/raw+ on this peer'))
4455 4472
4456 4473 # Concatenate the data together.
4457 4474 data = b''.join(l.lstrip() for l in lines)
4458 4475 data = stringutil.unescapestr(data)
4459 4476 stdin.write(data)
4460 4477
4461 4478 if action == b'raw+':
4462 4479 stdin.flush()
4463 4480 elif action == b'flush':
4464 4481 if not stdin:
4465 4482 raise error.Abort(_(b'cannot call flush on this peer'))
4466 4483 stdin.flush()
4467 4484 elif action.startswith(b'command'):
4468 4485 if not peer:
4469 4486 raise error.Abort(
4470 4487 _(
4471 4488 b'cannot send commands unless peer instance '
4472 4489 b'is available'
4473 4490 )
4474 4491 )
4475 4492
4476 4493 command = action.split(b' ', 1)[1]
4477 4494
4478 4495 args = {}
4479 4496 for line in lines:
4480 4497 # We need to allow empty values.
4481 4498 fields = line.lstrip().split(b' ', 1)
4482 4499 if len(fields) == 1:
4483 4500 key = fields[0]
4484 4501 value = b''
4485 4502 else:
4486 4503 key, value = fields
4487 4504
4488 4505 if value.startswith(b'eval:'):
4489 4506 value = stringutil.evalpythonliteral(value[5:])
4490 4507 else:
4491 4508 value = stringutil.unescapestr(value)
4492 4509
4493 4510 args[key] = value
4494 4511
4495 4512 if batchedcommands is not None:
4496 4513 batchedcommands.append((command, args))
4497 4514 continue
4498 4515
4499 4516 ui.status(_(b'sending %s command\n') % command)
4500 4517
4501 4518 if b'PUSHFILE' in args:
4502 4519 with open(args[b'PUSHFILE'], 'rb') as fh:
4503 4520 del args[b'PUSHFILE']
4504 4521 res, output = peer._callpush(
4505 4522 command, fh, **pycompat.strkwargs(args)
4506 4523 )
4507 4524 ui.status(_(b'result: %s\n') % stringutil.escapestr(res))
4508 4525 ui.status(
4509 4526 _(b'remote output: %s\n') % stringutil.escapestr(output)
4510 4527 )
4511 4528 else:
4512 4529 with peer.commandexecutor() as e:
4513 4530 res = e.callcommand(command, args).result()
4514 4531
4515 4532 if isinstance(res, wireprotov2peer.commandresponse):
4516 4533 val = res.objects()
4517 4534 ui.status(
4518 4535 _(b'response: %s\n')
4519 4536 % stringutil.pprint(val, bprefix=True, indent=2)
4520 4537 )
4521 4538 else:
4522 4539 ui.status(
4523 4540 _(b'response: %s\n')
4524 4541 % stringutil.pprint(res, bprefix=True, indent=2)
4525 4542 )
4526 4543
4527 4544 elif action == b'batchbegin':
4528 4545 if batchedcommands is not None:
4529 4546 raise error.Abort(_(b'nested batchbegin not allowed'))
4530 4547
4531 4548 batchedcommands = []
4532 4549 elif action == b'batchsubmit':
4533 4550 # There is a batching API we could go through. But it would be
4534 4551 # difficult to normalize requests into function calls. It is easier
4535 4552 # to bypass this layer and normalize to commands + args.
4536 4553 ui.status(
4537 4554 _(b'sending batch with %d sub-commands\n')
4538 4555 % len(batchedcommands)
4539 4556 )
4540 4557 assert peer is not None
4541 4558 for i, chunk in enumerate(peer._submitbatch(batchedcommands)):
4542 4559 ui.status(
4543 4560 _(b'response #%d: %s\n') % (i, stringutil.escapestr(chunk))
4544 4561 )
4545 4562
4546 4563 batchedcommands = None
4547 4564
4548 4565 elif action.startswith(b'httprequest '):
4549 4566 if not opener:
4550 4567 raise error.Abort(
4551 4568 _(b'cannot use httprequest without an HTTP peer')
4552 4569 )
4553 4570
4554 4571 request = action.split(b' ', 2)
4555 4572 if len(request) != 3:
4556 4573 raise error.Abort(
4557 4574 _(
4558 4575 b'invalid httprequest: expected format is '
4559 4576 b'"httprequest <method> <path>'
4560 4577 )
4561 4578 )
4562 4579
4563 4580 method, httppath = request[1:]
4564 4581 headers = {}
4565 4582 body = None
4566 4583 frames = []
4567 4584 for line in lines:
4568 4585 line = line.lstrip()
4569 4586 m = re.match(b'^([a-zA-Z0-9_-]+): (.*)$', line)
4570 4587 if m:
4571 4588 # Headers need to use native strings.
4572 4589 key = pycompat.strurl(m.group(1))
4573 4590 value = pycompat.strurl(m.group(2))
4574 4591 headers[key] = value
4575 4592 continue
4576 4593
4577 4594 if line.startswith(b'BODYFILE '):
4578 4595 with open(line.split(b' ', 1), b'rb') as fh:
4579 4596 body = fh.read()
4580 4597 elif line.startswith(b'frame '):
4581 4598 frame = wireprotoframing.makeframefromhumanstring(
4582 4599 line[len(b'frame ') :]
4583 4600 )
4584 4601
4585 4602 frames.append(frame)
4586 4603 else:
4587 4604 raise error.Abort(
4588 4605 _(b'unknown argument to httprequest: %s') % line
4589 4606 )
4590 4607
4591 4608 url = path + httppath
4592 4609
4593 4610 if frames:
4594 4611 body = b''.join(bytes(f) for f in frames)
4595 4612
4596 4613 req = urlmod.urlreq.request(pycompat.strurl(url), body, headers)
4597 4614
4598 4615 # urllib.Request insists on using has_data() as a proxy for
4599 4616 # determining the request method. Override that to use our
4600 4617 # explicitly requested method.
4601 4618 req.get_method = lambda: pycompat.sysstr(method)
4602 4619
4603 4620 try:
4604 4621 res = opener.open(req)
4605 4622 body = res.read()
4606 4623 except util.urlerr.urlerror as e:
4607 4624 # read() method must be called, but only exists in Python 2
4608 4625 getattr(e, 'read', lambda: None)()
4609 4626 continue
4610 4627
4611 4628 ct = res.headers.get('Content-Type')
4612 4629 if ct == 'application/mercurial-cbor':
4613 4630 ui.write(
4614 4631 _(b'cbor> %s\n')
4615 4632 % stringutil.pprint(
4616 4633 cborutil.decodeall(body), bprefix=True, indent=2
4617 4634 )
4618 4635 )
4619 4636
4620 4637 elif action == b'close':
4621 4638 assert peer is not None
4622 4639 peer.close()
4623 4640 elif action == b'readavailable':
4624 4641 if not stdout or not stderr:
4625 4642 raise error.Abort(
4626 4643 _(b'readavailable not available on this peer')
4627 4644 )
4628 4645
4629 4646 stdin.close()
4630 4647 stdout.read()
4631 4648 stderr.read()
4632 4649
4633 4650 elif action == b'readline':
4634 4651 if not stdout:
4635 4652 raise error.Abort(_(b'readline not available on this peer'))
4636 4653 stdout.readline()
4637 4654 elif action == b'ereadline':
4638 4655 if not stderr:
4639 4656 raise error.Abort(_(b'ereadline not available on this peer'))
4640 4657 stderr.readline()
4641 4658 elif action.startswith(b'read '):
4642 4659 count = int(action.split(b' ', 1)[1])
4643 4660 if not stdout:
4644 4661 raise error.Abort(_(b'read not available on this peer'))
4645 4662 stdout.read(count)
4646 4663 elif action.startswith(b'eread '):
4647 4664 count = int(action.split(b' ', 1)[1])
4648 4665 if not stderr:
4649 4666 raise error.Abort(_(b'eread not available on this peer'))
4650 4667 stderr.read(count)
4651 4668 else:
4652 4669 raise error.Abort(_(b'unknown action: %s') % action)
4653 4670
4654 4671 if batchedcommands is not None:
4655 4672 raise error.Abort(_(b'unclosed "batchbegin" request'))
4656 4673
4657 4674 if peer:
4658 4675 peer.close()
4659 4676
4660 4677 if proc:
4661 4678 proc.kill()
@@ -1,441 +1,443 b''
1 1 Show all commands except debug commands
2 2 $ hg debugcomplete
3 3 abort
4 4 add
5 5 addremove
6 6 annotate
7 7 archive
8 8 backout
9 9 bisect
10 10 bookmarks
11 11 branch
12 12 branches
13 13 bundle
14 14 cat
15 15 clone
16 16 commit
17 17 config
18 18 continue
19 19 copy
20 20 diff
21 21 export
22 22 files
23 23 forget
24 24 graft
25 25 grep
26 26 heads
27 27 help
28 28 identify
29 29 import
30 30 incoming
31 31 init
32 32 locate
33 33 log
34 34 manifest
35 35 merge
36 36 outgoing
37 37 parents
38 38 paths
39 39 phase
40 40 pull
41 41 purge
42 42 push
43 43 recover
44 44 remove
45 45 rename
46 46 resolve
47 47 revert
48 48 rollback
49 49 root
50 50 serve
51 51 shelve
52 52 status
53 53 summary
54 54 tag
55 55 tags
56 56 tip
57 57 unbundle
58 58 unshelve
59 59 update
60 60 verify
61 61 version
62 62
63 63 Show all commands that start with "a"
64 64 $ hg debugcomplete a
65 65 abort
66 66 add
67 67 addremove
68 68 annotate
69 69 archive
70 70
71 71 Do not show debug commands if there are other candidates
72 72 $ hg debugcomplete d
73 73 diff
74 74
75 75 Show debug commands if there are no other candidates
76 76 $ hg debugcomplete debug
77 77 debugancestor
78 78 debugantivirusrunning
79 79 debugapplystreamclonebundle
80 80 debugbackupbundle
81 81 debugbuilddag
82 82 debugbundle
83 83 debugcapabilities
84 84 debugchangedfiles
85 85 debugcheckstate
86 86 debugcolor
87 87 debugcommands
88 88 debugcomplete
89 89 debugconfig
90 90 debugcreatestreamclonebundle
91 91 debugdag
92 92 debugdata
93 93 debugdate
94 94 debugdeltachain
95 95 debugdirstate
96 96 debugdiscovery
97 97 debugdownload
98 98 debugextensions
99 99 debugfileset
100 100 debugformat
101 101 debugfsinfo
102 102 debuggetbundle
103 103 debugignore
104 104 debugindex
105 105 debugindexdot
106 106 debugindexstats
107 107 debuginstall
108 108 debugknown
109 109 debuglabelcomplete
110 110 debuglocks
111 111 debugmanifestfulltextcache
112 112 debugmergestate
113 113 debugnamecomplete
114 114 debugnodemap
115 115 debugobsolete
116 116 debugp1copies
117 117 debugp2copies
118 118 debugpathcomplete
119 119 debugpathcopies
120 120 debugpeer
121 121 debugpickmergetool
122 122 debugpushkey
123 123 debugpvec
124 124 debugrebuilddirstate
125 125 debugrebuildfncache
126 126 debugrename
127 127 debugrequires
128 128 debugrevlog
129 129 debugrevlogindex
130 130 debugrevspec
131 131 debugserve
132 132 debugsetparents
133 debugshell
133 134 debugsidedata
134 135 debugssl
135 136 debugstrip
136 137 debugsub
137 138 debugsuccessorssets
138 139 debugtagscache
139 140 debugtemplate
140 141 debuguigetpass
141 142 debuguiprompt
142 143 debugupdatecaches
143 144 debugupgraderepo
144 145 debugwalk
145 146 debugwhyunstable
146 147 debugwireargs
147 148 debugwireproto
148 149
149 150 Do not show the alias of a debug command if there are other candidates
150 151 (this should hide rawcommit)
151 152 $ hg debugcomplete r
152 153 recover
153 154 remove
154 155 rename
155 156 resolve
156 157 revert
157 158 rollback
158 159 root
159 160 Show the alias of a debug command if there are no other candidates
160 161 $ hg debugcomplete rawc
161 162
162 163
163 164 Show the global options
164 165 $ hg debugcomplete --options | sort
165 166 --color
166 167 --config
167 168 --cwd
168 169 --debug
169 170 --debugger
170 171 --encoding
171 172 --encodingmode
172 173 --help
173 174 --hidden
174 175 --noninteractive
175 176 --pager
176 177 --profile
177 178 --quiet
178 179 --repository
179 180 --time
180 181 --traceback
181 182 --verbose
182 183 --version
183 184 -R
184 185 -h
185 186 -q
186 187 -v
187 188 -y
188 189
189 190 Show the options for the "serve" command
190 191 $ hg debugcomplete --options serve | sort
191 192 --accesslog
192 193 --address
193 194 --certificate
194 195 --cmdserver
195 196 --color
196 197 --config
197 198 --cwd
198 199 --daemon
199 200 --daemon-postexec
200 201 --debug
201 202 --debugger
202 203 --encoding
203 204 --encodingmode
204 205 --errorlog
205 206 --help
206 207 --hidden
207 208 --ipv6
208 209 --name
209 210 --noninteractive
210 211 --pager
211 212 --pid-file
212 213 --port
213 214 --prefix
214 215 --print-url
215 216 --profile
216 217 --quiet
217 218 --repository
218 219 --stdio
219 220 --style
220 221 --subrepos
221 222 --templates
222 223 --time
223 224 --traceback
224 225 --verbose
225 226 --version
226 227 --web-conf
227 228 -6
228 229 -A
229 230 -E
230 231 -R
231 232 -S
232 233 -a
233 234 -d
234 235 -h
235 236 -n
236 237 -p
237 238 -q
238 239 -t
239 240 -v
240 241 -y
241 242
242 243 Show an error if we use --options with an ambiguous abbreviation
243 244 $ hg debugcomplete --options s
244 245 hg: command 's' is ambiguous:
245 246 serve shelve showconfig status summary
246 247 [10]
247 248
248 249 Show all commands + options
249 250 $ hg debugcommands
250 251 abort: dry-run
251 252 add: include, exclude, subrepos, dry-run
252 253 addremove: similarity, subrepos, include, exclude, dry-run
253 254 annotate: rev, follow, no-follow, text, user, file, date, number, changeset, line-number, skip, ignore-all-space, ignore-space-change, ignore-blank-lines, ignore-space-at-eol, include, exclude, template
254 255 archive: no-decode, prefix, rev, type, subrepos, include, exclude
255 256 backout: merge, commit, no-commit, parent, rev, edit, tool, include, exclude, message, logfile, date, user
256 257 bisect: reset, good, bad, skip, extend, command, noupdate
257 258 bookmarks: force, rev, delete, rename, inactive, list, template
258 259 branch: force, clean, rev
259 260 branches: active, closed, rev, template
260 261 bundle: force, rev, branch, base, all, type, ssh, remotecmd, insecure
261 262 cat: output, rev, decode, include, exclude, template
262 263 clone: noupdate, updaterev, rev, branch, pull, uncompressed, stream, ssh, remotecmd, insecure
263 264 commit: addremove, close-branch, amend, secret, edit, force-close-branch, interactive, include, exclude, message, logfile, date, user, subrepos
264 265 config: untrusted, edit, local, shared, non-shared, global, template
265 266 continue: dry-run
266 267 copy: forget, after, at-rev, force, include, exclude, dry-run
267 268 debugancestor:
268 269 debugantivirusrunning:
269 270 debugapplystreamclonebundle:
270 271 debugbackupbundle: recover, patch, git, limit, no-merges, stat, graph, style, template
271 272 debugbuilddag: mergeable-file, overwritten-file, new-file
272 273 debugbundle: all, part-type, spec
273 274 debugcapabilities:
274 275 debugchangedfiles:
275 276 debugcheckstate:
276 277 debugcolor: style
277 278 debugcommands:
278 279 debugcomplete: options
279 280 debugcreatestreamclonebundle:
280 281 debugdag: tags, branches, dots, spaces
281 282 debugdata: changelog, manifest, dir
282 283 debugdate: extended
283 284 debugdeltachain: changelog, manifest, dir, template
284 285 debugdirstate: nodates, dates, datesort
285 286 debugdiscovery: old, nonheads, rev, seed, ssh, remotecmd, insecure
286 287 debugdownload: output
287 288 debugextensions: template
288 289 debugfileset: rev, all-files, show-matcher, show-stage
289 290 debugformat: template
290 291 debugfsinfo:
291 292 debuggetbundle: head, common, type
292 293 debugignore:
293 294 debugindex: changelog, manifest, dir, template
294 295 debugindexdot: changelog, manifest, dir
295 296 debugindexstats:
296 297 debuginstall: template
297 298 debugknown:
298 299 debuglabelcomplete:
299 300 debuglocks: force-free-lock, force-free-wlock, set-lock, set-wlock
300 301 debugmanifestfulltextcache: clear, add
301 302 debugmergestate: style, template
302 303 debugnamecomplete:
303 304 debugnodemap: dump-new, dump-disk, check, metadata
304 305 debugobsolete: flags, record-parents, rev, exclusive, index, delete, date, user, template
305 306 debugp1copies: rev
306 307 debugp2copies: rev
307 308 debugpathcomplete: full, normal, added, removed
308 309 debugpathcopies: include, exclude
309 310 debugpeer:
310 311 debugpickmergetool: rev, changedelete, include, exclude, tool
311 312 debugpushkey:
312 313 debugpvec:
313 314 debugrebuilddirstate: rev, minimal
314 315 debugrebuildfncache:
315 316 debugrename: rev
316 317 debugrequires:
317 318 debugrevlog: changelog, manifest, dir, dump
318 319 debugrevlogindex: changelog, manifest, dir, format
319 320 debugrevspec: optimize, show-revs, show-set, show-stage, no-optimized, verify-optimized
320 321 debugserve: sshstdio, logiofd, logiofile
321 322 debugsetparents:
323 debugshell:
322 324 debugsidedata: changelog, manifest, dir
323 325 debugssl:
324 326 debugstrip: rev, force, no-backup, nobackup, , keep, bookmark, soft
325 327 debugsub: rev
326 328 debugsuccessorssets: closest
327 329 debugtagscache:
328 330 debugtemplate: rev, define
329 331 debuguigetpass: prompt
330 332 debuguiprompt: prompt
331 333 debugupdatecaches:
332 334 debugupgraderepo: optimize, run, backup, changelog, manifest, filelogs
333 335 debugwalk: include, exclude
334 336 debugwhyunstable:
335 337 debugwireargs: three, four, five, ssh, remotecmd, insecure
336 338 debugwireproto: localssh, peer, noreadstderr, nologhandshake, ssh, remotecmd, insecure
337 339 diff: rev, from, to, change, text, git, binary, nodates, noprefix, show-function, reverse, ignore-all-space, ignore-space-change, ignore-blank-lines, ignore-space-at-eol, unified, stat, root, include, exclude, subrepos
338 340 export: bookmark, output, switch-parent, rev, text, git, binary, nodates, template
339 341 files: rev, print0, include, exclude, template, subrepos
340 342 forget: interactive, include, exclude, dry-run
341 343 graft: rev, base, continue, stop, abort, edit, log, no-commit, force, currentdate, currentuser, date, user, tool, dry-run
342 344 grep: print0, all, diff, text, follow, ignore-case, files-with-matches, line-number, rev, all-files, user, date, template, include, exclude
343 345 heads: rev, topo, active, closed, style, template
344 346 help: extension, command, keyword, system
345 347 identify: rev, num, id, branch, tags, bookmarks, ssh, remotecmd, insecure, template
346 348 import: strip, base, secret, edit, force, no-commit, bypass, partial, exact, prefix, import-branch, message, logfile, date, user, similarity
347 349 incoming: force, newest-first, bundle, rev, bookmarks, branch, patch, git, limit, no-merges, stat, graph, style, template, ssh, remotecmd, insecure, subrepos
348 350 init: ssh, remotecmd, insecure
349 351 locate: rev, print0, fullpath, include, exclude
350 352 log: follow, follow-first, date, copies, keyword, rev, line-range, removed, only-merges, user, only-branch, branch, bookmark, prune, patch, git, limit, no-merges, stat, graph, style, template, include, exclude
351 353 manifest: rev, all, template
352 354 merge: force, rev, preview, abort, tool
353 355 outgoing: force, rev, newest-first, bookmarks, branch, patch, git, limit, no-merges, stat, graph, style, template, ssh, remotecmd, insecure, subrepos
354 356 parents: rev, style, template
355 357 paths: template
356 358 phase: public, draft, secret, force, rev
357 359 pull: update, force, confirm, rev, bookmark, branch, ssh, remotecmd, insecure
358 360 purge: abort-on-err, all, ignored, dirs, files, print, print0, confirm, include, exclude
359 361 push: force, rev, bookmark, all-bookmarks, branch, new-branch, pushvars, publish, ssh, remotecmd, insecure
360 362 recover: verify
361 363 remove: after, force, subrepos, include, exclude, dry-run
362 364 rename: after, at-rev, force, include, exclude, dry-run
363 365 resolve: all, list, mark, unmark, no-status, re-merge, tool, include, exclude, template
364 366 revert: all, date, rev, no-backup, interactive, include, exclude, dry-run
365 367 rollback: dry-run, force
366 368 root: template
367 369 serve: accesslog, daemon, daemon-postexec, errorlog, port, address, prefix, name, web-conf, webdir-conf, pid-file, stdio, cmdserver, templates, style, ipv6, certificate, print-url, subrepos
368 370 shelve: addremove, unknown, cleanup, date, delete, edit, keep, list, message, name, patch, interactive, stat, include, exclude
369 371 status: all, modified, added, removed, deleted, clean, unknown, ignored, no-status, terse, copies, print0, rev, change, include, exclude, subrepos, template
370 372 summary: remote
371 373 tag: force, local, rev, remove, edit, message, date, user
372 374 tags: template
373 375 tip: patch, git, style, template
374 376 unbundle: update
375 377 unshelve: abort, continue, interactive, keep, name, tool, date
376 378 update: clean, check, merge, date, rev, tool
377 379 verify: full
378 380 version: template
379 381
380 382 $ hg init a
381 383 $ cd a
382 384 $ echo fee > fee
383 385 $ hg ci -q -Amfee
384 386 $ hg tag fee
385 387 $ mkdir fie
386 388 $ echo dead > fie/dead
387 389 $ echo live > fie/live
388 390 $ hg bookmark fo
389 391 $ hg branch -q fie
390 392 $ hg ci -q -Amfie
391 393 $ echo fo > fo
392 394 $ hg branch -qf default
393 395 $ hg ci -q -Amfo
394 396 $ echo Fum > Fum
395 397 $ hg ci -q -AmFum
396 398 $ hg bookmark Fum
397 399
398 400 Test debugpathcomplete
399 401
400 402 $ hg debugpathcomplete f
401 403 fee
402 404 fie
403 405 fo
404 406 $ hg debugpathcomplete -f f
405 407 fee
406 408 fie/dead
407 409 fie/live
408 410 fo
409 411
410 412 $ hg rm Fum
411 413 $ hg debugpathcomplete -r F
412 414 Fum
413 415
414 416 Test debugnamecomplete
415 417
416 418 $ hg debugnamecomplete
417 419 Fum
418 420 default
419 421 fee
420 422 fie
421 423 fo
422 424 tip
423 425 $ hg debugnamecomplete f
424 426 fee
425 427 fie
426 428 fo
427 429
428 430 Test debuglabelcomplete, a deprecated name for debugnamecomplete that is still
429 431 used for completions in some shells.
430 432
431 433 $ hg debuglabelcomplete
432 434 Fum
433 435 default
434 436 fee
435 437 fie
436 438 fo
437 439 tip
438 440 $ hg debuglabelcomplete f
439 441 fee
440 442 fie
441 443 fo
@@ -1,3943 +1,3944 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 Extra extensions will be printed in help output in a non-reliable order since
48 48 the extension is unknown.
49 49 #if no-extraextensions
50 50
51 51 $ hg help
52 52 Mercurial Distributed SCM
53 53
54 54 list of commands:
55 55
56 56 Repository creation:
57 57
58 58 clone make a copy of an existing repository
59 59 init create a new repository in the given directory
60 60
61 61 Remote repository management:
62 62
63 63 incoming show new changesets found in source
64 64 outgoing show changesets not found in the destination
65 65 paths show aliases for remote repositories
66 66 pull pull changes from the specified source
67 67 push push changes to the specified destination
68 68 serve start stand-alone webserver
69 69
70 70 Change creation:
71 71
72 72 commit commit the specified files or all outstanding changes
73 73
74 74 Change manipulation:
75 75
76 76 backout reverse effect of earlier changeset
77 77 graft copy changes from other branches onto the current branch
78 78 merge merge another revision into working directory
79 79
80 80 Change organization:
81 81
82 82 bookmarks create a new bookmark or list existing bookmarks
83 83 branch set or show the current branch name
84 84 branches list repository named branches
85 85 phase set or show the current phase name
86 86 tag add one or more tags for the current or given revision
87 87 tags list repository tags
88 88
89 89 File content management:
90 90
91 91 annotate show changeset information by line for each file
92 92 cat output the current or given revision of files
93 93 copy mark files as copied for the next commit
94 94 diff diff repository (or selected files)
95 95 grep search for a pattern in specified files
96 96
97 97 Change navigation:
98 98
99 99 bisect subdivision search of changesets
100 100 heads show branch heads
101 101 identify identify the working directory or specified revision
102 102 log show revision history of entire repository or files
103 103
104 104 Working directory management:
105 105
106 106 add add the specified files on the next commit
107 107 addremove add all new files, delete all missing files
108 108 files list tracked files
109 109 forget forget the specified files on the next commit
110 110 purge removes files not tracked by Mercurial
111 111 remove remove the specified files on the next commit
112 112 rename rename files; equivalent of copy + remove
113 113 resolve redo merges or set/view the merge status of files
114 114 revert restore files to their checkout state
115 115 root print the root (top) of the current working directory
116 116 shelve save and set aside changes from the working directory
117 117 status show changed files in the working directory
118 118 summary summarize working directory state
119 119 unshelve restore a shelved change to the working directory
120 120 update update working directory (or switch revisions)
121 121
122 122 Change import/export:
123 123
124 124 archive create an unversioned archive of a repository revision
125 125 bundle create a bundle file
126 126 export dump the header and diffs for one or more changesets
127 127 import import an ordered set of patches
128 128 unbundle apply one or more bundle files
129 129
130 130 Repository maintenance:
131 131
132 132 manifest output the current or given revision of the project manifest
133 133 recover roll back an interrupted transaction
134 134 verify verify the integrity of the repository
135 135
136 136 Help:
137 137
138 138 config show combined config settings from all hgrc files
139 139 help show help for a given topic or a help overview
140 140 version output version and copyright information
141 141
142 142 additional help topics:
143 143
144 144 Mercurial identifiers:
145 145
146 146 filesets Specifying File Sets
147 147 hgignore Syntax for Mercurial Ignore Files
148 148 patterns File Name Patterns
149 149 revisions Specifying Revisions
150 150 urls URL Paths
151 151
152 152 Mercurial output:
153 153
154 154 color Colorizing Outputs
155 155 dates Date Formats
156 156 diffs Diff Formats
157 157 templating Template Usage
158 158
159 159 Mercurial configuration:
160 160
161 161 config Configuration Files
162 162 environment Environment Variables
163 163 extensions Using Additional Features
164 164 flags Command-line flags
165 165 hgweb Configuring hgweb
166 166 merge-tools Merge Tools
167 167 pager Pager Support
168 168
169 169 Concepts:
170 170
171 171 bundlespec Bundle File Formats
172 172 glossary Glossary
173 173 phases Working with Phases
174 174 subrepos Subrepositories
175 175
176 176 Miscellaneous:
177 177
178 178 deprecated Deprecated Features
179 179 internals Technical implementation topics
180 180 scripting Using Mercurial from scripts and automation
181 181
182 182 (use 'hg help -v' to show built-in aliases and global options)
183 183
184 184 $ hg -q help
185 185 Repository creation:
186 186
187 187 clone make a copy of an existing repository
188 188 init create a new repository in the given directory
189 189
190 190 Remote repository management:
191 191
192 192 incoming show new changesets found in source
193 193 outgoing show changesets not found in the destination
194 194 paths show aliases for remote repositories
195 195 pull pull changes from the specified source
196 196 push push changes to the specified destination
197 197 serve start stand-alone webserver
198 198
199 199 Change creation:
200 200
201 201 commit commit the specified files or all outstanding changes
202 202
203 203 Change manipulation:
204 204
205 205 backout reverse effect of earlier changeset
206 206 graft copy changes from other branches onto the current branch
207 207 merge merge another revision into working directory
208 208
209 209 Change organization:
210 210
211 211 bookmarks create a new bookmark or list existing bookmarks
212 212 branch set or show the current branch name
213 213 branches list repository named branches
214 214 phase set or show the current phase name
215 215 tag add one or more tags for the current or given revision
216 216 tags list repository tags
217 217
218 218 File content management:
219 219
220 220 annotate show changeset information by line for each file
221 221 cat output the current or given revision of files
222 222 copy mark files as copied for the next commit
223 223 diff diff repository (or selected files)
224 224 grep search for a pattern in specified files
225 225
226 226 Change navigation:
227 227
228 228 bisect subdivision search of changesets
229 229 heads show branch heads
230 230 identify identify the working directory or specified revision
231 231 log show revision history of entire repository or files
232 232
233 233 Working directory management:
234 234
235 235 add add the specified files on the next commit
236 236 addremove add all new files, delete all missing files
237 237 files list tracked files
238 238 forget forget the specified files on the next commit
239 239 purge removes files not tracked by Mercurial
240 240 remove remove the specified files on the next commit
241 241 rename rename files; equivalent of copy + remove
242 242 resolve redo merges or set/view the merge status of files
243 243 revert restore files to their checkout state
244 244 root print the root (top) of the current working directory
245 245 shelve save and set aside changes from the working directory
246 246 status show changed files in the working directory
247 247 summary summarize working directory state
248 248 unshelve restore a shelved change to the working directory
249 249 update update working directory (or switch revisions)
250 250
251 251 Change import/export:
252 252
253 253 archive create an unversioned archive of a repository revision
254 254 bundle create a bundle file
255 255 export dump the header and diffs for one or more changesets
256 256 import import an ordered set of patches
257 257 unbundle apply one or more bundle files
258 258
259 259 Repository maintenance:
260 260
261 261 manifest output the current or given revision of the project manifest
262 262 recover roll back an interrupted transaction
263 263 verify verify the integrity of the repository
264 264
265 265 Help:
266 266
267 267 config show combined config settings from all hgrc files
268 268 help show help for a given topic or a help overview
269 269 version output version and copyright information
270 270
271 271 additional help topics:
272 272
273 273 Mercurial identifiers:
274 274
275 275 filesets Specifying File Sets
276 276 hgignore Syntax for Mercurial Ignore Files
277 277 patterns File Name Patterns
278 278 revisions Specifying Revisions
279 279 urls URL Paths
280 280
281 281 Mercurial output:
282 282
283 283 color Colorizing Outputs
284 284 dates Date Formats
285 285 diffs Diff Formats
286 286 templating Template Usage
287 287
288 288 Mercurial configuration:
289 289
290 290 config Configuration Files
291 291 environment Environment Variables
292 292 extensions Using Additional Features
293 293 flags Command-line flags
294 294 hgweb Configuring hgweb
295 295 merge-tools Merge Tools
296 296 pager Pager Support
297 297
298 298 Concepts:
299 299
300 300 bundlespec Bundle File Formats
301 301 glossary Glossary
302 302 phases Working with Phases
303 303 subrepos Subrepositories
304 304
305 305 Miscellaneous:
306 306
307 307 deprecated Deprecated Features
308 308 internals Technical implementation topics
309 309 scripting Using Mercurial from scripts and automation
310 310
311 311 Test extension help:
312 312 $ hg help extensions --config extensions.rebase= --config extensions.children=
313 313 Using Additional Features
314 314 """""""""""""""""""""""""
315 315
316 316 Mercurial has the ability to add new features through the use of
317 317 extensions. Extensions may add new commands, add options to existing
318 318 commands, change the default behavior of commands, or implement hooks.
319 319
320 320 To enable the "foo" extension, either shipped with Mercurial or in the
321 321 Python search path, create an entry for it in your configuration file,
322 322 like this:
323 323
324 324 [extensions]
325 325 foo =
326 326
327 327 You may also specify the full path to an extension:
328 328
329 329 [extensions]
330 330 myfeature = ~/.hgext/myfeature.py
331 331
332 332 See 'hg help config' for more information on configuration files.
333 333
334 334 Extensions are not loaded by default for a variety of reasons: they can
335 335 increase startup overhead; they may be meant for advanced usage only; they
336 336 may provide potentially dangerous abilities (such as letting you destroy
337 337 or modify history); they might not be ready for prime time; or they may
338 338 alter some usual behaviors of stock Mercurial. It is thus up to the user
339 339 to activate extensions as needed.
340 340
341 341 To explicitly disable an extension enabled in a configuration file of
342 342 broader scope, prepend its path with !:
343 343
344 344 [extensions]
345 345 # disabling extension bar residing in /path/to/extension/bar.py
346 346 bar = !/path/to/extension/bar.py
347 347 # ditto, but no path was supplied for extension baz
348 348 baz = !
349 349
350 350 enabled extensions:
351 351
352 352 children command to display child changesets (DEPRECATED)
353 353 rebase command to move sets of revisions to a different ancestor
354 354
355 355 disabled extensions:
356 356
357 357 acl hooks for controlling repository access
358 358 blackbox log repository events to a blackbox for debugging
359 359 bugzilla hooks for integrating with the Bugzilla bug tracker
360 360 censor erase file content at a given revision
361 361 churn command to display statistics about repository history
362 362 clonebundles advertise pre-generated bundles to seed clones
363 363 closehead close arbitrary heads without checking them out first
364 364 convert import revisions from foreign VCS repositories into
365 365 Mercurial
366 366 eol automatically manage newlines in repository files
367 367 extdiff command to allow external programs to compare revisions
368 368 factotum http authentication with factotum
369 369 fastexport export repositories as git fast-import stream
370 370 githelp try mapping git commands to Mercurial commands
371 371 gpg commands to sign and verify changesets
372 372 hgk browse the repository in a graphical way
373 373 highlight syntax highlighting for hgweb (requires Pygments)
374 374 histedit interactive history editing
375 375 keyword expand keywords in tracked files
376 376 largefiles track large binary files
377 377 mq manage a stack of patches
378 378 notify hooks for sending email push notifications
379 379 patchbomb command to send changesets as (a series of) patch emails
380 380 relink recreates hardlinks between repository clones
381 381 schemes extend schemes with shortcuts to repository swarms
382 382 share share a common history between several working directories
383 383 transplant command to transplant changesets from another branch
384 384 win32mbcs allow the use of MBCS paths with problematic encodings
385 385 zeroconf discover and advertise repositories on the local network
386 386
387 387 #endif
388 388
389 389 Verify that deprecated extensions are included if --verbose:
390 390
391 391 $ hg -v help extensions | grep children
392 392 children command to display child changesets (DEPRECATED)
393 393
394 394 Verify that extension keywords appear in help templates
395 395
396 396 $ hg help --config extensions.transplant= templating|grep transplant > /dev/null
397 397
398 398 Test short command list with verbose option
399 399
400 400 $ hg -v help shortlist
401 401 Mercurial Distributed SCM
402 402
403 403 basic commands:
404 404
405 405 abort abort an unfinished operation (EXPERIMENTAL)
406 406 add add the specified files on the next commit
407 407 annotate, blame
408 408 show changeset information by line for each file
409 409 clone make a copy of an existing repository
410 410 commit, ci commit the specified files or all outstanding changes
411 411 continue resumes an interrupted operation (EXPERIMENTAL)
412 412 diff diff repository (or selected files)
413 413 export dump the header and diffs for one or more changesets
414 414 forget forget the specified files on the next commit
415 415 init create a new repository in the given directory
416 416 log, history show revision history of entire repository or files
417 417 merge merge another revision into working directory
418 418 pull pull changes from the specified source
419 419 push push changes to the specified destination
420 420 remove, rm remove the specified files on the next commit
421 421 serve start stand-alone webserver
422 422 status, st show changed files in the working directory
423 423 summary, sum summarize working directory state
424 424 update, up, checkout, co
425 425 update working directory (or switch revisions)
426 426
427 427 global options ([+] can be repeated):
428 428
429 429 -R --repository REPO repository root directory or name of overlay bundle
430 430 file
431 431 --cwd DIR change working directory
432 432 -y --noninteractive do not prompt, automatically pick the first choice for
433 433 all prompts
434 434 -q --quiet suppress output
435 435 -v --verbose enable additional output
436 436 --color TYPE when to colorize (boolean, always, auto, never, or
437 437 debug)
438 438 --config CONFIG [+] set/override config option (use 'section.name=value')
439 439 --debug enable debugging output
440 440 --debugger start debugger
441 441 --encoding ENCODE set the charset encoding (default: ascii)
442 442 --encodingmode MODE set the charset encoding mode (default: strict)
443 443 --traceback always print a traceback on exception
444 444 --time time how long the command takes
445 445 --profile print command execution profile
446 446 --version output version information and exit
447 447 -h --help display help and exit
448 448 --hidden consider hidden changesets
449 449 --pager TYPE when to paginate (boolean, always, auto, or never)
450 450 (default: auto)
451 451
452 452 (use 'hg help' for the full list of commands)
453 453
454 454 $ hg add -h
455 455 hg add [OPTION]... [FILE]...
456 456
457 457 add the specified files on the next commit
458 458
459 459 Schedule files to be version controlled and added to the repository.
460 460
461 461 The files will be added to the repository at the next commit. To undo an
462 462 add before that, see 'hg forget'.
463 463
464 464 If no names are given, add all files to the repository (except files
465 465 matching ".hgignore").
466 466
467 467 Returns 0 if all files are successfully added.
468 468
469 469 options ([+] can be repeated):
470 470
471 471 -I --include PATTERN [+] include names matching the given patterns
472 472 -X --exclude PATTERN [+] exclude names matching the given patterns
473 473 -S --subrepos recurse into subrepositories
474 474 -n --dry-run do not perform actions, just print output
475 475
476 476 (some details hidden, use --verbose to show complete help)
477 477
478 478 Verbose help for add
479 479
480 480 $ hg add -hv
481 481 hg add [OPTION]... [FILE]...
482 482
483 483 add the specified files on the next commit
484 484
485 485 Schedule files to be version controlled and added to the repository.
486 486
487 487 The files will be added to the repository at the next commit. To undo an
488 488 add before that, see 'hg forget'.
489 489
490 490 If no names are given, add all files to the repository (except files
491 491 matching ".hgignore").
492 492
493 493 Examples:
494 494
495 495 - New (unknown) files are added automatically by 'hg add':
496 496
497 497 $ ls
498 498 foo.c
499 499 $ hg status
500 500 ? foo.c
501 501 $ hg add
502 502 adding foo.c
503 503 $ hg status
504 504 A foo.c
505 505
506 506 - Specific files to be added can be specified:
507 507
508 508 $ ls
509 509 bar.c foo.c
510 510 $ hg status
511 511 ? bar.c
512 512 ? foo.c
513 513 $ hg add bar.c
514 514 $ hg status
515 515 A bar.c
516 516 ? foo.c
517 517
518 518 Returns 0 if all files are successfully added.
519 519
520 520 options ([+] can be repeated):
521 521
522 522 -I --include PATTERN [+] include names matching the given patterns
523 523 -X --exclude PATTERN [+] exclude names matching the given patterns
524 524 -S --subrepos recurse into subrepositories
525 525 -n --dry-run do not perform actions, just print output
526 526
527 527 global options ([+] can be repeated):
528 528
529 529 -R --repository REPO repository root directory or name of overlay bundle
530 530 file
531 531 --cwd DIR change working directory
532 532 -y --noninteractive do not prompt, automatically pick the first choice for
533 533 all prompts
534 534 -q --quiet suppress output
535 535 -v --verbose enable additional output
536 536 --color TYPE when to colorize (boolean, always, auto, never, or
537 537 debug)
538 538 --config CONFIG [+] set/override config option (use 'section.name=value')
539 539 --debug enable debugging output
540 540 --debugger start debugger
541 541 --encoding ENCODE set the charset encoding (default: ascii)
542 542 --encodingmode MODE set the charset encoding mode (default: strict)
543 543 --traceback always print a traceback on exception
544 544 --time time how long the command takes
545 545 --profile print command execution profile
546 546 --version output version information and exit
547 547 -h --help display help and exit
548 548 --hidden consider hidden changesets
549 549 --pager TYPE when to paginate (boolean, always, auto, or never)
550 550 (default: auto)
551 551
552 552 Test the textwidth config option
553 553
554 554 $ hg root -h --config ui.textwidth=50
555 555 hg root
556 556
557 557 print the root (top) of the current working
558 558 directory
559 559
560 560 Print the root directory of the current
561 561 repository.
562 562
563 563 Returns 0 on success.
564 564
565 565 options:
566 566
567 567 -T --template TEMPLATE display with template
568 568
569 569 (some details hidden, use --verbose to show
570 570 complete help)
571 571
572 572 Test help option with version option
573 573
574 574 $ hg add -h --version
575 575 Mercurial Distributed SCM (version *) (glob)
576 576 (see https://mercurial-scm.org for more information)
577 577
578 578 Copyright (C) 2005-* Matt Mackall and others (glob)
579 579 This is free software; see the source for copying conditions. There is NO
580 580 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
581 581
582 582 $ hg add --skjdfks
583 583 hg add: option --skjdfks not recognized
584 584 hg add [OPTION]... [FILE]...
585 585
586 586 add the specified files on the next commit
587 587
588 588 options ([+] can be repeated):
589 589
590 590 -I --include PATTERN [+] include names matching the given patterns
591 591 -X --exclude PATTERN [+] exclude names matching the given patterns
592 592 -S --subrepos recurse into subrepositories
593 593 -n --dry-run do not perform actions, just print output
594 594
595 595 (use 'hg add -h' to show more help)
596 596 [10]
597 597
598 598 Test ambiguous command help
599 599
600 600 $ hg help ad
601 601 list of commands:
602 602
603 603 add add the specified files on the next commit
604 604 addremove add all new files, delete all missing files
605 605
606 606 (use 'hg help -v ad' to show built-in aliases and global options)
607 607
608 608 Test command without options
609 609
610 610 $ hg help verify
611 611 hg verify
612 612
613 613 verify the integrity of the repository
614 614
615 615 Verify the integrity of the current repository.
616 616
617 617 This will perform an extensive check of the repository's integrity,
618 618 validating the hashes and checksums of each entry in the changelog,
619 619 manifest, and tracked files, as well as the integrity of their crosslinks
620 620 and indices.
621 621
622 622 Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more
623 623 information about recovery from corruption of the repository.
624 624
625 625 Returns 0 on success, 1 if errors are encountered.
626 626
627 627 options:
628 628
629 629 (some details hidden, use --verbose to show complete help)
630 630
631 631 $ hg help diff
632 632 hg diff [OPTION]... ([-c REV] | [--from REV1] [--to REV2]) [FILE]...
633 633
634 634 diff repository (or selected files)
635 635
636 636 Show differences between revisions for the specified files.
637 637
638 638 Differences between files are shown using the unified diff format.
639 639
640 640 Note:
641 641 'hg diff' may generate unexpected results for merges, as it will
642 642 default to comparing against the working directory's first parent
643 643 changeset if no revisions are specified.
644 644
645 645 By default, the working directory files are compared to its first parent.
646 646 To see the differences from another revision, use --from. To see the
647 647 difference to another revision, use --to. For example, 'hg diff --from .^'
648 648 will show the differences from the working copy's grandparent to the
649 649 working copy, 'hg diff --to .' will show the diff from the working copy to
650 650 its parent (i.e. the reverse of the default), and 'hg diff --from 1.0 --to
651 651 1.2' will show the diff between those two revisions.
652 652
653 653 Alternatively you can specify -c/--change with a revision to see the
654 654 changes in that changeset relative to its first parent (i.e. 'hg diff -c
655 655 42' is equivalent to 'hg diff --from 42^ --to 42')
656 656
657 657 Without the -a/--text option, diff will avoid generating diffs of files it
658 658 detects as binary. With -a, diff will generate a diff anyway, probably
659 659 with undesirable results.
660 660
661 661 Use the -g/--git option to generate diffs in the git extended diff format.
662 662 For more information, read 'hg help diffs'.
663 663
664 664 Returns 0 on success.
665 665
666 666 options ([+] can be repeated):
667 667
668 668 --from REV1 revision to diff from
669 669 --to REV2 revision to diff to
670 670 -c --change REV change made by revision
671 671 -a --text treat all files as text
672 672 -g --git use git extended diff format
673 673 --binary generate binary diffs in git mode (default)
674 674 --nodates omit dates from diff headers
675 675 --noprefix omit a/ and b/ prefixes from filenames
676 676 -p --show-function show which function each change is in
677 677 --reverse produce a diff that undoes the changes
678 678 -w --ignore-all-space ignore white space when comparing lines
679 679 -b --ignore-space-change ignore changes in the amount of white space
680 680 -B --ignore-blank-lines ignore changes whose lines are all blank
681 681 -Z --ignore-space-at-eol ignore changes in whitespace at EOL
682 682 -U --unified NUM number of lines of context to show
683 683 --stat output diffstat-style summary of changes
684 684 --root DIR produce diffs relative to subdirectory
685 685 -I --include PATTERN [+] include names matching the given patterns
686 686 -X --exclude PATTERN [+] exclude names matching the given patterns
687 687 -S --subrepos recurse into subrepositories
688 688
689 689 (some details hidden, use --verbose to show complete help)
690 690
691 691 $ hg help status
692 692 hg status [OPTION]... [FILE]...
693 693
694 694 aliases: st
695 695
696 696 show changed files in the working directory
697 697
698 698 Show status of files in the repository. If names are given, only files
699 699 that match are shown. Files that are clean or ignored or the source of a
700 700 copy/move operation, are not listed unless -c/--clean, -i/--ignored,
701 701 -C/--copies or -A/--all are given. Unless options described with "show
702 702 only ..." are given, the options -mardu are used.
703 703
704 704 Option -q/--quiet hides untracked (unknown and ignored) files unless
705 705 explicitly requested with -u/--unknown or -i/--ignored.
706 706
707 707 Note:
708 708 'hg status' may appear to disagree with diff if permissions have
709 709 changed or a merge has occurred. The standard diff format does not
710 710 report permission changes and diff only reports changes relative to one
711 711 merge parent.
712 712
713 713 If one revision is given, it is used as the base revision. If two
714 714 revisions are given, the differences between them are shown. The --change
715 715 option can also be used as a shortcut to list the changed files of a
716 716 revision from its first parent.
717 717
718 718 The codes used to show the status of files are:
719 719
720 720 M = modified
721 721 A = added
722 722 R = removed
723 723 C = clean
724 724 ! = missing (deleted by non-hg command, but still tracked)
725 725 ? = not tracked
726 726 I = ignored
727 727 = origin of the previous file (with --copies)
728 728
729 729 Returns 0 on success.
730 730
731 731 options ([+] can be repeated):
732 732
733 733 -A --all show status of all files
734 734 -m --modified show only modified files
735 735 -a --added show only added files
736 736 -r --removed show only removed files
737 737 -d --deleted show only missing files
738 738 -c --clean show only files without changes
739 739 -u --unknown show only unknown (not tracked) files
740 740 -i --ignored show only ignored files
741 741 -n --no-status hide status prefix
742 742 -C --copies show source of copied files
743 743 -0 --print0 end filenames with NUL, for use with xargs
744 744 --rev REV [+] show difference from revision
745 745 --change REV list the changed files of a revision
746 746 -I --include PATTERN [+] include names matching the given patterns
747 747 -X --exclude PATTERN [+] exclude names matching the given patterns
748 748 -S --subrepos recurse into subrepositories
749 749 -T --template TEMPLATE display with template
750 750
751 751 (some details hidden, use --verbose to show complete help)
752 752
753 753 $ hg -q help status
754 754 hg status [OPTION]... [FILE]...
755 755
756 756 show changed files in the working directory
757 757
758 758 $ hg help foo
759 759 abort: no such help topic: foo
760 760 (try 'hg help --keyword foo')
761 761 [10]
762 762
763 763 $ hg skjdfks
764 764 hg: unknown command 'skjdfks'
765 765 (use 'hg help' for a list of commands)
766 766 [10]
767 767
768 768 Typoed command gives suggestion
769 769 $ hg puls
770 770 hg: unknown command 'puls'
771 771 (did you mean one of pull, push?)
772 772 [10]
773 773
774 774 Not enabled extension gets suggested
775 775
776 776 $ hg rebase
777 777 hg: unknown command 'rebase'
778 778 'rebase' is provided by the following extension:
779 779
780 780 rebase command to move sets of revisions to a different ancestor
781 781
782 782 (use 'hg help extensions' for information on enabling extensions)
783 783 [10]
784 784
785 785 Disabled extension gets suggested
786 786 $ hg --config extensions.rebase=! rebase
787 787 hg: unknown command 'rebase'
788 788 'rebase' is provided by the following extension:
789 789
790 790 rebase command to move sets of revisions to a different ancestor
791 791
792 792 (use 'hg help extensions' for information on enabling extensions)
793 793 [10]
794 794
795 795 Checking that help adapts based on the config:
796 796
797 797 $ hg help diff --config ui.tweakdefaults=true | egrep -e '^ *(-g|config)'
798 798 -g --[no-]git use git extended diff format (default: on from
799 799 config)
800 800
801 801 Make sure that we don't run afoul of the help system thinking that
802 802 this is a section and erroring out weirdly.
803 803
804 804 $ hg .log
805 805 hg: unknown command '.log'
806 806 (did you mean log?)
807 807 [10]
808 808
809 809 $ hg log.
810 810 hg: unknown command 'log.'
811 811 (did you mean log?)
812 812 [10]
813 813 $ hg pu.lh
814 814 hg: unknown command 'pu.lh'
815 815 (did you mean one of pull, push?)
816 816 [10]
817 817
818 818 $ cat > helpext.py <<EOF
819 819 > import os
820 820 > from mercurial import commands, fancyopts, registrar
821 821 >
822 822 > def func(arg):
823 823 > return '%sfoo' % arg
824 824 > class customopt(fancyopts.customopt):
825 825 > def newstate(self, oldstate, newparam, abort):
826 826 > return '%sbar' % oldstate
827 827 > cmdtable = {}
828 828 > command = registrar.command(cmdtable)
829 829 >
830 830 > @command(b'nohelp',
831 831 > [(b'', b'longdesc', 3, b'x'*67),
832 832 > (b'n', b'', None, b'normal desc'),
833 833 > (b'', b'newline', b'', b'line1\nline2'),
834 834 > (b'', b'default-off', False, b'enable X'),
835 835 > (b'', b'default-on', True, b'enable Y'),
836 836 > (b'', b'callableopt', func, b'adds foo'),
837 837 > (b'', b'customopt', customopt(''), b'adds bar'),
838 838 > (b'', b'customopt-withdefault', customopt('foo'), b'adds bar')],
839 839 > b'hg nohelp',
840 840 > norepo=True)
841 841 > @command(b'debugoptADV', [(b'', b'aopt', None, b'option is (ADVANCED)')])
842 842 > @command(b'debugoptDEP', [(b'', b'dopt', None, b'option is (DEPRECATED)')])
843 843 > @command(b'debugoptEXP', [(b'', b'eopt', None, b'option is (EXPERIMENTAL)')])
844 844 > def nohelp(ui, *args, **kwargs):
845 845 > pass
846 846 >
847 847 > @command(b'hashelp', [], b'hg hashelp', norepo=True)
848 848 > def hashelp(ui, *args, **kwargs):
849 849 > """Extension command's help"""
850 850 >
851 851 > def uisetup(ui):
852 852 > ui.setconfig(b'alias', b'shellalias', b'!echo hi', b'helpext')
853 853 > ui.setconfig(b'alias', b'hgalias', b'summary', b'helpext')
854 854 > ui.setconfig(b'alias', b'hgalias:doc', b'My doc', b'helpext')
855 855 > ui.setconfig(b'alias', b'hgalias:category', b'navigation', b'helpext')
856 856 > ui.setconfig(b'alias', b'hgaliasnodoc', b'summary', b'helpext')
857 857 >
858 858 > EOF
859 859 $ echo '[extensions]' >> $HGRCPATH
860 860 $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
861 861
862 862 Test for aliases
863 863
864 864 $ hg help | grep hgalias
865 865 hgalias My doc
866 866
867 867 $ hg help hgalias
868 868 hg hgalias [--remote]
869 869
870 870 alias for: hg summary
871 871
872 872 My doc
873 873
874 874 defined by: helpext
875 875
876 876 options:
877 877
878 878 --remote check for push and pull
879 879
880 880 (some details hidden, use --verbose to show complete help)
881 881 $ hg help hgaliasnodoc
882 882 hg hgaliasnodoc [--remote]
883 883
884 884 alias for: hg summary
885 885
886 886 summarize working directory state
887 887
888 888 This generates a brief summary of the working directory state, including
889 889 parents, branch, commit status, phase and available updates.
890 890
891 891 With the --remote option, this will check the default paths for incoming
892 892 and outgoing changes. This can be time-consuming.
893 893
894 894 Returns 0 on success.
895 895
896 896 defined by: helpext
897 897
898 898 options:
899 899
900 900 --remote check for push and pull
901 901
902 902 (some details hidden, use --verbose to show complete help)
903 903
904 904 $ hg help shellalias
905 905 hg shellalias
906 906
907 907 shell alias for: echo hi
908 908
909 909 (no help text available)
910 910
911 911 defined by: helpext
912 912
913 913 (some details hidden, use --verbose to show complete help)
914 914
915 915 Test command with no help text
916 916
917 917 $ hg help nohelp
918 918 hg nohelp
919 919
920 920 (no help text available)
921 921
922 922 options:
923 923
924 924 --longdesc VALUE
925 925 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
926 926 xxxxxxxxxxxxxxxxxxxxxxx (default: 3)
927 927 -n -- normal desc
928 928 --newline VALUE line1 line2
929 929 --default-off enable X
930 930 --[no-]default-on enable Y (default: on)
931 931 --callableopt VALUE adds foo
932 932 --customopt VALUE adds bar
933 933 --customopt-withdefault VALUE adds bar (default: foo)
934 934
935 935 (some details hidden, use --verbose to show complete help)
936 936
937 937 Test that default list of commands includes extension commands that have help,
938 938 but not those that don't, except in verbose mode, when a keyword is passed, or
939 939 when help about the extension is requested.
940 940
941 941 #if no-extraextensions
942 942
943 943 $ hg help | grep hashelp
944 944 hashelp Extension command's help
945 945 $ hg help | grep nohelp
946 946 [1]
947 947 $ hg help -v | grep nohelp
948 948 nohelp (no help text available)
949 949
950 950 $ hg help -k nohelp
951 951 Commands:
952 952
953 953 nohelp hg nohelp
954 954
955 955 Extension Commands:
956 956
957 957 nohelp (no help text available)
958 958
959 959 $ hg help helpext
960 960 helpext extension - no help text available
961 961
962 962 list of commands:
963 963
964 964 hashelp Extension command's help
965 965 nohelp (no help text available)
966 966
967 967 (use 'hg help -v helpext' to show built-in aliases and global options)
968 968
969 969 #endif
970 970
971 971 Test list of internal help commands
972 972
973 973 $ hg help debug
974 974 debug commands (internal and unsupported):
975 975
976 976 debugancestor
977 977 find the ancestor revision of two revisions in a given index
978 978 debugantivirusrunning
979 979 attempt to trigger an antivirus scanner to see if one is active
980 980 debugapplystreamclonebundle
981 981 apply a stream clone bundle file
982 982 debugbackupbundle
983 983 lists the changesets available in backup bundles
984 984 debugbuilddag
985 985 builds a repo with a given DAG from scratch in the current
986 986 empty repo
987 987 debugbundle lists the contents of a bundle
988 988 debugcapabilities
989 989 lists the capabilities of a remote peer
990 990 debugchangedfiles
991 991 list the stored files changes for a revision
992 992 debugcheckstate
993 993 validate the correctness of the current dirstate
994 994 debugcolor show available color, effects or style
995 995 debugcommands
996 996 list all available commands and options
997 997 debugcomplete
998 998 returns the completion list associated with the given command
999 999 debugcreatestreamclonebundle
1000 1000 create a stream clone bundle file
1001 1001 debugdag format the changelog or an index DAG as a concise textual
1002 1002 description
1003 1003 debugdata dump the contents of a data file revision
1004 1004 debugdate parse and display a date
1005 1005 debugdeltachain
1006 1006 dump information about delta chains in a revlog
1007 1007 debugdirstate
1008 1008 show the contents of the current dirstate
1009 1009 debugdiscovery
1010 1010 runs the changeset discovery protocol in isolation
1011 1011 debugdownload
1012 1012 download a resource using Mercurial logic and config
1013 1013 debugextensions
1014 1014 show information about active extensions
1015 1015 debugfileset parse and apply a fileset specification
1016 1016 debugformat display format information about the current repository
1017 1017 debugfsinfo show information detected about current filesystem
1018 1018 debuggetbundle
1019 1019 retrieves a bundle from a repo
1020 1020 debugignore display the combined ignore pattern and information about
1021 1021 ignored files
1022 1022 debugindex dump index data for a storage primitive
1023 1023 debugindexdot
1024 1024 dump an index DAG as a graphviz dot file
1025 1025 debugindexstats
1026 1026 show stats related to the changelog index
1027 1027 debuginstall test Mercurial installation
1028 1028 debugknown test whether node ids are known to a repo
1029 1029 debuglocks show or modify state of locks
1030 1030 debugmanifestfulltextcache
1031 1031 show, clear or amend the contents of the manifest fulltext
1032 1032 cache
1033 1033 debugmergestate
1034 1034 print merge state
1035 1035 debugnamecomplete
1036 1036 complete "names" - tags, open branch names, bookmark names
1037 1037 debugnodemap write and inspect on disk nodemap
1038 1038 debugobsolete
1039 1039 create arbitrary obsolete marker
1040 1040 debugoptADV (no help text available)
1041 1041 debugoptDEP (no help text available)
1042 1042 debugoptEXP (no help text available)
1043 1043 debugp1copies
1044 1044 dump copy information compared to p1
1045 1045 debugp2copies
1046 1046 dump copy information compared to p2
1047 1047 debugpathcomplete
1048 1048 complete part or all of a tracked path
1049 1049 debugpathcopies
1050 1050 show copies between two revisions
1051 1051 debugpeer establish a connection to a peer repository
1052 1052 debugpickmergetool
1053 1053 examine which merge tool is chosen for specified file
1054 1054 debugpushkey access the pushkey key/value protocol
1055 1055 debugpvec (no help text available)
1056 1056 debugrebuilddirstate
1057 1057 rebuild the dirstate as it would look like for the given
1058 1058 revision
1059 1059 debugrebuildfncache
1060 1060 rebuild the fncache file
1061 1061 debugrename dump rename information
1062 1062 debugrequires
1063 1063 print the current repo requirements
1064 1064 debugrevlog show data and statistics about a revlog
1065 1065 debugrevlogindex
1066 1066 dump the contents of a revlog index
1067 1067 debugrevspec parse and apply a revision specification
1068 1068 debugserve run a server with advanced settings
1069 1069 debugsetparents
1070 1070 manually set the parents of the current working directory
1071 1071 (DANGEROUS)
1072 debugshell run an interactive Python interpreter
1072 1073 debugsidedata
1073 1074 dump the side data for a cl/manifest/file revision
1074 1075 debugssl test a secure connection to a server
1075 1076 debugstrip strip changesets and all their descendants from the repository
1076 1077 debugsub (no help text available)
1077 1078 debugsuccessorssets
1078 1079 show set of successors for revision
1079 1080 debugtagscache
1080 1081 display the contents of .hg/cache/hgtagsfnodes1
1081 1082 debugtemplate
1082 1083 parse and apply a template
1083 1084 debuguigetpass
1084 1085 show prompt to type password
1085 1086 debuguiprompt
1086 1087 show plain prompt
1087 1088 debugupdatecaches
1088 1089 warm all known caches in the repository
1089 1090 debugupgraderepo
1090 1091 upgrade a repository to use different features
1091 1092 debugwalk show how files match on given patterns
1092 1093 debugwhyunstable
1093 1094 explain instabilities of a changeset
1094 1095 debugwireargs
1095 1096 (no help text available)
1096 1097 debugwireproto
1097 1098 send wire protocol commands to a server
1098 1099
1099 1100 (use 'hg help -v debug' to show built-in aliases and global options)
1100 1101
1101 1102 internals topic renders index of available sub-topics
1102 1103
1103 1104 $ hg help internals
1104 1105 Technical implementation topics
1105 1106 """""""""""""""""""""""""""""""
1106 1107
1107 1108 To access a subtopic, use "hg help internals.{subtopic-name}"
1108 1109
1109 1110 bid-merge Bid Merge Algorithm
1110 1111 bundle2 Bundle2
1111 1112 bundles Bundles
1112 1113 cbor CBOR
1113 1114 censor Censor
1114 1115 changegroups Changegroups
1115 1116 config Config Registrar
1116 1117 extensions Extension API
1117 1118 mergestate Mergestate
1118 1119 requirements Repository Requirements
1119 1120 revlogs Revision Logs
1120 1121 wireprotocol Wire Protocol
1121 1122 wireprotocolrpc
1122 1123 Wire Protocol RPC
1123 1124 wireprotocolv2
1124 1125 Wire Protocol Version 2
1125 1126
1126 1127 sub-topics can be accessed
1127 1128
1128 1129 $ hg help internals.changegroups
1129 1130 Changegroups
1130 1131 """"""""""""
1131 1132
1132 1133 Changegroups are representations of repository revlog data, specifically
1133 1134 the changelog data, root/flat manifest data, treemanifest data, and
1134 1135 filelogs.
1135 1136
1136 1137 There are 3 versions of changegroups: "1", "2", and "3". From a high-
1137 1138 level, versions "1" and "2" are almost exactly the same, with the only
1138 1139 difference being an additional item in the *delta header*. Version "3"
1139 1140 adds support for storage flags in the *delta header* and optionally
1140 1141 exchanging treemanifests (enabled by setting an option on the
1141 1142 "changegroup" part in the bundle2).
1142 1143
1143 1144 Changegroups when not exchanging treemanifests consist of 3 logical
1144 1145 segments:
1145 1146
1146 1147 +---------------------------------+
1147 1148 | | | |
1148 1149 | changeset | manifest | filelogs |
1149 1150 | | | |
1150 1151 | | | |
1151 1152 +---------------------------------+
1152 1153
1153 1154 When exchanging treemanifests, there are 4 logical segments:
1154 1155
1155 1156 +-------------------------------------------------+
1156 1157 | | | | |
1157 1158 | changeset | root | treemanifests | filelogs |
1158 1159 | | manifest | | |
1159 1160 | | | | |
1160 1161 +-------------------------------------------------+
1161 1162
1162 1163 The principle building block of each segment is a *chunk*. A *chunk* is a
1163 1164 framed piece of data:
1164 1165
1165 1166 +---------------------------------------+
1166 1167 | | |
1167 1168 | length | data |
1168 1169 | (4 bytes) | (<length - 4> bytes) |
1169 1170 | | |
1170 1171 +---------------------------------------+
1171 1172
1172 1173 All integers are big-endian signed integers. Each chunk starts with a
1173 1174 32-bit integer indicating the length of the entire chunk (including the
1174 1175 length field itself).
1175 1176
1176 1177 There is a special case chunk that has a value of 0 for the length
1177 1178 ("0x00000000"). We call this an *empty chunk*.
1178 1179
1179 1180 Delta Groups
1180 1181 ============
1181 1182
1182 1183 A *delta group* expresses the content of a revlog as a series of deltas,
1183 1184 or patches against previous revisions.
1184 1185
1185 1186 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
1186 1187 to signal the end of the delta group:
1187 1188
1188 1189 +------------------------------------------------------------------------+
1189 1190 | | | | | |
1190 1191 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
1191 1192 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
1192 1193 | | | | | |
1193 1194 +------------------------------------------------------------------------+
1194 1195
1195 1196 Each *chunk*'s data consists of the following:
1196 1197
1197 1198 +---------------------------------------+
1198 1199 | | |
1199 1200 | delta header | delta data |
1200 1201 | (various by version) | (various) |
1201 1202 | | |
1202 1203 +---------------------------------------+
1203 1204
1204 1205 The *delta data* is a series of *delta*s that describe a diff from an
1205 1206 existing entry (either that the recipient already has, or previously
1206 1207 specified in the bundle/changegroup).
1207 1208
1208 1209 The *delta header* is different between versions "1", "2", and "3" of the
1209 1210 changegroup format.
1210 1211
1211 1212 Version 1 (headerlen=80):
1212 1213
1213 1214 +------------------------------------------------------+
1214 1215 | | | | |
1215 1216 | node | p1 node | p2 node | link node |
1216 1217 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1217 1218 | | | | |
1218 1219 +------------------------------------------------------+
1219 1220
1220 1221 Version 2 (headerlen=100):
1221 1222
1222 1223 +------------------------------------------------------------------+
1223 1224 | | | | | |
1224 1225 | node | p1 node | p2 node | base node | link node |
1225 1226 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1226 1227 | | | | | |
1227 1228 +------------------------------------------------------------------+
1228 1229
1229 1230 Version 3 (headerlen=102):
1230 1231
1231 1232 +------------------------------------------------------------------------------+
1232 1233 | | | | | | |
1233 1234 | node | p1 node | p2 node | base node | link node | flags |
1234 1235 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
1235 1236 | | | | | | |
1236 1237 +------------------------------------------------------------------------------+
1237 1238
1238 1239 The *delta data* consists of "chunklen - 4 - headerlen" bytes, which
1239 1240 contain a series of *delta*s, densely packed (no separators). These deltas
1240 1241 describe a diff from an existing entry (either that the recipient already
1241 1242 has, or previously specified in the bundle/changegroup). The format is
1242 1243 described more fully in "hg help internals.bdiff", but briefly:
1243 1244
1244 1245 +---------------------------------------------------------------+
1245 1246 | | | | |
1246 1247 | start offset | end offset | new length | content |
1247 1248 | (4 bytes) | (4 bytes) | (4 bytes) | (<new length> bytes) |
1248 1249 | | | | |
1249 1250 +---------------------------------------------------------------+
1250 1251
1251 1252 Please note that the length field in the delta data does *not* include
1252 1253 itself.
1253 1254
1254 1255 In version 1, the delta is always applied against the previous node from
1255 1256 the changegroup or the first parent if this is the first entry in the
1256 1257 changegroup.
1257 1258
1258 1259 In version 2 and up, the delta base node is encoded in the entry in the
1259 1260 changegroup. This allows the delta to be expressed against any parent,
1260 1261 which can result in smaller deltas and more efficient encoding of data.
1261 1262
1262 1263 The *flags* field holds bitwise flags affecting the processing of revision
1263 1264 data. The following flags are defined:
1264 1265
1265 1266 32768
1266 1267 Censored revision. The revision's fulltext has been replaced by censor
1267 1268 metadata. May only occur on file revisions.
1268 1269
1269 1270 16384
1270 1271 Ellipsis revision. Revision hash does not match data (likely due to
1271 1272 rewritten parents).
1272 1273
1273 1274 8192
1274 1275 Externally stored. The revision fulltext contains "key:value" "\n"
1275 1276 delimited metadata defining an object stored elsewhere. Used by the LFS
1276 1277 extension.
1277 1278
1278 1279 For historical reasons, the integer values are identical to revlog version
1279 1280 1 per-revision storage flags and correspond to bits being set in this
1280 1281 2-byte field. Bits were allocated starting from the most-significant bit,
1281 1282 hence the reverse ordering and allocation of these flags.
1282 1283
1283 1284 Changeset Segment
1284 1285 =================
1285 1286
1286 1287 The *changeset segment* consists of a single *delta group* holding
1287 1288 changelog data. The *empty chunk* at the end of the *delta group* denotes
1288 1289 the boundary to the *manifest segment*.
1289 1290
1290 1291 Manifest Segment
1291 1292 ================
1292 1293
1293 1294 The *manifest segment* consists of a single *delta group* holding manifest
1294 1295 data. If treemanifests are in use, it contains only the manifest for the
1295 1296 root directory of the repository. Otherwise, it contains the entire
1296 1297 manifest data. The *empty chunk* at the end of the *delta group* denotes
1297 1298 the boundary to the next segment (either the *treemanifests segment* or
1298 1299 the *filelogs segment*, depending on version and the request options).
1299 1300
1300 1301 Treemanifests Segment
1301 1302 ---------------------
1302 1303
1303 1304 The *treemanifests segment* only exists in changegroup version "3", and
1304 1305 only if the 'treemanifest' param is part of the bundle2 changegroup part
1305 1306 (it is not possible to use changegroup version 3 outside of bundle2).
1306 1307 Aside from the filenames in the *treemanifests segment* containing a
1307 1308 trailing "/" character, it behaves identically to the *filelogs segment*
1308 1309 (see below). The final sub-segment is followed by an *empty chunk*
1309 1310 (logically, a sub-segment with filename size 0). This denotes the boundary
1310 1311 to the *filelogs segment*.
1311 1312
1312 1313 Filelogs Segment
1313 1314 ================
1314 1315
1315 1316 The *filelogs segment* consists of multiple sub-segments, each
1316 1317 corresponding to an individual file whose data is being described:
1317 1318
1318 1319 +--------------------------------------------------+
1319 1320 | | | | | |
1320 1321 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
1321 1322 | | | | | (4 bytes) |
1322 1323 | | | | | |
1323 1324 +--------------------------------------------------+
1324 1325
1325 1326 The final filelog sub-segment is followed by an *empty chunk* (logically,
1326 1327 a sub-segment with filename size 0). This denotes the end of the segment
1327 1328 and of the overall changegroup.
1328 1329
1329 1330 Each filelog sub-segment consists of the following:
1330 1331
1331 1332 +------------------------------------------------------+
1332 1333 | | | |
1333 1334 | filename length | filename | delta group |
1334 1335 | (4 bytes) | (<length - 4> bytes) | (various) |
1335 1336 | | | |
1336 1337 +------------------------------------------------------+
1337 1338
1338 1339 That is, a *chunk* consisting of the filename (not terminated or padded)
1339 1340 followed by N chunks constituting the *delta group* for this file. The
1340 1341 *empty chunk* at the end of each *delta group* denotes the boundary to the
1341 1342 next filelog sub-segment.
1342 1343
1343 1344 non-existent subtopics print an error
1344 1345
1345 1346 $ hg help internals.foo
1346 1347 abort: no such help topic: internals.foo
1347 1348 (try 'hg help --keyword foo')
1348 1349 [10]
1349 1350
1350 1351 test advanced, deprecated and experimental options are hidden in command help
1351 1352 $ hg help debugoptADV
1352 1353 hg debugoptADV
1353 1354
1354 1355 (no help text available)
1355 1356
1356 1357 options:
1357 1358
1358 1359 (some details hidden, use --verbose to show complete help)
1359 1360 $ hg help debugoptDEP
1360 1361 hg debugoptDEP
1361 1362
1362 1363 (no help text available)
1363 1364
1364 1365 options:
1365 1366
1366 1367 (some details hidden, use --verbose to show complete help)
1367 1368
1368 1369 $ hg help debugoptEXP
1369 1370 hg debugoptEXP
1370 1371
1371 1372 (no help text available)
1372 1373
1373 1374 options:
1374 1375
1375 1376 (some details hidden, use --verbose to show complete help)
1376 1377
1377 1378 test advanced, deprecated and experimental options are shown with -v
1378 1379 $ hg help -v debugoptADV | grep aopt
1379 1380 --aopt option is (ADVANCED)
1380 1381 $ hg help -v debugoptDEP | grep dopt
1381 1382 --dopt option is (DEPRECATED)
1382 1383 $ hg help -v debugoptEXP | grep eopt
1383 1384 --eopt option is (EXPERIMENTAL)
1384 1385
1385 1386 #if gettext
1386 1387 test deprecated option is hidden with translation with untranslated description
1387 1388 (use many globy for not failing on changed transaction)
1388 1389 $ LANGUAGE=sv hg help debugoptDEP
1389 1390 hg debugoptDEP
1390 1391
1391 1392 (*) (glob)
1392 1393
1393 1394 options:
1394 1395
1395 1396 (some details hidden, use --verbose to show complete help)
1396 1397 #endif
1397 1398
1398 1399 Test commands that collide with topics (issue4240)
1399 1400
1400 1401 $ hg config -hq
1401 1402 hg config [-u] [NAME]...
1402 1403
1403 1404 show combined config settings from all hgrc files
1404 1405 $ hg showconfig -hq
1405 1406 hg config [-u] [NAME]...
1406 1407
1407 1408 show combined config settings from all hgrc files
1408 1409
1409 1410 Test a help topic
1410 1411
1411 1412 $ hg help dates
1412 1413 Date Formats
1413 1414 """"""""""""
1414 1415
1415 1416 Some commands allow the user to specify a date, e.g.:
1416 1417
1417 1418 - backout, commit, import, tag: Specify the commit date.
1418 1419 - log, revert, update: Select revision(s) by date.
1419 1420
1420 1421 Many date formats are valid. Here are some examples:
1421 1422
1422 1423 - "Wed Dec 6 13:18:29 2006" (local timezone assumed)
1423 1424 - "Dec 6 13:18 -0600" (year assumed, time offset provided)
1424 1425 - "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
1425 1426 - "Dec 6" (midnight)
1426 1427 - "13:18" (today assumed)
1427 1428 - "3:39" (3:39AM assumed)
1428 1429 - "3:39pm" (15:39)
1429 1430 - "2006-12-06 13:18:29" (ISO 8601 format)
1430 1431 - "2006-12-6 13:18"
1431 1432 - "2006-12-6"
1432 1433 - "12-6"
1433 1434 - "12/6"
1434 1435 - "12/6/6" (Dec 6 2006)
1435 1436 - "today" (midnight)
1436 1437 - "yesterday" (midnight)
1437 1438 - "now" - right now
1438 1439
1439 1440 Lastly, there is Mercurial's internal format:
1440 1441
1441 1442 - "1165411109 0" (Wed Dec 6 13:18:29 2006 UTC)
1442 1443
1443 1444 This is the internal representation format for dates. The first number is
1444 1445 the number of seconds since the epoch (1970-01-01 00:00 UTC). The second
1445 1446 is the offset of the local timezone, in seconds west of UTC (negative if
1446 1447 the timezone is east of UTC).
1447 1448
1448 1449 The log command also accepts date ranges:
1449 1450
1450 1451 - "<DATE" - at or before a given date/time
1451 1452 - ">DATE" - on or after a given date/time
1452 1453 - "DATE to DATE" - a date range, inclusive
1453 1454 - "-DAYS" - within a given number of days from today
1454 1455
1455 1456 Test repeated config section name
1456 1457
1457 1458 $ hg help config.host
1458 1459 "http_proxy.host"
1459 1460 Host name and (optional) port of the proxy server, for example
1460 1461 "myproxy:8000".
1461 1462
1462 1463 "smtp.host"
1463 1464 Host name of mail server, e.g. "mail.example.com".
1464 1465
1465 1466
1466 1467 Test section name with dot
1467 1468
1468 1469 $ hg help config.ui.username
1469 1470 "ui.username"
1470 1471 The committer of a changeset created when running "commit". Typically
1471 1472 a person's name and email address, e.g. "Fred Widget
1472 1473 <fred@example.com>". Environment variables in the username are
1473 1474 expanded.
1474 1475
1475 1476 (default: "$EMAIL" or "username@hostname". If the username in hgrc is
1476 1477 empty, e.g. if the system admin set "username =" in the system hgrc,
1477 1478 it has to be specified manually or in a different hgrc file)
1478 1479
1479 1480
1480 1481 $ hg help config.annotate.git
1481 1482 abort: help section not found: config.annotate.git
1482 1483 [10]
1483 1484
1484 1485 $ hg help config.update.check
1485 1486 "commands.update.check"
1486 1487 Determines what level of checking 'hg update' will perform before
1487 1488 moving to a destination revision. Valid values are "abort", "none",
1488 1489 "linear", and "noconflict". "abort" always fails if the working
1489 1490 directory has uncommitted changes. "none" performs no checking, and
1490 1491 may result in a merge with uncommitted changes. "linear" allows any
1491 1492 update as long as it follows a straight line in the revision history,
1492 1493 and may trigger a merge with uncommitted changes. "noconflict" will
1493 1494 allow any update which would not trigger a merge with uncommitted
1494 1495 changes, if any are present. (default: "linear")
1495 1496
1496 1497
1497 1498 $ hg help config.commands.update.check
1498 1499 "commands.update.check"
1499 1500 Determines what level of checking 'hg update' will perform before
1500 1501 moving to a destination revision. Valid values are "abort", "none",
1501 1502 "linear", and "noconflict". "abort" always fails if the working
1502 1503 directory has uncommitted changes. "none" performs no checking, and
1503 1504 may result in a merge with uncommitted changes. "linear" allows any
1504 1505 update as long as it follows a straight line in the revision history,
1505 1506 and may trigger a merge with uncommitted changes. "noconflict" will
1506 1507 allow any update which would not trigger a merge with uncommitted
1507 1508 changes, if any are present. (default: "linear")
1508 1509
1509 1510
1510 1511 $ hg help config.ommands.update.check
1511 1512 abort: help section not found: config.ommands.update.check
1512 1513 [10]
1513 1514
1514 1515 Unrelated trailing paragraphs shouldn't be included
1515 1516
1516 1517 $ hg help config.extramsg | grep '^$'
1517 1518
1518 1519
1519 1520 Test capitalized section name
1520 1521
1521 1522 $ hg help scripting.HGPLAIN > /dev/null
1522 1523
1523 1524 Help subsection:
1524 1525
1525 1526 $ hg help config.charsets |grep "Email example:" > /dev/null
1526 1527 [1]
1527 1528
1528 1529 Show nested definitions
1529 1530 ("profiling.type"[break]"ls"[break]"stat"[break])
1530 1531
1531 1532 $ hg help config.type | egrep '^$'|wc -l
1532 1533 \s*3 (re)
1533 1534
1534 1535 $ hg help config.profiling.type.ls
1535 1536 "profiling.type.ls"
1536 1537 Use Python's built-in instrumenting profiler. This profiler works on
1537 1538 all platforms, but each line number it reports is the first line of
1538 1539 a function. This restriction makes it difficult to identify the
1539 1540 expensive parts of a non-trivial function.
1540 1541
1541 1542
1542 1543 Separate sections from subsections
1543 1544
1544 1545 $ hg help config.format | egrep '^ ("|-)|^\s*$' | uniq
1545 1546 "format"
1546 1547 --------
1547 1548
1548 1549 "usegeneraldelta"
1549 1550
1550 1551 "dotencode"
1551 1552
1552 1553 "usefncache"
1553 1554
1554 1555 "use-persistent-nodemap"
1555 1556
1556 1557 "use-share-safe"
1557 1558
1558 1559 "usestore"
1559 1560
1560 1561 "sparse-revlog"
1561 1562
1562 1563 "revlog-compression"
1563 1564
1564 1565 "bookmarks-in-store"
1565 1566
1566 1567 "profiling"
1567 1568 -----------
1568 1569
1569 1570 "format"
1570 1571
1571 1572 "progress"
1572 1573 ----------
1573 1574
1574 1575 "format"
1575 1576
1576 1577
1577 1578 Last item in help config.*:
1578 1579
1579 1580 $ hg help config.`hg help config|grep '^ "'| \
1580 1581 > tail -1|sed 's![ "]*!!g'`| \
1581 1582 > grep 'hg help -c config' > /dev/null
1582 1583 [1]
1583 1584
1584 1585 note to use help -c for general hg help config:
1585 1586
1586 1587 $ hg help config |grep 'hg help -c config' > /dev/null
1587 1588
1588 1589 Test templating help
1589 1590
1590 1591 $ hg help templating | egrep '(desc|diffstat|firstline|nonempty) '
1591 1592 desc String. The text of the changeset description.
1592 1593 diffstat String. Statistics of changes with the following format:
1593 1594 firstline Any text. Returns the first line of text.
1594 1595 nonempty Any text. Returns '(none)' if the string is empty.
1595 1596
1596 1597 Test deprecated items
1597 1598
1598 1599 $ hg help -v templating | grep currentbookmark
1599 1600 currentbookmark
1600 1601 $ hg help templating | (grep currentbookmark || true)
1601 1602
1602 1603 Test help hooks
1603 1604
1604 1605 $ cat > helphook1.py <<EOF
1605 1606 > from mercurial import help
1606 1607 >
1607 1608 > def rewrite(ui, topic, doc):
1608 1609 > return doc + b'\nhelphook1\n'
1609 1610 >
1610 1611 > def extsetup(ui):
1611 1612 > help.addtopichook(b'revisions', rewrite)
1612 1613 > EOF
1613 1614 $ cat > helphook2.py <<EOF
1614 1615 > from mercurial import help
1615 1616 >
1616 1617 > def rewrite(ui, topic, doc):
1617 1618 > return doc + b'\nhelphook2\n'
1618 1619 >
1619 1620 > def extsetup(ui):
1620 1621 > help.addtopichook(b'revisions', rewrite)
1621 1622 > EOF
1622 1623 $ echo '[extensions]' >> $HGRCPATH
1623 1624 $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
1624 1625 $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
1625 1626 $ hg help revsets | grep helphook
1626 1627 helphook1
1627 1628 helphook2
1628 1629
1629 1630 help -c should only show debug --debug
1630 1631
1631 1632 $ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
1632 1633 [1]
1633 1634
1634 1635 help -c should only show deprecated for -v
1635 1636
1636 1637 $ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
1637 1638 [1]
1638 1639
1639 1640 Test -s / --system
1640 1641
1641 1642 $ hg help config.files -s windows |grep 'etc/mercurial' | \
1642 1643 > wc -l | sed -e 's/ //g'
1643 1644 0
1644 1645 $ hg help config.files --system unix | grep 'USER' | \
1645 1646 > wc -l | sed -e 's/ //g'
1646 1647 0
1647 1648
1648 1649 Test -e / -c / -k combinations
1649 1650
1650 1651 $ hg help -c|egrep '^[A-Z].*:|^ debug'
1651 1652 Commands:
1652 1653 $ hg help -e|egrep '^[A-Z].*:|^ debug'
1653 1654 Extensions:
1654 1655 $ hg help -k|egrep '^[A-Z].*:|^ debug'
1655 1656 Topics:
1656 1657 Commands:
1657 1658 Extensions:
1658 1659 Extension Commands:
1659 1660 $ hg help -c schemes
1660 1661 abort: no such help topic: schemes
1661 1662 (try 'hg help --keyword schemes')
1662 1663 [10]
1663 1664 $ hg help -e schemes |head -1
1664 1665 schemes extension - extend schemes with shortcuts to repository swarms
1665 1666 $ hg help -c -k dates |egrep '^(Topics|Extensions|Commands):'
1666 1667 Commands:
1667 1668 $ hg help -e -k a |egrep '^(Topics|Extensions|Commands):'
1668 1669 Extensions:
1669 1670 $ hg help -e -c -k date |egrep '^(Topics|Extensions|Commands):'
1670 1671 Extensions:
1671 1672 Commands:
1672 1673 $ hg help -c commit > /dev/null
1673 1674 $ hg help -e -c commit > /dev/null
1674 1675 $ hg help -e commit
1675 1676 abort: no such help topic: commit
1676 1677 (try 'hg help --keyword commit')
1677 1678 [10]
1678 1679
1679 1680 Test keyword search help
1680 1681
1681 1682 $ cat > prefixedname.py <<EOF
1682 1683 > '''matched against word "clone"
1683 1684 > '''
1684 1685 > EOF
1685 1686 $ echo '[extensions]' >> $HGRCPATH
1686 1687 $ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
1687 1688 $ hg help -k clone
1688 1689 Topics:
1689 1690
1690 1691 config Configuration Files
1691 1692 extensions Using Additional Features
1692 1693 glossary Glossary
1693 1694 phases Working with Phases
1694 1695 subrepos Subrepositories
1695 1696 urls URL Paths
1696 1697
1697 1698 Commands:
1698 1699
1699 1700 bookmarks create a new bookmark or list existing bookmarks
1700 1701 clone make a copy of an existing repository
1701 1702 paths show aliases for remote repositories
1702 1703 pull pull changes from the specified source
1703 1704 update update working directory (or switch revisions)
1704 1705
1705 1706 Extensions:
1706 1707
1707 1708 clonebundles advertise pre-generated bundles to seed clones
1708 1709 narrow create clones which fetch history data for subset of files
1709 1710 (EXPERIMENTAL)
1710 1711 prefixedname matched against word "clone"
1711 1712 relink recreates hardlinks between repository clones
1712 1713
1713 1714 Extension Commands:
1714 1715
1715 1716 qclone clone main and patch repository at same time
1716 1717
1717 1718 Test unfound topic
1718 1719
1719 1720 $ hg help nonexistingtopicthatwillneverexisteverever
1720 1721 abort: no such help topic: nonexistingtopicthatwillneverexisteverever
1721 1722 (try 'hg help --keyword nonexistingtopicthatwillneverexisteverever')
1722 1723 [10]
1723 1724
1724 1725 Test unfound keyword
1725 1726
1726 1727 $ hg help --keyword nonexistingwordthatwillneverexisteverever
1727 1728 abort: no matches
1728 1729 (try 'hg help' for a list of topics)
1729 1730 [10]
1730 1731
1731 1732 Test omit indicating for help
1732 1733
1733 1734 $ cat > addverboseitems.py <<EOF
1734 1735 > r'''extension to test omit indicating.
1735 1736 >
1736 1737 > This paragraph is never omitted (for extension)
1737 1738 >
1738 1739 > .. container:: verbose
1739 1740 >
1740 1741 > This paragraph is omitted,
1741 1742 > if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
1742 1743 >
1743 1744 > This paragraph is never omitted, too (for extension)
1744 1745 > '''
1745 1746 > from __future__ import absolute_import
1746 1747 > from mercurial import commands, help
1747 1748 > testtopic = br"""This paragraph is never omitted (for topic).
1748 1749 >
1749 1750 > .. container:: verbose
1750 1751 >
1751 1752 > This paragraph is omitted,
1752 1753 > if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
1753 1754 >
1754 1755 > This paragraph is never omitted, too (for topic)
1755 1756 > """
1756 1757 > def extsetup(ui):
1757 1758 > help.helptable.append(([b"topic-containing-verbose"],
1758 1759 > b"This is the topic to test omit indicating.",
1759 1760 > lambda ui: testtopic))
1760 1761 > EOF
1761 1762 $ echo '[extensions]' >> $HGRCPATH
1762 1763 $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
1763 1764 $ hg help addverboseitems
1764 1765 addverboseitems extension - extension to test omit indicating.
1765 1766
1766 1767 This paragraph is never omitted (for extension)
1767 1768
1768 1769 This paragraph is never omitted, too (for extension)
1769 1770
1770 1771 (some details hidden, use --verbose to show complete help)
1771 1772
1772 1773 no commands defined
1773 1774 $ hg help -v addverboseitems
1774 1775 addverboseitems extension - extension to test omit indicating.
1775 1776
1776 1777 This paragraph is never omitted (for extension)
1777 1778
1778 1779 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1779 1780 extension)
1780 1781
1781 1782 This paragraph is never omitted, too (for extension)
1782 1783
1783 1784 no commands defined
1784 1785 $ hg help topic-containing-verbose
1785 1786 This is the topic to test omit indicating.
1786 1787 """"""""""""""""""""""""""""""""""""""""""
1787 1788
1788 1789 This paragraph is never omitted (for topic).
1789 1790
1790 1791 This paragraph is never omitted, too (for topic)
1791 1792
1792 1793 (some details hidden, use --verbose to show complete help)
1793 1794 $ hg help -v topic-containing-verbose
1794 1795 This is the topic to test omit indicating.
1795 1796 """"""""""""""""""""""""""""""""""""""""""
1796 1797
1797 1798 This paragraph is never omitted (for topic).
1798 1799
1799 1800 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1800 1801 topic)
1801 1802
1802 1803 This paragraph is never omitted, too (for topic)
1803 1804
1804 1805 Test section lookup
1805 1806
1806 1807 $ hg help revset.merge
1807 1808 "merge()"
1808 1809 Changeset is a merge changeset.
1809 1810
1810 1811 $ hg help glossary.dag
1811 1812 DAG
1812 1813 The repository of changesets of a distributed version control system
1813 1814 (DVCS) can be described as a directed acyclic graph (DAG), consisting
1814 1815 of nodes and edges, where nodes correspond to changesets and edges
1815 1816 imply a parent -> child relation. This graph can be visualized by
1816 1817 graphical tools such as 'hg log --graph'. In Mercurial, the DAG is
1817 1818 limited by the requirement for children to have at most two parents.
1818 1819
1819 1820
1820 1821 $ hg help hgrc.paths
1821 1822 "paths"
1822 1823 -------
1823 1824
1824 1825 Assigns symbolic names and behavior to repositories.
1825 1826
1826 1827 Options are symbolic names defining the URL or directory that is the
1827 1828 location of the repository. Example:
1828 1829
1829 1830 [paths]
1830 1831 my_server = https://example.com/my_repo
1831 1832 local_path = /home/me/repo
1832 1833
1833 1834 These symbolic names can be used from the command line. To pull from
1834 1835 "my_server": 'hg pull my_server'. To push to "local_path": 'hg push
1835 1836 local_path'.
1836 1837
1837 1838 Options containing colons (":") denote sub-options that can influence
1838 1839 behavior for that specific path. Example:
1839 1840
1840 1841 [paths]
1841 1842 my_server = https://example.com/my_path
1842 1843 my_server:pushurl = ssh://example.com/my_path
1843 1844
1844 1845 The following sub-options can be defined:
1845 1846
1846 1847 "pushurl"
1847 1848 The URL to use for push operations. If not defined, the location
1848 1849 defined by the path's main entry is used.
1849 1850
1850 1851 "pushrev"
1851 1852 A revset defining which revisions to push by default.
1852 1853
1853 1854 When 'hg push' is executed without a "-r" argument, the revset defined
1854 1855 by this sub-option is evaluated to determine what to push.
1855 1856
1856 1857 For example, a value of "." will push the working directory's revision
1857 1858 by default.
1858 1859
1859 1860 Revsets specifying bookmarks will not result in the bookmark being
1860 1861 pushed.
1861 1862
1862 1863 The following special named paths exist:
1863 1864
1864 1865 "default"
1865 1866 The URL or directory to use when no source or remote is specified.
1866 1867
1867 1868 'hg clone' will automatically define this path to the location the
1868 1869 repository was cloned from.
1869 1870
1870 1871 "default-push"
1871 1872 (deprecated) The URL or directory for the default 'hg push' location.
1872 1873 "default:pushurl" should be used instead.
1873 1874
1874 1875 $ hg help glossary.mcguffin
1875 1876 abort: help section not found: glossary.mcguffin
1876 1877 [10]
1877 1878
1878 1879 $ hg help glossary.mc.guffin
1879 1880 abort: help section not found: glossary.mc.guffin
1880 1881 [10]
1881 1882
1882 1883 $ hg help template.files
1883 1884 files List of strings. All files modified, added, or removed by
1884 1885 this changeset.
1885 1886 files(pattern)
1886 1887 All files of the current changeset matching the pattern. See
1887 1888 'hg help patterns'.
1888 1889
1889 1890 Test section lookup by translated message
1890 1891
1891 1892 str.lower() instead of encoding.lower(str) on translated message might
1892 1893 make message meaningless, because some encoding uses 0x41(A) - 0x5a(Z)
1893 1894 as the second or later byte of multi-byte character.
1894 1895
1895 1896 For example, "\x8bL\x98^" (translation of "record" in ja_JP.cp932)
1896 1897 contains 0x4c (L). str.lower() replaces 0x4c(L) by 0x6c(l) and this
1897 1898 replacement makes message meaningless.
1898 1899
1899 1900 This tests that section lookup by translated string isn't broken by
1900 1901 such str.lower().
1901 1902
1902 1903 $ "$PYTHON" <<EOF
1903 1904 > def escape(s):
1904 1905 > return b''.join(b'\\u%x' % ord(uc) for uc in s.decode('cp932'))
1905 1906 > # translation of "record" in ja_JP.cp932
1906 1907 > upper = b"\x8bL\x98^"
1907 1908 > # str.lower()-ed section name should be treated as different one
1908 1909 > lower = b"\x8bl\x98^"
1909 1910 > with open('ambiguous.py', 'wb') as fp:
1910 1911 > fp.write(b"""# ambiguous section names in ja_JP.cp932
1911 1912 > u'''summary of extension
1912 1913 >
1913 1914 > %s
1914 1915 > ----
1915 1916 >
1916 1917 > Upper name should show only this message
1917 1918 >
1918 1919 > %s
1919 1920 > ----
1920 1921 >
1921 1922 > Lower name should show only this message
1922 1923 >
1923 1924 > subsequent section
1924 1925 > ------------------
1925 1926 >
1926 1927 > This should be hidden at 'hg help ambiguous' with section name.
1927 1928 > '''
1928 1929 > """ % (escape(upper), escape(lower)))
1929 1930 > EOF
1930 1931
1931 1932 $ cat >> $HGRCPATH <<EOF
1932 1933 > [extensions]
1933 1934 > ambiguous = ./ambiguous.py
1934 1935 > EOF
1935 1936
1936 1937 $ "$PYTHON" <<EOF | sh
1937 1938 > from mercurial.utils import procutil
1938 1939 > upper = b"\x8bL\x98^"
1939 1940 > procutil.stdout.write(b"hg --encoding cp932 help -e ambiguous.%s\n" % upper)
1940 1941 > EOF
1941 1942 \x8bL\x98^ (esc)
1942 1943 ----
1943 1944
1944 1945 Upper name should show only this message
1945 1946
1946 1947
1947 1948 $ "$PYTHON" <<EOF | sh
1948 1949 > from mercurial.utils import procutil
1949 1950 > lower = b"\x8bl\x98^"
1950 1951 > procutil.stdout.write(b"hg --encoding cp932 help -e ambiguous.%s\n" % lower)
1951 1952 > EOF
1952 1953 \x8bl\x98^ (esc)
1953 1954 ----
1954 1955
1955 1956 Lower name should show only this message
1956 1957
1957 1958
1958 1959 $ cat >> $HGRCPATH <<EOF
1959 1960 > [extensions]
1960 1961 > ambiguous = !
1961 1962 > EOF
1962 1963
1963 1964 Show help content of disabled extensions
1964 1965
1965 1966 $ cat >> $HGRCPATH <<EOF
1966 1967 > [extensions]
1967 1968 > ambiguous = !./ambiguous.py
1968 1969 > EOF
1969 1970 $ hg help -e ambiguous
1970 1971 ambiguous extension - (no help text available)
1971 1972
1972 1973 (use 'hg help extensions' for information on enabling extensions)
1973 1974
1974 1975 Test dynamic list of merge tools only shows up once
1975 1976 $ hg help merge-tools
1976 1977 Merge Tools
1977 1978 """""""""""
1978 1979
1979 1980 To merge files Mercurial uses merge tools.
1980 1981
1981 1982 A merge tool combines two different versions of a file into a merged file.
1982 1983 Merge tools are given the two files and the greatest common ancestor of
1983 1984 the two file versions, so they can determine the changes made on both
1984 1985 branches.
1985 1986
1986 1987 Merge tools are used both for 'hg resolve', 'hg merge', 'hg update', 'hg
1987 1988 backout' and in several extensions.
1988 1989
1989 1990 Usually, the merge tool tries to automatically reconcile the files by
1990 1991 combining all non-overlapping changes that occurred separately in the two
1991 1992 different evolutions of the same initial base file. Furthermore, some
1992 1993 interactive merge programs make it easier to manually resolve conflicting
1993 1994 merges, either in a graphical way, or by inserting some conflict markers.
1994 1995 Mercurial does not include any interactive merge programs but relies on
1995 1996 external tools for that.
1996 1997
1997 1998 Available merge tools
1998 1999 =====================
1999 2000
2000 2001 External merge tools and their properties are configured in the merge-
2001 2002 tools configuration section - see hgrc(5) - but they can often just be
2002 2003 named by their executable.
2003 2004
2004 2005 A merge tool is generally usable if its executable can be found on the
2005 2006 system and if it can handle the merge. The executable is found if it is an
2006 2007 absolute or relative executable path or the name of an application in the
2007 2008 executable search path. The tool is assumed to be able to handle the merge
2008 2009 if it can handle symlinks if the file is a symlink, if it can handle
2009 2010 binary files if the file is binary, and if a GUI is available if the tool
2010 2011 requires a GUI.
2011 2012
2012 2013 There are some internal merge tools which can be used. The internal merge
2013 2014 tools are:
2014 2015
2015 2016 ":dump"
2016 2017 Creates three versions of the files to merge, containing the contents of
2017 2018 local, other and base. These files can then be used to perform a merge
2018 2019 manually. If the file to be merged is named "a.txt", these files will
2019 2020 accordingly be named "a.txt.local", "a.txt.other" and "a.txt.base" and
2020 2021 they will be placed in the same directory as "a.txt".
2021 2022
2022 2023 This implies premerge. Therefore, files aren't dumped, if premerge runs
2023 2024 successfully. Use :forcedump to forcibly write files out.
2024 2025
2025 2026 (actual capabilities: binary, symlink)
2026 2027
2027 2028 ":fail"
2028 2029 Rather than attempting to merge files that were modified on both
2029 2030 branches, it marks them as unresolved. The resolve command must be used
2030 2031 to resolve these conflicts.
2031 2032
2032 2033 (actual capabilities: binary, symlink)
2033 2034
2034 2035 ":forcedump"
2035 2036 Creates three versions of the files as same as :dump, but omits
2036 2037 premerge.
2037 2038
2038 2039 (actual capabilities: binary, symlink)
2039 2040
2040 2041 ":local"
2041 2042 Uses the local 'p1()' version of files as the merged version.
2042 2043
2043 2044 (actual capabilities: binary, symlink)
2044 2045
2045 2046 ":merge"
2046 2047 Uses the internal non-interactive simple merge algorithm for merging
2047 2048 files. It will fail if there are any conflicts and leave markers in the
2048 2049 partially merged file. Markers will have two sections, one for each side
2049 2050 of merge.
2050 2051
2051 2052 ":merge-local"
2052 2053 Like :merge, but resolve all conflicts non-interactively in favor of the
2053 2054 local 'p1()' changes.
2054 2055
2055 2056 ":merge-other"
2056 2057 Like :merge, but resolve all conflicts non-interactively in favor of the
2057 2058 other 'p2()' changes.
2058 2059
2059 2060 ":merge3"
2060 2061 Uses the internal non-interactive simple merge algorithm for merging
2061 2062 files. It will fail if there are any conflicts and leave markers in the
2062 2063 partially merged file. Marker will have three sections, one from each
2063 2064 side of the merge and one for the base content.
2064 2065
2065 2066 ":mergediff"
2066 2067 Uses the internal non-interactive simple merge algorithm for merging
2067 2068 files. It will fail if there are any conflicts and leave markers in the
2068 2069 partially merged file. The marker will have two sections, one with the
2069 2070 content from one side of the merge, and one with a diff from the base
2070 2071 content to the content on the other side. (experimental)
2071 2072
2072 2073 ":other"
2073 2074 Uses the other 'p2()' version of files as the merged version.
2074 2075
2075 2076 (actual capabilities: binary, symlink)
2076 2077
2077 2078 ":prompt"
2078 2079 Asks the user which of the local 'p1()' or the other 'p2()' version to
2079 2080 keep as the merged version.
2080 2081
2081 2082 (actual capabilities: binary, symlink)
2082 2083
2083 2084 ":tagmerge"
2084 2085 Uses the internal tag merge algorithm (experimental).
2085 2086
2086 2087 ":union"
2087 2088 Uses the internal non-interactive simple merge algorithm for merging
2088 2089 files. It will use both left and right sides for conflict regions. No
2089 2090 markers are inserted.
2090 2091
2091 2092 Internal tools are always available and do not require a GUI but will by
2092 2093 default not handle symlinks or binary files. See next section for detail
2093 2094 about "actual capabilities" described above.
2094 2095
2095 2096 Choosing a merge tool
2096 2097 =====================
2097 2098
2098 2099 Mercurial uses these rules when deciding which merge tool to use:
2099 2100
2100 2101 1. If a tool has been specified with the --tool option to merge or
2101 2102 resolve, it is used. If it is the name of a tool in the merge-tools
2102 2103 configuration, its configuration is used. Otherwise the specified tool
2103 2104 must be executable by the shell.
2104 2105 2. If the "HGMERGE" environment variable is present, its value is used and
2105 2106 must be executable by the shell.
2106 2107 3. If the filename of the file to be merged matches any of the patterns in
2107 2108 the merge-patterns configuration section, the first usable merge tool
2108 2109 corresponding to a matching pattern is used.
2109 2110 4. If ui.merge is set it will be considered next. If the value is not the
2110 2111 name of a configured tool, the specified value is used and must be
2111 2112 executable by the shell. Otherwise the named tool is used if it is
2112 2113 usable.
2113 2114 5. If any usable merge tools are present in the merge-tools configuration
2114 2115 section, the one with the highest priority is used.
2115 2116 6. If a program named "hgmerge" can be found on the system, it is used -
2116 2117 but it will by default not be used for symlinks and binary files.
2117 2118 7. If the file to be merged is not binary and is not a symlink, then
2118 2119 internal ":merge" is used.
2119 2120 8. Otherwise, ":prompt" is used.
2120 2121
2121 2122 For historical reason, Mercurial treats merge tools as below while
2122 2123 examining rules above.
2123 2124
2124 2125 step specified via binary symlink
2125 2126 ----------------------------------
2126 2127 1. --tool o/o o/o
2127 2128 2. HGMERGE o/o o/o
2128 2129 3. merge-patterns o/o(*) x/?(*)
2129 2130 4. ui.merge x/?(*) x/?(*)
2130 2131
2131 2132 Each capability column indicates Mercurial behavior for internal/external
2132 2133 merge tools at examining each rule.
2133 2134
2134 2135 - "o": "assume that a tool has capability"
2135 2136 - "x": "assume that a tool does not have capability"
2136 2137 - "?": "check actual capability of a tool"
2137 2138
2138 2139 If "merge.strict-capability-check" configuration is true, Mercurial checks
2139 2140 capabilities of merge tools strictly in (*) cases above (= each capability
2140 2141 column becomes "?/?"). It is false by default for backward compatibility.
2141 2142
2142 2143 Note:
2143 2144 After selecting a merge program, Mercurial will by default attempt to
2144 2145 merge the files using a simple merge algorithm first. Only if it
2145 2146 doesn't succeed because of conflicting changes will Mercurial actually
2146 2147 execute the merge program. Whether to use the simple merge algorithm
2147 2148 first can be controlled by the premerge setting of the merge tool.
2148 2149 Premerge is enabled by default unless the file is binary or a symlink.
2149 2150
2150 2151 See the merge-tools and ui sections of hgrc(5) for details on the
2151 2152 configuration of merge tools.
2152 2153
2153 2154 Compression engines listed in `hg help bundlespec`
2154 2155
2155 2156 $ hg help bundlespec | grep gzip
2156 2157 "v1" bundles can only use the "gzip", "bzip2", and "none" compression
2157 2158 An algorithm that produces smaller bundles than "gzip".
2158 2159 This engine will likely produce smaller bundles than "gzip" but will be
2159 2160 "gzip"
2160 2161 better compression than "gzip". It also frequently yields better (?)
2161 2162
2162 2163 Test usage of section marks in help documents
2163 2164
2164 2165 $ cd "$TESTDIR"/../doc
2165 2166 $ "$PYTHON" check-seclevel.py
2166 2167 $ cd $TESTTMP
2167 2168
2168 2169 #if serve
2169 2170
2170 2171 Test the help pages in hgweb.
2171 2172
2172 2173 Dish up an empty repo; serve it cold.
2173 2174
2174 2175 $ hg init "$TESTTMP/test"
2175 2176 $ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
2176 2177 $ cat hg.pid >> $DAEMON_PIDS
2177 2178
2178 2179 $ get-with-headers.py $LOCALIP:$HGPORT "help"
2179 2180 200 Script output follows
2180 2181
2181 2182 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2182 2183 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2183 2184 <head>
2184 2185 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2185 2186 <meta name="robots" content="index, nofollow" />
2186 2187 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2187 2188 <script type="text/javascript" src="/static/mercurial.js"></script>
2188 2189
2189 2190 <title>Help: Index</title>
2190 2191 </head>
2191 2192 <body>
2192 2193
2193 2194 <div class="container">
2194 2195 <div class="menu">
2195 2196 <div class="logo">
2196 2197 <a href="https://mercurial-scm.org/">
2197 2198 <img src="/static/hglogo.png" alt="mercurial" /></a>
2198 2199 </div>
2199 2200 <ul>
2200 2201 <li><a href="/shortlog">log</a></li>
2201 2202 <li><a href="/graph">graph</a></li>
2202 2203 <li><a href="/tags">tags</a></li>
2203 2204 <li><a href="/bookmarks">bookmarks</a></li>
2204 2205 <li><a href="/branches">branches</a></li>
2205 2206 </ul>
2206 2207 <ul>
2207 2208 <li class="active">help</li>
2208 2209 </ul>
2209 2210 </div>
2210 2211
2211 2212 <div class="main">
2212 2213 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2213 2214
2214 2215 <form class="search" action="/log">
2215 2216
2216 2217 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2217 2218 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2218 2219 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2219 2220 </form>
2220 2221 <table class="bigtable">
2221 2222 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
2222 2223
2223 2224 <tr><td>
2224 2225 <a href="/help/bundlespec">
2225 2226 bundlespec
2226 2227 </a>
2227 2228 </td><td>
2228 2229 Bundle File Formats
2229 2230 </td></tr>
2230 2231 <tr><td>
2231 2232 <a href="/help/color">
2232 2233 color
2233 2234 </a>
2234 2235 </td><td>
2235 2236 Colorizing Outputs
2236 2237 </td></tr>
2237 2238 <tr><td>
2238 2239 <a href="/help/config">
2239 2240 config
2240 2241 </a>
2241 2242 </td><td>
2242 2243 Configuration Files
2243 2244 </td></tr>
2244 2245 <tr><td>
2245 2246 <a href="/help/dates">
2246 2247 dates
2247 2248 </a>
2248 2249 </td><td>
2249 2250 Date Formats
2250 2251 </td></tr>
2251 2252 <tr><td>
2252 2253 <a href="/help/deprecated">
2253 2254 deprecated
2254 2255 </a>
2255 2256 </td><td>
2256 2257 Deprecated Features
2257 2258 </td></tr>
2258 2259 <tr><td>
2259 2260 <a href="/help/diffs">
2260 2261 diffs
2261 2262 </a>
2262 2263 </td><td>
2263 2264 Diff Formats
2264 2265 </td></tr>
2265 2266 <tr><td>
2266 2267 <a href="/help/environment">
2267 2268 environment
2268 2269 </a>
2269 2270 </td><td>
2270 2271 Environment Variables
2271 2272 </td></tr>
2272 2273 <tr><td>
2273 2274 <a href="/help/extensions">
2274 2275 extensions
2275 2276 </a>
2276 2277 </td><td>
2277 2278 Using Additional Features
2278 2279 </td></tr>
2279 2280 <tr><td>
2280 2281 <a href="/help/filesets">
2281 2282 filesets
2282 2283 </a>
2283 2284 </td><td>
2284 2285 Specifying File Sets
2285 2286 </td></tr>
2286 2287 <tr><td>
2287 2288 <a href="/help/flags">
2288 2289 flags
2289 2290 </a>
2290 2291 </td><td>
2291 2292 Command-line flags
2292 2293 </td></tr>
2293 2294 <tr><td>
2294 2295 <a href="/help/glossary">
2295 2296 glossary
2296 2297 </a>
2297 2298 </td><td>
2298 2299 Glossary
2299 2300 </td></tr>
2300 2301 <tr><td>
2301 2302 <a href="/help/hgignore">
2302 2303 hgignore
2303 2304 </a>
2304 2305 </td><td>
2305 2306 Syntax for Mercurial Ignore Files
2306 2307 </td></tr>
2307 2308 <tr><td>
2308 2309 <a href="/help/hgweb">
2309 2310 hgweb
2310 2311 </a>
2311 2312 </td><td>
2312 2313 Configuring hgweb
2313 2314 </td></tr>
2314 2315 <tr><td>
2315 2316 <a href="/help/internals">
2316 2317 internals
2317 2318 </a>
2318 2319 </td><td>
2319 2320 Technical implementation topics
2320 2321 </td></tr>
2321 2322 <tr><td>
2322 2323 <a href="/help/merge-tools">
2323 2324 merge-tools
2324 2325 </a>
2325 2326 </td><td>
2326 2327 Merge Tools
2327 2328 </td></tr>
2328 2329 <tr><td>
2329 2330 <a href="/help/pager">
2330 2331 pager
2331 2332 </a>
2332 2333 </td><td>
2333 2334 Pager Support
2334 2335 </td></tr>
2335 2336 <tr><td>
2336 2337 <a href="/help/patterns">
2337 2338 patterns
2338 2339 </a>
2339 2340 </td><td>
2340 2341 File Name Patterns
2341 2342 </td></tr>
2342 2343 <tr><td>
2343 2344 <a href="/help/phases">
2344 2345 phases
2345 2346 </a>
2346 2347 </td><td>
2347 2348 Working with Phases
2348 2349 </td></tr>
2349 2350 <tr><td>
2350 2351 <a href="/help/revisions">
2351 2352 revisions
2352 2353 </a>
2353 2354 </td><td>
2354 2355 Specifying Revisions
2355 2356 </td></tr>
2356 2357 <tr><td>
2357 2358 <a href="/help/scripting">
2358 2359 scripting
2359 2360 </a>
2360 2361 </td><td>
2361 2362 Using Mercurial from scripts and automation
2362 2363 </td></tr>
2363 2364 <tr><td>
2364 2365 <a href="/help/subrepos">
2365 2366 subrepos
2366 2367 </a>
2367 2368 </td><td>
2368 2369 Subrepositories
2369 2370 </td></tr>
2370 2371 <tr><td>
2371 2372 <a href="/help/templating">
2372 2373 templating
2373 2374 </a>
2374 2375 </td><td>
2375 2376 Template Usage
2376 2377 </td></tr>
2377 2378 <tr><td>
2378 2379 <a href="/help/urls">
2379 2380 urls
2380 2381 </a>
2381 2382 </td><td>
2382 2383 URL Paths
2383 2384 </td></tr>
2384 2385 <tr><td>
2385 2386 <a href="/help/topic-containing-verbose">
2386 2387 topic-containing-verbose
2387 2388 </a>
2388 2389 </td><td>
2389 2390 This is the topic to test omit indicating.
2390 2391 </td></tr>
2391 2392
2392 2393
2393 2394 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
2394 2395
2395 2396 <tr><td>
2396 2397 <a href="/help/abort">
2397 2398 abort
2398 2399 </a>
2399 2400 </td><td>
2400 2401 abort an unfinished operation (EXPERIMENTAL)
2401 2402 </td></tr>
2402 2403 <tr><td>
2403 2404 <a href="/help/add">
2404 2405 add
2405 2406 </a>
2406 2407 </td><td>
2407 2408 add the specified files on the next commit
2408 2409 </td></tr>
2409 2410 <tr><td>
2410 2411 <a href="/help/annotate">
2411 2412 annotate
2412 2413 </a>
2413 2414 </td><td>
2414 2415 show changeset information by line for each file
2415 2416 </td></tr>
2416 2417 <tr><td>
2417 2418 <a href="/help/clone">
2418 2419 clone
2419 2420 </a>
2420 2421 </td><td>
2421 2422 make a copy of an existing repository
2422 2423 </td></tr>
2423 2424 <tr><td>
2424 2425 <a href="/help/commit">
2425 2426 commit
2426 2427 </a>
2427 2428 </td><td>
2428 2429 commit the specified files or all outstanding changes
2429 2430 </td></tr>
2430 2431 <tr><td>
2431 2432 <a href="/help/continue">
2432 2433 continue
2433 2434 </a>
2434 2435 </td><td>
2435 2436 resumes an interrupted operation (EXPERIMENTAL)
2436 2437 </td></tr>
2437 2438 <tr><td>
2438 2439 <a href="/help/diff">
2439 2440 diff
2440 2441 </a>
2441 2442 </td><td>
2442 2443 diff repository (or selected files)
2443 2444 </td></tr>
2444 2445 <tr><td>
2445 2446 <a href="/help/export">
2446 2447 export
2447 2448 </a>
2448 2449 </td><td>
2449 2450 dump the header and diffs for one or more changesets
2450 2451 </td></tr>
2451 2452 <tr><td>
2452 2453 <a href="/help/forget">
2453 2454 forget
2454 2455 </a>
2455 2456 </td><td>
2456 2457 forget the specified files on the next commit
2457 2458 </td></tr>
2458 2459 <tr><td>
2459 2460 <a href="/help/init">
2460 2461 init
2461 2462 </a>
2462 2463 </td><td>
2463 2464 create a new repository in the given directory
2464 2465 </td></tr>
2465 2466 <tr><td>
2466 2467 <a href="/help/log">
2467 2468 log
2468 2469 </a>
2469 2470 </td><td>
2470 2471 show revision history of entire repository or files
2471 2472 </td></tr>
2472 2473 <tr><td>
2473 2474 <a href="/help/merge">
2474 2475 merge
2475 2476 </a>
2476 2477 </td><td>
2477 2478 merge another revision into working directory
2478 2479 </td></tr>
2479 2480 <tr><td>
2480 2481 <a href="/help/pull">
2481 2482 pull
2482 2483 </a>
2483 2484 </td><td>
2484 2485 pull changes from the specified source
2485 2486 </td></tr>
2486 2487 <tr><td>
2487 2488 <a href="/help/push">
2488 2489 push
2489 2490 </a>
2490 2491 </td><td>
2491 2492 push changes to the specified destination
2492 2493 </td></tr>
2493 2494 <tr><td>
2494 2495 <a href="/help/remove">
2495 2496 remove
2496 2497 </a>
2497 2498 </td><td>
2498 2499 remove the specified files on the next commit
2499 2500 </td></tr>
2500 2501 <tr><td>
2501 2502 <a href="/help/serve">
2502 2503 serve
2503 2504 </a>
2504 2505 </td><td>
2505 2506 start stand-alone webserver
2506 2507 </td></tr>
2507 2508 <tr><td>
2508 2509 <a href="/help/status">
2509 2510 status
2510 2511 </a>
2511 2512 </td><td>
2512 2513 show changed files in the working directory
2513 2514 </td></tr>
2514 2515 <tr><td>
2515 2516 <a href="/help/summary">
2516 2517 summary
2517 2518 </a>
2518 2519 </td><td>
2519 2520 summarize working directory state
2520 2521 </td></tr>
2521 2522 <tr><td>
2522 2523 <a href="/help/update">
2523 2524 update
2524 2525 </a>
2525 2526 </td><td>
2526 2527 update working directory (or switch revisions)
2527 2528 </td></tr>
2528 2529
2529 2530
2530 2531
2531 2532 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
2532 2533
2533 2534 <tr><td>
2534 2535 <a href="/help/addremove">
2535 2536 addremove
2536 2537 </a>
2537 2538 </td><td>
2538 2539 add all new files, delete all missing files
2539 2540 </td></tr>
2540 2541 <tr><td>
2541 2542 <a href="/help/archive">
2542 2543 archive
2543 2544 </a>
2544 2545 </td><td>
2545 2546 create an unversioned archive of a repository revision
2546 2547 </td></tr>
2547 2548 <tr><td>
2548 2549 <a href="/help/backout">
2549 2550 backout
2550 2551 </a>
2551 2552 </td><td>
2552 2553 reverse effect of earlier changeset
2553 2554 </td></tr>
2554 2555 <tr><td>
2555 2556 <a href="/help/bisect">
2556 2557 bisect
2557 2558 </a>
2558 2559 </td><td>
2559 2560 subdivision search of changesets
2560 2561 </td></tr>
2561 2562 <tr><td>
2562 2563 <a href="/help/bookmarks">
2563 2564 bookmarks
2564 2565 </a>
2565 2566 </td><td>
2566 2567 create a new bookmark or list existing bookmarks
2567 2568 </td></tr>
2568 2569 <tr><td>
2569 2570 <a href="/help/branch">
2570 2571 branch
2571 2572 </a>
2572 2573 </td><td>
2573 2574 set or show the current branch name
2574 2575 </td></tr>
2575 2576 <tr><td>
2576 2577 <a href="/help/branches">
2577 2578 branches
2578 2579 </a>
2579 2580 </td><td>
2580 2581 list repository named branches
2581 2582 </td></tr>
2582 2583 <tr><td>
2583 2584 <a href="/help/bundle">
2584 2585 bundle
2585 2586 </a>
2586 2587 </td><td>
2587 2588 create a bundle file
2588 2589 </td></tr>
2589 2590 <tr><td>
2590 2591 <a href="/help/cat">
2591 2592 cat
2592 2593 </a>
2593 2594 </td><td>
2594 2595 output the current or given revision of files
2595 2596 </td></tr>
2596 2597 <tr><td>
2597 2598 <a href="/help/config">
2598 2599 config
2599 2600 </a>
2600 2601 </td><td>
2601 2602 show combined config settings from all hgrc files
2602 2603 </td></tr>
2603 2604 <tr><td>
2604 2605 <a href="/help/copy">
2605 2606 copy
2606 2607 </a>
2607 2608 </td><td>
2608 2609 mark files as copied for the next commit
2609 2610 </td></tr>
2610 2611 <tr><td>
2611 2612 <a href="/help/files">
2612 2613 files
2613 2614 </a>
2614 2615 </td><td>
2615 2616 list tracked files
2616 2617 </td></tr>
2617 2618 <tr><td>
2618 2619 <a href="/help/graft">
2619 2620 graft
2620 2621 </a>
2621 2622 </td><td>
2622 2623 copy changes from other branches onto the current branch
2623 2624 </td></tr>
2624 2625 <tr><td>
2625 2626 <a href="/help/grep">
2626 2627 grep
2627 2628 </a>
2628 2629 </td><td>
2629 2630 search for a pattern in specified files
2630 2631 </td></tr>
2631 2632 <tr><td>
2632 2633 <a href="/help/hashelp">
2633 2634 hashelp
2634 2635 </a>
2635 2636 </td><td>
2636 2637 Extension command's help
2637 2638 </td></tr>
2638 2639 <tr><td>
2639 2640 <a href="/help/heads">
2640 2641 heads
2641 2642 </a>
2642 2643 </td><td>
2643 2644 show branch heads
2644 2645 </td></tr>
2645 2646 <tr><td>
2646 2647 <a href="/help/help">
2647 2648 help
2648 2649 </a>
2649 2650 </td><td>
2650 2651 show help for a given topic or a help overview
2651 2652 </td></tr>
2652 2653 <tr><td>
2653 2654 <a href="/help/hgalias">
2654 2655 hgalias
2655 2656 </a>
2656 2657 </td><td>
2657 2658 My doc
2658 2659 </td></tr>
2659 2660 <tr><td>
2660 2661 <a href="/help/hgaliasnodoc">
2661 2662 hgaliasnodoc
2662 2663 </a>
2663 2664 </td><td>
2664 2665 summarize working directory state
2665 2666 </td></tr>
2666 2667 <tr><td>
2667 2668 <a href="/help/identify">
2668 2669 identify
2669 2670 </a>
2670 2671 </td><td>
2671 2672 identify the working directory or specified revision
2672 2673 </td></tr>
2673 2674 <tr><td>
2674 2675 <a href="/help/import">
2675 2676 import
2676 2677 </a>
2677 2678 </td><td>
2678 2679 import an ordered set of patches
2679 2680 </td></tr>
2680 2681 <tr><td>
2681 2682 <a href="/help/incoming">
2682 2683 incoming
2683 2684 </a>
2684 2685 </td><td>
2685 2686 show new changesets found in source
2686 2687 </td></tr>
2687 2688 <tr><td>
2688 2689 <a href="/help/manifest">
2689 2690 manifest
2690 2691 </a>
2691 2692 </td><td>
2692 2693 output the current or given revision of the project manifest
2693 2694 </td></tr>
2694 2695 <tr><td>
2695 2696 <a href="/help/nohelp">
2696 2697 nohelp
2697 2698 </a>
2698 2699 </td><td>
2699 2700 (no help text available)
2700 2701 </td></tr>
2701 2702 <tr><td>
2702 2703 <a href="/help/outgoing">
2703 2704 outgoing
2704 2705 </a>
2705 2706 </td><td>
2706 2707 show changesets not found in the destination
2707 2708 </td></tr>
2708 2709 <tr><td>
2709 2710 <a href="/help/paths">
2710 2711 paths
2711 2712 </a>
2712 2713 </td><td>
2713 2714 show aliases for remote repositories
2714 2715 </td></tr>
2715 2716 <tr><td>
2716 2717 <a href="/help/phase">
2717 2718 phase
2718 2719 </a>
2719 2720 </td><td>
2720 2721 set or show the current phase name
2721 2722 </td></tr>
2722 2723 <tr><td>
2723 2724 <a href="/help/purge">
2724 2725 purge
2725 2726 </a>
2726 2727 </td><td>
2727 2728 removes files not tracked by Mercurial
2728 2729 </td></tr>
2729 2730 <tr><td>
2730 2731 <a href="/help/recover">
2731 2732 recover
2732 2733 </a>
2733 2734 </td><td>
2734 2735 roll back an interrupted transaction
2735 2736 </td></tr>
2736 2737 <tr><td>
2737 2738 <a href="/help/rename">
2738 2739 rename
2739 2740 </a>
2740 2741 </td><td>
2741 2742 rename files; equivalent of copy + remove
2742 2743 </td></tr>
2743 2744 <tr><td>
2744 2745 <a href="/help/resolve">
2745 2746 resolve
2746 2747 </a>
2747 2748 </td><td>
2748 2749 redo merges or set/view the merge status of files
2749 2750 </td></tr>
2750 2751 <tr><td>
2751 2752 <a href="/help/revert">
2752 2753 revert
2753 2754 </a>
2754 2755 </td><td>
2755 2756 restore files to their checkout state
2756 2757 </td></tr>
2757 2758 <tr><td>
2758 2759 <a href="/help/root">
2759 2760 root
2760 2761 </a>
2761 2762 </td><td>
2762 2763 print the root (top) of the current working directory
2763 2764 </td></tr>
2764 2765 <tr><td>
2765 2766 <a href="/help/shellalias">
2766 2767 shellalias
2767 2768 </a>
2768 2769 </td><td>
2769 2770 (no help text available)
2770 2771 </td></tr>
2771 2772 <tr><td>
2772 2773 <a href="/help/shelve">
2773 2774 shelve
2774 2775 </a>
2775 2776 </td><td>
2776 2777 save and set aside changes from the working directory
2777 2778 </td></tr>
2778 2779 <tr><td>
2779 2780 <a href="/help/tag">
2780 2781 tag
2781 2782 </a>
2782 2783 </td><td>
2783 2784 add one or more tags for the current or given revision
2784 2785 </td></tr>
2785 2786 <tr><td>
2786 2787 <a href="/help/tags">
2787 2788 tags
2788 2789 </a>
2789 2790 </td><td>
2790 2791 list repository tags
2791 2792 </td></tr>
2792 2793 <tr><td>
2793 2794 <a href="/help/unbundle">
2794 2795 unbundle
2795 2796 </a>
2796 2797 </td><td>
2797 2798 apply one or more bundle files
2798 2799 </td></tr>
2799 2800 <tr><td>
2800 2801 <a href="/help/unshelve">
2801 2802 unshelve
2802 2803 </a>
2803 2804 </td><td>
2804 2805 restore a shelved change to the working directory
2805 2806 </td></tr>
2806 2807 <tr><td>
2807 2808 <a href="/help/verify">
2808 2809 verify
2809 2810 </a>
2810 2811 </td><td>
2811 2812 verify the integrity of the repository
2812 2813 </td></tr>
2813 2814 <tr><td>
2814 2815 <a href="/help/version">
2815 2816 version
2816 2817 </a>
2817 2818 </td><td>
2818 2819 output version and copyright information
2819 2820 </td></tr>
2820 2821
2821 2822
2822 2823 </table>
2823 2824 </div>
2824 2825 </div>
2825 2826
2826 2827
2827 2828
2828 2829 </body>
2829 2830 </html>
2830 2831
2831 2832
2832 2833 $ get-with-headers.py $LOCALIP:$HGPORT "help/add"
2833 2834 200 Script output follows
2834 2835
2835 2836 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2836 2837 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2837 2838 <head>
2838 2839 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2839 2840 <meta name="robots" content="index, nofollow" />
2840 2841 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2841 2842 <script type="text/javascript" src="/static/mercurial.js"></script>
2842 2843
2843 2844 <title>Help: add</title>
2844 2845 </head>
2845 2846 <body>
2846 2847
2847 2848 <div class="container">
2848 2849 <div class="menu">
2849 2850 <div class="logo">
2850 2851 <a href="https://mercurial-scm.org/">
2851 2852 <img src="/static/hglogo.png" alt="mercurial" /></a>
2852 2853 </div>
2853 2854 <ul>
2854 2855 <li><a href="/shortlog">log</a></li>
2855 2856 <li><a href="/graph">graph</a></li>
2856 2857 <li><a href="/tags">tags</a></li>
2857 2858 <li><a href="/bookmarks">bookmarks</a></li>
2858 2859 <li><a href="/branches">branches</a></li>
2859 2860 </ul>
2860 2861 <ul>
2861 2862 <li class="active"><a href="/help">help</a></li>
2862 2863 </ul>
2863 2864 </div>
2864 2865
2865 2866 <div class="main">
2866 2867 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2867 2868 <h3>Help: add</h3>
2868 2869
2869 2870 <form class="search" action="/log">
2870 2871
2871 2872 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2872 2873 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2873 2874 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2874 2875 </form>
2875 2876 <div id="doc">
2876 2877 <p>
2877 2878 hg add [OPTION]... [FILE]...
2878 2879 </p>
2879 2880 <p>
2880 2881 add the specified files on the next commit
2881 2882 </p>
2882 2883 <p>
2883 2884 Schedule files to be version controlled and added to the
2884 2885 repository.
2885 2886 </p>
2886 2887 <p>
2887 2888 The files will be added to the repository at the next commit. To
2888 2889 undo an add before that, see 'hg forget'.
2889 2890 </p>
2890 2891 <p>
2891 2892 If no names are given, add all files to the repository (except
2892 2893 files matching &quot;.hgignore&quot;).
2893 2894 </p>
2894 2895 <p>
2895 2896 Examples:
2896 2897 </p>
2897 2898 <ul>
2898 2899 <li> New (unknown) files are added automatically by 'hg add':
2899 2900 <pre>
2900 2901 \$ ls (re)
2901 2902 foo.c
2902 2903 \$ hg status (re)
2903 2904 ? foo.c
2904 2905 \$ hg add (re)
2905 2906 adding foo.c
2906 2907 \$ hg status (re)
2907 2908 A foo.c
2908 2909 </pre>
2909 2910 <li> Specific files to be added can be specified:
2910 2911 <pre>
2911 2912 \$ ls (re)
2912 2913 bar.c foo.c
2913 2914 \$ hg status (re)
2914 2915 ? bar.c
2915 2916 ? foo.c
2916 2917 \$ hg add bar.c (re)
2917 2918 \$ hg status (re)
2918 2919 A bar.c
2919 2920 ? foo.c
2920 2921 </pre>
2921 2922 </ul>
2922 2923 <p>
2923 2924 Returns 0 if all files are successfully added.
2924 2925 </p>
2925 2926 <p>
2926 2927 options ([+] can be repeated):
2927 2928 </p>
2928 2929 <table>
2929 2930 <tr><td>-I</td>
2930 2931 <td>--include PATTERN [+]</td>
2931 2932 <td>include names matching the given patterns</td></tr>
2932 2933 <tr><td>-X</td>
2933 2934 <td>--exclude PATTERN [+]</td>
2934 2935 <td>exclude names matching the given patterns</td></tr>
2935 2936 <tr><td>-S</td>
2936 2937 <td>--subrepos</td>
2937 2938 <td>recurse into subrepositories</td></tr>
2938 2939 <tr><td>-n</td>
2939 2940 <td>--dry-run</td>
2940 2941 <td>do not perform actions, just print output</td></tr>
2941 2942 </table>
2942 2943 <p>
2943 2944 global options ([+] can be repeated):
2944 2945 </p>
2945 2946 <table>
2946 2947 <tr><td>-R</td>
2947 2948 <td>--repository REPO</td>
2948 2949 <td>repository root directory or name of overlay bundle file</td></tr>
2949 2950 <tr><td></td>
2950 2951 <td>--cwd DIR</td>
2951 2952 <td>change working directory</td></tr>
2952 2953 <tr><td>-y</td>
2953 2954 <td>--noninteractive</td>
2954 2955 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2955 2956 <tr><td>-q</td>
2956 2957 <td>--quiet</td>
2957 2958 <td>suppress output</td></tr>
2958 2959 <tr><td>-v</td>
2959 2960 <td>--verbose</td>
2960 2961 <td>enable additional output</td></tr>
2961 2962 <tr><td></td>
2962 2963 <td>--color TYPE</td>
2963 2964 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
2964 2965 <tr><td></td>
2965 2966 <td>--config CONFIG [+]</td>
2966 2967 <td>set/override config option (use 'section.name=value')</td></tr>
2967 2968 <tr><td></td>
2968 2969 <td>--debug</td>
2969 2970 <td>enable debugging output</td></tr>
2970 2971 <tr><td></td>
2971 2972 <td>--debugger</td>
2972 2973 <td>start debugger</td></tr>
2973 2974 <tr><td></td>
2974 2975 <td>--encoding ENCODE</td>
2975 2976 <td>set the charset encoding (default: ascii)</td></tr>
2976 2977 <tr><td></td>
2977 2978 <td>--encodingmode MODE</td>
2978 2979 <td>set the charset encoding mode (default: strict)</td></tr>
2979 2980 <tr><td></td>
2980 2981 <td>--traceback</td>
2981 2982 <td>always print a traceback on exception</td></tr>
2982 2983 <tr><td></td>
2983 2984 <td>--time</td>
2984 2985 <td>time how long the command takes</td></tr>
2985 2986 <tr><td></td>
2986 2987 <td>--profile</td>
2987 2988 <td>print command execution profile</td></tr>
2988 2989 <tr><td></td>
2989 2990 <td>--version</td>
2990 2991 <td>output version information and exit</td></tr>
2991 2992 <tr><td>-h</td>
2992 2993 <td>--help</td>
2993 2994 <td>display help and exit</td></tr>
2994 2995 <tr><td></td>
2995 2996 <td>--hidden</td>
2996 2997 <td>consider hidden changesets</td></tr>
2997 2998 <tr><td></td>
2998 2999 <td>--pager TYPE</td>
2999 3000 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
3000 3001 </table>
3001 3002
3002 3003 </div>
3003 3004 </div>
3004 3005 </div>
3005 3006
3006 3007
3007 3008
3008 3009 </body>
3009 3010 </html>
3010 3011
3011 3012
3012 3013 $ get-with-headers.py $LOCALIP:$HGPORT "help/remove"
3013 3014 200 Script output follows
3014 3015
3015 3016 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3016 3017 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3017 3018 <head>
3018 3019 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3019 3020 <meta name="robots" content="index, nofollow" />
3020 3021 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3021 3022 <script type="text/javascript" src="/static/mercurial.js"></script>
3022 3023
3023 3024 <title>Help: remove</title>
3024 3025 </head>
3025 3026 <body>
3026 3027
3027 3028 <div class="container">
3028 3029 <div class="menu">
3029 3030 <div class="logo">
3030 3031 <a href="https://mercurial-scm.org/">
3031 3032 <img src="/static/hglogo.png" alt="mercurial" /></a>
3032 3033 </div>
3033 3034 <ul>
3034 3035 <li><a href="/shortlog">log</a></li>
3035 3036 <li><a href="/graph">graph</a></li>
3036 3037 <li><a href="/tags">tags</a></li>
3037 3038 <li><a href="/bookmarks">bookmarks</a></li>
3038 3039 <li><a href="/branches">branches</a></li>
3039 3040 </ul>
3040 3041 <ul>
3041 3042 <li class="active"><a href="/help">help</a></li>
3042 3043 </ul>
3043 3044 </div>
3044 3045
3045 3046 <div class="main">
3046 3047 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3047 3048 <h3>Help: remove</h3>
3048 3049
3049 3050 <form class="search" action="/log">
3050 3051
3051 3052 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3052 3053 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3053 3054 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3054 3055 </form>
3055 3056 <div id="doc">
3056 3057 <p>
3057 3058 hg remove [OPTION]... FILE...
3058 3059 </p>
3059 3060 <p>
3060 3061 aliases: rm
3061 3062 </p>
3062 3063 <p>
3063 3064 remove the specified files on the next commit
3064 3065 </p>
3065 3066 <p>
3066 3067 Schedule the indicated files for removal from the current branch.
3067 3068 </p>
3068 3069 <p>
3069 3070 This command schedules the files to be removed at the next commit.
3070 3071 To undo a remove before that, see 'hg revert'. To undo added
3071 3072 files, see 'hg forget'.
3072 3073 </p>
3073 3074 <p>
3074 3075 -A/--after can be used to remove only files that have already
3075 3076 been deleted, -f/--force can be used to force deletion, and -Af
3076 3077 can be used to remove files from the next revision without
3077 3078 deleting them from the working directory.
3078 3079 </p>
3079 3080 <p>
3080 3081 The following table details the behavior of remove for different
3081 3082 file states (columns) and option combinations (rows). The file
3082 3083 states are Added [A], Clean [C], Modified [M] and Missing [!]
3083 3084 (as reported by 'hg status'). The actions are Warn, Remove
3084 3085 (from branch) and Delete (from disk):
3085 3086 </p>
3086 3087 <table>
3087 3088 <tr><td>opt/state</td>
3088 3089 <td>A</td>
3089 3090 <td>C</td>
3090 3091 <td>M</td>
3091 3092 <td>!</td></tr>
3092 3093 <tr><td>none</td>
3093 3094 <td>W</td>
3094 3095 <td>RD</td>
3095 3096 <td>W</td>
3096 3097 <td>R</td></tr>
3097 3098 <tr><td>-f</td>
3098 3099 <td>R</td>
3099 3100 <td>RD</td>
3100 3101 <td>RD</td>
3101 3102 <td>R</td></tr>
3102 3103 <tr><td>-A</td>
3103 3104 <td>W</td>
3104 3105 <td>W</td>
3105 3106 <td>W</td>
3106 3107 <td>R</td></tr>
3107 3108 <tr><td>-Af</td>
3108 3109 <td>R</td>
3109 3110 <td>R</td>
3110 3111 <td>R</td>
3111 3112 <td>R</td></tr>
3112 3113 </table>
3113 3114 <p>
3114 3115 <b>Note:</b>
3115 3116 </p>
3116 3117 <p>
3117 3118 'hg remove' never deletes files in Added [A] state from the
3118 3119 working directory, not even if &quot;--force&quot; is specified.
3119 3120 </p>
3120 3121 <p>
3121 3122 Returns 0 on success, 1 if any warnings encountered.
3122 3123 </p>
3123 3124 <p>
3124 3125 options ([+] can be repeated):
3125 3126 </p>
3126 3127 <table>
3127 3128 <tr><td>-A</td>
3128 3129 <td>--after</td>
3129 3130 <td>record delete for missing files</td></tr>
3130 3131 <tr><td>-f</td>
3131 3132 <td>--force</td>
3132 3133 <td>forget added files, delete modified files</td></tr>
3133 3134 <tr><td>-S</td>
3134 3135 <td>--subrepos</td>
3135 3136 <td>recurse into subrepositories</td></tr>
3136 3137 <tr><td>-I</td>
3137 3138 <td>--include PATTERN [+]</td>
3138 3139 <td>include names matching the given patterns</td></tr>
3139 3140 <tr><td>-X</td>
3140 3141 <td>--exclude PATTERN [+]</td>
3141 3142 <td>exclude names matching the given patterns</td></tr>
3142 3143 <tr><td>-n</td>
3143 3144 <td>--dry-run</td>
3144 3145 <td>do not perform actions, just print output</td></tr>
3145 3146 </table>
3146 3147 <p>
3147 3148 global options ([+] can be repeated):
3148 3149 </p>
3149 3150 <table>
3150 3151 <tr><td>-R</td>
3151 3152 <td>--repository REPO</td>
3152 3153 <td>repository root directory or name of overlay bundle file</td></tr>
3153 3154 <tr><td></td>
3154 3155 <td>--cwd DIR</td>
3155 3156 <td>change working directory</td></tr>
3156 3157 <tr><td>-y</td>
3157 3158 <td>--noninteractive</td>
3158 3159 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
3159 3160 <tr><td>-q</td>
3160 3161 <td>--quiet</td>
3161 3162 <td>suppress output</td></tr>
3162 3163 <tr><td>-v</td>
3163 3164 <td>--verbose</td>
3164 3165 <td>enable additional output</td></tr>
3165 3166 <tr><td></td>
3166 3167 <td>--color TYPE</td>
3167 3168 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
3168 3169 <tr><td></td>
3169 3170 <td>--config CONFIG [+]</td>
3170 3171 <td>set/override config option (use 'section.name=value')</td></tr>
3171 3172 <tr><td></td>
3172 3173 <td>--debug</td>
3173 3174 <td>enable debugging output</td></tr>
3174 3175 <tr><td></td>
3175 3176 <td>--debugger</td>
3176 3177 <td>start debugger</td></tr>
3177 3178 <tr><td></td>
3178 3179 <td>--encoding ENCODE</td>
3179 3180 <td>set the charset encoding (default: ascii)</td></tr>
3180 3181 <tr><td></td>
3181 3182 <td>--encodingmode MODE</td>
3182 3183 <td>set the charset encoding mode (default: strict)</td></tr>
3183 3184 <tr><td></td>
3184 3185 <td>--traceback</td>
3185 3186 <td>always print a traceback on exception</td></tr>
3186 3187 <tr><td></td>
3187 3188 <td>--time</td>
3188 3189 <td>time how long the command takes</td></tr>
3189 3190 <tr><td></td>
3190 3191 <td>--profile</td>
3191 3192 <td>print command execution profile</td></tr>
3192 3193 <tr><td></td>
3193 3194 <td>--version</td>
3194 3195 <td>output version information and exit</td></tr>
3195 3196 <tr><td>-h</td>
3196 3197 <td>--help</td>
3197 3198 <td>display help and exit</td></tr>
3198 3199 <tr><td></td>
3199 3200 <td>--hidden</td>
3200 3201 <td>consider hidden changesets</td></tr>
3201 3202 <tr><td></td>
3202 3203 <td>--pager TYPE</td>
3203 3204 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
3204 3205 </table>
3205 3206
3206 3207 </div>
3207 3208 </div>
3208 3209 </div>
3209 3210
3210 3211
3211 3212
3212 3213 </body>
3213 3214 </html>
3214 3215
3215 3216
3216 3217 $ get-with-headers.py $LOCALIP:$HGPORT "help/dates"
3217 3218 200 Script output follows
3218 3219
3219 3220 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3220 3221 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3221 3222 <head>
3222 3223 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3223 3224 <meta name="robots" content="index, nofollow" />
3224 3225 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3225 3226 <script type="text/javascript" src="/static/mercurial.js"></script>
3226 3227
3227 3228 <title>Help: dates</title>
3228 3229 </head>
3229 3230 <body>
3230 3231
3231 3232 <div class="container">
3232 3233 <div class="menu">
3233 3234 <div class="logo">
3234 3235 <a href="https://mercurial-scm.org/">
3235 3236 <img src="/static/hglogo.png" alt="mercurial" /></a>
3236 3237 </div>
3237 3238 <ul>
3238 3239 <li><a href="/shortlog">log</a></li>
3239 3240 <li><a href="/graph">graph</a></li>
3240 3241 <li><a href="/tags">tags</a></li>
3241 3242 <li><a href="/bookmarks">bookmarks</a></li>
3242 3243 <li><a href="/branches">branches</a></li>
3243 3244 </ul>
3244 3245 <ul>
3245 3246 <li class="active"><a href="/help">help</a></li>
3246 3247 </ul>
3247 3248 </div>
3248 3249
3249 3250 <div class="main">
3250 3251 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3251 3252 <h3>Help: dates</h3>
3252 3253
3253 3254 <form class="search" action="/log">
3254 3255
3255 3256 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3256 3257 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3257 3258 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3258 3259 </form>
3259 3260 <div id="doc">
3260 3261 <h1>Date Formats</h1>
3261 3262 <p>
3262 3263 Some commands allow the user to specify a date, e.g.:
3263 3264 </p>
3264 3265 <ul>
3265 3266 <li> backout, commit, import, tag: Specify the commit date.
3266 3267 <li> log, revert, update: Select revision(s) by date.
3267 3268 </ul>
3268 3269 <p>
3269 3270 Many date formats are valid. Here are some examples:
3270 3271 </p>
3271 3272 <ul>
3272 3273 <li> &quot;Wed Dec 6 13:18:29 2006&quot; (local timezone assumed)
3273 3274 <li> &quot;Dec 6 13:18 -0600&quot; (year assumed, time offset provided)
3274 3275 <li> &quot;Dec 6 13:18 UTC&quot; (UTC and GMT are aliases for +0000)
3275 3276 <li> &quot;Dec 6&quot; (midnight)
3276 3277 <li> &quot;13:18&quot; (today assumed)
3277 3278 <li> &quot;3:39&quot; (3:39AM assumed)
3278 3279 <li> &quot;3:39pm&quot; (15:39)
3279 3280 <li> &quot;2006-12-06 13:18:29&quot; (ISO 8601 format)
3280 3281 <li> &quot;2006-12-6 13:18&quot;
3281 3282 <li> &quot;2006-12-6&quot;
3282 3283 <li> &quot;12-6&quot;
3283 3284 <li> &quot;12/6&quot;
3284 3285 <li> &quot;12/6/6&quot; (Dec 6 2006)
3285 3286 <li> &quot;today&quot; (midnight)
3286 3287 <li> &quot;yesterday&quot; (midnight)
3287 3288 <li> &quot;now&quot; - right now
3288 3289 </ul>
3289 3290 <p>
3290 3291 Lastly, there is Mercurial's internal format:
3291 3292 </p>
3292 3293 <ul>
3293 3294 <li> &quot;1165411109 0&quot; (Wed Dec 6 13:18:29 2006 UTC)
3294 3295 </ul>
3295 3296 <p>
3296 3297 This is the internal representation format for dates. The first number
3297 3298 is the number of seconds since the epoch (1970-01-01 00:00 UTC). The
3298 3299 second is the offset of the local timezone, in seconds west of UTC
3299 3300 (negative if the timezone is east of UTC).
3300 3301 </p>
3301 3302 <p>
3302 3303 The log command also accepts date ranges:
3303 3304 </p>
3304 3305 <ul>
3305 3306 <li> &quot;&lt;DATE&quot; - at or before a given date/time
3306 3307 <li> &quot;&gt;DATE&quot; - on or after a given date/time
3307 3308 <li> &quot;DATE to DATE&quot; - a date range, inclusive
3308 3309 <li> &quot;-DAYS&quot; - within a given number of days from today
3309 3310 </ul>
3310 3311
3311 3312 </div>
3312 3313 </div>
3313 3314 </div>
3314 3315
3315 3316
3316 3317
3317 3318 </body>
3318 3319 </html>
3319 3320
3320 3321
3321 3322 $ get-with-headers.py $LOCALIP:$HGPORT "help/pager"
3322 3323 200 Script output follows
3323 3324
3324 3325 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3325 3326 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3326 3327 <head>
3327 3328 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3328 3329 <meta name="robots" content="index, nofollow" />
3329 3330 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3330 3331 <script type="text/javascript" src="/static/mercurial.js"></script>
3331 3332
3332 3333 <title>Help: pager</title>
3333 3334 </head>
3334 3335 <body>
3335 3336
3336 3337 <div class="container">
3337 3338 <div class="menu">
3338 3339 <div class="logo">
3339 3340 <a href="https://mercurial-scm.org/">
3340 3341 <img src="/static/hglogo.png" alt="mercurial" /></a>
3341 3342 </div>
3342 3343 <ul>
3343 3344 <li><a href="/shortlog">log</a></li>
3344 3345 <li><a href="/graph">graph</a></li>
3345 3346 <li><a href="/tags">tags</a></li>
3346 3347 <li><a href="/bookmarks">bookmarks</a></li>
3347 3348 <li><a href="/branches">branches</a></li>
3348 3349 </ul>
3349 3350 <ul>
3350 3351 <li class="active"><a href="/help">help</a></li>
3351 3352 </ul>
3352 3353 </div>
3353 3354
3354 3355 <div class="main">
3355 3356 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3356 3357 <h3>Help: pager</h3>
3357 3358
3358 3359 <form class="search" action="/log">
3359 3360
3360 3361 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3361 3362 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3362 3363 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3363 3364 </form>
3364 3365 <div id="doc">
3365 3366 <h1>Pager Support</h1>
3366 3367 <p>
3367 3368 Some Mercurial commands can produce a lot of output, and Mercurial will
3368 3369 attempt to use a pager to make those commands more pleasant.
3369 3370 </p>
3370 3371 <p>
3371 3372 To set the pager that should be used, set the application variable:
3372 3373 </p>
3373 3374 <pre>
3374 3375 [pager]
3375 3376 pager = less -FRX
3376 3377 </pre>
3377 3378 <p>
3378 3379 If no pager is set in the user or repository configuration, Mercurial uses the
3379 3380 environment variable $PAGER. If $PAGER is not set, pager.pager from the default
3380 3381 or system configuration is used. If none of these are set, a default pager will
3381 3382 be used, typically 'less' on Unix and 'more' on Windows.
3382 3383 </p>
3383 3384 <p>
3384 3385 You can disable the pager for certain commands by adding them to the
3385 3386 pager.ignore list:
3386 3387 </p>
3387 3388 <pre>
3388 3389 [pager]
3389 3390 ignore = version, help, update
3390 3391 </pre>
3391 3392 <p>
3392 3393 To ignore global commands like 'hg version' or 'hg help', you have
3393 3394 to specify them in your user configuration file.
3394 3395 </p>
3395 3396 <p>
3396 3397 To control whether the pager is used at all for an individual command,
3397 3398 you can use --pager=&lt;value&gt;:
3398 3399 </p>
3399 3400 <ul>
3400 3401 <li> use as needed: 'auto'.
3401 3402 <li> require the pager: 'yes' or 'on'.
3402 3403 <li> suppress the pager: 'no' or 'off' (any unrecognized value will also work).
3403 3404 </ul>
3404 3405 <p>
3405 3406 To globally turn off all attempts to use a pager, set:
3406 3407 </p>
3407 3408 <pre>
3408 3409 [ui]
3409 3410 paginate = never
3410 3411 </pre>
3411 3412 <p>
3412 3413 which will prevent the pager from running.
3413 3414 </p>
3414 3415
3415 3416 </div>
3416 3417 </div>
3417 3418 </div>
3418 3419
3419 3420
3420 3421
3421 3422 </body>
3422 3423 </html>
3423 3424
3424 3425
3425 3426 Sub-topic indexes rendered properly
3426 3427
3427 3428 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals"
3428 3429 200 Script output follows
3429 3430
3430 3431 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3431 3432 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3432 3433 <head>
3433 3434 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3434 3435 <meta name="robots" content="index, nofollow" />
3435 3436 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3436 3437 <script type="text/javascript" src="/static/mercurial.js"></script>
3437 3438
3438 3439 <title>Help: internals</title>
3439 3440 </head>
3440 3441 <body>
3441 3442
3442 3443 <div class="container">
3443 3444 <div class="menu">
3444 3445 <div class="logo">
3445 3446 <a href="https://mercurial-scm.org/">
3446 3447 <img src="/static/hglogo.png" alt="mercurial" /></a>
3447 3448 </div>
3448 3449 <ul>
3449 3450 <li><a href="/shortlog">log</a></li>
3450 3451 <li><a href="/graph">graph</a></li>
3451 3452 <li><a href="/tags">tags</a></li>
3452 3453 <li><a href="/bookmarks">bookmarks</a></li>
3453 3454 <li><a href="/branches">branches</a></li>
3454 3455 </ul>
3455 3456 <ul>
3456 3457 <li><a href="/help">help</a></li>
3457 3458 </ul>
3458 3459 </div>
3459 3460
3460 3461 <div class="main">
3461 3462 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3462 3463
3463 3464 <form class="search" action="/log">
3464 3465
3465 3466 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3466 3467 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3467 3468 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3468 3469 </form>
3469 3470 <table class="bigtable">
3470 3471 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
3471 3472
3472 3473 <tr><td>
3473 3474 <a href="/help/internals.bid-merge">
3474 3475 bid-merge
3475 3476 </a>
3476 3477 </td><td>
3477 3478 Bid Merge Algorithm
3478 3479 </td></tr>
3479 3480 <tr><td>
3480 3481 <a href="/help/internals.bundle2">
3481 3482 bundle2
3482 3483 </a>
3483 3484 </td><td>
3484 3485 Bundle2
3485 3486 </td></tr>
3486 3487 <tr><td>
3487 3488 <a href="/help/internals.bundles">
3488 3489 bundles
3489 3490 </a>
3490 3491 </td><td>
3491 3492 Bundles
3492 3493 </td></tr>
3493 3494 <tr><td>
3494 3495 <a href="/help/internals.cbor">
3495 3496 cbor
3496 3497 </a>
3497 3498 </td><td>
3498 3499 CBOR
3499 3500 </td></tr>
3500 3501 <tr><td>
3501 3502 <a href="/help/internals.censor">
3502 3503 censor
3503 3504 </a>
3504 3505 </td><td>
3505 3506 Censor
3506 3507 </td></tr>
3507 3508 <tr><td>
3508 3509 <a href="/help/internals.changegroups">
3509 3510 changegroups
3510 3511 </a>
3511 3512 </td><td>
3512 3513 Changegroups
3513 3514 </td></tr>
3514 3515 <tr><td>
3515 3516 <a href="/help/internals.config">
3516 3517 config
3517 3518 </a>
3518 3519 </td><td>
3519 3520 Config Registrar
3520 3521 </td></tr>
3521 3522 <tr><td>
3522 3523 <a href="/help/internals.extensions">
3523 3524 extensions
3524 3525 </a>
3525 3526 </td><td>
3526 3527 Extension API
3527 3528 </td></tr>
3528 3529 <tr><td>
3529 3530 <a href="/help/internals.mergestate">
3530 3531 mergestate
3531 3532 </a>
3532 3533 </td><td>
3533 3534 Mergestate
3534 3535 </td></tr>
3535 3536 <tr><td>
3536 3537 <a href="/help/internals.requirements">
3537 3538 requirements
3538 3539 </a>
3539 3540 </td><td>
3540 3541 Repository Requirements
3541 3542 </td></tr>
3542 3543 <tr><td>
3543 3544 <a href="/help/internals.revlogs">
3544 3545 revlogs
3545 3546 </a>
3546 3547 </td><td>
3547 3548 Revision Logs
3548 3549 </td></tr>
3549 3550 <tr><td>
3550 3551 <a href="/help/internals.wireprotocol">
3551 3552 wireprotocol
3552 3553 </a>
3553 3554 </td><td>
3554 3555 Wire Protocol
3555 3556 </td></tr>
3556 3557 <tr><td>
3557 3558 <a href="/help/internals.wireprotocolrpc">
3558 3559 wireprotocolrpc
3559 3560 </a>
3560 3561 </td><td>
3561 3562 Wire Protocol RPC
3562 3563 </td></tr>
3563 3564 <tr><td>
3564 3565 <a href="/help/internals.wireprotocolv2">
3565 3566 wireprotocolv2
3566 3567 </a>
3567 3568 </td><td>
3568 3569 Wire Protocol Version 2
3569 3570 </td></tr>
3570 3571
3571 3572
3572 3573
3573 3574
3574 3575
3575 3576 </table>
3576 3577 </div>
3577 3578 </div>
3578 3579
3579 3580
3580 3581
3581 3582 </body>
3582 3583 </html>
3583 3584
3584 3585
3585 3586 Sub-topic topics rendered properly
3586 3587
3587 3588 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals.changegroups"
3588 3589 200 Script output follows
3589 3590
3590 3591 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3591 3592 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3592 3593 <head>
3593 3594 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3594 3595 <meta name="robots" content="index, nofollow" />
3595 3596 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3596 3597 <script type="text/javascript" src="/static/mercurial.js"></script>
3597 3598
3598 3599 <title>Help: internals.changegroups</title>
3599 3600 </head>
3600 3601 <body>
3601 3602
3602 3603 <div class="container">
3603 3604 <div class="menu">
3604 3605 <div class="logo">
3605 3606 <a href="https://mercurial-scm.org/">
3606 3607 <img src="/static/hglogo.png" alt="mercurial" /></a>
3607 3608 </div>
3608 3609 <ul>
3609 3610 <li><a href="/shortlog">log</a></li>
3610 3611 <li><a href="/graph">graph</a></li>
3611 3612 <li><a href="/tags">tags</a></li>
3612 3613 <li><a href="/bookmarks">bookmarks</a></li>
3613 3614 <li><a href="/branches">branches</a></li>
3614 3615 </ul>
3615 3616 <ul>
3616 3617 <li class="active"><a href="/help">help</a></li>
3617 3618 </ul>
3618 3619 </div>
3619 3620
3620 3621 <div class="main">
3621 3622 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3622 3623 <h3>Help: internals.changegroups</h3>
3623 3624
3624 3625 <form class="search" action="/log">
3625 3626
3626 3627 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3627 3628 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3628 3629 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3629 3630 </form>
3630 3631 <div id="doc">
3631 3632 <h1>Changegroups</h1>
3632 3633 <p>
3633 3634 Changegroups are representations of repository revlog data, specifically
3634 3635 the changelog data, root/flat manifest data, treemanifest data, and
3635 3636 filelogs.
3636 3637 </p>
3637 3638 <p>
3638 3639 There are 3 versions of changegroups: &quot;1&quot;, &quot;2&quot;, and &quot;3&quot;. From a
3639 3640 high-level, versions &quot;1&quot; and &quot;2&quot; are almost exactly the same, with the
3640 3641 only difference being an additional item in the *delta header*. Version
3641 3642 &quot;3&quot; adds support for storage flags in the *delta header* and optionally
3642 3643 exchanging treemanifests (enabled by setting an option on the
3643 3644 &quot;changegroup&quot; part in the bundle2).
3644 3645 </p>
3645 3646 <p>
3646 3647 Changegroups when not exchanging treemanifests consist of 3 logical
3647 3648 segments:
3648 3649 </p>
3649 3650 <pre>
3650 3651 +---------------------------------+
3651 3652 | | | |
3652 3653 | changeset | manifest | filelogs |
3653 3654 | | | |
3654 3655 | | | |
3655 3656 +---------------------------------+
3656 3657 </pre>
3657 3658 <p>
3658 3659 When exchanging treemanifests, there are 4 logical segments:
3659 3660 </p>
3660 3661 <pre>
3661 3662 +-------------------------------------------------+
3662 3663 | | | | |
3663 3664 | changeset | root | treemanifests | filelogs |
3664 3665 | | manifest | | |
3665 3666 | | | | |
3666 3667 +-------------------------------------------------+
3667 3668 </pre>
3668 3669 <p>
3669 3670 The principle building block of each segment is a *chunk*. A *chunk*
3670 3671 is a framed piece of data:
3671 3672 </p>
3672 3673 <pre>
3673 3674 +---------------------------------------+
3674 3675 | | |
3675 3676 | length | data |
3676 3677 | (4 bytes) | (&lt;length - 4&gt; bytes) |
3677 3678 | | |
3678 3679 +---------------------------------------+
3679 3680 </pre>
3680 3681 <p>
3681 3682 All integers are big-endian signed integers. Each chunk starts with a 32-bit
3682 3683 integer indicating the length of the entire chunk (including the length field
3683 3684 itself).
3684 3685 </p>
3685 3686 <p>
3686 3687 There is a special case chunk that has a value of 0 for the length
3687 3688 (&quot;0x00000000&quot;). We call this an *empty chunk*.
3688 3689 </p>
3689 3690 <h2>Delta Groups</h2>
3690 3691 <p>
3691 3692 A *delta group* expresses the content of a revlog as a series of deltas,
3692 3693 or patches against previous revisions.
3693 3694 </p>
3694 3695 <p>
3695 3696 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
3696 3697 to signal the end of the delta group:
3697 3698 </p>
3698 3699 <pre>
3699 3700 +------------------------------------------------------------------------+
3700 3701 | | | | | |
3701 3702 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
3702 3703 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
3703 3704 | | | | | |
3704 3705 +------------------------------------------------------------------------+
3705 3706 </pre>
3706 3707 <p>
3707 3708 Each *chunk*'s data consists of the following:
3708 3709 </p>
3709 3710 <pre>
3710 3711 +---------------------------------------+
3711 3712 | | |
3712 3713 | delta header | delta data |
3713 3714 | (various by version) | (various) |
3714 3715 | | |
3715 3716 +---------------------------------------+
3716 3717 </pre>
3717 3718 <p>
3718 3719 The *delta data* is a series of *delta*s that describe a diff from an existing
3719 3720 entry (either that the recipient already has, or previously specified in the
3720 3721 bundle/changegroup).
3721 3722 </p>
3722 3723 <p>
3723 3724 The *delta header* is different between versions &quot;1&quot;, &quot;2&quot;, and
3724 3725 &quot;3&quot; of the changegroup format.
3725 3726 </p>
3726 3727 <p>
3727 3728 Version 1 (headerlen=80):
3728 3729 </p>
3729 3730 <pre>
3730 3731 +------------------------------------------------------+
3731 3732 | | | | |
3732 3733 | node | p1 node | p2 node | link node |
3733 3734 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3734 3735 | | | | |
3735 3736 +------------------------------------------------------+
3736 3737 </pre>
3737 3738 <p>
3738 3739 Version 2 (headerlen=100):
3739 3740 </p>
3740 3741 <pre>
3741 3742 +------------------------------------------------------------------+
3742 3743 | | | | | |
3743 3744 | node | p1 node | p2 node | base node | link node |
3744 3745 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3745 3746 | | | | | |
3746 3747 +------------------------------------------------------------------+
3747 3748 </pre>
3748 3749 <p>
3749 3750 Version 3 (headerlen=102):
3750 3751 </p>
3751 3752 <pre>
3752 3753 +------------------------------------------------------------------------------+
3753 3754 | | | | | | |
3754 3755 | node | p1 node | p2 node | base node | link node | flags |
3755 3756 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
3756 3757 | | | | | | |
3757 3758 +------------------------------------------------------------------------------+
3758 3759 </pre>
3759 3760 <p>
3760 3761 The *delta data* consists of &quot;chunklen - 4 - headerlen&quot; bytes, which contain a
3761 3762 series of *delta*s, densely packed (no separators). These deltas describe a diff
3762 3763 from an existing entry (either that the recipient already has, or previously
3763 3764 specified in the bundle/changegroup). The format is described more fully in
3764 3765 &quot;hg help internals.bdiff&quot;, but briefly:
3765 3766 </p>
3766 3767 <pre>
3767 3768 +---------------------------------------------------------------+
3768 3769 | | | | |
3769 3770 | start offset | end offset | new length | content |
3770 3771 | (4 bytes) | (4 bytes) | (4 bytes) | (&lt;new length&gt; bytes) |
3771 3772 | | | | |
3772 3773 +---------------------------------------------------------------+
3773 3774 </pre>
3774 3775 <p>
3775 3776 Please note that the length field in the delta data does *not* include itself.
3776 3777 </p>
3777 3778 <p>
3778 3779 In version 1, the delta is always applied against the previous node from
3779 3780 the changegroup or the first parent if this is the first entry in the
3780 3781 changegroup.
3781 3782 </p>
3782 3783 <p>
3783 3784 In version 2 and up, the delta base node is encoded in the entry in the
3784 3785 changegroup. This allows the delta to be expressed against any parent,
3785 3786 which can result in smaller deltas and more efficient encoding of data.
3786 3787 </p>
3787 3788 <p>
3788 3789 The *flags* field holds bitwise flags affecting the processing of revision
3789 3790 data. The following flags are defined:
3790 3791 </p>
3791 3792 <dl>
3792 3793 <dt>32768
3793 3794 <dd>Censored revision. The revision's fulltext has been replaced by censor metadata. May only occur on file revisions.
3794 3795 <dt>16384
3795 3796 <dd>Ellipsis revision. Revision hash does not match data (likely due to rewritten parents).
3796 3797 <dt>8192
3797 3798 <dd>Externally stored. The revision fulltext contains &quot;key:value&quot; &quot;\n&quot; delimited metadata defining an object stored elsewhere. Used by the LFS extension.
3798 3799 </dl>
3799 3800 <p>
3800 3801 For historical reasons, the integer values are identical to revlog version 1
3801 3802 per-revision storage flags and correspond to bits being set in this 2-byte
3802 3803 field. Bits were allocated starting from the most-significant bit, hence the
3803 3804 reverse ordering and allocation of these flags.
3804 3805 </p>
3805 3806 <h2>Changeset Segment</h2>
3806 3807 <p>
3807 3808 The *changeset segment* consists of a single *delta group* holding
3808 3809 changelog data. The *empty chunk* at the end of the *delta group* denotes
3809 3810 the boundary to the *manifest segment*.
3810 3811 </p>
3811 3812 <h2>Manifest Segment</h2>
3812 3813 <p>
3813 3814 The *manifest segment* consists of a single *delta group* holding manifest
3814 3815 data. If treemanifests are in use, it contains only the manifest for the
3815 3816 root directory of the repository. Otherwise, it contains the entire
3816 3817 manifest data. The *empty chunk* at the end of the *delta group* denotes
3817 3818 the boundary to the next segment (either the *treemanifests segment* or the
3818 3819 *filelogs segment*, depending on version and the request options).
3819 3820 </p>
3820 3821 <h3>Treemanifests Segment</h3>
3821 3822 <p>
3822 3823 The *treemanifests segment* only exists in changegroup version &quot;3&quot;, and
3823 3824 only if the 'treemanifest' param is part of the bundle2 changegroup part
3824 3825 (it is not possible to use changegroup version 3 outside of bundle2).
3825 3826 Aside from the filenames in the *treemanifests segment* containing a
3826 3827 trailing &quot;/&quot; character, it behaves identically to the *filelogs segment*
3827 3828 (see below). The final sub-segment is followed by an *empty chunk* (logically,
3828 3829 a sub-segment with filename size 0). This denotes the boundary to the
3829 3830 *filelogs segment*.
3830 3831 </p>
3831 3832 <h2>Filelogs Segment</h2>
3832 3833 <p>
3833 3834 The *filelogs segment* consists of multiple sub-segments, each
3834 3835 corresponding to an individual file whose data is being described:
3835 3836 </p>
3836 3837 <pre>
3837 3838 +--------------------------------------------------+
3838 3839 | | | | | |
3839 3840 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
3840 3841 | | | | | (4 bytes) |
3841 3842 | | | | | |
3842 3843 +--------------------------------------------------+
3843 3844 </pre>
3844 3845 <p>
3845 3846 The final filelog sub-segment is followed by an *empty chunk* (logically,
3846 3847 a sub-segment with filename size 0). This denotes the end of the segment
3847 3848 and of the overall changegroup.
3848 3849 </p>
3849 3850 <p>
3850 3851 Each filelog sub-segment consists of the following:
3851 3852 </p>
3852 3853 <pre>
3853 3854 +------------------------------------------------------+
3854 3855 | | | |
3855 3856 | filename length | filename | delta group |
3856 3857 | (4 bytes) | (&lt;length - 4&gt; bytes) | (various) |
3857 3858 | | | |
3858 3859 +------------------------------------------------------+
3859 3860 </pre>
3860 3861 <p>
3861 3862 That is, a *chunk* consisting of the filename (not terminated or padded)
3862 3863 followed by N chunks constituting the *delta group* for this file. The
3863 3864 *empty chunk* at the end of each *delta group* denotes the boundary to the
3864 3865 next filelog sub-segment.
3865 3866 </p>
3866 3867
3867 3868 </div>
3868 3869 </div>
3869 3870 </div>
3870 3871
3871 3872
3872 3873
3873 3874 </body>
3874 3875 </html>
3875 3876
3876 3877
3877 3878 $ get-with-headers.py 127.0.0.1:$HGPORT "help/unknowntopic"
3878 3879 404 Not Found
3879 3880
3880 3881 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3881 3882 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3882 3883 <head>
3883 3884 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3884 3885 <meta name="robots" content="index, nofollow" />
3885 3886 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3886 3887 <script type="text/javascript" src="/static/mercurial.js"></script>
3887 3888
3888 3889 <title>test: error</title>
3889 3890 </head>
3890 3891 <body>
3891 3892
3892 3893 <div class="container">
3893 3894 <div class="menu">
3894 3895 <div class="logo">
3895 3896 <a href="https://mercurial-scm.org/">
3896 3897 <img src="/static/hglogo.png" width=75 height=90 border=0 alt="mercurial" /></a>
3897 3898 </div>
3898 3899 <ul>
3899 3900 <li><a href="/shortlog">log</a></li>
3900 3901 <li><a href="/graph">graph</a></li>
3901 3902 <li><a href="/tags">tags</a></li>
3902 3903 <li><a href="/bookmarks">bookmarks</a></li>
3903 3904 <li><a href="/branches">branches</a></li>
3904 3905 </ul>
3905 3906 <ul>
3906 3907 <li><a href="/help">help</a></li>
3907 3908 </ul>
3908 3909 </div>
3909 3910
3910 3911 <div class="main">
3911 3912
3912 3913 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3913 3914 <h3>error</h3>
3914 3915
3915 3916
3916 3917 <form class="search" action="/log">
3917 3918
3918 3919 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3919 3920 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3920 3921 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3921 3922 </form>
3922 3923
3923 3924 <div class="description">
3924 3925 <p>
3925 3926 An error occurred while processing your request:
3926 3927 </p>
3927 3928 <p>
3928 3929 Not Found
3929 3930 </p>
3930 3931 </div>
3931 3932 </div>
3932 3933 </div>
3933 3934
3934 3935
3935 3936
3936 3937 </body>
3937 3938 </html>
3938 3939
3939 3940 [1]
3940 3941
3941 3942 $ killdaemons.py
3942 3943
3943 3944 #endif
General Comments 0
You need to be logged in to leave comments. Login now