summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/getting_started/using-bcfg2-info.txt15
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/getting_started/using-bcfg2-info.txt b/doc/getting_started/using-bcfg2-info.txt
index dc5e3ea10..1fab0ea07 100644
--- a/doc/getting_started/using-bcfg2-info.txt
+++ b/doc/getting_started/using-bcfg2-info.txt
@@ -117,13 +117,16 @@ in *bcfg2-info* to aid in the process.
performance problems in configuration generation.
**debug**
- The debug command exits the *bcfg2-info* interpreter loop and
- drops to a python interpreter prompt. The Bcfg2 server core is
- available in this namespace as "self". Full documentation for
- the server core is out of scope for this document. This
- capability is most useful to call into plugin methods, often with
- setup calls or the enabling of diagnostics.
+ The debug command exits the *bcfg2-info* interpreter loop and drops
+ to a python interpreter prompt. The Bcfg2 server core is available
+ in this namespace as "self". Full documentation for the server core
+ is out of scope for this document. This capability is most useful
+ to call into plugin methods, often with setup calls or the enabling
+ of diagnostics.
It is possible to return to the *bcfg2-info* command loop by
exiting the python interpreter with ^D.
+ There is built-in support for IPython in *bcfg2-info*. If IPython
+ is installed, dropping into debug mode in *bcfg2-info* will use
+ the IPython interpreter by default.