Diff for "DebuggingFeatures"

Differences between revisions 4 and 10 (spanning 6 versions)

Mercurial has a bunch of features for debugging problems that are useful for developers to know about.

Global Options
`-v, --verbose`	show more verbose output
`--debug`	show extended debugging output
`--traceback`	show Python tracebacks that are otherwise hidden
`--profile`	generate performance profiling information
`--debugger`	drop into the built-in source-level debugger (more below)

Debug Commands
`debugcheckstate`	validate the correctness of the current dirstate
`debugconfig`	show combined config settings from all hgrc files
`debugdata`	dump the contents of an data file revision
`debugindex`	dump the contents of an index file
`debugindexdot`	dump an index DAG as a .dot file
`debugrename`	dump rename information
`debugstate`	show the contents of the current dirstate
`debugwalk`	show how files match on given patterns

To get a complete up-to-date list of all available debug commands use hg debugcomplete debug:

> hg debugcomplete debug
debugancestor
debugcheckstate
debugcomplete
debugconfig
debugdata
debugdate
debugfsinfo
debugindex
debugindexdot
debuginstall
debugrawcommit
debugrebuildstate
debugrename
debugsetparents
debugstate
debugwalk

Documentation for some debug commands is available through hg help:

> hg help debugstate
hg debugstate

show the contents of the current dirstate

use "hg -v help debugstate" to show global options

using the debugger

hg --debugger <command> will drop you at the debug prompt shortly before command execution. This will allow you to set breakpoints, singlestep code, inspect data structures, and run arbitrary bits of Python code. Help is available with '?'.

If you let Mercurial run (with 'cont'), the debugger will be reinvoked if an exception occurs. This is useful for diagnosing tracebacks in situ.

CategoryInternals

-  ⇤ ← Revision 4 as of 2008-03-11 09:04:36 → 
  Size: 1999
  Editor: abuehl
  Comment:
+   ← Revision 10 as of 2013-08-29 12:31:26 → ⇥
  Size: 2179
  Editor: AugieFackler
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 3:
-=== global options ===
+See also: DebuggingTests
 Line 5:
- -v, --verbose::
  show more verbose output
 --debug::
  show extended debugging output
 --traceback::
  show Python tracebacks that are otherwise hidden
 --profile::
  generate performance profiling information
 --debugger::
  drop into the built-in source-level debugger (more below)
+|||||| '''Global Options''' ||
|| {{{-v, --verbose}}} || show more verbose output ||
|| {{{--debug}}}       ||  show extended debugging output ||
|| {{{--traceback}}} || show Python tracebacks that are otherwise hidden ||
|| {{{--profile}}}  ||  generate performance profiling information ||
|| {{{--debugger}}} ||  drop into the built-in source-level debugger (more below) ||
-Line 16:
+Line 12:
-=== debug commands ===
+ .
-Line 18:
+Line 14:
- debugcheckstate::
      validate the correctness of the current dirstate
 debugconfig::
      show combined config settings from all hgrc files
 debugdata::
      dump the contents of an data file revision
 debugindex::
      dump the contents of an index file
 debugindexdot::
      dump an index DAG as a .dot file
 debugrename::
      dump rename information
 debugstate::
      show the contents of the current dirstate
 debugwalk::
      show how files match on given patterns
+|||||| '''Debug Commands''' ||
|| {{{ debugcheckstate }}} ||  validate the correctness of the current dirstate ||
|| {{{ debugconfig }}}   ||  show combined config settings from all hgrc files ||
|| {{{ debugdata }}}     ||  dump the contents of an data file revision ||
|| {{{ debugindex }}}    ||  dump the contents of an index file ||
|| {{{ debugindexdot }}} ||  dump an index DAG as a .dot file ||
|| {{{ debugrename }}}   ||  dump rename information ||
|| {{{ debugstate }}}    ||  show the contents of the current dirstate ||
|| {{{ debugwalk }}}     ||  show how files match on given patterns ||
-Line 74:
+Line 63:
-CategoryContributing
+CategoryInternals