Minor documentation improvements.
[pub/USBasp.git] / LUFA / DoxygenPages / BuildSystem.txt
index e8f0e5b..7ddfa1b 100644 (file)
@@ -6,14 +6,14 @@
 \r
 /** \page Page_BuildSystem The LUFA Build System\r
  *\r
- *  \section Sec_BuildSystemOverview Overview of the LUFA Build System\r
+ *  \section Sec_BuildSystem_Overview Overview of the LUFA Build System\r
  *  The LUFA build system is an attempt at making a set of re-usable, modular build make files which\r
  *  can be referenced in a LUFA powered project, to minimize the amount of code required in an\r
  *  application makefile. The system is written in GNU Make, and each module is independent 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
+ *  build system, see \ref Sec_CompilingApps_Prerequisites.\r
  *\r
  *  To use a LUFA build system module, simply add an include to your project makefile. All user projects\r
  *  should at a minimum include \ref Page_BuildModule_CORE for base functionality:\r
  *  project's build makefile targets automatically. To call a build target, run <tt>make {TARGET_NAME}</tt>\r
  *  from the command line, substituting in the appropriate target name.\r
  *\r
- *  \see \ref Sec_AppMakefileParams for a copy of the sample LUFA project makefile.\r
+ *  \see \ref Sec_ConfiguringApps_AppMakefileParams for a copy of the sample LUFA project makefile.\r
  *\r
  *  Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i>\r
  *  be supplied in the project makefile for the module to work, and one or more optional parameters which\r
  *  may be defined and which will assume a sensible default if not.\r
  *\r
- *  \section SSec_BuildSystemModules Available Modules\r
+ *  \section SSec_BuildSystem_Modules Available Modules\r
  *\r
  *  The following modules are included in this LUFA release:\r
  *\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>COMPILER_PATH</tt></td>\r
+ *    <td>Directory where the C/C++ toolchain is located, if not available in the system <tt>PATH</tt>.</td>\r
+ *   </tr>\r
+ *   <tr>\r
  *    <td><tt>LD_FLAGS</tt></td>\r
  *    <td>Flags to pass to the linker, after the automatically generated flags.</td>\r
  *   </tr>\r
  *  \section SSec_BuildModule_ATPROGRAM_Requirements Requirements\r
  *  This module requires the <tt>atprogram.exe</tt> utility to be available in your system's <b>PATH</b>\r
  *  variable. The <tt>atprogram.exe</tt> utility is distributed in Atmel AVR Studio 5.x and Atmel Studio 6.x\r
- *  inside the application install folder's "\avrdbg" subdirectory.\r
+ *  inside the application install folder's "\atbackend" subdirectory.\r
  *\r
  *  \section SSec_BuildModule_ATPROGRAM_Targets Targets\r
  *\r
  *\r
  *  The SOURCES LUFA build system module, providing variables listing the various LUFA source files\r
  *  required to be build by a project for a given LUFA module. This module gives a way to reference\r
- *  LUFA source files symbollically, so that changes to the library structure do not break the library\r
+ *  LUFA source files symbolically, so that changes to the library structure do not break the library\r
  *  makefile.\r
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *   <tr>\r
  *    <td>Error &quot;<b><tt>Makefile <i>{X}</i> option must be Y or N</tt></b>&quot; shown when compiling.</td>\r
  *    <td>The specified Makefile value was configured in your project's makefile or on the command line, but was set to a value other than a Y (for "Yes") or "N" (for "No").\r
- *        This configuration option is required to be one of the aformentioned boolean values, and other values are invalid. Set this option to either Y or N and try again.</td>\r
+ *        This configuration option is required to be one of the aforementioned boolean values, and other values are invalid. Set this option to either Y or N and try again.</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>Error &quot;<b><tt>Unknown input source file formats: <i>{X}</i></tt></b>&quot; shown when compiling.</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>Error &quot;<b><tt>unknown MCU '<i>{X}</i>' specified</tt></b>&quot; shown when compiling.</td>\r
- *    <td>The specified micocontroller device model name set in the user application's makefile as the <tt>MCU</tt> parameter is incorrect, or unsupported by the\r
+ *    <td>The specified microcontroller device model name set in the user application's makefile as the <tt>MCU</tt> parameter is incorrect, or unsupported by the\r
  *        version of the compiler being used. Make sure the model name is correct, or upgrade to the latest Atmel Toolchain to obtain newer device support.</td>\r
  *   </tr>\r
  *   <tr>\r