Mercurial Repositories > eric / annotate

docs/README-passive-debugging.md@c48c615c04a3 (annotated)

docs/README-passive-debugging.md

Sat, 26 Apr 2025 12:34:32 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 26 Apr 2025 12:34:32 +0200
branch
eric7
changeset 11240
c48c615c04a3
parent 10107
da76865312f1
permissions
-rw-r--r--

MicroPython
- Added a configuration option to disable the support for the no longer produced Pimoroni Pico Wireless Pack.

10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
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
10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
3 eric7 provides the capability to debug programs using the passive
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
4 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
5 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
6 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
7 to ensure, that the paths to the script to be debugged are identical
10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
8 on both machines or you configured the path translation accordingly.
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
9
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 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
11 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
12 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
13 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
14 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
15
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 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
17 Use DebugClient.py to debug normal and multi threaded scripts. The debugger
10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
18 knows about the following command line switches.
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
19
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
20 -h <hostname>
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
21 : This specifies the hostname of the machine running the IDE.
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
22
10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
23 -p <portnumber>
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
24 : This specifies the portnumber of the IDE.
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
25
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
26 -w <directory>
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
27 : This specifies the working directory to be used for the script
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
28 to be debugged.
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
29
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
30 -t
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
31 : This enables tracing into the Python library.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32
10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
33 -n
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
34 : This disables the redirection of stdin, stdout and stderr.
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
35
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
36 -e
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
37 : This disables reporting of exceptions.
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
38
10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
39 --fork-child
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
40 : This tells the debugger to follow the child when forking.
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
41
10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
42 --fork-parent
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
43 : This tells the debugger to follow the parent when forking
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
44
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
45 The command line parameters have to be followed by `--` (double dash),
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
46 the script to be debugged and its command line parameters.
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
47
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
48 Example:
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
49
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
50 python DebugClient -h somehost -- myscript.py param1
10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
51
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 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
53 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
54 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
55 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
56
10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
57 __Note__: The port and hostname may alternatively be set through the environment
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
58 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
59
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
60 Please send bug reports, feature requests or contributions to eric bugs address
10107
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
61 [eric-bugs@die-offenbachs.de](mailto:eric-bugs@die-offenbachs.de) or using the
da76865312f1 Changed the included documentation to Markdown format and corrected some of the texts.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
62 built-in bug reporting dialog.

Mercurial Repository: eric

eric ide

mercurial