docs/README-passive-debugging.rst

Fri, 19 Apr 2019 17:48:40 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 19 Apr 2019 17:48:40 +0200
changeset 6956
dfd3b53be436
parent 6942
2602857055c5
child 8477
81e25fe19818
permissions
-rw-r--r--

install: change minimum version of QScintilla to 2.9.0.

0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 README for passive mode debugging
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
2 =================================
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
3
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
4 eric6 provides the capability to debug programms using the passive
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
5 mode. In this mode it is possible to start the debugger separate from
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
6 the IDE. This may be done on a different computer as well. If the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
7 debugger is started on a remote machine, it is your responsibility
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
8 to ensure, that the paths to the script to be debugged are identical
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
9 on both machines.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
10
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
11 In order to enable passive mode debugging in the IDE choose the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
12 debugger tab of the preferences dialog and enable the passive mode
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
13 debugging checkbox. You may change the default port as well. Please
5422
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
14 be aware that you have to tell the debugger the port, if it is different
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
15 to the default value of 42424.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
16
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
17 On the remote computer you have to have the debugger scripts installed.
5422
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
18 Use DebugClient.py to debug normal and multi threaded scripts. The debugger
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
19 knows about the following commandline switches.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
20
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
21 ::
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
23 -h <hostname>
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
24 This specifies the hostname of the machine running the IDE.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
25 -p <portnumber>
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
26 This specifies the portnumber of the IDE.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
27 -w <directory>
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
28 This specifies the working directory to be used for the script
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 to be debugged.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
30 -t
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
31 This enables tracing into the Python library.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
32 -n
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
33 This disables the redirection of stdin, stdout and stderr.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
34 -e
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
35 This disables reporting of exceptions.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
36 --fork-child
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
37 This tells the debugger to follow the child when forking.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
38 --fork-parent
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
39 This tells the debugger to follow the parent when forking
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
40
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
41 The commandline parameters have to be followed by ``'--'`` (double dash),
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
42 the script to be debugged and its commandline parameters.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
43
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
44 Example::
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
45
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
46 python DebugClient -h somehost -- myscript.py param1
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
48 After the execution of the debugger command, it connects to the IDE and
5422
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
49 tells it the filename of the script being debugged. The IDE will try to
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
50 load it and the script will stop at the first line. After that you may set
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
51 breakpoints, step through your script and use all the debugging functions.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
52
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
53 Note: The port and hostname may alternatively be set through the environment
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
54 variables ERICPORT and ERICHOST.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
55
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
56 Please send bug reports, feature requests or contributions to eric bugs address
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3758
diff changeset
57 <eric-bugs@die-offenbachs.de> or using the buildt in bug reporting dialog.

eric ide

mercurial