Fix project makefiles - remove trailing slash from LUFA_PATH entries and the XPLAINBr...

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

diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt
index 0d7d6be..2c42c7d 100644 (file)
--- a/LUFA/DoxygenPages/BuildSystem.txt
+++ b/LUFA/DoxygenPages/BuildSystem.txt
@@ -12,6 +12,9 @@
  *  application makefile. The system is written in GNU Make, and each module is independant of\r
  *  one-another.\r
  *\r
+ *  For details on the prerequisites needed for Linux and Windows machines to be able to use the LUFA\r
+ *  build system, see \ref Sec_Prerequisites.\r
+ *\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
@@ -70,6 +73,14 @@
  *    <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>\r
  *   </tr>\r
  *   <tr>\r
+ *    <td><tt>check-source</tt></td>\r
+ *    <td>Display a list of input SRC source files which cannot be found (if any).</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><tt>lib</tt></td>\r
+ *    <td>Build and archive all source files into a library A binary file.</td>\r
+ *   </tr>\r
+ *   <tr>\r
  *    <td><tt>all</tt></td>\r
  *    <td>Build and link the application into ELF debug and HEX binary files.</td>\r
  *   </tr>\r
@@ -89,6 +100,10 @@
  *    <td><tt>clean</tt></td>\r
  *    <td>Remove all intermediatary files and binary output files.</td>\r
  *   </tr>\r
+ *   <tr>\r
+ *    <td><tt>mostlyclean</tt></td>\r
+ *    <td>Remove all intermediatary files but preserve any binary output files.</td>\r
+ *   </tr>\r
  *  </table>\r
  *\r
  *  \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters\r
@@ -166,11 +181,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
@@ -249,7 +268,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
@@ -324,7 +343,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
@@ -400,7 +419,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
@@ -492,7 +511,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
@@ -518,7 +537,7 @@
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.dfu.in
+ *  include $(LUFA_PATH)/Build/lufa.dfu.in\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_DFU_Requirements Requirements\r
@@ -569,7 +588,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
@@ -638,7 +657,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
@@ -681,8 +700,20 @@
  *    <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-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>hid-teensy</tt></td>\r
- *    <td>Program the device EEPROM memory with the application's executable data using <tt>teensy_loader_cli</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>hid-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
@@ -707,7 +738,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
@@ -768,7 +799,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