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

Minor improvements to the docs

Browse Source
This commit is contained in:
Ivan Kravets
2016-01-04 01:45:57 +02:00
parent 5d74e8ae6e
commit 363249f165
3 changed files with 19 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/librarymanager/config.rst
View File

@ -162,13 +162,12 @@ A version of the current library source code.
* Can contain a-z, digits, dots or dash.
* `Semantic Versioning <http://semver.org>`_ IS RECOMMENDED.
* A `CVS <http://en.wikipedia.org/wiki/Concurrent_Versions_System>`_
revision from the latest commit.
If :ref:`libjson_version` field is not defined and :ref:`libjson_repository`
field is defined, then |PIOAPICR| will use the *CVS*-revision from the latest
commit as "current version". For example, ``13`` (*SVN*) or first 10 chars of
*SHA* digest ``e4564b7da4`` (*Git*).
field is defined, then |PIOAPICR| will use the
`CVS <http://en.wikipedia.org/wiki/Concurrent_Versions_System>` revision from
the latest commit as "current version". For example, ``13`` (*SVN*) or first
10 chars of *SHA* digest ``e4564b7da4`` (*Git*).
If :ref:`libjson_version` and :ref:`libjson_repository` fields are defined,
then :ref:`libjson_version` has HIGHER PRIORITY. We recommend to use

4
docs/projectconf.rst
View File

@ -18,8 +18,8 @@ The Project configuration file is named ``platformio.ini``. This is a
`INI-style <http://en.wikipedia.org/wiki/INI_file>`_ file.
``platformio.ini`` has sections (each denoted by a ``[header]``) and
key / value pairs within the sections. A sign ``#`` at the beginning of the
line indicates a comment. Comment lines are ignored.
key / value pairs within the sections. Lines beginning with ``#`` or ``;``
are ignored and may be used to provide comments.
The sections and their allowable values are described below.

19
docs/userguide/cmd_settings.rst
View File

@ -113,12 +113,19 @@ Can PlatformIO communicate with you via prompts?
:Default: Yes
:Values: Yes/No
Share diagnostics and usage information (PlatformIO fatal errors/exceptions,
platforms, boards, frameworks, commands) to help us make PlatformIO better.
The `source code for telemetry service <https://github.com/platformio/platformio/blob/develop/platformio/telemetry.py>`_
is open source. You can make sure that we DO NOT share PRIVATE information or
source code of your project. All information shares anonymously. Thanks a lot
that live this setting enabled.
Share diagnostics and usage information to help us make PlatformIO better:
* PlatformIO errors/exceptions
* The name of used platforms, boards, frameworks (for example, "espressif", "arduino", "uno", etc.)
* The name of commands (for example, "run", "lib list", etc.)
* The type of IDE (for example, "atom", "eclipse", etc.)
This gives us a sense of what parts of the PlatformIO is most important.
The source code of telemetry service is `open source <https://github.com/platformio/platformio/blob/develop/platformio/telemetry.py>`_. You can make sure that we DO NOT share PRIVATE information or
source code of your project. All information shares anonymously.
Thanks a lot that keep this setting enabled.
.. note::