feedc0de/platformio-core
1
0
Fork 0
forked from platformio/platformio-core
Code Pull Requests Activity

Improve docs for library.json "version" field

Browse Source
This commit is contained in:
Ivan Kravets
2016-01-04 01:07:42 +02:00
parent db50043972
commit 5d74e8ae6e
1 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/librarymanager/config.rst
View File

@ -161,15 +161,25 @@ Example:
A version of the current library source code.
* Can contain a-z, digits, dots or dash.
* `Semantic Versioning <http://semver.org>`_ is recommended.
* `Semantic Versioning <http://semver.org>`_ IS RECOMMENDED.
* A `CVS <http://en.wikipedia.org/wiki/Concurrent_Versions_System>`_
revision from the latest commit. Example: ``13`` (*SVN*) or first 10
chars of *SHA* digest ``e4564b7da4`` (*Git*).
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*).
If :ref:`libjson_version` and :ref:`libjson_repository` fields are defined,
then :ref:`libjson_version` has HIGHER PRIORITY. We recommend to use
:ref:`libjson_version` field and specify the real release version. In other
case, users will receive updates for library with each new commit to
:ref:`libjson_repository`.
.. note::
You can omit :ref:`libjson_version` field and define
:ref:`libjson_repository` field. In this case
|PIOAPICR| will use the *CVS*-revision from the latest commit.
|PIOAPICR| updates library only if:
- the :ref:`libjson_version` is changed
- ``library.json`` is modified
Example: