projects / pub / lufa.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update CDC driver INF files so that they should work even on systems without usbser...
[pub/lufa.git] / LUFA / DoxygenPages / BuildSystem.txt
diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt
index 8cce2a5..d50dd7f 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
  *  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
  *  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,10 @@
  *    <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <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
  *    <td><tt>lib</tt></td>\r
  *    <td>Build and archive all source files into a library A binary file.</td>\r
  *   </tr>\r
@@ -93,6 +100,10 @@
  *    <td><tt>clean</tt></td>\r
  *    <td>Remove all intermediatary files and binary output files.</td>\r
  *   </tr>\r
  *    <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
  *  </table>\r
  *\r
  *  \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters\r
@@ -170,11 +181,11 @@
  *   <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
  *   <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
  *  </table>\r
  *\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
  *\r
  *  <table>\r
  *   <tr>\r
@@ -253,7 +264,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </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
  *\r
  *  <table>\r
  *   <tr>\r
@@ -328,7 +339,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </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
  *\r
  *  <table>\r
  *   <tr>\r
@@ -404,7 +415,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </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
  *\r
  *  <table>\r
  *   <tr>\r
@@ -496,7 +507,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </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
  *\r
  *  <table>\r
  *   <tr>\r
@@ -573,7 +584,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </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
  *\r
  *  <table>\r
  *   <tr>\r
@@ -642,7 +653,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </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
  *\r
  *  <table>\r
  *   <tr>\r
@@ -711,7 +722,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </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
  *\r
  *  <table>\r
  *   <tr>\r
@@ -772,7 +783,7 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </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
  *\r
  *  <table>\r
  *   <tr>\r
Lightweight USB Framework for AVRs