platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-07-31 02:27:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Minor improvements to docs

Browse Source
This commit is contained in:
Ivan Kravets
2016-09-02 16:45:08 +03:00
parent a48201f60f
commit 424d5e71a8
14 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/ci/appveyor.rst
View File

@ -56,7 +56,7 @@ Put ``appveyor.yml`` to the root directory of the GitHub repository.
- cmd: pip install -U platformio - cmd: pip install -U platformio
test_script: test_script:
- cmd: platformio ci --board=ID_1 --board=ID_2 --board=ID_N - cmd: platformio ci --board=<ID_1> --board=<ID_2> --board=<ID_N>
For more details as for PlatformIO build process please look into :ref:`cmd_ci` For more details as for PlatformIO build process please look into :ref:`cmd_ci`

12
docs/ci/circleci.rst
View File

@ -49,9 +49,9 @@ guide first.
test: test:
override: 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=<ID_1> --board=<ID_2> --board=<ID_N>
- platformio ci examples/file.ino --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/directory --board=<ID_1> --board=<ID_2> --board=<ID_N>
For more details as for PlatformIO build process please look into :ref:`cmd_ci`. 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 .. code-block:: yaml
script: script:
- platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N - platformio ci --lib="." --board=<ID_1> --board=<ID_2> --board=<ID_N>
Library dependecies Library dependecies
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
@ -87,7 +87,7 @@ Install dependent library using :ref:`librarymanager`
test: test:
override: 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=<ID_1> --board=<ID_2> --board=<ID_N>
Manually download dependent library and include in build process via ``--lib`` option 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: test:
override: 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=<ID_1> --board=<ID_2> --board=<ID_N>
Custom Build Flags Custom Build Flags
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~

2
docs/ci/drone.rst
View File

@ -51,7 +51,7 @@ Please fill all fields for your project in the Drone control panel:
.. code-block:: bash .. code-block:: bash
pip install -U platformio pip install -U platformio
platformio ci --board=ID_1 --board=ID_2 --board=ID_N platformio ci --board=<ID_1> --board=<ID_2> --board=<ID_N>
.. image:: ../_static/droneci-platformio-integration-1.png .. image:: ../_static/droneci-platformio-integration-1.png

2
docs/ci/shippable.rst
View File

@ -58,7 +58,7 @@ GitHub repository.
- pip install -U platformio - pip install -U platformio
script: script:
- platformio ci --board=ID_1 --board=ID_2 --board=ID_N - platformio ci --board=<ID_1> --board=<ID_2> --board=<ID_N>
For more details as for PlatformIO build process please look into :ref:`cmd_ci` For more details as for PlatformIO build process please look into :ref:`cmd_ci`

6
docs/ci/travis.rst
View File

@ -72,7 +72,7 @@ PlatformIO is written in Python and is recommended to be run within
- pip install -U platformio - pip install -U platformio
script: script:
- platformio ci --board=ID_1 --board=ID_2 --board=ID_N - platformio ci --board=<ID_1> --board=<ID_2> --board=<ID_N>
Then perform steps 1, 2 and 4 from http://docs.travis-ci.com/user/getting-started/ 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 .. code-block:: yaml
script: script:
- platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N - platformio ci --lib="." --board=<ID_1> --board=<ID_2> --board=<ID_N>
Library dependencies 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/ - unzip /tmp/onewire_source.zip -d /tmp/
script: script:
- platformio ci --lib="/tmp/OneWire-master" --board=ID_1 --board=ID_2 --board=ID_N - platformio ci --lib="/tmp/OneWire-master" --board=<ID_1> --board=<ID_2> --board=<ID_N>
Custom Build Flags Custom Build Flags
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~

2
docs/ide/clion.rst
View File

@ -36,7 +36,7 @@ command and generate project via :option:`platformio init --ide` command:
.. code-block:: shell .. code-block:: shell
platformio init --ide clion --board %ID% platformio init --ide clion --board <ID>
# For example, generate project for Arduino UNO # For example, generate project for Arduino UNO
platformio init --ide clion --board uno platformio init --ide clion --board uno

2
docs/ide/codeblocks.rst
View File

@ -35,7 +35,7 @@ command and generate project via :option:`platformio init --ide` command:
.. code-block:: shell .. code-block:: shell
platformio init --ide codeblocks --board %ID% platformio init --ide codeblocks --board <ID>
# For example, generate project for Arduino UNO # For example, generate project for Arduino UNO
platformio init --ide codeblocks --board uno platformio init --ide codeblocks --board uno

2
docs/ide/eclipse.rst
View File

@ -40,7 +40,7 @@ command and generate project via :option:`platformio init --ide` command:
.. code-block:: shell .. code-block:: shell
platformio init --ide eclipse --board %ID% platformio init --ide eclipse --board <ID>
# For example, generate project for Arduino UNO # For example, generate project for Arduino UNO
platformio init --ide eclipse --board uno platformio init --ide eclipse --board uno

2
docs/ide/emacs.rst
View File

@ -50,7 +50,7 @@ command and generate project via :option:`platformio init --ide` command:
.. code-block:: shell .. code-block:: shell
platformio init --ide emacs --board %ID% platformio init --ide emacs --board <ID>
There are 6 predefined targets for building. There are 6 predefined targets for building.

2
docs/ide/netbeans.rst
View File

@ -38,7 +38,7 @@ command and generate project via :option:`platformio init --ide` command:
.. code-block:: shell .. code-block:: shell
platformio init --ide netbeans --board %ID% platformio init --ide netbeans --board <ID>
# For example, generate project for Arduino UNO # For example, generate project for Arduino UNO
platformio init --ide netbeans --board uno platformio init --ide netbeans --board uno

2
docs/ide/qtcreator.rst
View File

@ -40,7 +40,7 @@ command and generate project via :option:`platformio init --ide` command:
.. code-block:: shell .. code-block:: shell
platformio init --ide qtcreator --board %ID% platformio init --ide qtcreator --board <ID>
# For example, generate project for Arduino UNO # For example, generate project for Arduino UNO
platformio init --ide qtcreator --board uno platformio init --ide qtcreator --board uno

2
docs/ide/sublimetext.rst
View File

@ -47,7 +47,7 @@ command and generate project via :option:`platformio init --ide` command:
.. code-block:: shell .. code-block:: shell
platformio init --ide sublimetext --board %ID% platformio init --ide sublimetext --board <ID>
# For example, generate project for Arduino UNO # For example, generate project for Arduino UNO
platformio init --ide sublimetext --board uno platformio init --ide sublimetext --board uno

2
docs/ide/visualstudio.rst
View File

@ -40,7 +40,7 @@ command and generate project via :option:`platformio init --ide` command:
.. code-block:: shell .. code-block:: shell
platformio init --ide sublimetext --board %ID% platformio init --ide sublimetext --board <ID>
# For example, generate project for Arduino UNO # For example, generate project for Arduino UNO
platformio init --ide visualstudio --board uno platformio init --ide visualstudio --board uno

4
docs/userguide/cmd_ci.rst
View File

@ -63,10 +63,10 @@ Options
.. option:: .. option::
-l, --lib -l, --lib
Source code which will be copied to ``%build_dir%/lib`` directly. Source code which will be copied to ``<BUILD_DIR>/lib`` directly.
If :option:`platformio ci --lib` is a path to file (not to directory), then 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 ``<BUILD_DIR>/lib`` and copy
the rest files into it. the rest files into it.