From a1bad33d9dec989e355fa6337bbcee8f163191d6 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Thu, 7 May 2015 16:44:56 +0100 Subject: [PATCH] Add "program" to command options --- docs/userguide/cmd_ci.rst | 2 +- docs/userguide/cmd_init.rst | 5 ++++- docs/userguide/cmd_run.rst | 2 ++ docs/userguide/cmd_serialports.rst | 4 ++++ docs/userguide/index.rst | 2 ++ docs/userguide/lib/cmd_install.rst | 2 ++ docs/userguide/lib/cmd_list.rst | 2 ++ docs/userguide/lib/cmd_search.rst | 2 ++ docs/userguide/platforms/cmd_install.rst | 2 ++ docs/userguide/platforms/cmd_list.rst | 2 ++ docs/userguide/platforms/cmd_search.rst | 2 ++ 11 files changed, 25 insertions(+), 2 deletions(-) diff --git a/docs/userguide/cmd_ci.rst b/docs/userguide/cmd_ci.rst index cb7e6642..a9b7b153 100644 --- a/docs/userguide/cmd_ci.rst +++ b/docs/userguide/cmd_ci.rst @@ -47,7 +47,7 @@ Options .. program:: platformio ci .. option:: - -l, --lib + --lib, -l Source code which will be copied to ``%build_dir%/lib`` directly. diff --git a/docs/userguide/cmd_init.rst b/docs/userguide/cmd_init.rst index fa0d8e43..d7c5170a 100644 --- a/docs/userguide/cmd_init.rst +++ b/docs/userguide/cmd_init.rst @@ -29,6 +29,8 @@ This command will create: Options ------- +.. program:: platformio init + .. option:: --project-dir, -d @@ -50,7 +52,8 @@ The full list with pre-configured boards is available here :ref:`platforms`. .. option:: --disable-auto-uploading -If you initialise project with the specified ``--board``, then *PlatformIO* +If you initialise project with the specified +:option:`platformio init --board``, then *PlatformIO* will create environment with enabled firmware auto-uploading. This option allows you to disable firmware auto-uploading by default. diff --git a/docs/userguide/cmd_run.rst b/docs/userguide/cmd_run.rst index 9c170794..9daa9dda 100644 --- a/docs/userguide/cmd_run.rst +++ b/docs/userguide/cmd_run.rst @@ -22,6 +22,8 @@ Process environments which are defined in :ref:`projectconf` file Options ------- +.. program:: platformio run + .. option:: -e, --environment diff --git a/docs/userguide/cmd_serialports.rst b/docs/userguide/cmd_serialports.rst index 360877ec..53bae993 100644 --- a/docs/userguide/cmd_serialports.rst +++ b/docs/userguide/cmd_serialports.rst @@ -24,6 +24,8 @@ List available `Serial Ports `_ Options ~~~~~~~ +.. program:: platformio serialports list + .. option:: --json-output @@ -99,6 +101,8 @@ To control *monitor* please use these "hot keys": Options ~~~~~~~ +.. program:: platformio serialports monitor + .. option:: -p, --port diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index e849ed58..6c52a9e5 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -15,6 +15,8 @@ Usage Options ------- +.. program:: platformio + .. option:: --force, - f diff --git a/docs/userguide/lib/cmd_install.rst b/docs/userguide/lib/cmd_install.rst index 854401b7..bb4dd95f 100644 --- a/docs/userguide/lib/cmd_install.rst +++ b/docs/userguide/lib/cmd_install.rst @@ -22,6 +22,8 @@ Install new library by specified Options ------- +.. program:: platformio lib install + .. option:: -v, --version diff --git a/docs/userguide/lib/cmd_list.rst b/docs/userguide/lib/cmd_list.rst index 2551704b..07c68bc3 100644 --- a/docs/userguide/lib/cmd_list.rst +++ b/docs/userguide/lib/cmd_list.rst @@ -21,6 +21,8 @@ List installed libraries Options ~~~~~~~ +.. program:: platformio lib list + .. option:: --json-output diff --git a/docs/userguide/lib/cmd_search.rst b/docs/userguide/lib/cmd_search.rst index 84899256..41bd8199 100644 --- a/docs/userguide/lib/cmd_search.rst +++ b/docs/userguide/lib/cmd_search.rst @@ -61,6 +61,8 @@ For more detail information please go to Options ------- +.. program:: platformio lib search + .. option:: -a, --author diff --git a/docs/userguide/platforms/cmd_install.rst b/docs/userguide/platforms/cmd_install.rst index 6f7dc8a8..ced397f8 100644 --- a/docs/userguide/platforms/cmd_install.rst +++ b/docs/userguide/platforms/cmd_install.rst @@ -27,6 +27,8 @@ There are several predefined aliases for packages, such as: Options ------- +.. program:: platformio platforms install + .. option:: --with-package diff --git a/docs/userguide/platforms/cmd_list.rst b/docs/userguide/platforms/cmd_list.rst index 594defe6..90e5d9a5 100644 --- a/docs/userguide/platforms/cmd_list.rst +++ b/docs/userguide/platforms/cmd_list.rst @@ -21,6 +21,8 @@ List installed :ref:`Platforms ` Options ~~~~~~~ +.. program:: platformio platforms list + .. option:: --json-output diff --git a/docs/userguide/platforms/cmd_search.rst b/docs/userguide/platforms/cmd_search.rst index b77bed41..20d9e42e 100644 --- a/docs/userguide/platforms/cmd_search.rst +++ b/docs/userguide/platforms/cmd_search.rst @@ -21,6 +21,8 @@ Search for development :ref:`Platforms ` Options ~~~~~~~ +.. program:: platformio platforms search + .. option:: --json-output