Update User Guide documentation for PlatformIO 2.0 // Issue #158

docs/platforms/creating_platform.rst

@@ -294,9 +294,9 @@ Installation
 1. Create ``platforms`` directory in :ref:`projectconf_pio_home_dir` if it
    doesn't exists.
 2. Copy ``test.py`` and ``test-builder.py`` files to ``platforms`` directory.
-3. Search available platforms via :ref:`cmd_search` command. You should see
+3. Search available platforms via :ref:`cmd_platforms_search` command. You should see
    ``test`` platform.
-4. Install ``test`` platform via :ref:`cmd_install` command.
+4. Install ``test`` platform via :ref:`cmd_platforms_install` command.
 
 Now, you can use ``test`` for the :ref:`projectconf_env_platform` option in
 :ref:`projectconf`.
@@ -413,5 +413,5 @@ and copy there two files:
 
     Default([target_firm, target_size])
 
-Now, we should see ``ststm32gdb`` platform using :ref:`cmd_search` command output
+Now, we should see ``ststm32gdb`` platform using :ref:`cmd_platforms_search` command output
-and can install it via :ref:`platformio platforms install ststm32gdb <cmd_install>` command.
+and can install it via :ref:`platformio platforms install ststm32gdb <cmd_platforms_install>` command.

docs/userguide/cmd_update.rst

@@ -16,7 +16,8 @@ Usage
 Description
 -----------
 
-Check or update installed :ref:`Platforms <platforms>`
+Check or update installed :ref:`Platforms <platforms>` and
+:ref:`Libraries <librarymanager>`
 
 
 Examples

docs/userguide/index.rst

@@ -16,14 +16,10 @@ To print all available commands and options use:
 
     cmd_boards
     cmd_init
-    cmd_install
     platformio lib <lib/index>
-    cmd_list
+    platformio platforms <platforms/index>
     cmd_run
-    cmd_search
     cmd_serialports
     cmd_settings
-    cmd_show
-    cmd_uninstall
     cmd_update
     cmd_upgrade

docs/userguide/platforms/cmd_install.rst

@@ -1,7 +1,7 @@
-.. _cmd_install:
+.. _cmd_platforms_install:
 
-platformio install
+platformio platforms install
-==================
+============================
 
 .. contents::
 
@@ -10,7 +10,7 @@ Usage
 
 .. code-block:: bash
 
-    platformio install [OPTIONS] [PLATFORMS]
+    platformio platforms install [OPTIONS] [PLATFORMS]
 
 
 Description
