diff --git a/docs/librarymanager/config.rst b/docs/librarymanager/config.rst index e49794d7..945f9e15 100644 --- a/docs/librarymanager/config.rst +++ b/docs/librarymanager/config.rst @@ -162,13 +162,12 @@ A version of the current library source code. * Can contain a-z, digits, dots or dash. * `Semantic Versioning `_ IS RECOMMENDED. -* A `CVS `_ - 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 ` 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 diff --git a/docs/projectconf.rst b/docs/projectconf.rst index 88ce7188..bb541a10 100644 --- a/docs/projectconf.rst +++ b/docs/projectconf.rst @@ -18,8 +18,8 @@ The Project configuration file is named ``platformio.ini``. This is a `INI-style `_ 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. diff --git a/docs/userguide/cmd_settings.rst b/docs/userguide/cmd_settings.rst index e1b6b528..835ad70a 100644 --- a/docs/userguide/cmd_settings.rst +++ b/docs/userguide/cmd_settings.rst @@ -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 `_ -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 `_. 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::