From f186ad30c1f3642894e7111e36e2436417fe6744 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Fri, 9 Sep 2016 18:08:18 +0300 Subject: [PATCH] Notify about `version` field when creating library --- docs/librarymanager/config.rst | 2 +- docs/librarymanager/creating.rst | 55 ++++++++++++++++++++++++-------- docs/quickstart.rst | 2 +- docs/userguide/cmd_init.rst | 2 +- platformio/exception.py | 2 +- 5 files changed, 46 insertions(+), 17 deletions(-) diff --git a/docs/librarymanager/config.rst b/docs/librarymanager/config.rst index 67a5e6bb..a3a2edc1 100644 --- a/docs/librarymanager/config.rst +++ b/docs/librarymanager/config.rst @@ -196,7 +196,7 @@ dash. `Semantic Versioning `_ IS RECOMMENDED. field is defined. |PIOAPICR| will use the - `CVS `_ revision from + `VCS `_ revision from the latest commit as "current version". For example, ``13`` (*SVN*) or first 10 chars of *SHA* digest ``e4564b7da4`` (*Git*). If :ref:`libjson_repository` ``branch`` is not specified, then default branch will be used. diff --git a/docs/librarymanager/creating.rst b/docs/librarymanager/creating.rst index 8bdbf5b9..16051a8d 100644 --- a/docs/librarymanager/creating.rst +++ b/docs/librarymanager/creating.rst @@ -44,34 +44,63 @@ If a library source code is located at `GitHub `_, then you **need to specify** only these fields in the :ref:`library_config`: * :ref:`libjson_name` +* :ref:`libjson_version` (is not required, but highly recommended for new :ref:`librarymanager`) * :ref:`libjson_keywords` * :ref:`libjson_description` * :ref:`libjson_repository` -|PIOAPICR| will populate the rest fields, like :ref:`libjson_version` or -:ref:`libjson_authors` with an actual information from *GitHub*. +|PIOAPICR| will populate the rest fields, like :ref:`libjson_authors` with an +actual information from *GitHub*. -Example: +Example, `DallasTemperature `_: .. code-block:: javascript { - "name": "IRremote", - "keywords": "infrared, ir, remote", - "description": "Send and receive infrared signals with multiple protocols", - "repository": + "name": "DallasTemperature", + "keywords": "onewire, 1-wire, bus, sensor, temperature", + "description": "Arduino Library for Dallas Temperature ICs (DS18B20, DS18S20, DS1822, DS1820)", + "repository": + { + "type": "git", + "url": "https://github.com/milesburton/Arduino-Temperature-Control-Library.git" + }, + "authors": + [ { - "type": "git", - "url": "https://github.com/shirriff/Arduino-IRremote.git" + "name": "Miles Burton", + "email": "miles@mnetcs.com", + "url": "http://www.milesburton.com", + "maintainer": true }, - "frameworks": "arduino", - "platforms": "atmelavr" + { + "name": "Tim Newsome", + "email": "nuisance@casualhacker.net" + }, + { + "name": "Guil Barros", + "email": "gfbarros@bappos.com" + }, + { + "name": "Rob Tillaart", + "email": "rob.tillaart@gmail.com" + } + ], + "dependencies": + { + "name": "OneWire", + "authors": "Paul Stoffregen", + "frameworks": "arduino" + }, + "version": "3.7.7", + "frameworks": "arduino", + "platforms": "*" } -Under CVS (SVN/GIT) +Under VCS (SVN/GIT) ^^^^^^^^^^^^^^^^^^^ -|PIOAPICR| can operate with a library source code that is under *CVS* control. +|PIOAPICR| can operate with a library source code that is under *VCS* control. The list of **required** fields in the :ref:`library_config` will look like: * :ref:`libjson_name` diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 83442cb9..a1859629 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -133,7 +133,7 @@ next structure: (``*.h, *.c, *.cpp, *.S, *.ino, etc.``) * ``lib`` directory can be used for the project specific (private) libraries. More details are located in ``lib/readme.txt`` file. -* Miscellaneous files for CVS and :ref:`ci` support. +* Miscellaneous files for VCS and :ref:`ci` support. .. note:: diff --git a/docs/userguide/cmd_init.rst b/docs/userguide/cmd_init.rst index a9dcb194..c3c4ab87 100644 --- a/docs/userguide/cmd_init.rst +++ b/docs/userguide/cmd_init.rst @@ -37,7 +37,7 @@ This command will create: (``*.h, *.c, *.cpp, *.S, *.ino, etc.``) * ``lib`` directory can be used for the project specific (private) libraries. More details are located in ``lib/readme.txt`` file. -* Miscellaneous files for CVS and :ref:`ci` support. +* Miscellaneous files for VCS and :ref:`ci` support. Options ------- diff --git a/platformio/exception.py b/platformio/exception.py index 5d8f3b76..62b96b40 100644 --- a/platformio/exception.py +++ b/platformio/exception.py @@ -50,7 +50,7 @@ class PlatformNotInstalledYet(PlatformioException): class BoardNotDefined(PlatformioException): - MESSAGE = "You need to specify board type using `-b` or `--board` "\ + MESSAGE = "You need to specify board ID using `-b` or `--board` "\ "option. Supported boards list is available via "\ " `platformio boards` command"