X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/393fc71d8e82f4be67fac7f7f33538b92555b4f9..b7e3c86e4e5d4262a608163176d0b01c0cc54b29:/LUFA/DoxygenPages/BuildSystem.txt

diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt
index 0d7d6be74..3ecb9459a 100644
--- a/LUFA/DoxygenPages/BuildSystem.txt
+++ b/LUFA/DoxygenPages/BuildSystem.txt
@@ -12,9 +12,12 @@
  *  application makefile. The system is written in GNU Make, and each module is independant of
  *  one-another.
  *
+ *  For details on the prerequisites needed for Linux and Windows machines to be able to use the LUFA
+ *  build system, see \ref Sec_Prerequisites.
+ *
  *  To use a LUFA build system module, simply add an include to your project makefile:
  *  \code
- *  include $(LUFA_PATH)/Build/lufa.core.in
+ *  include $(LUFA_PATH)/Build/lufa_core.mk
  *  \endcode
  *
  *  And the associated build module targets will be added to your project's build makefile automatically.
@@ -50,7 +53,7 @@
  *
  *  To use this module in your application makefile, add the following code:
  *  \code
- *  include $(LUFA_PATH)/Build/lufa.build.in
+ *  include $(LUFA_PATH)/Build/lufa_build.mk
  *  \endcode
  *
  *  \section SSec_BuildModule_BUILD_Requirements Requirements
@@ -70,6 +73,14 @@
  *    <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>
  *   </tr>
  *   <tr>
+ *    <td><tt>check-source</tt></td>
+ *    <td>Display a list of input SRC source files which cannot be found (if any).</td>
+ *   </tr>
+ *   <tr>
+ *    <td><tt>lib</tt></td>
+ *    <td>Build and archive all source files into a library A binary file.</td>
+ *   </tr>
+ *   <tr>
  *    <td><tt>all</tt></td>
  *    <td>Build and link the application into ELF debug and HEX binary files.</td>
  *   </tr>
@@ -89,6 +100,10 @@
  *    <td><tt>clean</tt></td>
  *    <td>Remove all intermediatary files and binary output files.</td>
  *   </tr>
+ *   <tr>
+ *    <td><tt>mostlyclean</tt></td>
+ *    <td>Remove all intermediatary files but preserve any binary output files.</td>
+ *   </tr>
  *  </table>
  *
  *  \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters
@@ -166,11 +181,15 @@
  *   <tr>
  *    <td><tt>OBJDIR</tt></td>
  *    <td>Directory to place the generated object and dependency files. If set to "." the same folder as the source file will be used.
- *        \note When this option is enabled, all source filenames must be unique.</td>
+ *        \note When this option is enabled, all source filenames <b>must</b> be unique.</td>
+ *   </tr>
+ *   <tr>
+ *    <td><tt>OBJECT_FILES</tt></td>
+ *    <td>List of additional object files that should be linked into the resulting binary.</td>
  *   </tr>
  *  </table>
  *
- *  \section SSec_BuildModule_BUILD_ProvideVariables Module Provided Variables
+ *  \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables
  *
  *  <table>
  *   <tr>
@@ -193,7 +212,7 @@
  *
  *  To use this module in your application makefile, add the following code:
  *  \code
- *  include $(LUFA_PATH)/Build/lufa.core.in
+ *  include $(LUFA_PATH)/Build/lufa_core.mk
  *  \endcode
  *
  *  \section SSec_BuildModule_CORE_Requirements Requirements
@@ -249,7 +268,7 @@
  *   </tr>
  *  </table>
  *
- *  \section SSec_BuildModule_CORE_ProvideVariables Module Provided Variables
+ *  \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables
  *
  *  <table>
  *   <tr>
@@ -273,7 +292,7 @@
  *
  *  To use this module in your application makefile, add the following code:
  *  \code
- *  include $(LUFA_PATH)/Build/lufa.atprogram.in
+ *  include $(LUFA_PATH)/Build/lufa_atprogram.mk
  *  \endcode
  *
  *  \section SSec_BuildModule_ATPROGRAM_Requirements Requirements
@@ -324,7 +343,7 @@
  *   </tr>
  *  </table>
  *
- *  \section SSec_BuildModule_ATPROGRAM_ProvideVariables Module Provided Variables
+ *  \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables
  *
  *  <table>
  *   <tr>
@@ -348,7 +367,7 @@
  *
  *  To use this module in your application makefile, add the following code:
  *  \code
- *  include $(LUFA_PATH)/Build/lufa.avrdude.in
+ *  include $(LUFA_PATH)/Build/lufa_avrdude.mk
  *  \endcode
  *
  *  \section SSec_BuildModule_AVRDUDE_Requirements Requirements
