8000 Debug probe: installation instruction improvements · raspberrypi/documentation@2ba070c · GitHub
[go: up one dir, main page]
Skip to content

Commit 2ba070c

Browse files
P33MP33M
committed
Debug probe: installation instruction improvements
Users should be steered to VSCode as that provides the fewest opportunities to get something wrong. Remove obsolete pico-setup-windows reference, along with broken references to parts of the Pico guide.
1 parent 34c51dd commit 2ba070c

File tree

1 file changed

+5
-59
lines changed

1 file changed

+5
-59
lines changed

‎documentation/asciidoc/microcontrollers/debug-probe/installing-tools.adoc

Lines changed: 5 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,12 @@
11
== Install tools
22

3-
To use the Debug Probe, install the following tools.
3+
To use the Debug Probe, OpenOCD and the GNU Project Debugger (GDB) are required. An Integrated Development Environment (IDE) may also be useful.
44

5-
=== Install OpenOCD
5+
On Raspberry Pi OS, most Linux variants, macOS, and Microsoft Windows, it is recommended to install our VS Code extension. This extension bundles OpenOCD, ARM toolchains, GDB, and register definitions for Pico-series microcontrollers.
66

7-
You need to install OpenOCD.
7+
See Chapter 3 of our https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting Started with Raspberry Pi Pico] guide.
88

9-
To install OpenOCD, run the following command in a terminal:
9+
Alternatively, tools can be manually installed by following Appendix C in the guide.
1010

11-
[source,console]
12-
----
13-
$ sudo apt install openocd
14-
----
11+
NOTE: Manual installation of the tools on Windows is not recommended.
1512

16-
To run OpenOCD, use the `openocd` command in your terminal.
17-
18-
==== Install OpenOCD on macOS
19-
20-
First, install the https://brew.sh/[Homebrew] package manager:
21-
22-
[source,console]
23-
----
24-
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
25-
----
26-
27-
To install OpenOCD on macOS, run the following commands:
28-
29-
[source,console]
30-
----
31-
$ brew install openocd
32-
----
33-
34-
To run OpenOCD, use the `openocd` command in your terminal.
35-
36-
=== Install GDB
37-
38-
We also need to install the GNU debugger (GDB).
39-
40-
==== Linux
41-
42-
Install `gdb-multiarch`:
43-
44-
[source,console]
45-
----
46-
$ sudo apt install gdb-multiarch
47-
----
48-
49-
==== macOS
50-
51-
Run the following command to install `gdb`:
52-
53-
[source,console]
54-
----
55-
$ brew install arm-none-eabi-gdb
56-
----
57-
58-
You can safely ignore the request for "special privileges" messages on installation.
59-
60-
==== MS Windows
61-
62-
GDB is available as part of our https://github.com/raspberrypi/pico-setup-windows/releases/latest[Pico setup for Windows installer]. It is also included in the https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads[Arm GNU Toolchain Downloads].
63-
64-
Alternatively information about manual installation can be found in Chapter 9 and Appendix A of our https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf[Getting Started with Raspberry Pi Pico] book.
65-
66-
NOTE: Manual installation of GDB on Windows is not recommended.

0 commit comments

Comments
 (0)
0