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

Document tags/releases for "version" field in library.json

Browse Source
This commit is contained in:
Ivan Kravets
2016-01-22 22:25:13 +02:00
parent 1ae2e189dd
commit 5535529903
1 changed files with 35 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/librarymanager/config.rst
View File

@ -143,7 +143,7 @@ next items:
* ``type`` * ``type``
* ``url`` * ``url``
* ``branch`` if isn't specified, default branch will be used. * ``branch`` if is not specified, default branch will be used.
Example: Example:
@ -163,20 +163,41 @@ Example:
*Required* if :ref:`libjson_repository` field is not defined | Type: ``String`` *Required* if :ref:`libjson_repository` field is not defined | Type: ``String``
| Max. Length: 20 | Max. Length: 20
A version of the current library source code. A version of the current library source code. Can contain a-z, digits, dots or
dash. `Semantic Versioning <http://semver.org>`_ IS RECOMMENDED.
* Can contain a-z, digits, dots or dash. :Case 1:
* `Semantic Versioning <http://semver.org>`_ IS RECOMMENDED.
If :ref:`libjson_version` field is not defined and :ref:`libjson_repository` :ref:`libjson_version` and :ref:`libjson_repository` fields are defined.
field is defined, then |PIOAPICR| will use the The :ref:`libjson_repository` hosted on GitHub or Bitbucket.
|PIOAPICR| will lookup for release tag named as value of :ref:`libjson_version`
or with ``v`` prefix (you do not need to pass this ``v`` prefix to the
:ref:`libjson_version` field).
:Case 2:
:ref:`libjson_version` and :ref:`libjson_repository` fields are defined
and :ref:`libjson_repository` does not contain tag/release with value of
:ref:`libjson_version`.
|PIOAPICR| will use the latest source code and link it with specified
:ref:`libjson_version`. If you push new commits to :ref:`libjson_repository`
and do not update :ref:`libjson_version` field, the library will not be
updated until you change the :ref:`libjson_version`.
:Case 3:
:ref:`libjson_version` field is not defined and :ref:`libjson_repository`
field is defined.
|PIOAPICR| will use the
`CVS <http://en.wikipedia.org/wiki/Concurrent_Versions_System>`_ revision from `CVS <http://en.wikipedia.org/wiki/Concurrent_Versions_System>`_ revision from
the latest commit as "current version". For example, ``13`` (*SVN*) or first the latest commit as "current version". For example, ``13`` (*SVN*) or first
10 chars of *SHA* digest ``e4564b7da4`` (*Git*). 10 chars of *SHA* digest ``e4564b7da4`` (*Git*).
If :ref:`libjson_version` and :ref:`libjson_repository` fields are defined, We recommend to use :ref:`libjson_version` field and specify the real release
then :ref:`libjson_version` has HIGHER PRIORITY. We recommend to use version and make appropriate target in the :ref:`libjson_repository`. In other
:ref:`libjson_version` field and specify the real release version. In other
case, users will receive updates for library with each new commit to case, users will receive updates for library with each new commit to
:ref:`libjson_repository`. :ref:`libjson_repository`.