@@ -400,7 +419,7 @@
  *   </tr>
  *  </table>
  *
- *  \section SSec_BuildModule_AVRDUDE_ProvideVariables Module Provided Variables
+ *  \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables
  *
  *  <table>
  *   <tr>
@@ -424,7 +443,7 @@
  *
  *  To use this module in your application makefile, add the following code:
  *  \code
- *  include $(LUFA_PATH)/Build/lufa.cppcheck.in
+ *  include $(LUFA_PATH)/Build/lufa_cppcheck.mk
  *  \endcode
  *
  *  \section SSec_BuildModule_CPPCHECK_Requirements Requirements
@@ -492,7 +511,7 @@
  *   </tr>
  *  </table>
  *
- *  \section SSec_BuildModule_CPPCHECK_ProvideVariables Module Provided Variables
+ *  \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables
  *
  *  <table>
  *   <tr>
@@ -518,7 +537,7 @@
  *
  *  To use this module in your application makefile, add the following code:
  *  \code
- *  include $(LUFA_PATH)/Build/lufa.dfu.in
+ *  include $(LUFA_PATH)/Build/lufa_dfu.mk
  *  \endcode
  *
  *  \section SSec_BuildModule_DFU_Requirements Requirements
@@ -569,7 +588,7 @@
  *   </tr>
  *  </table>
  *
- *  \section SSec_BuildModule_DFU_ProvideVariables Module Provided Variables
+ *  \section SSec_BuildModule_DFU_ProvidedVariables Module Provided Variables
  *
  *  <table>
  *   <tr>
@@ -594,7 +613,7 @@
  *
  *  To use this module in your application makefile, add the following code:
  *  \code
- *  include $(LUFA_PATH)/Build/lufa.doxygen.in
+ *  include $(LUFA_PATH)/Build/lufa_doxygen.mk
  *  \endcode
  *
  *  \section SSec_BuildModule_DOXYGEN_Requirements Requirements
@@ -638,7 +657,7 @@
  *   </tr>
  *  </table>
  *
- *  \section SSec_BuildModule_DOXYGEN_ProvideVariables Module Provided Variables
+ *  \section SSec_BuildModule_DOXYGEN_ProvidedVariables Module Provided Variables
  *
  *  <table>
  *   <tr>
@@ -664,7 +683,7 @@
  *
  *  To use this module in your application makefile, add the following code:
  *  \code
- *  include $(LUFA_PATH)/Build/lufa.hid.in
+ *  include $(LUFA_PATH)/Build/lufa_hid.mk
  *  \endcode
  *
  *  \section SSec_BuildModule_HID_Requirements Requirements
@@ -681,8 +700,20 @@
  *    <td>Program the device FLASH memory with the application's executable data using <tt>hid_bootloader_cli</tt>.</td>
  *   </tr>
  *   <tr>
- *    <td><tt>hid-teensy</tt></td>
- *    <td>Program the device EEPROM memory with the application's executable data using <tt>teensy_loader_cli</tt>.</td>
+ *    <td><tt>hid-ee</tt></td>
+ *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>hid_bootloader_cli</tt> and
+ *        a temporary AVR application programmed into the target's FLASH.
+ *        \note This will erase the currently loaded application in the target.</td>
+ *   </tr>
+ *   <tr>
+ *    <td><tt>teensy</tt></td>
+ *    <td>Program the device FLASH memory with the application's executable data using <tt>teensy_loader_cli</tt>.</td>
+ *   </tr>
+ *   <tr>
+ *    <td><tt>teensy-ee</tt></td>
+ *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>teensy_loader_cli</tt> and
+ *        a temporary AVR application programmed into the target's FLASH.
+ *        \note This will erase the currently loaded application in the target.</td>
  *   </tr>
  *  </table>
  *
@@ -707,7 +738,7 @@
  *   </tr>
  *  </table>
  *
- *  \section SSec_BuildModule_HID_ProvideVariables Module Provided Variables
+ *  \section SSec_BuildModule_HID_ProvidedVariables Module Provided Variables
  *
  *  <table>
  *   <tr>
@@ -733,7 +764,7 @@
  *
  *  To use this module in your application makefile, add the following code:
  *  \code
- *  include $(LUFA_PATH)/Build/lufa.sources.in
+ *  include $(LUFA_PATH)/Build/lufa_sources.mk
  *  \endcode
  *
  *  \section SSec_BuildModule_SOURCES_Requirements Requirements
@@ -768,7 +799,7 @@
  *   </tr>
  *  </table>
  *
- *  \section SSec_BuildModule_SOURCES_ProvideVariables Module Provided Variables
+ *  \section SSec_BuildModule_SOURCES_ProvidedVariables Module Provided Variables
  *
  *  <table>
  *   <tr>