Extend bootloader build test to include all supported configurations including the...

[pub/USBasp.git] / LUFA / DoxygenPages / BuildSystem.txt

diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt
index 1b26381..c30a88b 100644 (file)
--- a/LUFA/DoxygenPages/BuildSystem.txt
+++ b/LUFA/DoxygenPages/BuildSystem.txt
@@ -17,7 +17,7 @@
  *\r
  *  To use a LUFA build system module, simply add an include to your project makefile:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.core.in\r
+ *  include $(LUFA_PATH)/Build/lufa_core.mk\r
  *  \endcode\r
  *\r
  *  And the associated build module targets will be added to your project's build makefile automatically.\r
@@ -53,7 +53,7 @@
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.build.in\r
+ *  include $(LUFA_PATH)/Build/lufa_build.mk\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_BUILD_Requirements Requirements\r
@@ -155,6 +155,14 @@
  *    <td>Version of the C++ standard to apply when compiling C++ source files (see GCC manual).</td>\r
  *   </tr>\r
  *   <tr>\r
+ *    <td><tt>DEBUG_FORMAT</tt></td>\r
+ *    <td>Format of the debug information to embed in the generated object files (see GCC manual).</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><tt>DEBUG_LEVEL</tt></td>\r
+ *    <td>Level of the debugging information to embed in the generated object files (see GCC manual).</td>\r
+ *   </tr>\r
+ *   <tr>\r
  *    <td><tt>F_CPU</tt></td>\r
  *    <td>Speed of the processor CPU clock, in Hz.</td>\r
  *   </tr>\r
@@ -172,7 +180,7 @@
  *   </tr>\r
  *   <tr>\r
  *    <td><tt>CC_FLAGS</tt></td>\r
- *    <td>Common flags to pass to the compiler, assembler and linker, after the automatically generated flags.</td>\r
+ *    <td>Common flags to pass to the C/C++ compiler and assembler, after the automatically generated flags.</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><tt>LD_FLAGS</tt></td>\r
@@ -181,11 +189,15 @@
  *   <tr>\r
  *    <td><tt>OBJDIR</tt></td>\r
  *    <td>Directory to place the generated object and dependency files. If set to "." the same folder as the source file will be used.\r
- *        \note When this option is enabled, all source filenames must be unique.</td>\r
+ *        \note When this option is enabled, all source filenames <b>must</b> be unique.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><tt>OBJECT_FILES</tt></td>\r
+ *    <td>List of additional object files that should be linked into the resulting binary.</td>\r
  *   </tr>\r
  *  </table>\r
  *\r
- *  \section SSec_BuildModule_BUILD_ProvideVariables Module Provided Variables\r
+ *  \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables\r
  *\r
  *  <table>\r
  *   <tr>\r
@@ -208,7 +220,7 @@
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.core.in\r
+ *  include $(LUFA_PATH)/Build/lufa_core.mk\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_CORE_Requirements Requirements\r
@@ -264,7 +276,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
- *  \section SSec_BuildModule_CORE_ProvideVariables Module Provided Variables\r
+ *  \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables\r
  *\r
  *  <table>\r
  *   <tr>\r
@@ -288,7 +300,7 @@
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.atprogram.in\r
+ *  include $(LUFA_PATH)/Build/lufa_atprogram.mk\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_ATPROGRAM_Requirements Requirements\r
@@ -339,7 +351,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
- *  \section SSec_BuildModule_ATPROGRAM_ProvideVariables Module Provided Variables\r
+ *  \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables\r
  *\r
  *  <table>\r
  *   <tr>\r
@@ -363,7 +375,7 @@
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.avrdude.in\r
+ *  include $(LUFA_PATH)/Build/lufa_avrdude.mk\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_AVRDUDE_Requirements Requirements\r
@@ -415,7 +427,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
- *  \section SSec_BuildModule_AVRDUDE_ProvideVariables Module Provided Variables\r
+ *  \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables\r
  *\r
  *  <table>\r
  *   <tr>\r
@@ -439,7 +451,7 @@
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.cppcheck.in\r
+ *  include $(LUFA_PATH)/Build/lufa_cppcheck.mk\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_CPPCHECK_Requirements Requirements\r
@@ -507,7 +519,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
- *  \section SSec_BuildModule_CPPCHECK_ProvideVariables Module Provided Variables\r
+ *  \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables\r
  *\r
  *  <table>\r
  *   <tr>\r
@@ -533,7 +545,7 @@
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.dfu.in\r
+ *  include $(LUFA_PATH)/Build/lufa_dfu.mk\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_DFU_Requirements Requirements\r
@@ -584,7 +596,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
- *  \section SSec_BuildModule_DFU_ProvideVariables Module Provided Variables\r
+ *  \section SSec_BuildModule_DFU_ProvidedVariables Module Provided Variables\r
  *\r
  *  <table>\r
  *   <tr>\r
@@ -609,7 +621,7 @@
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.doxygen.in\r
+ *  include $(LUFA_PATH)/Build/lufa_doxygen.mk\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_DOXYGEN_Requirements Requirements\r
@@ -653,7 +665,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
- *  \section SSec_BuildModule_DOXYGEN_ProvideVariables Module Provided Variables\r
+ *  \section SSec_BuildModule_DOXYGEN_ProvidedVariables Module Provided Variables\r
  *\r
  *  <table>\r
  *   <tr>\r
@@ -679,7 +691,7 @@
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.hid.in\r
+ *  include $(LUFA_PATH)/Build/lufa_hid.mk\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_HID_Requirements Requirements\r
@@ -696,9 +708,21 @@
  *    <td>Program the device FLASH memory with the application's executable data using <tt>hid_bootloader_cli</tt>.</td>\r
  *   </tr>\r
  *   <tr>\r
- *    <td><tt>hid-teensy</tt></td>\r
+ *    <td><tt>hid-ee</tt></td>\r
+ *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>hid_bootloader_cli</tt> and\r
+ *        a temporary AVR application programmed into the target's FLASH.\r
+ *        \note This will erase the currently loaded application in the target.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><tt>teensy</tt></td>\r
  *    <td>Program the device FLASH memory with the application's executable data using <tt>teensy_loader_cli</tt>.</td>\r
  *   </tr>\r
+ *   <tr>\r
+ *    <td><tt>teensy-ee</tt></td>\r
+ *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>teensy_loader_cli</tt> and\r
+ *        a temporary AVR application programmed into the target's FLASH.\r
+ *        \note This will erase the currently loaded application in the target.</td>\r
+ *   </tr>\r
  *  </table>\r
  *\r
  *  \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters\r
@@ -722,7 +746,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
- *  \section SSec_BuildModule_HID_ProvideVariables Module Provided Variables\r
+ *  \section SSec_BuildModule_HID_ProvidedVariables Module Provided Variables\r
  *\r
  *  <table>\r
  *   <tr>\r
@@ -748,7 +772,7 @@
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.sources.in\r
+ *  include $(LUFA_PATH)/Build/lufa_sources.mk\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_SOURCES_Requirements Requirements\r
@@ -783,7 +807,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
- *  \section SSec_BuildModule_SOURCES_ProvideVariables Module Provided Variables\r
+ *  \section SSec_BuildModule_SOURCES_ProvidedVariables Module Provided Variables\r
  *\r
  *  <table>\r
  *   <tr>\r