diff options
28 files changed, 150 insertions, 32 deletions
diff --git a/doc/Makefile b/doc/Makefile index 939969ab..08835ad3 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -3,6 +3,7 @@ # RELNOTES_INC=\ + release-notes-1.6.2.inc \ release-notes-1.6.1.inc \ release-notes-1.6.inc \ release-notes-1.5.inc \ diff --git a/doc/RELNOTES b/doc/RELNOTES new file mode 100644 index 00000000..0b04ac5f --- /dev/null +++ b/doc/RELNOTES @@ -0,0 +1,25 @@ +Creating documentation for a new release of AltOS + +* Write release notes in release-notes-${version}.inc. Write docinfo + for release notes in release-notes-${version}-docinfo.xml. Add to + Makefile + +* Add references to that as appropriate from each of the + documents: + + release-notes.inc + easymini-release-notes.inc + telegps-release-notes.inc + +* Update date and add docinfo short release info for each document as + appropriate + + altusmetrum-docinfo.xml + companion-docinfo.xml + easymini-docinfo.xml + micropeak-docinfo.xml + telegps-docinfo.xml + telemetry-docinfo.xml + +* Add release-notes-${version}.inc and + release-notes-${version}-docinfo.xml to git diff --git a/doc/altusmetrum-docinfo.xml b/doc/altusmetrum-docinfo.xml index 69a769b6..9f2dda1c 100644 --- a/doc/altusmetrum-docinfo.xml +++ b/doc/altusmetrum-docinfo.xml @@ -30,7 +30,7 @@ <corpauthor> <inlinemediaobject> <imageobject> - <imagedata fileref="altusmetrum-oneline.svg" width="3in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="4in"/> </imageobject> </inlinemediaobject> </corpauthor> @@ -47,6 +47,13 @@ <revhistory> <?dbhtml filename="altusmetrum-revhistory.html"?> <revision> + <revnumber>1.6.2</revnumber> + <date>10 January 2016</date> + <revremark> + Minor release adding TeleMega v2.0 support. + </revremark> + </revision> + <revision> <revnumber>1.6.1</revnumber> <date>15 July 2015</date> <revremark> diff --git a/doc/easymini-docinfo.xml b/doc/easymini-docinfo.xml index f3c7ba19..7789d2f3 100644 --- a/doc/easymini-docinfo.xml +++ b/doc/easymini-docinfo.xml @@ -10,7 +10,7 @@ <email>keithp@keithp.com</email> </author> <copyright> - <year>2015</year> + <year>2016</year> <holder>Bdale Garbee and Keith Packard</holder> </copyright> <mediaobject> @@ -40,7 +40,7 @@ <?dbhtml filename="easymini-revhistory.html"?> <revision> <revnumber>1.6.2</revnumber> - <date>13 November 2015</date> + <date>10 January 2016</date> <revremark> First release of separate EasyMini doc </revremark> diff --git a/doc/easymini-release-notes.inc b/doc/easymini-release-notes.inc index e448b394..352a989b 100644 --- a/doc/easymini-release-notes.inc +++ b/doc/easymini-release-notes.inc @@ -2,6 +2,6 @@ == Release Notes :leveloffset: 2 - include::release-notes-1.6.1.raw[] + include::release-notes-1.6.2.raw[] :leveloffset: 0 diff --git a/doc/release-notes-0.7.1-docinfo.xml b/doc/release-notes-0.7.1-docinfo.xml index 71bc3180..9657f2a6 100644 --- a/doc/release-notes-0.7.1-docinfo.xml +++ b/doc/release-notes-0.7.1-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-0.8-docinfo.xml b/doc/release-notes-0.8-docinfo.xml index d06249f5..d593da31 100644 --- a/doc/release-notes-0.8-docinfo.xml +++ b/doc/release-notes-0.8-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-0.9-docinfo.xml b/doc/release-notes-0.9-docinfo.xml index 0602cb02..605472f2 100644 --- a/doc/release-notes-0.9-docinfo.xml +++ b/doc/release-notes-0.9-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-0.9.2-docinfo.xml b/doc/release-notes-0.9.2-docinfo.xml index ec1e4482..40e53634 100644 --- a/doc/release-notes-0.9.2-docinfo.xml +++ b/doc/release-notes-0.9.2-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.0.1-docinfo.xml b/doc/release-notes-1.0.1-docinfo.xml index 95a7681d..23972104 100644 --- a/doc/release-notes-1.0.1-docinfo.xml +++ b/doc/release-notes-1.0.1-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.1-docinfo.xml b/doc/release-notes-1.1-docinfo.xml index 032a06c5..93273918 100644 --- a/doc/release-notes-1.1-docinfo.xml +++ b/doc/release-notes-1.1-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.1.1-docinfo.xml b/doc/release-notes-1.1.1-docinfo.xml index 4c2c8b1c..41ea12da 100644 --- a/doc/release-notes-1.1.1-docinfo.xml +++ b/doc/release-notes-1.1.1-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.2-docinfo.xml b/doc/release-notes-1.2-docinfo.xml index f35f033d..ba2c9d56 100644 --- a/doc/release-notes-1.2-docinfo.xml +++ b/doc/release-notes-1.2-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.2.1-docinfo.xml b/doc/release-notes-1.2.1-docinfo.xml index 968c0434..d0f08b9c 100644 --- a/doc/release-notes-1.2.1-docinfo.xml +++ b/doc/release-notes-1.2.1-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.3-docinfo.xml b/doc/release-notes-1.3-docinfo.xml index b10fd9dd..aa569df4 100644 --- a/doc/release-notes-1.3-docinfo.xml +++ b/doc/release-notes-1.3-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.3.1-docinfo.xml b/doc/release-notes-1.3.1-docinfo.xml index 52264773..f67cf3b8 100644 --- a/doc/release-notes-1.3.1-docinfo.xml +++ b/doc/release-notes-1.3.1-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.3.2-docinfo.xml b/doc/release-notes-1.3.2-docinfo.xml index f55aef04..82b7677e 100644 --- a/doc/release-notes-1.3.2-docinfo.xml +++ b/doc/release-notes-1.3.2-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.4-docinfo.xml b/doc/release-notes-1.4-docinfo.xml index 216c0ae3..12a38ce5 100644 --- a/doc/release-notes-1.4-docinfo.xml +++ b/doc/release-notes-1.4-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.4.1-docinfo.xml b/doc/release-notes-1.4.1-docinfo.xml index d87052f7..6224b16e 100644 --- a/doc/release-notes-1.4.1-docinfo.xml +++ b/doc/release-notes-1.4.1-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.4.2-docinfo.xml b/doc/release-notes-1.4.2-docinfo.xml index 4b4f7b21..8fd94324 100644 --- a/doc/release-notes-1.4.2-docinfo.xml +++ b/doc/release-notes-1.4.2-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.5-docinfo.xml b/doc/release-notes-1.5-docinfo.xml index 3d018630..0c0cace7 100644 --- a/doc/release-notes-1.5-docinfo.xml +++ b/doc/release-notes-1.5-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.6-docinfo.xml b/doc/release-notes-1.6-docinfo.xml index 760d5e60..5ae58bb5 100644 --- a/doc/release-notes-1.6-docinfo.xml +++ b/doc/release-notes-1.6-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.6.1-docinfo.xml b/doc/release-notes-1.6.1-docinfo.xml index 1b27b79a..dc0a2d67 100644 --- a/doc/release-notes-1.6.1-docinfo.xml +++ b/doc/release-notes-1.6.1-docinfo.xml @@ -15,7 +15,7 @@ </copyright> <mediaobject> <imageobject> - <imagedata fileref="../themes/background.png" width="6.0in"/> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> </imageobject> </mediaobject> <legalnotice> diff --git a/doc/release-notes-1.6.2-docinfo.xml b/doc/release-notes-1.6.2-docinfo.xml new file mode 100644 index 00000000..78206e2a --- /dev/null +++ b/doc/release-notes-1.6.2-docinfo.xml @@ -0,0 +1,29 @@ +<author> + <firstname>Bdale</firstname> + <surname>Garbee</surname> + <email>bdale@gag.com</email> +</author> +<author> + <firstname>Keith</firstname> + <surname>Packard</surname> + <email>keithp@keithp.com</email> +</author> +<date>10 January 2016</date> +<copyright> + <year>2016</year> + <holder>Bdale Garbee and Keith Packard</holder> +</copyright> +<mediaobject> + <imageobject> + <imagedata fileref="altusmetrum-oneline.svg" width="6.0in"/> + </imageobject> +</mediaobject> +<legalnotice> + <para> + This document is released under the terms of the + <ulink url="http://creativecommons.org/licenses/by-sa/3.0/"> + Creative Commons ShareAlike 3.0 + </ulink> + license. + </para> +</legalnotice> diff --git a/doc/release-notes-1.6.2.inc b/doc/release-notes-1.6.2.inc new file mode 100644 index 00000000..990eb48f --- /dev/null +++ b/doc/release-notes-1.6.2.inc @@ -0,0 +1,46 @@ += Release Notes for Version 1.6.2 +:toc!: +:doctype: article + + Version 1.6.2 includes support for our updated TeleMega v2.0 + product and bug fixes in in the flight software for all our boards + and ground station interfaces. + + == AltOS + + AltOS New Features: + + * Add support for TeleMega v2.0 boards. + + * Add PWM servo driver. There's no higher level code using + this yet, but the driver allows testing of the TeleMega v2.0 + servo output connector. + + AltOS Fixes: + + * Slow down telemetry packets to allow receiver to keep + up. + + == AltosUI and TeleGPS Applications + + AltosUI and TeleGPS Fixes: + + * Fix post-flight orientation computation when processing + TeleMega and EasyMega eeprom data files. + + * Capture complete eeprom data even when there are invalid + entries in the data. This keeps reading eeprom contents and + writing the associated .eeprom file when an error is detected. + + == Documentation + + We spent a bunch of time trying to improve our documentation + + * HTML versions now have a table of contents on the left side. + + * EasyMini now has its own shorter manual. + + * Provide links between sections in each document. + + * Lots of minor rewriting and restructuring to avoid + duplication of information diff --git a/doc/release-notes.inc b/doc/release-notes.inc index 70653ed9..a6240d43 100644 --- a/doc/release-notes.inc +++ b/doc/release-notes.inc @@ -2,6 +2,10 @@ == Release Notes :leveloffset: 2 + include::release-notes-1.6.2.raw[] + + <<<< + :leveloffset: 2 include::release-notes-1.6.1.raw[] <<<< diff --git a/doc/telegps-release-notes.inc b/doc/telegps-release-notes.inc index 7a53bd2d..dcdabc05 100644 --- a/doc/telegps-release-notes.inc +++ b/doc/telegps-release-notes.inc @@ -2,6 +2,10 @@ == Release Notes :leveloffset: 2 + include::release-notes-1.6.2.raw[] + + <<<< + :leveloffset: 2 include::release-notes-1.6.1.raw[] <<<< diff --git a/doc/titlepage.templates.tmpl b/doc/titlepage.templates.tmpl index 1669e465..f437fb76 100644 --- a/doc/titlepage.templates.tmpl +++ b/doc/titlepage.templates.tmpl @@ -36,6 +36,8 @@ start-indent="0pt" text-align="center"> + <mediaobject space-before="1em"/> + <title t:named-template="component.title" param:node="ancestor-or-self::article[1]" keep-with-next.within-column="always" @@ -57,17 +59,17 @@ because only the first editor generates the list of editors. <editor t:predicate="[position() = 1]"/> --> - <othercredit space-before="0.5em"/> - <releaseinfo space-before="0.5em"/> - <copyright space-before="0.5em"/> + <othercredit space-before="0.15in"/> + <releaseinfo space-before="0.15in"/> + <copyright space-before="0.15in"/> <legalnotice text-align="start" margin-left="0.5in" margin-right="0.5in" font-family="{$body.fontset}"/> - <pubdate space-before="0.5em"/> - <revision space-before="0.5em"/> - <revhistory space-before="0.5em"/> - <abstract space-before="0.5em" + <pubdate space-before="0.15in"/> + <revision space-before="0.15in"/> + <revhistory space-before="0.15in"/> + <abstract space-before="0.15in" text-align="start" margin-left="0.5in" margin-right="0.5in" @@ -103,7 +105,7 @@ <subtitle font-family="{$title.fontset}" text-align="center"/> - <corpauthor/> + <corpauthor space-before="0.25in"/> <authorgroup/> <author/> <othercredit/> @@ -177,12 +179,12 @@ <editor t:predicate="[position() = 1]"/> --> <othercredit/> - <releaseinfo space-before="0.5em"/> + <releaseinfo space-before="0.15in"/> <pubdate space-before="1em"/> <copyright/> <abstract/> <legalnotice font-size="8pt"/> - <corpauthor text-align="center"/> + <corpauthor text-align="center" space-before="0.5in"/> <revhistory space-before="0.5in"/> </t:titlepage-content> |