##// END OF EJS Templates
help: filter extension commands
timeless -
r27387:dfab0afd default
parent child Browse files
Show More
@@ -1,578 +1,580 b''
1 1 # help.py - help data for mercurial
2 2 #
3 3 # Copyright 2006 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 i18n import gettext, _
9 9 import itertools, os, textwrap
10 10 import error
11 11 import extensions, revset, fileset, templatekw, templatefilters, filemerge
12 12 import templater
13 13 import encoding, util, minirst
14 14 import cmdutil
15 15 import hgweb.webcommands as webcommands
16 16
17 17 _exclkeywords = [
18 18 "(DEPRECATED)",
19 19 "(EXPERIMENTAL)",
20 20 # i18n: "(DEPRECATED)" is a keyword, must be translated consistently
21 21 _("(DEPRECATED)"),
22 22 # i18n: "(EXPERIMENTAL)" is a keyword, must be translated consistently
23 23 _("(EXPERIMENTAL)"),
24 24 ]
25 25
26 26 def listexts(header, exts, indent=1, showdeprecated=False):
27 27 '''return a text listing of the given extensions'''
28 28 rst = []
29 29 if exts:
30 30 for name, desc in sorted(exts.iteritems()):
31 31 if not showdeprecated and any(w in desc for w in _exclkeywords):
32 32 continue
33 33 rst.append('%s:%s: %s\n' % (' ' * indent, name, desc))
34 34 if rst:
35 35 rst.insert(0, '\n%s\n\n' % header)
36 36 return rst
37 37
38 38 def extshelp(ui):
39 39 rst = loaddoc('extensions')(ui).splitlines(True)
40 40 rst.extend(listexts(
41 41 _('enabled extensions:'), extensions.enabled(), showdeprecated=True))
42 42 rst.extend(listexts(_('disabled extensions:'), extensions.disabled()))
43 43 doc = ''.join(rst)
44 44 return doc
45 45
46 46 def optrst(header, options, verbose):
47 47 data = []
48 48 multioccur = False
49 49 for option in options:
50 50 if len(option) == 5:
51 51 shortopt, longopt, default, desc, optlabel = option
52 52 else:
53 53 shortopt, longopt, default, desc = option
54 54 optlabel = _("VALUE") # default label
55 55
56 56 if not verbose and any(w in desc for w in _exclkeywords):
57 57 continue
58 58
59 59 so = ''
60 60 if shortopt:
61 61 so = '-' + shortopt
62 62 lo = '--' + longopt
63 63 if default:
64 64 desc += _(" (default: %s)") % default
65 65
66 66 if isinstance(default, list):
67 67 lo += " %s [+]" % optlabel
68 68 multioccur = True
69 69 elif (default is not None) and not isinstance(default, bool):
70 70 lo += " %s" % optlabel
71 71
72 72 data.append((so, lo, desc))
73 73
74 74 if multioccur:
75 75 header += (_(" ([+] can be repeated)"))
76 76
77 77 rst = ['\n%s:\n\n' % header]
78 78 rst.extend(minirst.maketable(data, 1))
79 79
80 80 return ''.join(rst)
81 81
82 82 def indicateomitted(rst, omitted, notomitted=None):
83 83 rst.append('\n\n.. container:: omitted\n\n %s\n\n' % omitted)
84 84 if notomitted:
85 85 rst.append('\n\n.. container:: notomitted\n\n %s\n\n' % notomitted)
86 86
87 87 def filtercmd(ui, cmd, kw, doc):
88 88 if not ui.debugflag and cmd.startswith("debug") and kw != "debug":
89 89 return True
90 90 if not ui.verbose and doc and any(w in doc for w in _exclkeywords):
91 91 return True
92 92 return False
93 93
94 94 def topicmatch(ui, kw):
95 95 """Return help topics matching kw.
96 96
97 97 Returns {'section': [(name, summary), ...], ...} where section is
98 98 one of topics, commands, extensions, or extensioncommands.
99 99 """
100 100 kw = encoding.lower(kw)
101 101 def lowercontains(container):
102 102 return kw in encoding.lower(container) # translated in helptable
103 103 results = {'topics': [],
104 104 'commands': [],
105 105 'extensions': [],
106 106 'extensioncommands': [],
107 107 }
108 108 for names, header, doc in helptable:
109 109 # Old extensions may use a str as doc.
110 110 if (sum(map(lowercontains, names))
111 111 or lowercontains(header)
112 112 or (callable(doc) and lowercontains(doc(ui)))):
113 113 results['topics'].append((names[0], header))
114 114 import commands # avoid cycle
115 115 for cmd, entry in commands.table.iteritems():
116 116 if len(entry) == 3:
117 117 summary = entry[2]
118 118 else:
119 119 summary = ''
120 120 # translate docs *before* searching there
121 121 docs = _(getattr(entry[0], '__doc__', None)) or ''
122 122 if kw in cmd or lowercontains(summary) or lowercontains(docs):
123 123 doclines = docs.splitlines()
124 124 if doclines:
125 125 summary = doclines[0]
126 126 cmdname = cmd.partition('|')[0].lstrip('^')
127 127 if filtercmd(ui, cmdname, kw, docs):
128 128 continue
129 129 results['commands'].append((cmdname, summary))
130 130 for name, docs in itertools.chain(
131 131 extensions.enabled(False).iteritems(),
132 132 extensions.disabled().iteritems()):
133 133 # extensions.load ignores the UI argument
134 134 mod = extensions.load(None, name, '')
135 135 name = name.rpartition('.')[-1]
136 136 if lowercontains(name) or lowercontains(docs):
137 137 # extension docs are already translated
138 138 results['extensions'].append((name, docs.splitlines()[0]))
139 139 for cmd, entry in getattr(mod, 'cmdtable', {}).iteritems():
140 140 if kw in cmd or (len(entry) > 2 and lowercontains(entry[2])):
141 141 cmdname = cmd.partition('|')[0].lstrip('^')
142 142 if entry[0].__doc__:
143 143 cmddoc = gettext(entry[0].__doc__).splitlines()[0]
144 144 else:
145 145 cmddoc = _('(no help text available)')
146 if filtercmd(ui, cmdname, kw, cmddoc):
147 continue
146 148 results['extensioncommands'].append((cmdname, cmddoc))
147 149 return results
148 150
149 151 def loaddoc(topic, subdir=None):
150 152 """Return a delayed loader for help/topic.txt."""
151 153
152 154 def loader(ui):
153 155 docdir = os.path.join(util.datapath, 'help')
154 156 if subdir:
155 157 docdir = os.path.join(docdir, subdir)
156 158 path = os.path.join(docdir, topic + ".txt")
157 159 doc = gettext(util.readfile(path))
158 160 for rewriter in helphooks.get(topic, []):
159 161 doc = rewriter(ui, topic, doc)
160 162 return doc
161 163
162 164 return loader
163 165
164 166 internalstable = sorted([
165 167 (['bundles'], _('container for exchange of repository data'),
166 168 loaddoc('bundles', subdir='internals')),
167 169 (['changegroups'], _('representation of revlog data'),
168 170 loaddoc('changegroups', subdir='internals')),
169 171 ])
170 172
171 173 def internalshelp(ui):
172 174 """Generate the index for the "internals" topic."""
173 175 lines = []
174 176 for names, header, doc in internalstable:
175 177 lines.append(' :%s: %s' % (names[0], header))
176 178
177 179 return '\n'.join(lines)
178 180
179 181 helptable = sorted([
180 182 (["config", "hgrc"], _("Configuration Files"), loaddoc('config')),
181 183 (["dates"], _("Date Formats"), loaddoc('dates')),
182 184 (["patterns"], _("File Name Patterns"), loaddoc('patterns')),
183 185 (['environment', 'env'], _('Environment Variables'),
184 186 loaddoc('environment')),
185 187 (['revisions', 'revs'], _('Specifying Single Revisions'),
186 188 loaddoc('revisions')),
187 189 (['multirevs', 'mrevs'], _('Specifying Multiple Revisions'),
188 190 loaddoc('multirevs')),
189 191 (['revsets', 'revset'], _("Specifying Revision Sets"), loaddoc('revsets')),
190 192 (['filesets', 'fileset'], _("Specifying File Sets"), loaddoc('filesets')),
191 193 (['diffs'], _('Diff Formats'), loaddoc('diffs')),
192 194 (['merge-tools', 'mergetools'], _('Merge Tools'), loaddoc('merge-tools')),
193 195 (['templating', 'templates', 'template', 'style'], _('Template Usage'),
194 196 loaddoc('templates')),
195 197 (['urls'], _('URL Paths'), loaddoc('urls')),
196 198 (["extensions"], _("Using Additional Features"), extshelp),
197 199 (["subrepos", "subrepo"], _("Subrepositories"), loaddoc('subrepos')),
198 200 (["hgweb"], _("Configuring hgweb"), loaddoc('hgweb')),
199 201 (["glossary"], _("Glossary"), loaddoc('glossary')),
200 202 (["hgignore", "ignore"], _("Syntax for Mercurial Ignore Files"),
201 203 loaddoc('hgignore')),
202 204 (["phases"], _("Working with Phases"), loaddoc('phases')),
203 205 (['scripting'], _('Using Mercurial from scripts and automation'),
204 206 loaddoc('scripting')),
205 207 (['internals'], _("Technical implementation topics"),
206 208 internalshelp),
207 209 ])
208 210
209 211 # Maps topics with sub-topics to a list of their sub-topics.
210 212 subtopics = {
211 213 'internals': internalstable,
212 214 }
213 215
214 216 # Map topics to lists of callable taking the current topic help and
215 217 # returning the updated version
216 218 helphooks = {}
217 219
218 220 def addtopichook(topic, rewriter):
219 221 helphooks.setdefault(topic, []).append(rewriter)
220 222
221 223 def makeitemsdoc(ui, topic, doc, marker, items, dedent=False):
222 224 """Extract docstring from the items key to function mapping, build a
223 225 single documentation block and use it to overwrite the marker in doc.
224 226 """
225 227 entries = []
226 228 for name in sorted(items):
227 229 text = (items[name].__doc__ or '').rstrip()
228 230 if (not text
229 231 or not ui.verbose and any(w in text for w in _exclkeywords)):
230 232 continue
231 233 text = gettext(text)
232 234 if dedent:
233 235 text = textwrap.dedent(text)
234 236 lines = text.splitlines()
235 237 doclines = [(lines[0])]
236 238 for l in lines[1:]:
237 239 # Stop once we find some Python doctest
238 240 if l.strip().startswith('>>>'):
239 241 break
240 242 if dedent:
241 243 doclines.append(l.rstrip())
242 244 else:
243 245 doclines.append(' ' + l.strip())
244 246 entries.append('\n'.join(doclines))
245 247 entries = '\n\n'.join(entries)
246 248 return doc.replace(marker, entries)
247 249
248 250 def addtopicsymbols(topic, marker, symbols, dedent=False):
249 251 def add(ui, topic, doc):
250 252 return makeitemsdoc(ui, topic, doc, marker, symbols, dedent=dedent)
251 253 addtopichook(topic, add)
252 254
253 255 addtopicsymbols('filesets', '.. predicatesmarker', fileset.symbols)
254 256 addtopicsymbols('merge-tools', '.. internaltoolsmarker',
255 257 filemerge.internalsdoc)
256 258 addtopicsymbols('revsets', '.. predicatesmarker', revset.symbols)
257 259 addtopicsymbols('templates', '.. keywordsmarker', templatekw.keywords)
258 260 addtopicsymbols('templates', '.. filtersmarker', templatefilters.filters)
259 261 addtopicsymbols('templates', '.. functionsmarker', templater.funcs)
260 262 addtopicsymbols('hgweb', '.. webcommandsmarker', webcommands.commands,
261 263 dedent=True)
262 264
263 265 def help_(ui, name, unknowncmd=False, full=True, subtopic=None, **opts):
264 266 '''
265 267 Generate the help for 'name' as unformatted restructured text. If
266 268 'name' is None, describe the commands available.
267 269 '''
268 270
269 271 import commands # avoid cycle
270 272
271 273 def helpcmd(name, subtopic=None):
272 274 try:
273 275 aliases, entry = cmdutil.findcmd(name, commands.table,
274 276 strict=unknowncmd)
275 277 except error.AmbiguousCommand as inst:
276 278 # py3k fix: except vars can't be used outside the scope of the
277 279 # except block, nor can be used inside a lambda. python issue4617
278 280 prefix = inst.args[0]
279 281 select = lambda c: c.lstrip('^').startswith(prefix)
280 282 rst = helplist(select)
281 283 return rst
282 284
283 285 rst = []
284 286
285 287 # check if it's an invalid alias and display its error if it is
286 288 if getattr(entry[0], 'badalias', None):
287 289 rst.append(entry[0].badalias + '\n')
288 290 if entry[0].unknowncmd:
289 291 try:
290 292 rst.extend(helpextcmd(entry[0].cmdname))
291 293 except error.UnknownCommand:
292 294 pass
293 295 return rst
294 296
295 297 # synopsis
296 298 if len(entry) > 2:
297 299 if entry[2].startswith('hg'):
298 300 rst.append("%s\n" % entry[2])
299 301 else:
300 302 rst.append('hg %s %s\n' % (aliases[0], entry[2]))
301 303 else:
302 304 rst.append('hg %s\n' % aliases[0])
303 305 # aliases
304 306 if full and not ui.quiet and len(aliases) > 1:
305 307 rst.append(_("\naliases: %s\n") % ', '.join(aliases[1:]))
306 308 rst.append('\n')
307 309
308 310 # description
309 311 doc = gettext(entry[0].__doc__)
310 312 if not doc:
311 313 doc = _("(no help text available)")
312 314 if util.safehasattr(entry[0], 'definition'): # aliased command
313 315 if entry[0].definition.startswith('!'): # shell alias
314 316 doc = _('shell alias for::\n\n %s') % entry[0].definition[1:]
315 317 else:
316 318 doc = _('alias for: hg %s\n\n%s') % (entry[0].definition, doc)
317 319 doc = doc.splitlines(True)
318 320 if ui.quiet or not full:
319 321 rst.append(doc[0])
320 322 else:
321 323 rst.extend(doc)
322 324 rst.append('\n')
323 325
324 326 # check if this command shadows a non-trivial (multi-line)
325 327 # extension help text
326 328 try:
327 329 mod = extensions.find(name)
328 330 doc = gettext(mod.__doc__) or ''
329 331 if '\n' in doc.strip():
330 332 msg = _('(use "hg help -e %s" to show help for '
331 333 'the %s extension)') % (name, name)
332 334 rst.append('\n%s\n' % msg)
333 335 except KeyError:
334 336 pass
335 337
336 338 # options
337 339 if not ui.quiet and entry[1]:
338 340 rst.append(optrst(_("options"), entry[1], ui.verbose))
339 341
340 342 if ui.verbose:
341 343 rst.append(optrst(_("global options"),
342 344 commands.globalopts, ui.verbose))
343 345
344 346 if not ui.verbose:
345 347 if not full:
346 348 rst.append(_('\n(use "hg %s -h" to show more help)\n')
347 349 % name)
348 350 elif not ui.quiet:
349 351 rst.append(_('\n(some details hidden, use --verbose '
350 352 'to show complete help)'))
351 353
352 354 return rst
353 355
354 356
355 357 def helplist(select=None, **opts):
356 358 # list of commands
357 359 if name == "shortlist":
358 360 header = _('basic commands:\n\n')
359 361 elif name == "debug":
360 362 header = _('debug commands (internal and unsupported):\n\n')
361 363 else:
362 364 header = _('list of commands:\n\n')
363 365
364 366 h = {}
365 367 cmds = {}
366 368 for c, e in commands.table.iteritems():
367 369 f = c.partition("|")[0]
368 370 if select and not select(f):
369 371 continue
370 372 if (not select and name != 'shortlist' and
371 373 e[0].__module__ != commands.__name__):
372 374 continue
373 375 if name == "shortlist" and not f.startswith("^"):
374 376 continue
375 377 f = f.lstrip("^")
376 378 doc = e[0].__doc__
377 379 if filtercmd(ui, f, name, doc):
378 380 continue
379 381 doc = gettext(doc)
380 382 if not doc:
381 383 doc = _("(no help text available)")
382 384 h[f] = doc.splitlines()[0].rstrip()
383 385 cmds[f] = c.lstrip("^")
384 386
385 387 rst = []
386 388 if not h:
387 389 if not ui.quiet:
388 390 rst.append(_('no commands defined\n'))
389 391 return rst
390 392
391 393 if not ui.quiet:
392 394 rst.append(header)
393 395 fns = sorted(h)
394 396 for f in fns:
395 397 if ui.verbose:
396 398 commacmds = cmds[f].replace("|",", ")
397 399 rst.append(" :%s: %s\n" % (commacmds, h[f]))
398 400 else:
399 401 rst.append(' :%s: %s\n' % (f, h[f]))
400 402
401 403 ex = opts.get
402 404 anyopts = (ex('keyword') or not (ex('command') or ex('extension')))
403 405 if not name and anyopts:
404 406 exts = listexts(_('enabled extensions:'), extensions.enabled())
405 407 if exts:
406 408 rst.append('\n')
407 409 rst.extend(exts)
408 410
409 411 rst.append(_("\nadditional help topics:\n\n"))
410 412 topics = []
411 413 for names, header, doc in helptable:
412 414 topics.append((names[0], header))
413 415 for t, desc in topics:
414 416 rst.append(" :%s: %s\n" % (t, desc))
415 417
416 418 if ui.quiet:
417 419 pass
418 420 elif ui.verbose:
419 421 rst.append('\n%s\n' % optrst(_("global options"),
420 422 commands.globalopts, ui.verbose))
421 423 if name == 'shortlist':
422 424 rst.append(_('\n(use "hg help" for the full list '
423 425 'of commands)\n'))
424 426 else:
425 427 if name == 'shortlist':
426 428 rst.append(_('\n(use "hg help" for the full list of commands '
427 429 'or "hg -v" for details)\n'))
428 430 elif name and not full:
429 431 rst.append(_('\n(use "hg help %s" to show the full help '
430 432 'text)\n') % name)
431 433 elif name and cmds and name in cmds.keys():
432 434 rst.append(_('\n(use "hg help -v -e %s" to show built-in '
433 435 'aliases and global options)\n') % name)
434 436 else:
435 437 rst.append(_('\n(use "hg help -v%s" to show built-in aliases '
436 438 'and global options)\n')
437 439 % (name and " " + name or ""))
438 440 return rst
439 441
440 442 def helptopic(name, subtopic=None):
441 443 # Look for sub-topic entry first.
442 444 header, doc = None, None
443 445 if subtopic and name in subtopics:
444 446 for names, header, doc in subtopics[name]:
445 447 if subtopic in names:
446 448 break
447 449
448 450 if not header:
449 451 for names, header, doc in helptable:
450 452 if name in names:
451 453 break
452 454 else:
453 455 raise error.UnknownCommand(name)
454 456
455 457 rst = [minirst.section(header)]
456 458
457 459 # description
458 460 if not doc:
459 461 rst.append(" %s\n" % _("(no help text available)"))
460 462 if callable(doc):
461 463 rst += [" %s\n" % l for l in doc(ui).splitlines()]
462 464
463 465 if not ui.verbose:
464 466 omitted = _('(some details hidden, use --verbose'
465 467 ' to show complete help)')
466 468 indicateomitted(rst, omitted)
467 469
468 470 try:
469 471 cmdutil.findcmd(name, commands.table)
470 472 rst.append(_('\nuse "hg help -c %s" to see help for '
471 473 'the %s command\n') % (name, name))
472 474 except error.UnknownCommand:
473 475 pass
474 476 return rst
475 477
476 478 def helpext(name, subtopic=None):
477 479 try:
478 480 mod = extensions.find(name)
479 481 doc = gettext(mod.__doc__) or _('no help text available')
480 482 except KeyError:
481 483 mod = None
482 484 doc = extensions.disabledext(name)
483 485 if not doc:
484 486 raise error.UnknownCommand(name)
485 487
486 488 if '\n' not in doc:
487 489 head, tail = doc, ""
488 490 else:
489 491 head, tail = doc.split('\n', 1)
490 492 rst = [_('%s extension - %s\n\n') % (name.rpartition('.')[-1], head)]
491 493 if tail:
492 494 rst.extend(tail.splitlines(True))
493 495 rst.append('\n')
494 496
495 497 if not ui.verbose:
496 498 omitted = _('(some details hidden, use --verbose'
497 499 ' to show complete help)')
498 500 indicateomitted(rst, omitted)
499 501
500 502 if mod:
501 503 try:
502 504 ct = mod.cmdtable
503 505 except AttributeError:
504 506 ct = {}
505 507 modcmds = set([c.partition('|')[0] for c in ct])
506 508 rst.extend(helplist(modcmds.__contains__))
507 509 else:
508 510 rst.append(_('(use "hg help extensions" for information on enabling'
509 511 ' extensions)\n'))
510 512 return rst
511 513
512 514 def helpextcmd(name, subtopic=None):
513 515 cmd, ext, mod = extensions.disabledcmd(ui, name,
514 516 ui.configbool('ui', 'strict'))
515 517 doc = gettext(mod.__doc__).splitlines()[0]
516 518
517 519 rst = listexts(_("'%s' is provided by the following "
518 520 "extension:") % cmd, {ext: doc}, indent=4,
519 521 showdeprecated=True)
520 522 rst.append('\n')
521 523 rst.append(_('(use "hg help extensions" for information on enabling '
522 524 'extensions)\n'))
523 525 return rst
524 526
525 527
526 528 rst = []
527 529 kw = opts.get('keyword')
528 530 if kw or name is None and any(opts[o] for o in opts):
529 531 matches = topicmatch(ui, name or '')
530 532 helpareas = []
531 533 if opts.get('extension'):
532 534 helpareas += [('extensions', _('Extensions'))]
533 535 if opts.get('command'):
534 536 helpareas += [('commands', _('Commands'))]
535 537 if not helpareas:
536 538 helpareas = [('topics', _('Topics')),
537 539 ('commands', _('Commands')),
538 540 ('extensions', _('Extensions')),
539 541 ('extensioncommands', _('Extension Commands'))]
540 542 for t, title in helpareas:
541 543 if matches[t]:
542 544 rst.append('%s:\n\n' % title)
543 545 rst.extend(minirst.maketable(sorted(matches[t]), 1))
544 546 rst.append('\n')
545 547 if not rst:
546 548 msg = _('no matches')
547 549 hint = _('try "hg help" for a list of topics')
548 550 raise error.Abort(msg, hint=hint)
549 551 elif name and name != 'shortlist':
550 552 queries = []
551 553 if unknowncmd:
552 554 queries += [helpextcmd]
553 555 if opts.get('extension'):
554 556 queries += [helpext]
555 557 if opts.get('command'):
556 558 queries += [helpcmd]
557 559 if not queries:
558 560 queries = (helptopic, helpcmd, helpext, helpextcmd)
559 561 for f in queries:
560 562 try:
561 563 rst = f(name, subtopic)
562 564 break
563 565 except error.UnknownCommand:
564 566 pass
565 567 else:
566 568 if unknowncmd:
567 569 raise error.UnknownCommand(name)
568 570 else:
569 571 msg = _('no such help topic: %s') % name
570 572 hint = _('try "hg help --keyword %s"') % name
571 573 raise error.Abort(msg, hint=hint)
572 574 else:
573 575 # program name
574 576 if not ui.quiet:
575 577 rst = [_("Mercurial Distributed SCM\n"), '\n']
576 578 rst.extend(helplist(None, **opts))
577 579
578 580 return ''.join(rst)
@@ -1,2610 +1,2610 b''
1 1 Short help:
2 2
3 3 $ hg
4 4 Mercurial Distributed SCM
5 5
6 6 basic commands:
7 7
8 8 add add the specified files on the next commit
9 9 annotate show changeset information by line for each file
10 10 clone make a copy of an existing repository
11 11 commit commit the specified files or all outstanding changes
12 12 diff diff repository (or selected files)
13 13 export dump the header and diffs for one or more changesets
14 14 forget forget the specified files on the next commit
15 15 init create a new repository in the given directory
16 16 log show revision history of entire repository or files
17 17 merge merge another revision into working directory
18 18 pull pull changes from the specified source
19 19 push push changes to the specified destination
20 20 remove remove the specified files on the next commit
21 21 serve start stand-alone webserver
22 22 status show changed files in the working directory
23 23 summary summarize working directory state
24 24 update update working directory (or switch revisions)
25 25
26 26 (use "hg help" for the full list of commands or "hg -v" for details)
27 27
28 28 $ hg -q
29 29 add add the specified files on the next commit
30 30 annotate show changeset information by line for each file
31 31 clone make a copy of an existing repository
32 32 commit commit the specified files or all outstanding changes
33 33 diff diff repository (or selected files)
34 34 export dump the header and diffs for one or more changesets
35 35 forget forget the specified files on the next commit
36 36 init create a new repository in the given directory
37 37 log show revision history of entire repository or files
38 38 merge merge another revision into working directory
39 39 pull pull changes from the specified source
40 40 push push changes to the specified destination
41 41 remove remove the specified files on the next commit
42 42 serve start stand-alone webserver
43 43 status show changed files in the working directory
44 44 summary summarize working directory state
45 45 update update working directory (or switch revisions)
46 46
47 47 $ hg help
48 48 Mercurial Distributed SCM
49 49
50 50 list of commands:
51 51
52 52 add add the specified files on the next commit
53 53 addremove add all new files, delete all missing files
54 54 annotate show changeset information by line for each file
55 55 archive create an unversioned archive of a repository revision
56 56 backout reverse effect of earlier changeset
57 57 bisect subdivision search of changesets
58 58 bookmarks create a new bookmark or list existing bookmarks
59 59 branch set or show the current branch name
60 60 branches list repository named branches
61 61 bundle create a changegroup file
62 62 cat output the current or given revision of files
63 63 clone make a copy of an existing repository
64 64 commit commit the specified files or all outstanding changes
65 65 config show combined config settings from all hgrc files
66 66 copy mark files as copied for the next commit
67 67 diff diff repository (or selected files)
68 68 export dump the header and diffs for one or more changesets
69 69 files list tracked files
70 70 forget forget the specified files on the next commit
71 71 graft copy changes from other branches onto the current branch
72 72 grep search for a pattern in specified files and revisions
73 73 heads show branch heads
74 74 help show help for a given topic or a help overview
75 75 identify identify the working directory or specified revision
76 76 import import an ordered set of patches
77 77 incoming show new changesets found in source
78 78 init create a new repository in the given directory
79 79 log show revision history of entire repository or files
80 80 manifest output the current or given revision of the project manifest
81 81 merge merge another revision into working directory
82 82 outgoing show changesets not found in the destination
83 83 paths show aliases for remote repositories
84 84 phase set or show the current phase name
85 85 pull pull changes from the specified source
86 86 push push changes to the specified destination
87 87 recover roll back an interrupted transaction
88 88 remove remove the specified files on the next commit
89 89 rename rename files; equivalent of copy + remove
90 90 resolve redo merges or set/view the merge status of files
91 91 revert restore files to their checkout state
92 92 root print the root (top) of the current working directory
93 93 serve start stand-alone webserver
94 94 status show changed files in the working directory
95 95 summary summarize working directory state
96 96 tag add one or more tags for the current or given revision
97 97 tags list repository tags
98 98 unbundle apply one or more changegroup files
99 99 update update working directory (or switch revisions)
100 100 verify verify the integrity of the repository
101 101 version output version and copyright information
102 102
103 103 additional help topics:
104 104
105 105 config Configuration Files
106 106 dates Date Formats
107 107 diffs Diff Formats
108 108 environment Environment Variables
109 109 extensions Using Additional Features
110 110 filesets Specifying File Sets
111 111 glossary Glossary
112 112 hgignore Syntax for Mercurial Ignore Files
113 113 hgweb Configuring hgweb
114 114 internals Technical implementation topics
115 115 merge-tools Merge Tools
116 116 multirevs Specifying Multiple Revisions
117 117 patterns File Name Patterns
118 118 phases Working with Phases
119 119 revisions Specifying Single Revisions
120 120 revsets Specifying Revision Sets
121 121 scripting Using Mercurial from scripts and automation
122 122 subrepos Subrepositories
123 123 templating Template Usage
124 124 urls URL Paths
125 125
126 126 (use "hg help -v" to show built-in aliases and global options)
127 127
128 128 $ hg -q help
129 129 add add the specified files on the next commit
130 130 addremove add all new files, delete all missing files
131 131 annotate show changeset information by line for each file
132 132 archive create an unversioned archive of a repository revision
133 133 backout reverse effect of earlier changeset
134 134 bisect subdivision search of changesets
135 135 bookmarks create a new bookmark or list existing bookmarks
136 136 branch set or show the current branch name
137 137 branches list repository named branches
138 138 bundle create a changegroup file
139 139 cat output the current or given revision of files
140 140 clone make a copy of an existing repository
141 141 commit commit the specified files or all outstanding changes
142 142 config show combined config settings from all hgrc files
143 143 copy mark files as copied for the next commit
144 144 diff diff repository (or selected files)
145 145 export dump the header and diffs for one or more changesets
146 146 files list tracked files
147 147 forget forget the specified files on the next commit
148 148 graft copy changes from other branches onto the current branch
149 149 grep search for a pattern in specified files and revisions
150 150 heads show branch heads
151 151 help show help for a given topic or a help overview
152 152 identify identify the working directory or specified revision
153 153 import import an ordered set of patches
154 154 incoming show new changesets found in source
155 155 init create a new repository in the given directory
156 156 log show revision history of entire repository or files
157 157 manifest output the current or given revision of the project manifest
158 158 merge merge another revision into working directory
159 159 outgoing show changesets not found in the destination
160 160 paths show aliases for remote repositories
161 161 phase set or show the current phase name
162 162 pull pull changes from the specified source
163 163 push push changes to the specified destination
164 164 recover roll back an interrupted transaction
165 165 remove remove the specified files on the next commit
166 166 rename rename files; equivalent of copy + remove
167 167 resolve redo merges or set/view the merge status of files
168 168 revert restore files to their checkout state
169 169 root print the root (top) of the current working directory
170 170 serve start stand-alone webserver
171 171 status show changed files in the working directory
172 172 summary summarize working directory state
173 173 tag add one or more tags for the current or given revision
174 174 tags list repository tags
175 175 unbundle apply one or more changegroup files
176 176 update update working directory (or switch revisions)
177 177 verify verify the integrity of the repository
178 178 version output version and copyright information
179 179
180 180 additional help topics:
181 181
182 182 config Configuration Files
183 183 dates Date Formats
184 184 diffs Diff Formats
185 185 environment Environment Variables
186 186 extensions Using Additional Features
187 187 filesets Specifying File Sets
188 188 glossary Glossary
189 189 hgignore Syntax for Mercurial Ignore Files
190 190 hgweb Configuring hgweb
191 191 internals Technical implementation topics
192 192 merge-tools Merge Tools
193 193 multirevs Specifying Multiple Revisions
194 194 patterns File Name Patterns
195 195 phases Working with Phases
196 196 revisions Specifying Single Revisions
197 197 revsets Specifying Revision Sets
198 198 scripting Using Mercurial from scripts and automation
199 199 subrepos Subrepositories
200 200 templating Template Usage
201 201 urls URL Paths
202 202
203 203 Test extension help:
204 204 $ hg help extensions --config extensions.rebase= --config extensions.children=
205 205 Using Additional Features
206 206 """""""""""""""""""""""""
207 207
208 208 Mercurial has the ability to add new features through the use of
209 209 extensions. Extensions may add new commands, add options to existing
210 210 commands, change the default behavior of commands, or implement hooks.
211 211
212 212 To enable the "foo" extension, either shipped with Mercurial or in the
213 213 Python search path, create an entry for it in your configuration file,
214 214 like this:
215 215
216 216 [extensions]
217 217 foo =
218 218
219 219 You may also specify the full path to an extension:
220 220
221 221 [extensions]
222 222 myfeature = ~/.hgext/myfeature.py
223 223
224 224 See "hg help config" for more information on configuration files.
225 225
226 226 Extensions are not loaded by default for a variety of reasons: they can
227 227 increase startup overhead; they may be meant for advanced usage only; they
228 228 may provide potentially dangerous abilities (such as letting you destroy
229 229 or modify history); they might not be ready for prime time; or they may
230 230 alter some usual behaviors of stock Mercurial. It is thus up to the user
231 231 to activate extensions as needed.
232 232
233 233 To explicitly disable an extension enabled in a configuration file of
234 234 broader scope, prepend its path with !:
235 235
236 236 [extensions]
237 237 # disabling extension bar residing in /path/to/extension/bar.py
238 238 bar = !/path/to/extension/bar.py
239 239 # ditto, but no path was supplied for extension baz
240 240 baz = !
241 241
242 242 enabled extensions:
243 243
244 244 children command to display child changesets (DEPRECATED)
245 245 rebase command to move sets of revisions to a different ancestor
246 246
247 247 disabled extensions:
248 248
249 249 acl hooks for controlling repository access
250 250 blackbox log repository events to a blackbox for debugging
251 251 bugzilla hooks for integrating with the Bugzilla bug tracker
252 252 censor erase file content at a given revision
253 253 churn command to display statistics about repository history
254 254 clonebundles advertise pre-generated bundles to seed clones
255 255 (experimental)
256 256 color colorize output from some commands
257 257 convert import revisions from foreign VCS repositories into
258 258 Mercurial
259 259 eol automatically manage newlines in repository files
260 260 extdiff command to allow external programs to compare revisions
261 261 factotum http authentication with factotum
262 262 gpg commands to sign and verify changesets
263 263 hgcia hooks for integrating with the CIA.vc notification service
264 264 hgk browse the repository in a graphical way
265 265 highlight syntax highlighting for hgweb (requires Pygments)
266 266 histedit interactive history editing
267 267 keyword expand keywords in tracked files
268 268 largefiles track large binary files
269 269 mq manage a stack of patches
270 270 notify hooks for sending email push notifications
271 271 pager browse command output with an external pager
272 272 patchbomb command to send changesets as (a series of) patch emails
273 273 purge command to delete untracked files from the working
274 274 directory
275 275 record commands to interactively select changes for
276 276 commit/qrefresh
277 277 relink recreates hardlinks between repository clones
278 278 schemes extend schemes with shortcuts to repository swarms
279 279 share share a common history between several working directories
280 280 shelve save and restore changes to the working directory
281 281 strip strip changesets and their descendants from history
282 282 transplant command to transplant changesets from another branch
283 283 win32mbcs allow the use of MBCS paths with problematic encodings
284 284 zeroconf discover and advertise repositories on the local network
285 285
286 286 Verify that extension keywords appear in help templates
287 287
288 288 $ hg help --config extensions.transplant= templating|grep transplant > /dev/null
289 289
290 290 Test short command list with verbose option
291 291
292 292 $ hg -v help shortlist
293 293 Mercurial Distributed SCM
294 294
295 295 basic commands:
296 296
297 297 add add the specified files on the next commit
298 298 annotate, blame
299 299 show changeset information by line for each file
300 300 clone make a copy of an existing repository
301 301 commit, ci commit the specified files or all outstanding changes
302 302 diff diff repository (or selected files)
303 303 export dump the header and diffs for one or more changesets
304 304 forget forget the specified files on the next commit
305 305 init create a new repository in the given directory
306 306 log, history show revision history of entire repository or files
307 307 merge merge another revision into working directory
308 308 pull pull changes from the specified source
309 309 push push changes to the specified destination
310 310 remove, rm remove the specified files on the next commit
311 311 serve start stand-alone webserver
312 312 status, st show changed files in the working directory
313 313 summary, sum summarize working directory state
314 314 update, up, checkout, co
315 315 update working directory (or switch revisions)
316 316
317 317 global options ([+] can be repeated):
318 318
319 319 -R --repository REPO repository root directory or name of overlay bundle
320 320 file
321 321 --cwd DIR change working directory
322 322 -y --noninteractive do not prompt, automatically pick the first choice for
323 323 all prompts
324 324 -q --quiet suppress output
325 325 -v --verbose enable additional output
326 326 --config CONFIG [+] set/override config option (use 'section.name=value')
327 327 --debug enable debugging output
328 328 --debugger start debugger
329 329 --encoding ENCODE set the charset encoding (default: ascii)
330 330 --encodingmode MODE set the charset encoding mode (default: strict)
331 331 --traceback always print a traceback on exception
332 332 --time time how long the command takes
333 333 --profile print command execution profile
334 334 --version output version information and exit
335 335 -h --help display help and exit
336 336 --hidden consider hidden changesets
337 337
338 338 (use "hg help" for the full list of commands)
339 339
340 340 $ hg add -h
341 341 hg add [OPTION]... [FILE]...
342 342
343 343 add the specified files on the next commit
344 344
345 345 Schedule files to be version controlled and added to the repository.
346 346
347 347 The files will be added to the repository at the next commit. To undo an
348 348 add before that, see "hg forget".
349 349
350 350 If no names are given, add all files to the repository.
351 351
352 352 Returns 0 if all files are successfully added.
353 353
354 354 options ([+] can be repeated):
355 355
356 356 -I --include PATTERN [+] include names matching the given patterns
357 357 -X --exclude PATTERN [+] exclude names matching the given patterns
358 358 -S --subrepos recurse into subrepositories
359 359 -n --dry-run do not perform actions, just print output
360 360
361 361 (some details hidden, use --verbose to show complete help)
362 362
363 363 Verbose help for add
364 364
365 365 $ hg add -hv
366 366 hg add [OPTION]... [FILE]...
367 367
368 368 add the specified files on the next commit
369 369
370 370 Schedule files to be version controlled and added to the repository.
371 371
372 372 The files will be added to the repository at the next commit. To undo an
373 373 add before that, see "hg forget".
374 374
375 375 If no names are given, add all files to the repository.
376 376
377 377 Examples:
378 378
379 379 - New (unknown) files are added automatically by "hg add":
380 380
381 381 $ ls
382 382 foo.c
383 383 $ hg status
384 384 ? foo.c
385 385 $ hg add
386 386 adding foo.c
387 387 $ hg status
388 388 A foo.c
389 389
390 390 - Specific files to be added can be specified:
391 391
392 392 $ ls
393 393 bar.c foo.c
394 394 $ hg status
395 395 ? bar.c
396 396 ? foo.c
397 397 $ hg add bar.c
398 398 $ hg status
399 399 A bar.c
400 400 ? foo.c
401 401
402 402 Returns 0 if all files are successfully added.
403 403
404 404 options ([+] can be repeated):
405 405
406 406 -I --include PATTERN [+] include names matching the given patterns
407 407 -X --exclude PATTERN [+] exclude names matching the given patterns
408 408 -S --subrepos recurse into subrepositories
409 409 -n --dry-run do not perform actions, just print output
410 410
411 411 global options ([+] can be repeated):
412 412
413 413 -R --repository REPO repository root directory or name of overlay bundle
414 414 file
415 415 --cwd DIR change working directory
416 416 -y --noninteractive do not prompt, automatically pick the first choice for
417 417 all prompts
418 418 -q --quiet suppress output
419 419 -v --verbose enable additional output
420 420 --config CONFIG [+] set/override config option (use 'section.name=value')
421 421 --debug enable debugging output
422 422 --debugger start debugger
423 423 --encoding ENCODE set the charset encoding (default: ascii)
424 424 --encodingmode MODE set the charset encoding mode (default: strict)
425 425 --traceback always print a traceback on exception
426 426 --time time how long the command takes
427 427 --profile print command execution profile
428 428 --version output version information and exit
429 429 -h --help display help and exit
430 430 --hidden consider hidden changesets
431 431
432 432 Test help option with version option
433 433
434 434 $ hg add -h --version
435 435 Mercurial Distributed SCM (version *) (glob)
436 436 (see https://mercurial-scm.org for more information)
437 437
438 438 Copyright (C) 2005-2015 Matt Mackall and others
439 439 This is free software; see the source for copying conditions. There is NO
440 440 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
441 441
442 442 $ hg add --skjdfks
443 443 hg add: option --skjdfks not recognized
444 444 hg add [OPTION]... [FILE]...
445 445
446 446 add the specified files on the next commit
447 447
448 448 options ([+] can be repeated):
449 449
450 450 -I --include PATTERN [+] include names matching the given patterns
451 451 -X --exclude PATTERN [+] exclude names matching the given patterns
452 452 -S --subrepos recurse into subrepositories
453 453 -n --dry-run do not perform actions, just print output
454 454
455 455 (use "hg add -h" to show more help)
456 456 [255]
457 457
458 458 Test ambiguous command help
459 459
460 460 $ hg help ad
461 461 list of commands:
462 462
463 463 add add the specified files on the next commit
464 464 addremove add all new files, delete all missing files
465 465
466 466 (use "hg help -v ad" to show built-in aliases and global options)
467 467
468 468 Test command without options
469 469
470 470 $ hg help verify
471 471 hg verify
472 472
473 473 verify the integrity of the repository
474 474
475 475 Verify the integrity of the current repository.
476 476
477 477 This will perform an extensive check of the repository's integrity,
478 478 validating the hashes and checksums of each entry in the changelog,
479 479 manifest, and tracked files, as well as the integrity of their crosslinks
480 480 and indices.
481 481
482 482 Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more
483 483 information about recovery from corruption of the repository.
484 484
485 485 Returns 0 on success, 1 if errors are encountered.
486 486
487 487 (some details hidden, use --verbose to show complete help)
488 488
489 489 $ hg help diff
490 490 hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
491 491
492 492 diff repository (or selected files)
493 493
494 494 Show differences between revisions for the specified files.
495 495
496 496 Differences between files are shown using the unified diff format.
497 497
498 498 Note:
499 499 diff may generate unexpected results for merges, as it will default to
500 500 comparing against the working directory's first parent changeset if no
501 501 revisions are specified.
502 502
503 503 When two revision arguments are given, then changes are shown between
504 504 those revisions. If only one revision is specified then that revision is
505 505 compared to the working directory, and, when no revisions are specified,
506 506 the working directory files are compared to its parent.
507 507
508 508 Alternatively you can specify -c/--change with a revision to see the
509 509 changes in that changeset relative to its first parent.
510 510
511 511 Without the -a/--text option, diff will avoid generating diffs of files it
512 512 detects as binary. With -a, diff will generate a diff anyway, probably
513 513 with undesirable results.
514 514
515 515 Use the -g/--git option to generate diffs in the git extended diff format.
516 516 For more information, read "hg help diffs".
517 517
518 518 Returns 0 on success.
519 519
520 520 options ([+] can be repeated):
521 521
522 522 -r --rev REV [+] revision
523 523 -c --change REV change made by revision
524 524 -a --text treat all files as text
525 525 -g --git use git extended diff format
526 526 --nodates omit dates from diff headers
527 527 --noprefix omit a/ and b/ prefixes from filenames
528 528 -p --show-function show which function each change is in
529 529 --reverse produce a diff that undoes the changes
530 530 -w --ignore-all-space ignore white space when comparing lines
531 531 -b --ignore-space-change ignore changes in the amount of white space
532 532 -B --ignore-blank-lines ignore changes whose lines are all blank
533 533 -U --unified NUM number of lines of context to show
534 534 --stat output diffstat-style summary of changes
535 535 --root DIR produce diffs relative to subdirectory
536 536 -I --include PATTERN [+] include names matching the given patterns
537 537 -X --exclude PATTERN [+] exclude names matching the given patterns
538 538 -S --subrepos recurse into subrepositories
539 539
540 540 (some details hidden, use --verbose to show complete help)
541 541
542 542 $ hg help status
543 543 hg status [OPTION]... [FILE]...
544 544
545 545 aliases: st
546 546
547 547 show changed files in the working directory
548 548
549 549 Show status of files in the repository. If names are given, only files
550 550 that match are shown. Files that are clean or ignored or the source of a
551 551 copy/move operation, are not listed unless -c/--clean, -i/--ignored,
552 552 -C/--copies or -A/--all are given. Unless options described with "show
553 553 only ..." are given, the options -mardu are used.
554 554
555 555 Option -q/--quiet hides untracked (unknown and ignored) files unless
556 556 explicitly requested with -u/--unknown or -i/--ignored.
557 557
558 558 Note:
559 559 status may appear to disagree with diff if permissions have changed or
560 560 a merge has occurred. The standard diff format does not report
561 561 permission changes and diff only reports changes relative to one merge
562 562 parent.
563 563
564 564 If one revision is given, it is used as the base revision. If two
565 565 revisions are given, the differences between them are shown. The --change
566 566 option can also be used as a shortcut to list the changed files of a
567 567 revision from its first parent.
568 568
569 569 The codes used to show the status of files are:
570 570
571 571 M = modified
572 572 A = added
573 573 R = removed
574 574 C = clean
575 575 ! = missing (deleted by non-hg command, but still tracked)
576 576 ? = not tracked
577 577 I = ignored
578 578 = origin of the previous file (with --copies)
579 579
580 580 Returns 0 on success.
581 581
582 582 options ([+] can be repeated):
583 583
584 584 -A --all show status of all files
585 585 -m --modified show only modified files
586 586 -a --added show only added files
587 587 -r --removed show only removed files
588 588 -d --deleted show only deleted (but tracked) files
589 589 -c --clean show only files without changes
590 590 -u --unknown show only unknown (not tracked) files
591 591 -i --ignored show only ignored files
592 592 -n --no-status hide status prefix
593 593 -C --copies show source of copied files
594 594 -0 --print0 end filenames with NUL, for use with xargs
595 595 --rev REV [+] show difference from revision
596 596 --change REV list the changed files of a revision
597 597 -I --include PATTERN [+] include names matching the given patterns
598 598 -X --exclude PATTERN [+] exclude names matching the given patterns
599 599 -S --subrepos recurse into subrepositories
600 600
601 601 (some details hidden, use --verbose to show complete help)
602 602
603 603 $ hg -q help status
604 604 hg status [OPTION]... [FILE]...
605 605
606 606 show changed files in the working directory
607 607
608 608 $ hg help foo
609 609 abort: no such help topic: foo
610 610 (try "hg help --keyword foo")
611 611 [255]
612 612
613 613 $ hg skjdfks
614 614 hg: unknown command 'skjdfks'
615 615 Mercurial Distributed SCM
616 616
617 617 basic commands:
618 618
619 619 add add the specified files on the next commit
620 620 annotate show changeset information by line for each file
621 621 clone make a copy of an existing repository
622 622 commit commit the specified files or all outstanding changes
623 623 diff diff repository (or selected files)
624 624 export dump the header and diffs for one or more changesets
625 625 forget forget the specified files on the next commit
626 626 init create a new repository in the given directory
627 627 log show revision history of entire repository or files
628 628 merge merge another revision into working directory
629 629 pull pull changes from the specified source
630 630 push push changes to the specified destination
631 631 remove remove the specified files on the next commit
632 632 serve start stand-alone webserver
633 633 status show changed files in the working directory
634 634 summary summarize working directory state
635 635 update update working directory (or switch revisions)
636 636
637 637 (use "hg help" for the full list of commands or "hg -v" for details)
638 638 [255]
639 639
640 640
641 641 Make sure that we don't run afoul of the help system thinking that
642 642 this is a section and erroring out weirdly.
643 643
644 644 $ hg .log
645 645 hg: unknown command '.log'
646 646 (did you mean one of log?)
647 647 [255]
648 648
649 649 $ hg log.
650 650 hg: unknown command 'log.'
651 651 (did you mean one of log?)
652 652 [255]
653 653 $ hg pu.lh
654 654 hg: unknown command 'pu.lh'
655 655 (did you mean one of pull, push?)
656 656 [255]
657 657
658 658 $ cat > helpext.py <<EOF
659 659 > import os
660 660 > from mercurial import cmdutil, commands
661 661 >
662 662 > cmdtable = {}
663 663 > command = cmdutil.command(cmdtable)
664 664 >
665 665 > @command('nohelp',
666 666 > [('', 'longdesc', 3, 'x'*90),
667 667 > ('n', '', None, 'normal desc'),
668 668 > ('', 'newline', '', 'line1\nline2')],
669 669 > 'hg nohelp',
670 670 > norepo=True)
671 671 > @command('debugoptDEP', [('', 'dopt', None, 'option is (DEPRECATED)')])
672 672 > @command('debugoptEXP', [('', 'eopt', None, 'option is (EXPERIMENTAL)')])
673 673 > def nohelp(ui, *args, **kwargs):
674 674 > pass
675 675 >
676 676 > EOF
677 677 $ echo '[extensions]' >> $HGRCPATH
678 678 $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
679 679
680 680 Test command with no help text
681 681
682 682 $ hg help nohelp
683 683 hg nohelp
684 684
685 685 (no help text available)
686 686
687 687 options:
688 688
689 689 --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
690 690 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (default: 3)
691 691 -n -- normal desc
692 692 --newline VALUE line1 line2
693 693
694 694 (some details hidden, use --verbose to show complete help)
695 695
696 696 $ hg help -k nohelp
697 697 Commands:
698 698
699 699 nohelp hg nohelp
700 700
701 701 Extension Commands:
702 702
703 703 nohelp (no help text available)
704 704
705 705 Test that default list of commands omits extension commands
706 706
707 707 $ hg help
708 708 Mercurial Distributed SCM
709 709
710 710 list of commands:
711 711
712 712 add add the specified files on the next commit
713 713 addremove add all new files, delete all missing files
714 714 annotate show changeset information by line for each file
715 715 archive create an unversioned archive of a repository revision
716 716 backout reverse effect of earlier changeset
717 717 bisect subdivision search of changesets
718 718 bookmarks create a new bookmark or list existing bookmarks
719 719 branch set or show the current branch name
720 720 branches list repository named branches
721 721 bundle create a changegroup file
722 722 cat output the current or given revision of files
723 723 clone make a copy of an existing repository
724 724 commit commit the specified files or all outstanding changes
725 725 config show combined config settings from all hgrc files
726 726 copy mark files as copied for the next commit
727 727 diff diff repository (or selected files)
728 728 export dump the header and diffs for one or more changesets
729 729 files list tracked files
730 730 forget forget the specified files on the next commit
731 731 graft copy changes from other branches onto the current branch
732 732 grep search for a pattern in specified files and revisions
733 733 heads show branch heads
734 734 help show help for a given topic or a help overview
735 735 identify identify the working directory or specified revision
736 736 import import an ordered set of patches
737 737 incoming show new changesets found in source
738 738 init create a new repository in the given directory
739 739 log show revision history of entire repository or files
740 740 manifest output the current or given revision of the project manifest
741 741 merge merge another revision into working directory
742 742 outgoing show changesets not found in the destination
743 743 paths show aliases for remote repositories
744 744 phase set or show the current phase name
745 745 pull pull changes from the specified source
746 746 push push changes to the specified destination
747 747 recover roll back an interrupted transaction
748 748 remove remove the specified files on the next commit
749 749 rename rename files; equivalent of copy + remove
750 750 resolve redo merges or set/view the merge status of files
751 751 revert restore files to their checkout state
752 752 root print the root (top) of the current working directory
753 753 serve start stand-alone webserver
754 754 status show changed files in the working directory
755 755 summary summarize working directory state
756 756 tag add one or more tags for the current or given revision
757 757 tags list repository tags
758 758 unbundle apply one or more changegroup files
759 759 update update working directory (or switch revisions)
760 760 verify verify the integrity of the repository
761 761 version output version and copyright information
762 762
763 763 enabled extensions:
764 764
765 765 helpext (no help text available)
766 766
767 767 additional help topics:
768 768
769 769 config Configuration Files
770 770 dates Date Formats
771 771 diffs Diff Formats
772 772 environment Environment Variables
773 773 extensions Using Additional Features
774 774 filesets Specifying File Sets
775 775 glossary Glossary
776 776 hgignore Syntax for Mercurial Ignore Files
777 777 hgweb Configuring hgweb
778 778 internals Technical implementation topics
779 779 merge-tools Merge Tools
780 780 multirevs Specifying Multiple Revisions
781 781 patterns File Name Patterns
782 782 phases Working with Phases
783 783 revisions Specifying Single Revisions
784 784 revsets Specifying Revision Sets
785 785 scripting Using Mercurial from scripts and automation
786 786 subrepos Subrepositories
787 787 templating Template Usage
788 788 urls URL Paths
789 789
790 790 (use "hg help -v" to show built-in aliases and global options)
791 791
792 792
793 793 Test list of internal help commands
794 794
795 795 $ hg help debug
796 796 debug commands (internal and unsupported):
797 797
798 798 debugancestor
799 799 find the ancestor revision of two revisions in a given index
800 800 debugapplystreamclonebundle
801 801 apply a stream clone bundle file
802 802 debugbuilddag
803 803 builds a repo with a given DAG from scratch in the current
804 804 empty repo
805 805 debugbundle lists the contents of a bundle
806 806 debugcheckstate
807 807 validate the correctness of the current dirstate
808 808 debugcommands
809 809 list all available commands and options
810 810 debugcomplete
811 811 returns the completion list associated with the given command
812 812 debugcreatestreamclonebundle
813 813 create a stream clone bundle file
814 814 debugdag format the changelog or an index DAG as a concise textual
815 815 description
816 816 debugdata dump the contents of a data file revision
817 817 debugdate parse and display a date
818 818 debugdeltachain
819 819 dump information about delta chains in a revlog
820 820 debugdirstate
821 821 show the contents of the current dirstate
822 822 debugdiscovery
823 823 runs the changeset discovery protocol in isolation
824 824 debugextensions
825 825 show information about active extensions
826 826 debugfileset parse and apply a fileset specification
827 827 debugfsinfo show information detected about current filesystem
828 828 debuggetbundle
829 829 retrieves a bundle from a repo
830 830 debugignore display the combined ignore pattern
831 831 debugindex dump the contents of an index file
832 832 debugindexdot
833 833 dump an index DAG as a graphviz dot file
834 834 debuginstall test Mercurial installation
835 835 debugknown test whether node ids are known to a repo
836 836 debuglocks show or modify state of locks
837 837 debugmergestate
838 838 print merge state
839 839 debugnamecomplete
840 840 complete "names" - tags, open branch names, bookmark names
841 841 debugobsolete
842 842 create arbitrary obsolete marker
843 843 debugoptDEP (no help text available)
844 844 debugoptEXP (no help text available)
845 845 debugpathcomplete
846 846 complete part or all of a tracked path
847 847 debugpushkey access the pushkey key/value protocol
848 848 debugpvec (no help text available)
849 849 debugrebuilddirstate
850 850 rebuild the dirstate as it would look like for the given
851 851 revision
852 852 debugrebuildfncache
853 853 rebuild the fncache file
854 854 debugrename dump rename information
855 855 debugrevlog show data and statistics about a revlog
856 856 debugrevspec parse and apply a revision specification
857 857 debugsetparents
858 858 manually set the parents of the current working directory
859 859 debugsub (no help text available)
860 860 debugsuccessorssets
861 861 show set of successors for revision
862 862 debugwalk show how files match on given patterns
863 863 debugwireargs
864 864 (no help text available)
865 865
866 866 (use "hg help -v debug" to show built-in aliases and global options)
867 867
868 868 internals topic renders index of available sub-topics
869 869
870 870 $ hg help internals
871 871 Technical implementation topics
872 872 """""""""""""""""""""""""""""""
873 873
874 874 bundles container for exchange of repository data
875 875 changegroups representation of revlog data
876 876
877 877 sub-topics can be accessed
878 878
879 879 $ hg help internals.changegroups
880 880 Changegroups
881 881 ============
882 882
883 883 Changegroups are representations of repository revlog data, specifically
884 884 the changelog, manifest, and filelogs.
885 885
886 886 There are 2 versions of changegroups: "1" and "2". From a high-level, they
887 887 are almost exactly the same, with the only difference being a header on
888 888 entries in the changeset segment.
889 889
890 890 Changegroups consists of 3 logical segments:
891 891
892 892 +---------------------------------+
893 893 | | | |
894 894 | changeset | manifest | filelogs |
895 895 | | | |
896 896 +---------------------------------+
897 897
898 898 The principle building block of each segment is a *chunk*. A *chunk* is a
899 899 framed piece of data:
900 900
901 901 +---------------------------------------+
902 902 | | |
903 903 | length | data |
904 904 | (32 bits) | <length> bytes |
905 905 | | |
906 906 +---------------------------------------+
907 907
908 908 Each chunk starts with a 32-bit big-endian signed integer indicating the
909 909 length of the raw data that follows.
910 910
911 911 There is a special case chunk that has 0 length ("0x00000000"). We call
912 912 this an *empty chunk*.
913 913
914 914 Delta Groups
915 915 ------------
916 916
917 917 A *delta group* expresses the content of a revlog as a series of deltas,
918 918 or patches against previous revisions.
919 919
920 920 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
921 921 to signal the end of the delta group:
922 922
923 923 +------------------------------------------------------------------------+
924 924 | | | | | |
925 925 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
926 926 | (32 bits) | (various) | (32 bits) | (various) | (32 bits) |
927 927 | | | | | |
928 928 +------------------------------------------------------------+-----------+
929 929
930 930 Each *chunk*'s data consists of the following:
931 931
932 932 +-----------------------------------------+
933 933 | | | |
934 934 | delta header | mdiff header | delta |
935 935 | (various) | (12 bytes) | (various) |
936 936 | | | |
937 937 +-----------------------------------------+
938 938
939 939 The *length* field is the byte length of the remaining 3 logical pieces of
940 940 data. The *delta* is a diff from an existing entry in the changelog.
941 941
942 942 The *delta header* is different between versions "1" and "2" of the
943 943 changegroup format.
944 944
945 945 Version 1:
946 946
947 947 +------------------------------------------------------+
948 948 | | | | |
949 949 | node | p1 node | p2 node | link node |
950 950 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
951 951 | | | | |
952 952 +------------------------------------------------------+
953 953
954 954 Version 2:
955 955
956 956 +------------------------------------------------------------------+
957 957 | | | | | |
958 958 | node | p1 node | p2 node | base node | link node |
959 959 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
960 960 | | | | | |
961 961 +------------------------------------------------------------------+
962 962
963 963 The *mdiff header* consists of 3 32-bit big-endian signed integers
964 964 describing offsets at which to apply the following delta content:
965 965
966 966 +-------------------------------------+
967 967 | | | |
968 968 | offset | old length | new length |
969 969 | (32 bits) | (32 bits) | (32 bits) |
970 970 | | | |
971 971 +-------------------------------------+
972 972
973 973 In version 1, the delta is always applied against the previous node from
974 974 the changegroup or the first parent if this is the first entry in the
975 975 changegroup.
976 976
977 977 In version 2, the delta base node is encoded in the entry in the
978 978 changegroup. This allows the delta to be expressed against any parent,
979 979 which can result in smaller deltas and more efficient encoding of data.
980 980
981 981 Changeset Segment
982 982 -----------------
983 983
984 984 The *changeset segment* consists of a single *delta group* holding
985 985 changelog data. It is followed by an *empty chunk* to denote the boundary
986 986 to the *manifests segment*.
987 987
988 988 Manifest Segment
989 989 ----------------
990 990
991 991 The *manifest segment* consists of a single *delta group* holding manifest
992 992 data. It is followed by an *empty chunk* to denote the boundary to the
993 993 *filelogs segment*.
994 994
995 995 Filelogs Segment
996 996 ----------------
997 997
998 998 The *filelogs* segment consists of multiple sub-segments, each
999 999 corresponding to an individual file whose data is being described:
1000 1000
1001 1001 +--------------------------------------+
1002 1002 | | | | |
1003 1003 | filelog0 | filelog1 | filelog2 | ... |
1004 1004 | | | | |
1005 1005 +--------------------------------------+
1006 1006
1007 1007 The final filelog sub-segment is followed by an *empty chunk* to denote
1008 1008 the end of the segment and the overall changegroup.
1009 1009
1010 1010 Each filelog sub-segment consists of the following:
1011 1011
1012 1012 +------------------------------------------+
1013 1013 | | | |
1014 1014 | filename size | filename | delta group |
1015 1015 | (32 bits) | (various) | (various) |
1016 1016 | | | |
1017 1017 +------------------------------------------+
1018 1018
1019 1019 That is, a *chunk* consisting of the filename (not terminated or padded)
1020 1020 followed by N chunks constituting the *delta group* for this file.
1021 1021
1022 1022 Test list of commands with command with no help text
1023 1023
1024 1024 $ hg help helpext
1025 1025 helpext extension - no help text available
1026 1026
1027 1027 list of commands:
1028 1028
1029 1029 nohelp (no help text available)
1030 1030
1031 1031 (use "hg help -v helpext" to show built-in aliases and global options)
1032 1032
1033 1033
1034 1034 test deprecated and experimental options are hidden in command help
1035 1035 $ hg help debugoptDEP
1036 1036 hg debugoptDEP
1037 1037
1038 1038 (no help text available)
1039 1039
1040 1040 options:
1041 1041
1042 1042 (some details hidden, use --verbose to show complete help)
1043 1043
1044 1044 $ hg help debugoptEXP
1045 1045 hg debugoptEXP
1046 1046
1047 1047 (no help text available)
1048 1048
1049 1049 options:
1050 1050
1051 1051 (some details hidden, use --verbose to show complete help)
1052 1052
1053 1053 test deprecated and experimental options is shown with -v
1054 1054 $ hg help -v debugoptDEP | grep dopt
1055 1055 --dopt option is (DEPRECATED)
1056 1056 $ hg help -v debugoptEXP | grep eopt
1057 1057 --eopt option is (EXPERIMENTAL)
1058 1058
1059 1059 #if gettext
1060 1060 test deprecated option is hidden with translation with untranslated description
1061 1061 (use many globy for not failing on changed transaction)
1062 1062 $ LANGUAGE=sv hg help debugoptDEP
1063 1063 hg debugoptDEP
1064 1064
1065 1065 (*) (glob)
1066 1066
1067 1067 options:
1068 1068
1069 1069 (some details hidden, use --verbose to show complete help)
1070 1070 #endif
1071 1071
1072 1072 Test commands that collide with topics (issue4240)
1073 1073
1074 1074 $ hg config -hq
1075 1075 hg config [-u] [NAME]...
1076 1076
1077 1077 show combined config settings from all hgrc files
1078 1078 $ hg showconfig -hq
1079 1079 hg config [-u] [NAME]...
1080 1080
1081 1081 show combined config settings from all hgrc files
1082 1082
1083 1083 Test a help topic
1084 1084
1085 1085 $ hg help revs
1086 1086 Specifying Single Revisions
1087 1087 """""""""""""""""""""""""""
1088 1088
1089 1089 Mercurial supports several ways to specify individual revisions.
1090 1090
1091 1091 A plain integer is treated as a revision number. Negative integers are
1092 1092 treated as sequential offsets from the tip, with -1 denoting the tip, -2
1093 1093 denoting the revision prior to the tip, and so forth.
1094 1094
1095 1095 A 40-digit hexadecimal string is treated as a unique revision identifier.
1096 1096
1097 1097 A hexadecimal string less than 40 characters long is treated as a unique
1098 1098 revision identifier and is referred to as a short-form identifier. A
1099 1099 short-form identifier is only valid if it is the prefix of exactly one
1100 1100 full-length identifier.
1101 1101
1102 1102 Any other string is treated as a bookmark, tag, or branch name. A bookmark
1103 1103 is a movable pointer to a revision. A tag is a permanent name associated
1104 1104 with a revision. A branch name denotes the tipmost open branch head of
1105 1105 that branch - or if they are all closed, the tipmost closed head of the
1106 1106 branch. Bookmark, tag, and branch names must not contain the ":"
1107 1107 character.
1108 1108
1109 1109 The reserved name "tip" always identifies the most recent revision.
1110 1110
1111 1111 The reserved name "null" indicates the null revision. This is the revision
1112 1112 of an empty repository, and the parent of revision 0.
1113 1113
1114 1114 The reserved name "." indicates the working directory parent. If no
1115 1115 working directory is checked out, it is equivalent to null. If an
1116 1116 uncommitted merge is in progress, "." is the revision of the first parent.
1117 1117
1118 1118 Test repeated config section name
1119 1119
1120 1120 $ hg help config.host
1121 1121 "http_proxy.host"
1122 1122 Host name and (optional) port of the proxy server, for example
1123 1123 "myproxy:8000".
1124 1124
1125 1125 "smtp.host"
1126 1126 Host name of mail server, e.g. "mail.example.com".
1127 1127
1128 1128 Unrelated trailing paragraphs shouldn't be included
1129 1129
1130 1130 $ hg help config.extramsg | grep '^$'
1131 1131
1132 1132
1133 1133 Test capitalized section name
1134 1134
1135 1135 $ hg help scripting.HGPLAIN > /dev/null
1136 1136
1137 1137 Help subsection:
1138 1138
1139 1139 $ hg help config.charsets |grep "Email example:" > /dev/null
1140 1140 [1]
1141 1141
1142 1142 Show nested definitions
1143 1143 ("profiling.type"[break]"ls"[break]"stat"[break])
1144 1144
1145 1145 $ hg help config.type | egrep '^$'|wc -l
1146 1146 \s*3 (re)
1147 1147
1148 1148 Last item in help config.*:
1149 1149
1150 1150 $ hg help config.`hg help config|grep '^ "'| \
1151 1151 > tail -1|sed 's![ "]*!!g'`| \
1152 1152 > grep "hg help -c config" > /dev/null
1153 1153 [1]
1154 1154
1155 1155 note to use help -c for general hg help config:
1156 1156
1157 1157 $ hg help config |grep "hg help -c config" > /dev/null
1158 1158
1159 1159 Test templating help
1160 1160
1161 1161 $ hg help templating | egrep '(desc|diffstat|firstline|nonempty) '
1162 1162 desc String. The text of the changeset description.
1163 1163 diffstat String. Statistics of changes with the following format:
1164 1164 firstline Any text. Returns the first line of text.
1165 1165 nonempty Any text. Returns '(none)' if the string is empty.
1166 1166
1167 1167 Test deprecated items
1168 1168
1169 1169 $ hg help -v templating | grep currentbookmark
1170 1170 currentbookmark
1171 1171 $ hg help templating | (grep currentbookmark || true)
1172 1172
1173 1173 Test help hooks
1174 1174
1175 1175 $ cat > helphook1.py <<EOF
1176 1176 > from mercurial import help
1177 1177 >
1178 1178 > def rewrite(ui, topic, doc):
1179 1179 > return doc + '\nhelphook1\n'
1180 1180 >
1181 1181 > def extsetup(ui):
1182 1182 > help.addtopichook('revsets', rewrite)
1183 1183 > EOF
1184 1184 $ cat > helphook2.py <<EOF
1185 1185 > from mercurial import help
1186 1186 >
1187 1187 > def rewrite(ui, topic, doc):
1188 1188 > return doc + '\nhelphook2\n'
1189 1189 >
1190 1190 > def extsetup(ui):
1191 1191 > help.addtopichook('revsets', rewrite)
1192 1192 > EOF
1193 1193 $ echo '[extensions]' >> $HGRCPATH
1194 1194 $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
1195 1195 $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
1196 1196 $ hg help revsets | grep helphook
1197 1197 helphook1
1198 1198 helphook2
1199 1199
1200 1200 help -c should only show debug --debug
1201 1201
1202 1202 $ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
1203 1203 [1]
1204 1204
1205 1205 help -c should only show deprecated for -v
1206 1206
1207 1207 $ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
1208 1208 [1]
1209 1209
1210 1210 Test -e / -c / -k combinations
1211 1211
1212 1212 $ hg help -c|egrep '^[A-Z].*:|^ debug'
1213 1213 Commands:
1214 1214 $ hg help -e|egrep '^[A-Z].*:|^ debug'
1215 1215 Extensions:
1216 $ hg help -k|egrep '^[A-Z].*:'
1216 $ hg help -k|egrep '^[A-Z].*:|^ debug'
1217 1217 Topics:
1218 1218 Commands:
1219 1219 Extensions:
1220 1220 Extension Commands:
1221 1221 $ hg help -c schemes
1222 1222 abort: no such help topic: schemes
1223 1223 (try "hg help --keyword schemes")
1224 1224 [255]
1225 1225 $ hg help -e schemes |head -1
1226 1226 schemes extension - extend schemes with shortcuts to repository swarms
1227 1227 $ hg help -c -k dates |egrep '^(Topics|Extensions|Commands):'
1228 1228 Commands:
1229 1229 $ hg help -e -k a |egrep '^(Topics|Extensions|Commands):'
1230 1230 Extensions:
1231 1231 $ hg help -e -c -k date |egrep '^(Topics|Extensions|Commands):'
1232 1232 Extensions:
1233 1233 Commands:
1234 1234 $ hg help -c commit > /dev/null
1235 1235 $ hg help -e -c commit > /dev/null
1236 1236 $ hg help -e commit > /dev/null
1237 1237 abort: no such help topic: commit
1238 1238 (try "hg help --keyword commit")
1239 1239 [255]
1240 1240
1241 1241 Test keyword search help
1242 1242
1243 1243 $ cat > prefixedname.py <<EOF
1244 1244 > '''matched against word "clone"
1245 1245 > '''
1246 1246 > EOF
1247 1247 $ echo '[extensions]' >> $HGRCPATH
1248 1248 $ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
1249 1249 $ hg help -k clone
1250 1250 Topics:
1251 1251
1252 1252 config Configuration Files
1253 1253 extensions Using Additional Features
1254 1254 glossary Glossary
1255 1255 phases Working with Phases
1256 1256 subrepos Subrepositories
1257 1257 urls URL Paths
1258 1258
1259 1259 Commands:
1260 1260
1261 1261 bookmarks create a new bookmark or list existing bookmarks
1262 1262 clone make a copy of an existing repository
1263 1263 paths show aliases for remote repositories
1264 1264 update update working directory (or switch revisions)
1265 1265
1266 1266 Extensions:
1267 1267
1268 1268 clonebundles advertise pre-generated bundles to seed clones (experimental)
1269 1269 prefixedname matched against word "clone"
1270 1270 relink recreates hardlinks between repository clones
1271 1271
1272 1272 Extension Commands:
1273 1273
1274 1274 qclone clone main and patch repository at same time
1275 1275
1276 1276 Test unfound topic
1277 1277
1278 1278 $ hg help nonexistingtopicthatwillneverexisteverever
1279 1279 abort: no such help topic: nonexistingtopicthatwillneverexisteverever
1280 1280 (try "hg help --keyword nonexistingtopicthatwillneverexisteverever")
1281 1281 [255]
1282 1282
1283 1283 Test unfound keyword
1284 1284
1285 1285 $ hg help --keyword nonexistingwordthatwillneverexisteverever
1286 1286 abort: no matches
1287 1287 (try "hg help" for a list of topics)
1288 1288 [255]
1289 1289
1290 1290 Test omit indicating for help
1291 1291
1292 1292 $ cat > addverboseitems.py <<EOF
1293 1293 > '''extension to test omit indicating.
1294 1294 >
1295 1295 > This paragraph is never omitted (for extension)
1296 1296 >
1297 1297 > .. container:: verbose
1298 1298 >
1299 1299 > This paragraph is omitted,
1300 1300 > if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
1301 1301 >
1302 1302 > This paragraph is never omitted, too (for extension)
1303 1303 > '''
1304 1304 >
1305 1305 > from mercurial import help, commands
1306 1306 > testtopic = """This paragraph is never omitted (for topic).
1307 1307 >
1308 1308 > .. container:: verbose
1309 1309 >
1310 1310 > This paragraph is omitted,
1311 1311 > if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
1312 1312 >
1313 1313 > This paragraph is never omitted, too (for topic)
1314 1314 > """
1315 1315 > def extsetup(ui):
1316 1316 > help.helptable.append((["topic-containing-verbose"],
1317 1317 > "This is the topic to test omit indicating.",
1318 1318 > lambda ui: testtopic))
1319 1319 > EOF
1320 1320 $ echo '[extensions]' >> $HGRCPATH
1321 1321 $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
1322 1322 $ hg help addverboseitems
1323 1323 addverboseitems extension - extension to test omit indicating.
1324 1324
1325 1325 This paragraph is never omitted (for extension)
1326 1326
1327 1327 This paragraph is never omitted, too (for extension)
1328 1328
1329 1329 (some details hidden, use --verbose to show complete help)
1330 1330
1331 1331 no commands defined
1332 1332 $ hg help -v addverboseitems
1333 1333 addverboseitems extension - extension to test omit indicating.
1334 1334
1335 1335 This paragraph is never omitted (for extension)
1336 1336
1337 1337 This paragraph is omitted, if "hg help" is invoked without "-v" (for
1338 1338 extension)
1339 1339
1340 1340 This paragraph is never omitted, too (for extension)
1341 1341
1342 1342 no commands defined
1343 1343 $ hg help topic-containing-verbose
1344 1344 This is the topic to test omit indicating.
1345 1345 """"""""""""""""""""""""""""""""""""""""""
1346 1346
1347 1347 This paragraph is never omitted (for topic).
1348 1348
1349 1349 This paragraph is never omitted, too (for topic)
1350 1350
1351 1351 (some details hidden, use --verbose to show complete help)
1352 1352 $ hg help -v topic-containing-verbose
1353 1353 This is the topic to test omit indicating.
1354 1354 """"""""""""""""""""""""""""""""""""""""""
1355 1355
1356 1356 This paragraph is never omitted (for topic).
1357 1357
1358 1358 This paragraph is omitted, if "hg help" is invoked without "-v" (for
1359 1359 topic)
1360 1360
1361 1361 This paragraph is never omitted, too (for topic)
1362 1362
1363 1363 Test section lookup
1364 1364
1365 1365 $ hg help revset.merge
1366 1366 "merge()"
1367 1367 Changeset is a merge changeset.
1368 1368
1369 1369 $ hg help glossary.dag
1370 1370 DAG
1371 1371 The repository of changesets of a distributed version control system
1372 1372 (DVCS) can be described as a directed acyclic graph (DAG), consisting
1373 1373 of nodes and edges, where nodes correspond to changesets and edges
1374 1374 imply a parent -> child relation. This graph can be visualized by
1375 1375 graphical tools such as "hg log --graph". In Mercurial, the DAG is
1376 1376 limited by the requirement for children to have at most two parents.
1377 1377
1378 1378
1379 1379 $ hg help hgrc.paths
1380 1380 "paths"
1381 1381 -------
1382 1382
1383 1383 Assigns symbolic names and behavior to repositories.
1384 1384
1385 1385 Options are symbolic names defining the URL or directory that is the
1386 1386 location of the repository. Example:
1387 1387
1388 1388 [paths]
1389 1389 my_server = https://example.com/my_repo
1390 1390 local_path = /home/me/repo
1391 1391
1392 1392 These symbolic names can be used from the command line. To pull from
1393 1393 "my_server": "hg pull my_server". To push to "local_path": "hg push
1394 1394 local_path".
1395 1395
1396 1396 Options containing colons (":") denote sub-options that can influence
1397 1397 behavior for that specific path. Example:
1398 1398
1399 1399 [paths]
1400 1400 my_server = https://example.com/my_path
1401 1401 my_server:pushurl = ssh://example.com/my_path
1402 1402
1403 1403 The following sub-options can be defined:
1404 1404
1405 1405 "pushurl"
1406 1406 The URL to use for push operations. If not defined, the location
1407 1407 defined by the path's main entry is used.
1408 1408
1409 1409 The following special named paths exist:
1410 1410
1411 1411 "default"
1412 1412 The URL or directory to use when no source or remote is specified.
1413 1413
1414 1414 "hg clone" will automatically define this path to the location the
1415 1415 repository was cloned from.
1416 1416
1417 1417 "default-push"
1418 1418 (deprecated) The URL or directory for the default "hg push" location.
1419 1419 "default:pushurl" should be used instead.
1420 1420
1421 1421 $ hg help glossary.mcguffin
1422 1422 abort: help section not found
1423 1423 [255]
1424 1424
1425 1425 $ hg help glossary.mc.guffin
1426 1426 abort: help section not found
1427 1427 [255]
1428 1428
1429 1429 $ hg help template.files
1430 1430 files List of strings. All files modified, added, or removed by
1431 1431 this changeset.
1432 1432
1433 1433 Test dynamic list of merge tools only shows up once
1434 1434 $ hg help merge-tools
1435 1435 Merge Tools
1436 1436 """""""""""
1437 1437
1438 1438 To merge files Mercurial uses merge tools.
1439 1439
1440 1440 A merge tool combines two different versions of a file into a merged file.
1441 1441 Merge tools are given the two files and the greatest common ancestor of
1442 1442 the two file versions, so they can determine the changes made on both
1443 1443 branches.
1444 1444
1445 1445 Merge tools are used both for "hg resolve", "hg merge", "hg update", "hg
1446 1446 backout" and in several extensions.
1447 1447
1448 1448 Usually, the merge tool tries to automatically reconcile the files by
1449 1449 combining all non-overlapping changes that occurred separately in the two
1450 1450 different evolutions of the same initial base file. Furthermore, some
1451 1451 interactive merge programs make it easier to manually resolve conflicting
1452 1452 merges, either in a graphical way, or by inserting some conflict markers.
1453 1453 Mercurial does not include any interactive merge programs but relies on
1454 1454 external tools for that.
1455 1455
1456 1456 Available merge tools
1457 1457 =====================
1458 1458
1459 1459 External merge tools and their properties are configured in the merge-
1460 1460 tools configuration section - see hgrc(5) - but they can often just be
1461 1461 named by their executable.
1462 1462
1463 1463 A merge tool is generally usable if its executable can be found on the
1464 1464 system and if it can handle the merge. The executable is found if it is an
1465 1465 absolute or relative executable path or the name of an application in the
1466 1466 executable search path. The tool is assumed to be able to handle the merge
1467 1467 if it can handle symlinks if the file is a symlink, if it can handle
1468 1468 binary files if the file is binary, and if a GUI is available if the tool
1469 1469 requires a GUI.
1470 1470
1471 1471 There are some internal merge tools which can be used. The internal merge
1472 1472 tools are:
1473 1473
1474 1474 ":dump"
1475 1475 Creates three versions of the files to merge, containing the contents of
1476 1476 local, other and base. These files can then be used to perform a merge
1477 1477 manually. If the file to be merged is named "a.txt", these files will
1478 1478 accordingly be named "a.txt.local", "a.txt.other" and "a.txt.base" and
1479 1479 they will be placed in the same directory as "a.txt".
1480 1480
1481 1481 ":fail"
1482 1482 Rather than attempting to merge files that were modified on both
1483 1483 branches, it marks them as unresolved. The resolve command must be used
1484 1484 to resolve these conflicts.
1485 1485
1486 1486 ":local"
1487 1487 Uses the local version of files as the merged version.
1488 1488
1489 1489 ":merge"
1490 1490 Uses the internal non-interactive simple merge algorithm for merging
1491 1491 files. It will fail if there are any conflicts and leave markers in the
1492 1492 partially merged file. Markers will have two sections, one for each side
1493 1493 of merge.
1494 1494
1495 1495 ":merge-local"
1496 1496 Like :merge, but resolve all conflicts non-interactively in favor of the
1497 1497 local changes.
1498 1498
1499 1499 ":merge-other"
1500 1500 Like :merge, but resolve all conflicts non-interactively in favor of the
1501 1501 other changes.
1502 1502
1503 1503 ":merge3"
1504 1504 Uses the internal non-interactive simple merge algorithm for merging
1505 1505 files. It will fail if there are any conflicts and leave markers in the
1506 1506 partially merged file. Marker will have three sections, one from each
1507 1507 side of the merge and one for the base content.
1508 1508
1509 1509 ":other"
1510 1510 Uses the other version of files as the merged version.
1511 1511
1512 1512 ":prompt"
1513 1513 Asks the user which of the local or the other version to keep as the
1514 1514 merged version.
1515 1515
1516 1516 ":tagmerge"
1517 1517 Uses the internal tag merge algorithm (experimental).
1518 1518
1519 1519 ":union"
1520 1520 Uses the internal non-interactive simple merge algorithm for merging
1521 1521 files. It will use both left and right sides for conflict regions. No
1522 1522 markers are inserted.
1523 1523
1524 1524 Internal tools are always available and do not require a GUI but will by
1525 1525 default not handle symlinks or binary files.
1526 1526
1527 1527 Choosing a merge tool
1528 1528 =====================
1529 1529
1530 1530 Mercurial uses these rules when deciding which merge tool to use:
1531 1531
1532 1532 1. If a tool has been specified with the --tool option to merge or
1533 1533 resolve, it is used. If it is the name of a tool in the merge-tools
1534 1534 configuration, its configuration is used. Otherwise the specified tool
1535 1535 must be executable by the shell.
1536 1536 2. If the "HGMERGE" environment variable is present, its value is used and
1537 1537 must be executable by the shell.
1538 1538 3. If the filename of the file to be merged matches any of the patterns in
1539 1539 the merge-patterns configuration section, the first usable merge tool
1540 1540 corresponding to a matching pattern is used. Here, binary capabilities
1541 1541 of the merge tool are not considered.
1542 1542 4. If ui.merge is set it will be considered next. If the value is not the
1543 1543 name of a configured tool, the specified value is used and must be
1544 1544 executable by the shell. Otherwise the named tool is used if it is
1545 1545 usable.
1546 1546 5. If any usable merge tools are present in the merge-tools configuration
1547 1547 section, the one with the highest priority is used.
1548 1548 6. If a program named "hgmerge" can be found on the system, it is used -
1549 1549 but it will by default not be used for symlinks and binary files.
1550 1550 7. If the file to be merged is not binary and is not a symlink, then
1551 1551 internal ":merge" is used.
1552 1552 8. The merge of the file fails and must be resolved before commit.
1553 1553
1554 1554 Note:
1555 1555 After selecting a merge program, Mercurial will by default attempt to
1556 1556 merge the files using a simple merge algorithm first. Only if it
1557 1557 doesn't succeed because of conflicting changes Mercurial will actually
1558 1558 execute the merge program. Whether to use the simple merge algorithm
1559 1559 first can be controlled by the premerge setting of the merge tool.
1560 1560 Premerge is enabled by default unless the file is binary or a symlink.
1561 1561
1562 1562 See the merge-tools and ui sections of hgrc(5) for details on the
1563 1563 configuration of merge tools.
1564 1564
1565 1565 Test usage of section marks in help documents
1566 1566
1567 1567 $ cd "$TESTDIR"/../doc
1568 1568 $ python check-seclevel.py
1569 1569 $ cd $TESTTMP
1570 1570
1571 1571 #if serve
1572 1572
1573 1573 Test the help pages in hgweb.
1574 1574
1575 1575 Dish up an empty repo; serve it cold.
1576 1576
1577 1577 $ hg init "$TESTTMP/test"
1578 1578 $ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
1579 1579 $ cat hg.pid >> $DAEMON_PIDS
1580 1580
1581 1581 $ get-with-headers.py 127.0.0.1:$HGPORT "help"
1582 1582 200 Script output follows
1583 1583
1584 1584 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
1585 1585 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
1586 1586 <head>
1587 1587 <link rel="icon" href="/static/hgicon.png" type="image/png" />
1588 1588 <meta name="robots" content="index, nofollow" />
1589 1589 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
1590 1590 <script type="text/javascript" src="/static/mercurial.js"></script>
1591 1591
1592 1592 <title>Help: Index</title>
1593 1593 </head>
1594 1594 <body>
1595 1595
1596 1596 <div class="container">
1597 1597 <div class="menu">
1598 1598 <div class="logo">
1599 1599 <a href="https://mercurial-scm.org/">
1600 1600 <img src="/static/hglogo.png" alt="mercurial" /></a>
1601 1601 </div>
1602 1602 <ul>
1603 1603 <li><a href="/shortlog">log</a></li>
1604 1604 <li><a href="/graph">graph</a></li>
1605 1605 <li><a href="/tags">tags</a></li>
1606 1606 <li><a href="/bookmarks">bookmarks</a></li>
1607 1607 <li><a href="/branches">branches</a></li>
1608 1608 </ul>
1609 1609 <ul>
1610 1610 <li class="active">help</li>
1611 1611 </ul>
1612 1612 </div>
1613 1613
1614 1614 <div class="main">
1615 1615 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
1616 1616 <form class="search" action="/log">
1617 1617
1618 1618 <p><input name="rev" id="search1" type="text" size="30" /></p>
1619 1619 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
1620 1620 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
1621 1621 </form>
1622 1622 <table class="bigtable">
1623 1623 <tr><td colspan="2"><h2><a name="main" href="#topics">Topics</a></h2></td></tr>
1624 1624
1625 1625 <tr><td>
1626 1626 <a href="/help/config">
1627 1627 config
1628 1628 </a>
1629 1629 </td><td>
1630 1630 Configuration Files
1631 1631 </td></tr>
1632 1632 <tr><td>
1633 1633 <a href="/help/dates">
1634 1634 dates
1635 1635 </a>
1636 1636 </td><td>
1637 1637 Date Formats
1638 1638 </td></tr>
1639 1639 <tr><td>
1640 1640 <a href="/help/diffs">
1641 1641 diffs
1642 1642 </a>
1643 1643 </td><td>
1644 1644 Diff Formats
1645 1645 </td></tr>
1646 1646 <tr><td>
1647 1647 <a href="/help/environment">
1648 1648 environment
1649 1649 </a>
1650 1650 </td><td>
1651 1651 Environment Variables
1652 1652 </td></tr>
1653 1653 <tr><td>
1654 1654 <a href="/help/extensions">
1655 1655 extensions
1656 1656 </a>
1657 1657 </td><td>
1658 1658 Using Additional Features
1659 1659 </td></tr>
1660 1660 <tr><td>
1661 1661 <a href="/help/filesets">
1662 1662 filesets
1663 1663 </a>
1664 1664 </td><td>
1665 1665 Specifying File Sets
1666 1666 </td></tr>
1667 1667 <tr><td>
1668 1668 <a href="/help/glossary">
1669 1669 glossary
1670 1670 </a>
1671 1671 </td><td>
1672 1672 Glossary
1673 1673 </td></tr>
1674 1674 <tr><td>
1675 1675 <a href="/help/hgignore">
1676 1676 hgignore
1677 1677 </a>
1678 1678 </td><td>
1679 1679 Syntax for Mercurial Ignore Files
1680 1680 </td></tr>
1681 1681 <tr><td>
1682 1682 <a href="/help/hgweb">
1683 1683 hgweb
1684 1684 </a>
1685 1685 </td><td>
1686 1686 Configuring hgweb
1687 1687 </td></tr>
1688 1688 <tr><td>
1689 1689 <a href="/help/internals">
1690 1690 internals
1691 1691 </a>
1692 1692 </td><td>
1693 1693 Technical implementation topics
1694 1694 </td></tr>
1695 1695 <tr><td>
1696 1696 <a href="/help/merge-tools">
1697 1697 merge-tools
1698 1698 </a>
1699 1699 </td><td>
1700 1700 Merge Tools
1701 1701 </td></tr>
1702 1702 <tr><td>
1703 1703 <a href="/help/multirevs">
1704 1704 multirevs
1705 1705 </a>
1706 1706 </td><td>
1707 1707 Specifying Multiple Revisions
1708 1708 </td></tr>
1709 1709 <tr><td>
1710 1710 <a href="/help/patterns">
1711 1711 patterns
1712 1712 </a>
1713 1713 </td><td>
1714 1714 File Name Patterns
1715 1715 </td></tr>
1716 1716 <tr><td>
1717 1717 <a href="/help/phases">
1718 1718 phases
1719 1719 </a>
1720 1720 </td><td>
1721 1721 Working with Phases
1722 1722 </td></tr>
1723 1723 <tr><td>
1724 1724 <a href="/help/revisions">
1725 1725 revisions
1726 1726 </a>
1727 1727 </td><td>
1728 1728 Specifying Single Revisions
1729 1729 </td></tr>
1730 1730 <tr><td>
1731 1731 <a href="/help/revsets">
1732 1732 revsets
1733 1733 </a>
1734 1734 </td><td>
1735 1735 Specifying Revision Sets
1736 1736 </td></tr>
1737 1737 <tr><td>
1738 1738 <a href="/help/scripting">
1739 1739 scripting
1740 1740 </a>
1741 1741 </td><td>
1742 1742 Using Mercurial from scripts and automation
1743 1743 </td></tr>
1744 1744 <tr><td>
1745 1745 <a href="/help/subrepos">
1746 1746 subrepos
1747 1747 </a>
1748 1748 </td><td>
1749 1749 Subrepositories
1750 1750 </td></tr>
1751 1751 <tr><td>
1752 1752 <a href="/help/templating">
1753 1753 templating
1754 1754 </a>
1755 1755 </td><td>
1756 1756 Template Usage
1757 1757 </td></tr>
1758 1758 <tr><td>
1759 1759 <a href="/help/urls">
1760 1760 urls
1761 1761 </a>
1762 1762 </td><td>
1763 1763 URL Paths
1764 1764 </td></tr>
1765 1765 <tr><td>
1766 1766 <a href="/help/topic-containing-verbose">
1767 1767 topic-containing-verbose
1768 1768 </a>
1769 1769 </td><td>
1770 1770 This is the topic to test omit indicating.
1771 1771 </td></tr>
1772 1772
1773 1773 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
1774 1774
1775 1775 <tr><td>
1776 1776 <a href="/help/add">
1777 1777 add
1778 1778 </a>
1779 1779 </td><td>
1780 1780 add the specified files on the next commit
1781 1781 </td></tr>
1782 1782 <tr><td>
1783 1783 <a href="/help/annotate">
1784 1784 annotate
1785 1785 </a>
1786 1786 </td><td>
1787 1787 show changeset information by line for each file
1788 1788 </td></tr>
1789 1789 <tr><td>
1790 1790 <a href="/help/clone">
1791 1791 clone
1792 1792 </a>
1793 1793 </td><td>
1794 1794 make a copy of an existing repository
1795 1795 </td></tr>
1796 1796 <tr><td>
1797 1797 <a href="/help/commit">
1798 1798 commit
1799 1799 </a>
1800 1800 </td><td>
1801 1801 commit the specified files or all outstanding changes
1802 1802 </td></tr>
1803 1803 <tr><td>
1804 1804 <a href="/help/diff">
1805 1805 diff
1806 1806 </a>
1807 1807 </td><td>
1808 1808 diff repository (or selected files)
1809 1809 </td></tr>
1810 1810 <tr><td>
1811 1811 <a href="/help/export">
1812 1812 export
1813 1813 </a>
1814 1814 </td><td>
1815 1815 dump the header and diffs for one or more changesets
1816 1816 </td></tr>
1817 1817 <tr><td>
1818 1818 <a href="/help/forget">
1819 1819 forget
1820 1820 </a>
1821 1821 </td><td>
1822 1822 forget the specified files on the next commit
1823 1823 </td></tr>
1824 1824 <tr><td>
1825 1825 <a href="/help/init">
1826 1826 init
1827 1827 </a>
1828 1828 </td><td>
1829 1829 create a new repository in the given directory
1830 1830 </td></tr>
1831 1831 <tr><td>
1832 1832 <a href="/help/log">
1833 1833 log
1834 1834 </a>
1835 1835 </td><td>
1836 1836 show revision history of entire repository or files
1837 1837 </td></tr>
1838 1838 <tr><td>
1839 1839 <a href="/help/merge">
1840 1840 merge
1841 1841 </a>
1842 1842 </td><td>
1843 1843 merge another revision into working directory
1844 1844 </td></tr>
1845 1845 <tr><td>
1846 1846 <a href="/help/pull">
1847 1847 pull
1848 1848 </a>
1849 1849 </td><td>
1850 1850 pull changes from the specified source
1851 1851 </td></tr>
1852 1852 <tr><td>
1853 1853 <a href="/help/push">
1854 1854 push
1855 1855 </a>
1856 1856 </td><td>
1857 1857 push changes to the specified destination
1858 1858 </td></tr>
1859 1859 <tr><td>
1860 1860 <a href="/help/remove">
1861 1861 remove
1862 1862 </a>
1863 1863 </td><td>
1864 1864 remove the specified files on the next commit
1865 1865 </td></tr>
1866 1866 <tr><td>
1867 1867 <a href="/help/serve">
1868 1868 serve
1869 1869 </a>
1870 1870 </td><td>
1871 1871 start stand-alone webserver
1872 1872 </td></tr>
1873 1873 <tr><td>
1874 1874 <a href="/help/status">
1875 1875 status
1876 1876 </a>
1877 1877 </td><td>
1878 1878 show changed files in the working directory
1879 1879 </td></tr>
1880 1880 <tr><td>
1881 1881 <a href="/help/summary">
1882 1882 summary
1883 1883 </a>
1884 1884 </td><td>
1885 1885 summarize working directory state
1886 1886 </td></tr>
1887 1887 <tr><td>
1888 1888 <a href="/help/update">
1889 1889 update
1890 1890 </a>
1891 1891 </td><td>
1892 1892 update working directory (or switch revisions)
1893 1893 </td></tr>
1894 1894
1895 1895 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
1896 1896
1897 1897 <tr><td>
1898 1898 <a href="/help/addremove">
1899 1899 addremove
1900 1900 </a>
1901 1901 </td><td>
1902 1902 add all new files, delete all missing files
1903 1903 </td></tr>
1904 1904 <tr><td>
1905 1905 <a href="/help/archive">
1906 1906 archive
1907 1907 </a>
1908 1908 </td><td>
1909 1909 create an unversioned archive of a repository revision
1910 1910 </td></tr>
1911 1911 <tr><td>
1912 1912 <a href="/help/backout">
1913 1913 backout
1914 1914 </a>
1915 1915 </td><td>
1916 1916 reverse effect of earlier changeset
1917 1917 </td></tr>
1918 1918 <tr><td>
1919 1919 <a href="/help/bisect">
1920 1920 bisect
1921 1921 </a>
1922 1922 </td><td>
1923 1923 subdivision search of changesets
1924 1924 </td></tr>
1925 1925 <tr><td>
1926 1926 <a href="/help/bookmarks">
1927 1927 bookmarks
1928 1928 </a>
1929 1929 </td><td>
1930 1930 create a new bookmark or list existing bookmarks
1931 1931 </td></tr>
1932 1932 <tr><td>
1933 1933 <a href="/help/branch">
1934 1934 branch
1935 1935 </a>
1936 1936 </td><td>
1937 1937 set or show the current branch name
1938 1938 </td></tr>
1939 1939 <tr><td>
1940 1940 <a href="/help/branches">
1941 1941 branches
1942 1942 </a>
1943 1943 </td><td>
1944 1944 list repository named branches
1945 1945 </td></tr>
1946 1946 <tr><td>
1947 1947 <a href="/help/bundle">
1948 1948 bundle
1949 1949 </a>
1950 1950 </td><td>
1951 1951 create a changegroup file
1952 1952 </td></tr>
1953 1953 <tr><td>
1954 1954 <a href="/help/cat">
1955 1955 cat
1956 1956 </a>
1957 1957 </td><td>
1958 1958 output the current or given revision of files
1959 1959 </td></tr>
1960 1960 <tr><td>
1961 1961 <a href="/help/config">
1962 1962 config
1963 1963 </a>
1964 1964 </td><td>
1965 1965 show combined config settings from all hgrc files
1966 1966 </td></tr>
1967 1967 <tr><td>
1968 1968 <a href="/help/copy">
1969 1969 copy
1970 1970 </a>
1971 1971 </td><td>
1972 1972 mark files as copied for the next commit
1973 1973 </td></tr>
1974 1974 <tr><td>
1975 1975 <a href="/help/files">
1976 1976 files
1977 1977 </a>
1978 1978 </td><td>
1979 1979 list tracked files
1980 1980 </td></tr>
1981 1981 <tr><td>
1982 1982 <a href="/help/graft">
1983 1983 graft
1984 1984 </a>
1985 1985 </td><td>
1986 1986 copy changes from other branches onto the current branch
1987 1987 </td></tr>
1988 1988 <tr><td>
1989 1989 <a href="/help/grep">
1990 1990 grep
1991 1991 </a>
1992 1992 </td><td>
1993 1993 search for a pattern in specified files and revisions
1994 1994 </td></tr>
1995 1995 <tr><td>
1996 1996 <a href="/help/heads">
1997 1997 heads
1998 1998 </a>
1999 1999 </td><td>
2000 2000 show branch heads
2001 2001 </td></tr>
2002 2002 <tr><td>
2003 2003 <a href="/help/help">
2004 2004 help
2005 2005 </a>
2006 2006 </td><td>
2007 2007 show help for a given topic or a help overview
2008 2008 </td></tr>
2009 2009 <tr><td>
2010 2010 <a href="/help/identify">
2011 2011 identify
2012 2012 </a>
2013 2013 </td><td>
2014 2014 identify the working directory or specified revision
2015 2015 </td></tr>
2016 2016 <tr><td>
2017 2017 <a href="/help/import">
2018 2018 import
2019 2019 </a>
2020 2020 </td><td>
2021 2021 import an ordered set of patches
2022 2022 </td></tr>
2023 2023 <tr><td>
2024 2024 <a href="/help/incoming">
2025 2025 incoming
2026 2026 </a>
2027 2027 </td><td>
2028 2028 show new changesets found in source
2029 2029 </td></tr>
2030 2030 <tr><td>
2031 2031 <a href="/help/manifest">
2032 2032 manifest
2033 2033 </a>
2034 2034 </td><td>
2035 2035 output the current or given revision of the project manifest
2036 2036 </td></tr>
2037 2037 <tr><td>
2038 2038 <a href="/help/nohelp">
2039 2039 nohelp
2040 2040 </a>
2041 2041 </td><td>
2042 2042 (no help text available)
2043 2043 </td></tr>
2044 2044 <tr><td>
2045 2045 <a href="/help/outgoing">
2046 2046 outgoing
2047 2047 </a>
2048 2048 </td><td>
2049 2049 show changesets not found in the destination
2050 2050 </td></tr>
2051 2051 <tr><td>
2052 2052 <a href="/help/paths">
2053 2053 paths
2054 2054 </a>
2055 2055 </td><td>
2056 2056 show aliases for remote repositories
2057 2057 </td></tr>
2058 2058 <tr><td>
2059 2059 <a href="/help/phase">
2060 2060 phase
2061 2061 </a>
2062 2062 </td><td>
2063 2063 set or show the current phase name
2064 2064 </td></tr>
2065 2065 <tr><td>
2066 2066 <a href="/help/recover">
2067 2067 recover
2068 2068 </a>
2069 2069 </td><td>
2070 2070 roll back an interrupted transaction
2071 2071 </td></tr>
2072 2072 <tr><td>
2073 2073 <a href="/help/rename">
2074 2074 rename
2075 2075 </a>
2076 2076 </td><td>
2077 2077 rename files; equivalent of copy + remove
2078 2078 </td></tr>
2079 2079 <tr><td>
2080 2080 <a href="/help/resolve">
2081 2081 resolve
2082 2082 </a>
2083 2083 </td><td>
2084 2084 redo merges or set/view the merge status of files
2085 2085 </td></tr>
2086 2086 <tr><td>
2087 2087 <a href="/help/revert">
2088 2088 revert
2089 2089 </a>
2090 2090 </td><td>
2091 2091 restore files to their checkout state
2092 2092 </td></tr>
2093 2093 <tr><td>
2094 2094 <a href="/help/root">
2095 2095 root
2096 2096 </a>
2097 2097 </td><td>
2098 2098 print the root (top) of the current working directory
2099 2099 </td></tr>
2100 2100 <tr><td>
2101 2101 <a href="/help/tag">
2102 2102 tag
2103 2103 </a>
2104 2104 </td><td>
2105 2105 add one or more tags for the current or given revision
2106 2106 </td></tr>
2107 2107 <tr><td>
2108 2108 <a href="/help/tags">
2109 2109 tags
2110 2110 </a>
2111 2111 </td><td>
2112 2112 list repository tags
2113 2113 </td></tr>
2114 2114 <tr><td>
2115 2115 <a href="/help/unbundle">
2116 2116 unbundle
2117 2117 </a>
2118 2118 </td><td>
2119 2119 apply one or more changegroup files
2120 2120 </td></tr>
2121 2121 <tr><td>
2122 2122 <a href="/help/verify">
2123 2123 verify
2124 2124 </a>
2125 2125 </td><td>
2126 2126 verify the integrity of the repository
2127 2127 </td></tr>
2128 2128 <tr><td>
2129 2129 <a href="/help/version">
2130 2130 version
2131 2131 </a>
2132 2132 </td><td>
2133 2133 output version and copyright information
2134 2134 </td></tr>
2135 2135 </table>
2136 2136 </div>
2137 2137 </div>
2138 2138
2139 2139 <script type="text/javascript">process_dates()</script>
2140 2140
2141 2141
2142 2142 </body>
2143 2143 </html>
2144 2144
2145 2145
2146 2146 $ get-with-headers.py 127.0.0.1:$HGPORT "help/add"
2147 2147 200 Script output follows
2148 2148
2149 2149 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2150 2150 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2151 2151 <head>
2152 2152 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2153 2153 <meta name="robots" content="index, nofollow" />
2154 2154 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2155 2155 <script type="text/javascript" src="/static/mercurial.js"></script>
2156 2156
2157 2157 <title>Help: add</title>
2158 2158 </head>
2159 2159 <body>
2160 2160
2161 2161 <div class="container">
2162 2162 <div class="menu">
2163 2163 <div class="logo">
2164 2164 <a href="https://mercurial-scm.org/">
2165 2165 <img src="/static/hglogo.png" alt="mercurial" /></a>
2166 2166 </div>
2167 2167 <ul>
2168 2168 <li><a href="/shortlog">log</a></li>
2169 2169 <li><a href="/graph">graph</a></li>
2170 2170 <li><a href="/tags">tags</a></li>
2171 2171 <li><a href="/bookmarks">bookmarks</a></li>
2172 2172 <li><a href="/branches">branches</a></li>
2173 2173 </ul>
2174 2174 <ul>
2175 2175 <li class="active"><a href="/help">help</a></li>
2176 2176 </ul>
2177 2177 </div>
2178 2178
2179 2179 <div class="main">
2180 2180 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2181 2181 <h3>Help: add</h3>
2182 2182
2183 2183 <form class="search" action="/log">
2184 2184
2185 2185 <p><input name="rev" id="search1" type="text" size="30" /></p>
2186 2186 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2187 2187 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2188 2188 </form>
2189 2189 <div id="doc">
2190 2190 <p>
2191 2191 hg add [OPTION]... [FILE]...
2192 2192 </p>
2193 2193 <p>
2194 2194 add the specified files on the next commit
2195 2195 </p>
2196 2196 <p>
2197 2197 Schedule files to be version controlled and added to the
2198 2198 repository.
2199 2199 </p>
2200 2200 <p>
2201 2201 The files will be added to the repository at the next commit. To
2202 2202 undo an add before that, see &quot;hg forget&quot;.
2203 2203 </p>
2204 2204 <p>
2205 2205 If no names are given, add all files to the repository.
2206 2206 </p>
2207 2207 <p>
2208 2208 Examples:
2209 2209 </p>
2210 2210 <ul>
2211 2211 <li> New (unknown) files are added automatically by &quot;hg add&quot;:
2212 2212 <pre>
2213 2213 \$ ls (re)
2214 2214 foo.c
2215 2215 \$ hg status (re)
2216 2216 ? foo.c
2217 2217 \$ hg add (re)
2218 2218 adding foo.c
2219 2219 \$ hg status (re)
2220 2220 A foo.c
2221 2221 </pre>
2222 2222 <li> Specific files to be added can be specified:
2223 2223 <pre>
2224 2224 \$ ls (re)
2225 2225 bar.c foo.c
2226 2226 \$ hg status (re)
2227 2227 ? bar.c
2228 2228 ? foo.c
2229 2229 \$ hg add bar.c (re)
2230 2230 \$ hg status (re)
2231 2231 A bar.c
2232 2232 ? foo.c
2233 2233 </pre>
2234 2234 </ul>
2235 2235 <p>
2236 2236 Returns 0 if all files are successfully added.
2237 2237 </p>
2238 2238 <p>
2239 2239 options ([+] can be repeated):
2240 2240 </p>
2241 2241 <table>
2242 2242 <tr><td>-I</td>
2243 2243 <td>--include PATTERN [+]</td>
2244 2244 <td>include names matching the given patterns</td></tr>
2245 2245 <tr><td>-X</td>
2246 2246 <td>--exclude PATTERN [+]</td>
2247 2247 <td>exclude names matching the given patterns</td></tr>
2248 2248 <tr><td>-S</td>
2249 2249 <td>--subrepos</td>
2250 2250 <td>recurse into subrepositories</td></tr>
2251 2251 <tr><td>-n</td>
2252 2252 <td>--dry-run</td>
2253 2253 <td>do not perform actions, just print output</td></tr>
2254 2254 </table>
2255 2255 <p>
2256 2256 global options ([+] can be repeated):
2257 2257 </p>
2258 2258 <table>
2259 2259 <tr><td>-R</td>
2260 2260 <td>--repository REPO</td>
2261 2261 <td>repository root directory or name of overlay bundle file</td></tr>
2262 2262 <tr><td></td>
2263 2263 <td>--cwd DIR</td>
2264 2264 <td>change working directory</td></tr>
2265 2265 <tr><td>-y</td>
2266 2266 <td>--noninteractive</td>
2267 2267 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2268 2268 <tr><td>-q</td>
2269 2269 <td>--quiet</td>
2270 2270 <td>suppress output</td></tr>
2271 2271 <tr><td>-v</td>
2272 2272 <td>--verbose</td>
2273 2273 <td>enable additional output</td></tr>
2274 2274 <tr><td></td>
2275 2275 <td>--config CONFIG [+]</td>
2276 2276 <td>set/override config option (use 'section.name=value')</td></tr>
2277 2277 <tr><td></td>
2278 2278 <td>--debug</td>
2279 2279 <td>enable debugging output</td></tr>
2280 2280 <tr><td></td>
2281 2281 <td>--debugger</td>
2282 2282 <td>start debugger</td></tr>
2283 2283 <tr><td></td>
2284 2284 <td>--encoding ENCODE</td>
2285 2285 <td>set the charset encoding (default: ascii)</td></tr>
2286 2286 <tr><td></td>
2287 2287 <td>--encodingmode MODE</td>
2288 2288 <td>set the charset encoding mode (default: strict)</td></tr>
2289 2289 <tr><td></td>
2290 2290 <td>--traceback</td>
2291 2291 <td>always print a traceback on exception</td></tr>
2292 2292 <tr><td></td>
2293 2293 <td>--time</td>
2294 2294 <td>time how long the command takes</td></tr>
2295 2295 <tr><td></td>
2296 2296 <td>--profile</td>
2297 2297 <td>print command execution profile</td></tr>
2298 2298 <tr><td></td>
2299 2299 <td>--version</td>
2300 2300 <td>output version information and exit</td></tr>
2301 2301 <tr><td>-h</td>
2302 2302 <td>--help</td>
2303 2303 <td>display help and exit</td></tr>
2304 2304 <tr><td></td>
2305 2305 <td>--hidden</td>
2306 2306 <td>consider hidden changesets</td></tr>
2307 2307 </table>
2308 2308
2309 2309 </div>
2310 2310 </div>
2311 2311 </div>
2312 2312
2313 2313 <script type="text/javascript">process_dates()</script>
2314 2314
2315 2315
2316 2316 </body>
2317 2317 </html>
2318 2318
2319 2319
2320 2320 $ get-with-headers.py 127.0.0.1:$HGPORT "help/remove"
2321 2321 200 Script output follows
2322 2322
2323 2323 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2324 2324 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2325 2325 <head>
2326 2326 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2327 2327 <meta name="robots" content="index, nofollow" />
2328 2328 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2329 2329 <script type="text/javascript" src="/static/mercurial.js"></script>
2330 2330
2331 2331 <title>Help: remove</title>
2332 2332 </head>
2333 2333 <body>
2334 2334
2335 2335 <div class="container">
2336 2336 <div class="menu">
2337 2337 <div class="logo">
2338 2338 <a href="https://mercurial-scm.org/">
2339 2339 <img src="/static/hglogo.png" alt="mercurial" /></a>
2340 2340 </div>
2341 2341 <ul>
2342 2342 <li><a href="/shortlog">log</a></li>
2343 2343 <li><a href="/graph">graph</a></li>
2344 2344 <li><a href="/tags">tags</a></li>
2345 2345 <li><a href="/bookmarks">bookmarks</a></li>
2346 2346 <li><a href="/branches">branches</a></li>
2347 2347 </ul>
2348 2348 <ul>
2349 2349 <li class="active"><a href="/help">help</a></li>
2350 2350 </ul>
2351 2351 </div>
2352 2352
2353 2353 <div class="main">
2354 2354 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2355 2355 <h3>Help: remove</h3>
2356 2356
2357 2357 <form class="search" action="/log">
2358 2358
2359 2359 <p><input name="rev" id="search1" type="text" size="30" /></p>
2360 2360 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2361 2361 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2362 2362 </form>
2363 2363 <div id="doc">
2364 2364 <p>
2365 2365 hg remove [OPTION]... FILE...
2366 2366 </p>
2367 2367 <p>
2368 2368 aliases: rm
2369 2369 </p>
2370 2370 <p>
2371 2371 remove the specified files on the next commit
2372 2372 </p>
2373 2373 <p>
2374 2374 Schedule the indicated files for removal from the current branch.
2375 2375 </p>
2376 2376 <p>
2377 2377 This command schedules the files to be removed at the next commit.
2378 2378 To undo a remove before that, see &quot;hg revert&quot;. To undo added
2379 2379 files, see &quot;hg forget&quot;.
2380 2380 </p>
2381 2381 <p>
2382 2382 -A/--after can be used to remove only files that have already
2383 2383 been deleted, -f/--force can be used to force deletion, and -Af
2384 2384 can be used to remove files from the next revision without
2385 2385 deleting them from the working directory.
2386 2386 </p>
2387 2387 <p>
2388 2388 The following table details the behavior of remove for different
2389 2389 file states (columns) and option combinations (rows). The file
2390 2390 states are Added [A], Clean [C], Modified [M] and Missing [!]
2391 2391 (as reported by &quot;hg status&quot;). The actions are Warn, Remove
2392 2392 (from branch) and Delete (from disk):
2393 2393 </p>
2394 2394 <table>
2395 2395 <tr><td>opt/state</td>
2396 2396 <td>A</td>
2397 2397 <td>C</td>
2398 2398 <td>M</td>
2399 2399 <td>!</td></tr>
2400 2400 <tr><td>none</td>
2401 2401 <td>W</td>
2402 2402 <td>RD</td>
2403 2403 <td>W</td>
2404 2404 <td>R</td></tr>
2405 2405 <tr><td>-f</td>
2406 2406 <td>R</td>
2407 2407 <td>RD</td>
2408 2408 <td>RD</td>
2409 2409 <td>R</td></tr>
2410 2410 <tr><td>-A</td>
2411 2411 <td>W</td>
2412 2412 <td>W</td>
2413 2413 <td>W</td>
2414 2414 <td>R</td></tr>
2415 2415 <tr><td>-Af</td>
2416 2416 <td>R</td>
2417 2417 <td>R</td>
2418 2418 <td>R</td>
2419 2419 <td>R</td></tr>
2420 2420 </table>
2421 2421 <p>
2422 2422 Note that remove never deletes files in Added [A] state from the
2423 2423 working directory, not even if option --force is specified.
2424 2424 </p>
2425 2425 <p>
2426 2426 Returns 0 on success, 1 if any warnings encountered.
2427 2427 </p>
2428 2428 <p>
2429 2429 options ([+] can be repeated):
2430 2430 </p>
2431 2431 <table>
2432 2432 <tr><td>-A</td>
2433 2433 <td>--after</td>
2434 2434 <td>record delete for missing files</td></tr>
2435 2435 <tr><td>-f</td>
2436 2436 <td>--force</td>
2437 2437 <td>remove (and delete) file even if added or modified</td></tr>
2438 2438 <tr><td>-S</td>
2439 2439 <td>--subrepos</td>
2440 2440 <td>recurse into subrepositories</td></tr>
2441 2441 <tr><td>-I</td>
2442 2442 <td>--include PATTERN [+]</td>
2443 2443 <td>include names matching the given patterns</td></tr>
2444 2444 <tr><td>-X</td>
2445 2445 <td>--exclude PATTERN [+]</td>
2446 2446 <td>exclude names matching the given patterns</td></tr>
2447 2447 </table>
2448 2448 <p>
2449 2449 global options ([+] can be repeated):
2450 2450 </p>
2451 2451 <table>
2452 2452 <tr><td>-R</td>
2453 2453 <td>--repository REPO</td>
2454 2454 <td>repository root directory or name of overlay bundle file</td></tr>
2455 2455 <tr><td></td>
2456 2456 <td>--cwd DIR</td>
2457 2457 <td>change working directory</td></tr>
2458 2458 <tr><td>-y</td>
2459 2459 <td>--noninteractive</td>
2460 2460 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2461 2461 <tr><td>-q</td>
2462 2462 <td>--quiet</td>
2463 2463 <td>suppress output</td></tr>
2464 2464 <tr><td>-v</td>
2465 2465 <td>--verbose</td>
2466 2466 <td>enable additional output</td></tr>
2467 2467 <tr><td></td>
2468 2468 <td>--config CONFIG [+]</td>
2469 2469 <td>set/override config option (use 'section.name=value')</td></tr>
2470 2470 <tr><td></td>
2471 2471 <td>--debug</td>
2472 2472 <td>enable debugging output</td></tr>
2473 2473 <tr><td></td>
2474 2474 <td>--debugger</td>
2475 2475 <td>start debugger</td></tr>
2476 2476 <tr><td></td>
2477 2477 <td>--encoding ENCODE</td>
2478 2478 <td>set the charset encoding (default: ascii)</td></tr>
2479 2479 <tr><td></td>
2480 2480 <td>--encodingmode MODE</td>
2481 2481 <td>set the charset encoding mode (default: strict)</td></tr>
2482 2482 <tr><td></td>
2483 2483 <td>--traceback</td>
2484 2484 <td>always print a traceback on exception</td></tr>
2485 2485 <tr><td></td>
2486 2486 <td>--time</td>
2487 2487 <td>time how long the command takes</td></tr>
2488 2488 <tr><td></td>
2489 2489 <td>--profile</td>
2490 2490 <td>print command execution profile</td></tr>
2491 2491 <tr><td></td>
2492 2492 <td>--version</td>
2493 2493 <td>output version information and exit</td></tr>
2494 2494 <tr><td>-h</td>
2495 2495 <td>--help</td>
2496 2496 <td>display help and exit</td></tr>
2497 2497 <tr><td></td>
2498 2498 <td>--hidden</td>
2499 2499 <td>consider hidden changesets</td></tr>
2500 2500 </table>
2501 2501
2502 2502 </div>
2503 2503 </div>
2504 2504 </div>
2505 2505
2506 2506 <script type="text/javascript">process_dates()</script>
2507 2507
2508 2508
2509 2509 </body>
2510 2510 </html>
2511 2511
2512 2512
2513 2513 $ get-with-headers.py 127.0.0.1:$HGPORT "help/revisions"
2514 2514 200 Script output follows
2515 2515
2516 2516 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2517 2517 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2518 2518 <head>
2519 2519 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2520 2520 <meta name="robots" content="index, nofollow" />
2521 2521 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2522 2522 <script type="text/javascript" src="/static/mercurial.js"></script>
2523 2523
2524 2524 <title>Help: revisions</title>
2525 2525 </head>
2526 2526 <body>
2527 2527
2528 2528 <div class="container">
2529 2529 <div class="menu">
2530 2530 <div class="logo">
2531 2531 <a href="https://mercurial-scm.org/">
2532 2532 <img src="/static/hglogo.png" alt="mercurial" /></a>
2533 2533 </div>
2534 2534 <ul>
2535 2535 <li><a href="/shortlog">log</a></li>
2536 2536 <li><a href="/graph">graph</a></li>
2537 2537 <li><a href="/tags">tags</a></li>
2538 2538 <li><a href="/bookmarks">bookmarks</a></li>
2539 2539 <li><a href="/branches">branches</a></li>
2540 2540 </ul>
2541 2541 <ul>
2542 2542 <li class="active"><a href="/help">help</a></li>
2543 2543 </ul>
2544 2544 </div>
2545 2545
2546 2546 <div class="main">
2547 2547 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2548 2548 <h3>Help: revisions</h3>
2549 2549
2550 2550 <form class="search" action="/log">
2551 2551
2552 2552 <p><input name="rev" id="search1" type="text" size="30" /></p>
2553 2553 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2554 2554 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2555 2555 </form>
2556 2556 <div id="doc">
2557 2557 <h1>Specifying Single Revisions</h1>
2558 2558 <p>
2559 2559 Mercurial supports several ways to specify individual revisions.
2560 2560 </p>
2561 2561 <p>
2562 2562 A plain integer is treated as a revision number. Negative integers are
2563 2563 treated as sequential offsets from the tip, with -1 denoting the tip,
2564 2564 -2 denoting the revision prior to the tip, and so forth.
2565 2565 </p>
2566 2566 <p>
2567 2567 A 40-digit hexadecimal string is treated as a unique revision
2568 2568 identifier.
2569 2569 </p>
2570 2570 <p>
2571 2571 A hexadecimal string less than 40 characters long is treated as a
2572 2572 unique revision identifier and is referred to as a short-form
2573 2573 identifier. A short-form identifier is only valid if it is the prefix
2574 2574 of exactly one full-length identifier.
2575 2575 </p>
2576 2576 <p>
2577 2577 Any other string is treated as a bookmark, tag, or branch name. A
2578 2578 bookmark is a movable pointer to a revision. A tag is a permanent name
2579 2579 associated with a revision. A branch name denotes the tipmost open branch head
2580 2580 of that branch - or if they are all closed, the tipmost closed head of the
2581 2581 branch. Bookmark, tag, and branch names must not contain the &quot;:&quot; character.
2582 2582 </p>
2583 2583 <p>
2584 2584 The reserved name &quot;tip&quot; always identifies the most recent revision.
2585 2585 </p>
2586 2586 <p>
2587 2587 The reserved name &quot;null&quot; indicates the null revision. This is the
2588 2588 revision of an empty repository, and the parent of revision 0.
2589 2589 </p>
2590 2590 <p>
2591 2591 The reserved name &quot;.&quot; indicates the working directory parent. If no
2592 2592 working directory is checked out, it is equivalent to null. If an
2593 2593 uncommitted merge is in progress, &quot;.&quot; is the revision of the first
2594 2594 parent.
2595 2595 </p>
2596 2596
2597 2597 </div>
2598 2598 </div>
2599 2599 </div>
2600 2600
2601 2601 <script type="text/javascript">process_dates()</script>
2602 2602
2603 2603
2604 2604 </body>
2605 2605 </html>
2606 2606
2607 2607
2608 2608 $ killdaemons.py
2609 2609
2610 2610 #endif
General Comments 0
You need to be logged in to leave comments. Login now