From 6b9e894deee06ba9f6e48f1a319004c8d834d02b Mon Sep 17 00:00:00 2001 From: marchersimon <50295997+marchersimon@users.noreply.github.com> Date: Sun, 18 Apr 2021 16:09:06 +0200 Subject: [PATCH] pio-debug, piodebuggdb: add page (#5780) * pio-debug, piodebuggdb: add page * Apply suggestion from code review Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com> * Apply suggestion from code review Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com> Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com> --- pages/common/pio-debug.md | 24 ++++++++++++++++++++++++ pages/common/piodebuggdb.md | 7 +++++++ 2 files changed, 31 insertions(+) create mode 100644 pages/common/pio-debug.md create mode 100644 pages/common/piodebuggdb.md diff --git a/pages/common/pio-debug.md b/pages/common/pio-debug.md new file mode 100644 index 0000000000..745037df60 --- /dev/null +++ b/pages/common/pio-debug.md @@ -0,0 +1,24 @@ +# pio debug + +> Debug PlatformIO projects. +> More information: . + +- Debug the PlatformIO project in the current directory: + +`pio debug` + +- Debug a specific PlatformIO project: + +`pio debug --project-dir {{path/to/platformio_project}}` + +- Debug a specific environment: + +`pio debug --environment {{environment}}` + +- Debug a PlatformIO project using a specific configuration file: + +`pio debug --project-conf {{path/to/platformio.ini}}` + +- Debug a PlatformIO project using the `gdb` debugger: + +`pio debug --interface={{gdb}} {{gdb_options}}` diff --git a/pages/common/piodebuggdb.md b/pages/common/piodebuggdb.md new file mode 100644 index 0000000000..7735048012 --- /dev/null +++ b/pages/common/piodebuggdb.md @@ -0,0 +1,7 @@ +# piodebuggdb + +> This command is an alias of `pio debug --interface=gdb`. + +- View documentation for the original command: + +`tldr pio debug`