Added new high level TWI packet read/write commands, altered behaviour of the TWI_Sta...

[pub/lufa.git] / LUFA / ManPages / MigrationInformation.txt

diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt
index 489e91a..8f8fbcd 100644 (file)
--- a/LUFA/ManPages/MigrationInformation.txt
+++ b/LUFA/ManPages/MigrationInformation.txt
@@ -11,6 +11,12 @@
  *  areas relevant to making older projects compatible with the API changes of each new release.
  *
  *  \section Sec_MigrationXXXXXX Migrating from 101122 to XXXXXX
+ *  <b>Non-USB Library Components</b>
+ *    - The TWI driver \ref TWI_StartTransmission() function return type has now changed, so that the function returns an
+ *      error code from the \ref TWI_ErrorCodes_t enum instead of a boolean success flag. Existing code must now check
+ *      against the \ref TWI_ERROR_NoError return value for success instead of a boolean true value, or it will not function
+ *      correctly.
+ *
  *  <b>USB Core</b>
  *    - By default, unordered Endpoint and Pipe configuration is now allowed once again, via the previous workaround of
  *      reconfiguring all Endpoints/Pipes in order each time a new Endpoint/Pipe is created. To minimise the compiled program
@@ -43,7 +49,7 @@
  *    - The USB mode specifier constants have been moved into a new enum and renamed. Existing projects should use the equivalent
  *      value in the new \ref USB_Modes_t enum.
  *    - All class driver headers are now included as part of the standard LUFA/Drivers/USB/USB.h master dispatch header, and should
- *      no longer be included seperately. Class driver module source files must still be added as a seperate module in the project's
+ *      no longer be included separately. Class driver module source files must still be added as a separate module in the project's
  *      makefile if used.
  *
  *  <b>Device Mode</b>
@@ -57,7 +63,7 @@
  *      for each class driver for the new class specific descriptor type names.
  *    - The ENDPOINT_DOUBLEBANK_SUPPORTED() macro is has been renamed \ref ENDPOINT_BANKS_SUPPORTED() and now returns the total number of
  *      banks supported by the given endpoint. Existing code should switch to the new naming scheme, and test that the return value of the
- *      macro is equal to or greated than 2 to regain the previous functionality.
+ *      macro is equal to or greater than 2 to regain the previous functionality.
  *    - The EVENT_USB_Device_UnhandledControlRequest() event is now named \ref EVENT_USB_Device_ControlRequest() and fires before (not after)
  *      the internal library event handlers. Existing code should rename the event handlers in the user application to match the new event
  *      name, and should ensure that the new execution order does not affect the application's operation.