From 1fc85d3d1da01a036c371c7744be6b0e561fa8d4 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Mon, 23 Feb 2015 23:47:44 +0200 Subject: [PATCH] Fill documentation with the new platforms, boards and etc. --- HISTORY.rst | 51 +++++++++++++++++++++++++-------- docs/platforms/atmelsam.rst | 6 ++-- docs/userguide/cmd_list.rst | 7 +++-- docs/userguide/cmd_search.rst | 2 -- docs/userguide/cmd_show.rst | 13 +++++---- docs/userguide/cmd_update.rst | 53 ++++++++++++++++++++++++++++++++--- 6 files changed, 105 insertions(+), 27 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index 429d8bad..5a098f3b 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -4,11 +4,31 @@ Release History 1.0.0 (2015-?) -------------- -* Added support for *ARM*-based credit-card computers: `Raspberry Pi `_, - `BeagleBoard `_ and `CubieBoard `_ -* Added new boards to `atmelavr `__ +* Added support for *ARM*-based credit-card computers: + `Raspberry Pi `_, + `BeagleBone `_ and `CubieBoard `_ +* Added `atmelsam `_ + development platform with supported boards: *Arduino Due and Digistump DigiX* + (`issue #71 `_) +* Added `stm32 `_ + development platform with supported boards: *Discovery kit for STM32L151/152, + STM32F303xx, STM32F407/417 lines* + (`issue #73 `_) +* Added `teensy `_ + development platform with supported boards: *Teensy 2.x & 3.x* + (`issue #72 `_) +* Added new *Arduino* boards to + `atmelavr `__ platform: *Arduino NG, Arduino BT, Arduino Esplora, Arduino Ethernet, Arduino Robot Control, Arduino Robot Motor and Arduino Yun* +* Added support for *Adafruit* boards to + `atmelavr `__ + platform: *Adafruit Flora and Adafruit Trinkets* + (`issue #65 `_) +* Added support for *Digispark* boards to + `atmelavr `__ + platform: *Digispark USB Development Board and Digispark Pro* + (`issue #47 `_) * Covered code with tests (`issue #2 `_) * Refactored *Library Dependency Finder* (issues `#48 `_, @@ -18,22 +38,28 @@ Release History option to ``[platformio]`` section of `platformio.ini `__ which allows to redefine location to project's source directory + (`issue #83 `_) * Added ``--json-output`` option to `platformio boards `__ and `platformio search `__ - commands which allow to return the output in `JSON `_ format + commands which allows to return the output in `JSON `_ format (`issue #42 `_) * Allowed to ignore some libs from *Library Dependency Finder* via `ignore_libs `_ option * Improved `platformio run `__ command: asynchronous output for build process, timing and detailed - information about environment configuration (`issue #74 `_) -* Output compiled size and static memory usage with `platformio run `__ + information about environment configuration + (`issue #74 `_) +* Output compiled size and static memory usage with + `platformio run `__ command (`issue #59 `_) * Updated `framework-arduino` AVR & SAM to 1.6 stable version -* Fixed an issue with the libraries that are git repositories (`issue #49 `_) -* Fixed handling of assembly files (`issue #58 `_) -* Fixed compiling error if space is in user's folder (`issue #56 `_) +* Fixed an issue with the libraries that are git repositories + (`issue #49 `_) +* Fixed handling of assembly files + (`issue #58 `_) +* Fixed compiling error if space is in user's folder + (`issue #56 `_) * Fixed `AttributeError: 'module' object has no attribute 'disable_warnings'` when a version of `requests` package is less then 2.4.0 * Fixed bug with invalid process's "return code" when PlatformIO has internal @@ -43,8 +69,11 @@ Release History 0.10.2 (2015-01-06) ------------------- -* Fixed an issue with ``--json-output`` (`issue #42 `_) -* Fixed an exception during `platformio upgrade `__ under Windows OS (`issue #45 `_) +* Fixed an issue with ``--json-output`` + (`issue #42 `_) +* Fixed an exception during + `platformio upgrade `__ + under Windows OS (`issue #45 `_) 0.10.1 (2015-01-02) ------------------- diff --git a/docs/platforms/atmelsam.rst b/docs/platforms/atmelsam.rst index 90ccb97d..6db06f5a 100644 --- a/docs/platforms/atmelsam.rst +++ b/docs/platforms/atmelsam.rst @@ -3,9 +3,9 @@ Platform ``atmelsam`` ===================== -`Atmel® | SMART `_ -offers Flash- based ARM® products based on the ARM Cortex-®M0+, Cortex-M3 and -Cortex-M4 architectures, ranging from 8KB to 2MB of Flash including a rich +`Atmel® | SMART `_ +offers Flash- based ARM® products based on the ARM Cortex-®M0+, Cortex-M3 and +Cortex-M4 architectures, ranging from 8KB to 2MB of Flash including a rich peripheral and feature mix. .. contents:: diff --git a/docs/userguide/cmd_list.rst b/docs/userguide/cmd_list.rst index bbbf7197..103c457b 100644 --- a/docs/userguide/cmd_list.rst +++ b/docs/userguide/cmd_list.rst @@ -32,6 +32,9 @@ Examples .. code-block:: bash $ platformio list + atmelavr with packages: toolchain-atmelavr, tool-avrdude, framework-arduinoavr, tool-micronucleus + atmelsam with packages: framework-arduinosam, ldscripts, toolchain-gccarmnoneeabi, tool-bossac + stm32 with packages: toolchain-gccarmnoneeabi, tool-stlink, framework-spl, framework-cmsis, framework-opencm3, ldscripts + teensy with packages: toolchain-atmelavr, ldscripts, framework-arduinoteensy, toolchain-gccarmnoneeabi, tool-teensy timsp430 with packages: toolchain-timsp430, tool-mspdebug, framework-energiamsp430 - atmelavr with packages: toolchain-atmelavr, tool-avrdude, framework-arduinoavr - titiva with packages: toolchain-gccarmnoneeabi, tool-lm4flash, framework-energiativa + titiva with packages: ldscripts, toolchain-gccarmnoneeabi, tool-lm4flash, framework-opencm3, framework-energiativa diff --git a/docs/userguide/cmd_search.rst b/docs/userguide/cmd_search.rst index 3a60b25f..c6b9e743 100644 --- a/docs/userguide/cmd_search.rst +++ b/docs/userguide/cmd_search.rst @@ -37,7 +37,6 @@ Examples $ platformio search atmelavr - An embedded platform for Atmel AVR microcontrollers (with Arduino Framework) atmelsam - An embedded platform for Atmel SAM microcontrollers (with Arduino Framework) - digistump - An embedded platform for Digistump boards (with Arduino Framework) stm32 - An embedded platform for STMicroelectronics ARM microcontrollers teensy - An embedded platform for Teensy boards (with Arduino Framework) timsp430 - An embedded platform for TI MSP430 microcontrollers (with Energia Framework) @@ -59,5 +58,4 @@ Examples $ platformio search arduino atmelavr - An embedded platform for Atmel AVR microcontrollers (with Arduino Framework) atmelsam - An embedded platform for Atmel SAM microcontrollers (with Arduino Framework) - digistump - An embedded platform for Digistump boards (with Arduino Framework) teensy - An embedded platform for Teensy boards (with Arduino Framework) diff --git a/docs/userguide/cmd_show.rst b/docs/userguide/cmd_show.rst index 3c48efee..c109117f 100644 --- a/docs/userguide/cmd_show.rst +++ b/docs/userguide/cmd_show.rst @@ -29,14 +29,17 @@ Examples ---------- Package: toolchain-atmelavr Alias: toolchain - Location: /Users/ikravets/.platformio/atmelavr/tools/toolchain Version: 1 + Installed: 2014-12-13 23:58:48 ---------- Package: tool-avrdude - Alias: uploader - Location: /Users/ikravets/.platformio/atmelavr/tools/avrdude - Version: 1 + Version: 2 + Installed: 2015-02-13 22:23:17 ---------- Package: framework-arduinoavr - Location: /Users/ikravets/.platformio/atmelavr/frameworks/arduino + Version: 12 + Installed: 2015-02-23 20:57:40 + ---------- + Package: tool-micronucleus Version: 1 + Installed: 2015-02-23 21:20:14 diff --git a/docs/userguide/cmd_update.rst b/docs/userguide/cmd_update.rst index 66734508..b01cf9b4 100644 --- a/docs/userguide/cmd_update.rst +++ b/docs/userguide/cmd_update.rst @@ -30,9 +30,50 @@ Examples -------- Updating toolchain-atmelavr package: Versions: Current=1, Latest=1 [Up-to-date] - Updating framework-arduinoavr package: - Versions: Current=1, Latest=1 [Up-to-date] Updating tool-avrdude package: + Versions: Current=2, Latest=2 [Up-to-date] + Updating framework-arduinoavr package: + Versions: Current=12, Latest=12 [Up-to-date] + Updating tool-micronucleus package: + Versions: Current=1, Latest=1 [Up-to-date] + + Platform atmelsam + -------- + Updating framework-arduinosam package: + Versions: Current=3, Latest=3 [Up-to-date] + Updating ldscripts package: + Versions: Current=1, Latest=1 [Up-to-date] + Updating toolchain-gccarmnoneeabi package: + Versions: Current=1, Latest=1 [Up-to-date] + Updating tool-bossac package: + Versions: Current=1, Latest=1 [Up-to-date] + + Platform stm32 + -------- + Updating toolchain-gccarmnoneeabi package: + Versions: Current=1, Latest=1 [Up-to-date] + Updating tool-stlink package: + Versions: Current=1, Latest=1 [Up-to-date] + Updating framework-spl package: + Versions: Current=1, Latest=1 [Up-to-date] + Updating framework-cmsis package: + Versions: Current=2, Latest=2 [Up-to-date] + Updating framework-opencm3 package: + Versions: Current=1, Latest=1 [Up-to-date] + Updating ldscripts package: + Versions: Current=1, Latest=1 [Up-to-date] + + Platform teensy + -------- + Updating toolchain-atmelavr package: + Versions: Current=1, Latest=1 [Up-to-date] + Updating ldscripts package: + Versions: Current=1, Latest=1 [Up-to-date] + Updating framework-arduinoteensy package: + Versions: Current=1, Latest=1 [Up-to-date] + Updating toolchain-gccarmnoneeabi package: + Versions: Current=1, Latest=1 [Up-to-date] + Updating tool-teensy package: Versions: Current=1, Latest=1 [Up-to-date] Platform timsp430 @@ -42,13 +83,17 @@ Examples Updating tool-mspdebug package: Versions: Current=1, Latest=1 [Up-to-date] Updating framework-energiamsp430 package: - Versions: Current=1, Latest=1 [Up-to-date] + Versions: Current=2, Latest=2 [Up-to-date] Platform titiva -------- + Updating ldscripts package: + Versions: Current=1, Latest=1 [Up-to-date] Updating toolchain-gccarmnoneeabi package: Versions: Current=1, Latest=1 [Up-to-date] Updating tool-lm4flash package: Versions: Current=1, Latest=1 [Up-to-date] - Updating framework-energiativa package: + Updating framework-opencm3 package: Versions: Current=1, Latest=1 [Up-to-date] + Updating framework-energiativa package: + Versions: Current=4, Latest=4 [Up-to-date]