Revert version and update documentation after the 140302 release.
authorDean Camera <dean@fourwalledcubicle.com>
Sat, 1 Mar 2014 10:30:40 +0000 (21:30 +1100)
committerDean Camera <dean@fourwalledcubicle.com>
Sat, 1 Mar 2014 10:30:40 +0000 (21:30 +1100)
LUFA/DoxygenPages/ChangeLog.txt
LUFA/DoxygenPages/KnownIssues.txt
LUFA/DoxygenPages/MigrationInformation.txt
LUFA/Version.h

index 57d0121..a80a4c0 100644 (file)
@@ -6,6 +6,9 @@
 
  /** \page Page_ChangeLog Project Changelog
   *
+  *  \section Sec_ChangeLogXXXXXX Version XXXXXX
+  *  None
+  *
   *  \section Sec_ChangeLog140302 Version 140302
   *  <b>New:</b>
   *  - Library Applications:
index d283b0f..425fb26 100644 (file)
@@ -9,6 +9,38 @@
   *  issues in the library. Most of these issues should be corrected in the future release - see
   *  \ref Page_FutureChanges for a list of planned changes in future releases.
   *
+  *  \section Sec_KnownIssuesXXXXXX Version XXXXXX
+  *  - AVR8 Architecture
+  *    - No known issues.
+  *  - UC3 Architecture
+  *    \warning The UC3 device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only. \n
+  *
+  *    - No demos, bootloaders or projects have been ported for the UC3 devices in the current release,
+  *      although the architecture is supported in the LUFA core library.
+  *    - DMA transfers to and from the USB controller are not yet implemented for this release.
+  *    - The UC3C, UC3D and UC3L sub-families of UC3 are not currently supported by the library due to their
+  *      altered USB controller design.
+  *    - The various \c *_CreateStream() functions for creating standard \c <stdio.h> compatible virtual file
+  *      streams are not available on the UC3 architecture, due to a lack of suitable library support.
+  *  - XMEGA Architecture
+  *    \warning The XMEGA device support is currently <b>experimental</b> (incomplete and/or non-functional), and is included for preview purposes only.
+  *
+  *    - Endpoints of more than 64 bytes are not currently supported in this release.
+  *    - Isochronous endpoints are not currently supported in this release. As a result, the audio class
+  *      cannot be used on XMEGA devices.
+  *    - Multiple-bank endpoints are not currently supported in this release.
+  *    - Early silicon revisions of the ATXMEGA128A1U are incompatible with LUFA, due to their various errata
+  *      relating to the USB controller.
+  *  - Architecture Independent
+  *    - The LUFA library is not watchdog aware, and thus timeouts are possible if short periods are used
+  *      and a lengthy USB operation is initiated.
+  *    - No LUFA provided driver INF files for Windows are signed, and thus may fail to install on systems where driver signing is enforced (e.g. Windows 8).
+  *  - Build System
+  *    - No known issues.
+  *  - Atmel Studio Integration
+  *    - Not all devices are listed in the "Supported Parts" screen when selecting a device. To select an alternative device, change the "Show Device" drop-down to "All Parts".
+  *    - When switching boards after changing the device selection, a second conflicting BOARD symbol definition can be created that prevents successful compilation. To fix, open the project properties window (<i>Project->Project {name} Properties...</i> menu item), click the Toolchain tab, click "Symbols" under the "AVR/GNU C Compiler" section and remove the incorrect definition.
+  *
   *  \section Sec_KnownIssues140302 Version 140302
   *  - AVR8 Architecture
   *    - No known issues.
index cf3cc17..e87fa16 100644 (file)
@@ -10,6 +10,9 @@
  *  to the next version released. It does not indicate all new additions to the library in each version change, only
  *  areas relevant to making older projects compatible with the API changes of each new release.
  *
+ *  \section Sec_MigrationXXXXXX Migrating from 140302 to XXXXXX
+ *  None
+ *
  *  \section Sec_Migration140302 Migrating from 130901 to 140302
  *  <b>USB Core</b>
  *    - The \c VERSION_BCD() macro has changed from accepting one floating point parameter to taking three distinct major/minor/revision integer parameters, as
index d3ee7f3..84c9dd6 100644 (file)
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Indicates the version number of the library, as an integer. */
-                       #define LUFA_VERSION_INTEGER     0x140302
+                       #define LUFA_VERSION_INTEGER     0x000000
 
                        /** Indicates the version number of the library, as a string. */
-                       #define LUFA_VERSION_STRING      "140302"
+                       #define LUFA_VERSION_STRING      "000000"
 
 #endif