aboutsummaryrefslogtreecommitdiffstats
path: root/source
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2012-06-29 21:06:19 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2012-06-29 21:09:52 -0400
commit47733bcc78c2d3f7ac95457a086eb34afd0660f0 (patch)
tree9130e0b1b3e557814491b13204334dc9493b46fd /source
parent840a6bb74eb6dc3306191044a7a3ef6ed645dbe2 (diff)
downloadlibrambutan-47733bcc78c2d3f7ac95457a086eb34afd0660f0.tar.gz
librambutan-47733bcc78c2d3f7ac95457a086eb34afd0660f0.zip
Add initial whats-new.rst.
It needs a lot more work before being done, obviously. Refer to it prominently from the index page, and add it to the contents tree. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'source')
-rw-r--r--source/_templates/indexcontent.html3
-rw-r--r--source/contents.rst1
-rw-r--r--source/whats-new.rst78
3 files changed, 82 insertions, 0 deletions
diff --git a/source/_templates/indexcontent.html b/source/_templates/indexcontent.html
index 74b5273..a043f8a 100644
--- a/source/_templates/indexcontent.html
+++ b/source/_templates/indexcontent.html
@@ -29,6 +29,9 @@ here? Look on the <a href="http://wiki.leaflabs.com/">LeafLabs
wiki</a>.
</p>
+<p>See the <a href="{{ pathto("whats-new") }}">What's New</a> page for
+changes that are new in {{ release }}.</p>
+
<h2>Contents at a Glance</h2>
<table class="contents-table">
diff --git a/source/contents.rst b/source/contents.rst
index 4b10889..7bb60b8 100644
--- a/source/contents.rst
+++ b/source/contents.rst
@@ -14,6 +14,7 @@ Contents in Full
maple-ide-install
ide
unix-toolchain
+ whats-new
.. _index-maple-programming:
diff --git a/source/whats-new.rst b/source/whats-new.rst
new file mode 100644
index 0000000..c1f0bd5
--- /dev/null
+++ b/source/whats-new.rst
@@ -0,0 +1,78 @@
+.. highlight:: c
+
+What's New
+==========
+
+.. FIXME [RELEASE] finish.
+
+This page tracks updates to libmaple and MapleIDE.
+
+.. contents::
+ :local:
+ :depth: 1
+
+v0.0.13
+-------
+
+**General Changes**
+
+.. We started doing this as we updated the docs on 29 Jun 2012, so
+.. updates before then need to be pulled from libmaple's Git logs.
+
+- Additional STM32 support: for this release, libmaple was taught
+ how to target STM32F1 value line (thanks to Anton Eltchaninov) and
+ STM32F2 series microcontrollers. It learned a huge bag of new
+ tricks as a result, so this list is only a summary of the most
+ important changes.
+
+- New include style: You should now include libmaple and Wirish
+ headers like this (respectively)::
+
+ #include <libmaple/libmaple.h>
+ #include <wirish/wirish.h>
+
+ The old include style (e.g. ``#include "libmaple.h"``) is now
+ **deprecated**, and will **break in the next release**. This is more
+ standard usage for libraries, and was necessary to e.g. allow for
+ implementing a Wiring/Arduino-style SPI library (which is included
+ as ``#include "SPI.h"`` and clashes with :ref:`libmaple-spi` on
+ case-insensitive filesystems like OS X's).
+
+**Wirish**
+
+- Wire I2C library: New, improved, and more Arduino-compatible
+ :ref:`Wire <libs-wire>` library, thanks to Trystan Jones.
+
+**libmaple proper**
+
+Better documentation: The old documentation for libmaple's C layer did
+little more than list the Doxygen comments in the source code. It now
+includes explanatory material and usage notes. See
+:ref:`libmaple-apis`.
+
+.. FIXME [0.0.13] this is ugly
+
+Changes by header follow.
+
+.. list-table::
+ :header-rows: 1
+ :widths: 1 10
+
+ * - Header
+ - Changes
+
+ * - :ref:`libmaple-rcc`
+ - :ref:`rcc_clk_init() <rcc-rcc_clk_init>` is deprecated. Use
+ :ref:`rcc_configure_pll() <libmaple-rcc-rcc_configure_pll>` as
+ the basis for a portable replacement; see the
+ ``rcc_clk_init()`` docs for a porting guide.
+
+ * - :ref:`libmaple-libmaple_types`
+ - Various new attributes and type qualifiers.
+
+ * - :ref:`libmaple-adc`
+ - New :ref:`adc_enable_single_swstart()
+ <adc-adc_enable_single_swstart>` and :ref:`adc_config_gpio()
+ <adc-adc_config_gpio>`, for portably enabling ADC peripherals
+ and their associated pins for use with :ref:`adc_read()
+ <adc-adc_read>`.