From 8f76edcc04224a22accf6f30b41e4ed4e6aad2b5 Mon Sep 17 00:00:00 2001 From: Anurag Kumar Singh Date: Tue, 8 Sep 2026 12:28:04 +0530 Subject: [PATCH] Updated the neovim docs and fixed broken *:PioTermList tag --- doc/platformio.txt | 47 ++++++++++++++++++++++++++++++++++++++-------- doc/tags | 6 ++++++ 2 files changed, 45 insertions(+), 8 deletions(-) diff --git a/doc/platformio.txt b/doc/platformio.txt index 278d369..82a74de 100644 --- a/doc/platformio.txt +++ b/doc/platformio.txt @@ -21,12 +21,14 @@ USAGE *platformio-usage* *:Piorun* :Piorun [arg] This command builds and uploads the code. Optional - arguments: build, upload, clean. If no argument is - provided, it defaults to build and upload. + arguments: build, upload, uploadfs, clean. If no + argument is provided, it defaults to build and + upload. Examples: `:Piorun` `:Piorun build` `:Piorun upload` + `:Piorun uploadfs` `:Piorun clean` *:Piocmd* @@ -51,12 +53,14 @@ USAGE *platformio-usage* `:Piolib keyboard` *:Piomon* -:Piomon [baud_rate] Open a serial monitor. Specify a baud rate as an - optional argument. If not provided, it uses the default - baud rate (9600) or the one specified in platformio.ini. +:Piomon [baud] [port] Open a serial monitor. Specify a baud rate and, + optionally, a port. If not provided, it uses the + default baud rate (9600) or the one specified in + platformio.ini, and auto-detects the port. Examples: `:Piomon` `:Piomon 115200` + `:Piomon 115200 /dev/ttyUSB0` *:Piolsserial* :Piolsserial List out all the serial devices connected with their @@ -73,9 +77,11 @@ USAGE *platformio-usage* *:Piodebug* :Piodebug Starts the default PlatformIO debugger with gdb - *:PioTermList -:PioTermList You can see a list of pio terminals using :PioTermList - command in normal mode. It is mapped to pl + *:PioTermList* +:PioTermList Lists open PIO terminals (CLI and monitor) and lets + you pick one to switch to. Not bound to any key by + default; bind it yourself or add it to + `menu_bindings` (see |platformio-configuration|). ============================================================================== @@ -84,6 +90,11 @@ CONFIGURATION *platformio-configuration* The plugin exposes a few configuration options that can be set in your `setup()` call. +lsp *platformio-lsp* + Which language server the generated project config should target. + Allowed values: `ccls` (default) or `clangd`. See |platformio-clangd_source| + below when using `clangd`. + clangd_source *platformio-clangd_source* PlatformIO CLI officially only supports generating LSP configuration for CCLS, since it creates a `.ccls` file when you use the `--ide=vim` flag. @@ -142,4 +153,24 @@ picker_backend *platformio-picker* `vim.ui.select` or any plugin that overrides it (for example, telescope-ui-select, dressing.nvim, snacks picker adapters, etc.). +menu_key *platformio-menu_key* + Key prefix that opens the PlatformIO which-key menu (requires + folke/which-key.nvim). Unset (`nil`) by default, which disables the menu + entirely. Example: `menu_key = '\\'`. + +menu_name *platformio-menu_name* + Display name for the top-level menu group shown by which-key. + Default: `'PlatformIO'`. + +menu_bindings *platformio-menu_bindings* + Table describing the which-key menu tree: nested `menu` nodes (with + `desc`, `shortcut`, `items`) and `item` nodes (with `desc`, `shortcut`, + `command`). See the README for the full default table, which you can + copy and edit. Note that a partial table does not selectively override + individual default entries — provide the whole tree if you customize it. + +debug *platformio-debug* + When `true`, echoes extra diagnostic info (terminal name, window/buffer + ids, job id) each time a PIO terminal opens. Default: `false`. + vim:tw=78:sw=4:ts=8:ft=help:norl:noet: diff --git a/doc/tags b/doc/tags index fac6b44..e689bfa 100644 --- a/doc/tags +++ b/doc/tags @@ -1,4 +1,5 @@ :PioLSP platformio.txt /*:PioLSP* +:PioTermList platformio.txt /*:PioTermList* :Piocmd platformio.txt /*:Piocmd* :Piodebug platformio.txt /*:Piodebug* :Pioinit platformio.txt /*:Pioinit* @@ -9,6 +10,11 @@ PlatformIO platformio.txt /*PlatformIO* platformio-clangd_source platformio.txt /*platformio-clangd_source* platformio-configuration platformio.txt /*platformio-configuration* +platformio-debug platformio.txt /*platformio-debug* +platformio-lsp platformio.txt /*platformio-lsp* +platformio-menu_bindings platformio.txt /*platformio-menu_bindings* +platformio-menu_key platformio.txt /*platformio-menu_key* +platformio-menu_name platformio.txt /*platformio-menu_name* platformio-picker platformio.txt /*platformio-picker* platformio-usage platformio.txt /*platformio-usage* platformio.lua platformio.txt /*platformio.lua*