From 424d5e71a835bae2afebb9b1c4bdc26f2ca059b0 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Fri, 2 Sep 2016 16:45:08 +0300 Subject: [PATCH] Minor improvements to docs --- docs/ci/appveyor.rst | 2 +- docs/ci/circleci.rst | 12 ++++++------ docs/ci/drone.rst | 2 +- docs/ci/shippable.rst | 2 +- docs/ci/travis.rst | 6 +++--- docs/ide/clion.rst | 2 +- docs/ide/codeblocks.rst | 2 +- docs/ide/eclipse.rst | 2 +- docs/ide/emacs.rst | 2 +- docs/ide/netbeans.rst | 2 +- docs/ide/qtcreator.rst | 2 +- docs/ide/sublimetext.rst | 2 +- docs/ide/visualstudio.rst | 2 +- docs/userguide/cmd_ci.rst | 4 ++-- 14 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/ci/appveyor.rst b/docs/ci/appveyor.rst index 2341c0e3..5a018b29 100644 --- a/docs/ci/appveyor.rst +++ b/docs/ci/appveyor.rst @@ -56,7 +56,7 @@ Put ``appveyor.yml`` to the root directory of the GitHub repository. - cmd: pip install -U platformio test_script: - - cmd: platformio ci --board=ID_1 --board=ID_2 --board=ID_N + - cmd: platformio ci --board= --board= --board= For more details as for PlatformIO build process please look into :ref:`cmd_ci` diff --git a/docs/ci/circleci.rst b/docs/ci/circleci.rst index ebc9c7ac..da331230 100644 --- a/docs/ci/circleci.rst +++ b/docs/ci/circleci.rst @@ -49,9 +49,9 @@ guide first. test: override: - - platformio ci path/to/test/file.c --board=ID_1 --board=ID_2 --board=ID_N - - platformio ci examples/file.ino --board=ID_1 --board=ID_2 --board=ID_N - - platformio ci path/to/test/directory --board=ID_1 --board=ID_2 --board=ID_N + - platformio ci path/to/test/file.c --board= --board= --board= + - platformio ci examples/file.ino --board= --board= --board= + - platformio ci path/to/test/directory --board= --board= --board= For more details as for PlatformIO build process please look into :ref:`cmd_ci`. @@ -65,7 +65,7 @@ it), please use ``--lib="."`` option for :ref:`cmd_ci` command .. code-block:: yaml script: - - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N + - platformio ci --lib="." --board= --board= --board= Library dependecies ~~~~~~~~~~~~~~~~~~~ @@ -87,7 +87,7 @@ Install dependent library using :ref:`librarymanager` test: override: - - platformio ci path/to/test/file.c --board=ID_1 --board=ID_2 --board=ID_N + - platformio ci path/to/test/file.c --board= --board= --board= Manually download dependent library and include in build process via ``--lib`` option ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -105,7 +105,7 @@ Manually download dependent library and include in build process via ``--lib`` o test: override: - - platformio ci path/to/test/file.c --lib="/tmp/OneWire-master" --board=ID_1 --board=ID_2 --board=ID_N + - platformio ci path/to/test/file.c --lib="/tmp/OneWire-master" --board= --board= --board= Custom Build Flags ~~~~~~~~~~~~~~~~~~ diff --git a/docs/ci/drone.rst b/docs/ci/drone.rst index ec9d1118..c0537d8e 100644 --- a/docs/ci/drone.rst +++ b/docs/ci/drone.rst @@ -51,7 +51,7 @@ Please fill all fields for your project in the Drone control panel: .. code-block:: bash pip install -U platformio - platformio ci --board=ID_1 --board=ID_2 --board=ID_N + platformio ci --board= --board= --board= .. image:: ../_static/droneci-platformio-integration-1.png diff --git a/docs/ci/shippable.rst b/docs/ci/shippable.rst index 4a71e7a7..63daa960 100644 --- a/docs/ci/shippable.rst +++ b/docs/ci/shippable.rst @@ -58,7 +58,7 @@ GitHub repository. - pip install -U platformio script: - - platformio ci --board=ID_1 --board=ID_2 --board=ID_N + - platformio ci --board= --board= --board= For more details as for PlatformIO build process please look into :ref:`cmd_ci` diff --git a/docs/ci/travis.rst b/docs/ci/travis.rst index e4dd6ef5..a690e5a0 100644 --- a/docs/ci/travis.rst +++ b/docs/ci/travis.rst @@ -72,7 +72,7 @@ PlatformIO is written in Python and is recommended to be run within - pip install -U platformio script: - - platformio ci --board=ID_1 --board=ID_2 --board=ID_N + - platformio ci --board= --board= --board= Then perform steps 1, 2 and 4 from http://docs.travis-ci.com/user/getting-started/ @@ -87,7 +87,7 @@ it), please use ``--lib="."`` option for :ref:`cmd_ci` command .. code-block:: yaml script: - - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N + - platformio ci --lib="." --board= --board= --board= Library dependencies ~~~~~~~~~~~~~~~~~~~~ @@ -121,7 +121,7 @@ Manually download dependent library and include in build process via ``--lib`` o - unzip /tmp/onewire_source.zip -d /tmp/ script: - - platformio ci --lib="/tmp/OneWire-master" --board=ID_1 --board=ID_2 --board=ID_N + - platformio ci --lib="/tmp/OneWire-master" --board= --board= --board= Custom Build Flags ~~~~~~~~~~~~~~~~~~ diff --git a/docs/ide/clion.rst b/docs/ide/clion.rst index 2d04fbbd..185f503e 100644 --- a/docs/ide/clion.rst +++ b/docs/ide/clion.rst @@ -36,7 +36,7 @@ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide clion --board %ID% + platformio init --ide clion --board # For example, generate project for Arduino UNO platformio init --ide clion --board uno diff --git a/docs/ide/codeblocks.rst b/docs/ide/codeblocks.rst index 7ac5b3c6..23df9db1 100644 --- a/docs/ide/codeblocks.rst +++ b/docs/ide/codeblocks.rst @@ -35,7 +35,7 @@ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide codeblocks --board %ID% + platformio init --ide codeblocks --board # For example, generate project for Arduino UNO platformio init --ide codeblocks --board uno diff --git a/docs/ide/eclipse.rst b/docs/ide/eclipse.rst index 418cdec7..3d21ea09 100644 --- a/docs/ide/eclipse.rst +++ b/docs/ide/eclipse.rst @@ -40,7 +40,7 @@ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide eclipse --board %ID% + platformio init --ide eclipse --board # For example, generate project for Arduino UNO platformio init --ide eclipse --board uno diff --git a/docs/ide/emacs.rst b/docs/ide/emacs.rst index 768c6333..fbbc108d 100644 --- a/docs/ide/emacs.rst +++ b/docs/ide/emacs.rst @@ -50,7 +50,7 @@ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide emacs --board %ID% + platformio init --ide emacs --board There are 6 predefined targets for building. diff --git a/docs/ide/netbeans.rst b/docs/ide/netbeans.rst index dfe96f35..a44a3311 100644 --- a/docs/ide/netbeans.rst +++ b/docs/ide/netbeans.rst @@ -38,7 +38,7 @@ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide netbeans --board %ID% + platformio init --ide netbeans --board # For example, generate project for Arduino UNO platformio init --ide netbeans --board uno diff --git a/docs/ide/qtcreator.rst b/docs/ide/qtcreator.rst index 2cacc2c8..42df4feb 100644 --- a/docs/ide/qtcreator.rst +++ b/docs/ide/qtcreator.rst @@ -40,7 +40,7 @@ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide qtcreator --board %ID% + platformio init --ide qtcreator --board # For example, generate project for Arduino UNO platformio init --ide qtcreator --board uno diff --git a/docs/ide/sublimetext.rst b/docs/ide/sublimetext.rst index 150c7a96..3589287d 100644 --- a/docs/ide/sublimetext.rst +++ b/docs/ide/sublimetext.rst @@ -47,7 +47,7 @@ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide sublimetext --board %ID% + platformio init --ide sublimetext --board # For example, generate project for Arduino UNO platformio init --ide sublimetext --board uno diff --git a/docs/ide/visualstudio.rst b/docs/ide/visualstudio.rst index ddcd2d54..7848e6cf 100644 --- a/docs/ide/visualstudio.rst +++ b/docs/ide/visualstudio.rst @@ -40,7 +40,7 @@ command and generate project via :option:`platformio init --ide` command: .. code-block:: shell - platformio init --ide sublimetext --board %ID% + platformio init --ide sublimetext --board # For example, generate project for Arduino UNO platformio init --ide visualstudio --board uno diff --git a/docs/userguide/cmd_ci.rst b/docs/userguide/cmd_ci.rst index 708996e2..87c3735b 100644 --- a/docs/userguide/cmd_ci.rst +++ b/docs/userguide/cmd_ci.rst @@ -63,10 +63,10 @@ Options .. option:: -l, --lib -Source code which will be copied to ``%build_dir%/lib`` directly. +Source code which will be copied to ``/lib`` directly. If :option:`platformio ci --lib` is a path to file (not to directory), then -PlatformIO will create temporary directory within ``%build_dir%/lib`` and copy +PlatformIO will create temporary directory within ``/lib`` and copy the rest files into it.