Debug_init_cmds environment variables

wearyhacker · March 30, 2023, 8:24am

The documentation for debug_init_cmds shows the following example.

[env:debug]
platform = …
board = …
debug_init_cmds =
target extended-remote $DEBUG_PORT
$INIT_BREAK
monitor reset halt
$LOAD_CMDS
monitor init
monitor reset halt

Does anyone know where these upper case environment variables are documented? Are there any others?

maxgerhardt · March 30, 2023, 9:04am

$DEBUG_PORT is the value of debug_port in the platformio.ini (or an automatically evaluated one).
$INIT_BREAK is debug_init_break.
$LOAD_CMDS are the GDB load commands decided per debug_load_cmds — PlatformIO latest documentation and debug_load_mode — PlatformIO latest documentation

All of that can be looked up in the PlatformIO core source code too

Plus some can be overriden by the development platforms.

github.com

platformio/platform-espressif32/blob/4b44a501c9229053eba72987d77c9c3d60cbbc60/platform.py#L233-L246


      
          "init_break": "thb app_main",
          "init_cmds": [
              "define pio_reset_halt_target",
              "   monitor reset halt",
              "   flushregs",
              "end",
              "define pio_reset_run_target",
              "   monitor reset",
              "end",
              "target extended-remote $DEBUG_PORT",
              "$LOAD_CMDS",
              "pio_reset_halt_target",
              "$INIT_BREAK",
          ],

wearyhacker · March 30, 2023, 5:03pm

Thanks for your reply Max. The point I was making was that it would be nice if the documentation for the commands themselves mentioned the name of the the environment variable they cause to be created.

Roger

maxgerhardt · March 30, 2023, 5:48pm

Please file an issue in Issues · platformio/platformio-docs · GitHub to get that tracked.