@@ -50,7 +50,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio install timsp430
+    $ platformio platforms install timsp430
     Installing toolchain-timsp430 package:
     Downloading  [####################################]  100%
     Unpacking  [####################################]  100%
@@ -68,7 +68,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio install timsp430 --skip-default-package --with-package=uploader
+    $ platformio platforms install timsp430 --skip-default-package --with-package=uploader
     Installing tool-mspdebug package:
     Downloading  [####################################]  100%
     Unpacking  [####################################]  100%

docs/userguide/platforms/cmd_list.rst

@@ -1,7 +1,7 @@
-.. _cmd_list:
+.. _cmd_platforms_list:
 
-platformio list
+platformio platforms list
-===============
+=========================
 
 .. contents::
 
@@ -10,7 +10,7 @@ Usage
 
 .. code-block:: bash
 
-    platformio list [OPTIONS]
+    platformio platforms list [OPTIONS]
 
 
 Description
@@ -31,7 +31,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio list
+    $ platformio platforms list
     atmelavr    with packages: toolchain-atmelavr, tool-avrdude, framework-arduinoavr, tool-micronucleus
     atmelsam    with packages: framework-arduinosam, ldscripts, toolchain-gccarmnoneeabi, tool-bossac
     freescalekinetis with packages: framework-mbed, toolchain-gccarmnoneeabi

docs/userguide/platforms/cmd_search.rst

@@ -1,7 +1,7 @@
-.. _cmd_search:
+.. _cmd_platforms_search:
 
-platformio search
+platformio platforms search
-=================
+===========================
 
 .. contents::
 
@@ -10,7 +10,7 @@ Usage
 
 .. code-block:: bash
 
-    platformio search QUERY [OPTIONS]
+    platformio platforms search QUERY [OPTIONS]
 
 
 Description
@@ -34,7 +34,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio search
+    $ platformio platforms search
     atmelavr (available packages: ldscripts, toolchain-gccarmnoneeabi, tool-lm4flash, framework-opencm3, framework-energiativa)
     --------
     Atmel AVR 8- and 32-bit MCUs deliver a unique combination of performance...
@@ -75,7 +75,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio search ti
+    $ platformio platforms search ti
     timsp430 (available packages: ldscripts, toolchain-gccarmnoneeabi, tool-lm4flash, framework-opencm3, framework-energiativa)
     --------
     MSP430 microcontrollers (MCUs) from Texas Instruments (TI) are ...
@@ -88,7 +88,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio search mbed
+    $ platformio platforms search mbed
     freescalekinetis (available packages: ldscripts, toolchain-gccarmnoneeabi, tool-lm4flash, framework-opencm3, framework-energiativa)
     ----------------
     Freescale Kinetis Microcontrollers is family of multiple hardware- and ...

docs/userguide/platforms/cmd_show.rst

@@ -1,7 +1,7 @@
-.. _cmd_show:
+.. _cmd_platforms_show:
 
-platformio show
+platformio platforms show
-===============
+=========================
 
 .. contents::
 
@@ -10,7 +10,7 @@ Usage
 
 .. code-block:: bash
 
-    platformio show PLATFORM
+    platformio platforms show PLATFORM
 
 
 Description
@@ -24,7 +24,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio show atmelavr
+    $ platformio platforms show atmelavr
     atmelavr    - An embedded platform for Atmel AVR microcontrollers (with Arduino Framework)
     ----------
     Package: toolchain-atmelavr

docs/userguide/platforms/cmd_uninstall.rst

@@ -1,7 +1,7 @@
-.. _cmd_uninstall:
+.. _cmd_platforms_uninstall:
 
-platformio uninstall
+platformio platforms uninstall
-====================
+==============================
 
 .. contents::
 
@@ -10,7 +10,7 @@ Usage
 
 .. code-block:: bash
 
-    platformio uninstall PLATFORM
+    platformio platforms uninstall PLATFORM
 
 
 Description
@@ -24,7 +24,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio uninstall timsp430
+    $ platformio platforms uninstall timsp430
     Uninstalling toolchain-timsp430 package:        [OK]
     Uninstalling tool-mspdebug package:             [OK]
     Uninstalling framework-energiamsp430 package:   [OK]

docs/userguide/platforms/cmd_update.rst

@@ -0,0 +1,99 @@
+.. _cmd_platforms_update:
+
+platformio platforms update
+===========================
+
+.. contents::
+
+Usage
+-----
+
+.. code-block:: bash
+
+    platformio platforms update
+
+
+Description
+-----------
+
+Check or update installed :ref:`Platforms <platforms>`
+
+
+Examples
+--------
+
+.. code-block:: bash
+
+    $ platformio platforms update
+
+    Platform atmelavr
+    --------
+    Updating toolchain-atmelavr package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating tool-avrdude package:
+    Versions: Current=2, Latest=2 	 [Up-to-date]
+    Updating framework-arduinoavr package:
+    Versions: Current=12, Latest=12 	 [Up-to-date]
+    Updating tool-micronucleus package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+
+    Platform atmelsam
+    --------
+    Updating framework-arduinosam package:
+    Versions: Current=3, Latest=3 	 [Up-to-date]
+    Updating ldscripts package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating toolchain-gccarmnoneeabi package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating tool-bossac package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+
+    Platform stm32
+    --------
+    Updating toolchain-gccarmnoneeabi package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating tool-stlink package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating framework-spl package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating framework-cmsis package:
+    Versions: Current=2, Latest=2 	 [Up-to-date]
+    Updating framework-opencm3 package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating ldscripts package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+
+    Platform teensy
+    --------
+    Updating toolchain-atmelavr package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating ldscripts package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating framework-arduinoteensy package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating toolchain-gccarmnoneeabi package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating tool-teensy package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+
+    Platform timsp430
+    --------
+    Updating toolchain-timsp430 package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating tool-mspdebug package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating framework-energiamsp430 package:
+    Versions: Current=2, Latest=2 	 [Up-to-date]
+
+    Platform titiva
+    --------
+    Updating ldscripts package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating toolchain-gccarmnoneeabi package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating tool-lm4flash package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating framework-opencm3 package:
+    Versions: Current=1, Latest=1 	 [Up-to-date]
+    Updating framework-energiativa package:
+    Versions: Current=4, Latest=4 	 [Up-to-date]

docs/userguide/platforms/index.rst

@@ -0,0 +1,22 @@
+.. _userguide_platforms:
+
+Platforms Manager
+=================
+
+To print all available commands and options use:
+
+.. code-block:: bash
+
+    $ platformio platforms --help
+    $ platformio platforms COMMAND --help
+
+
+.. toctree::
+    :maxdepth: 2
+
+    cmd_install
+    cmd_list
+    cmd_search
+    cmd_show
+    cmd_uninstall
+    cmd_update