diff --git a/docs/librarymanager/config.rst b/docs/librarymanager/config.rst index e4032cbf..1d85cbaf 100644 --- a/docs/librarymanager/config.rst +++ b/docs/librarymanager/config.rst @@ -143,7 +143,7 @@ next items: * ``type`` * ``url`` -* ``branch`` if isn't specified, default branch will be used. +* ``branch`` if is not specified, default branch will be used. Example: @@ -163,22 +163,43 @@ Example: *Required* if :ref:`libjson_repository` field is not defined | Type: ``String`` | 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 `_ IS RECOMMENDED. -* Can contain a-z, digits, dots or dash. -* `Semantic Versioning `_ IS RECOMMENDED. +:Case 1: -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*). + :ref:`libjson_version` and :ref:`libjson_repository` fields are defined. + The :ref:`libjson_repository` hosted on GitHub or Bitbucket. -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`. + |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 `_ revision from + the latest commit as "current version". For example, ``13`` (*SVN*) or first + 10 chars of *SHA* digest ``e4564b7da4`` (*Git*). + + We recommend to use :ref:`libjson_version` field and specify the real release + version and make appropriate target in the :ref:`libjson_repository`. In other + case, users will receive updates for library with each new commit to + :ref:`libjson_repository`. .. note:: |PIOAPICR| updates library only if: