Minor documentation improvements.

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

diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt
index 7aa357d..8a498a3 100644 (file)
--- a/LUFA/DoxygenPages/BuildSystem.txt
+++ b/LUFA/DoxygenPages/BuildSystem.txt
@@ -6,14 +6,14 @@
 \r
 /** \page Page_BuildSystem The LUFA Build System\r
  *\r
 \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
  *  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
  *\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


@@ -25,13 +25,13 @@
  *  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
  *  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
  *\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
  *\r
  *  The following modules are included in this LUFA release:\r
  *\r


@@ -939,17 +939,6 @@
  *        upgrade to the latest AVR-GCC. If the option is a valid linker option, use the prefix "-Wl," to ensure it is passed to the linker correctly.</td>\r
  *   </tr>\r
  *   <tr>\r
  *        upgrade to the latest AVR-GCC. If the option is a valid linker option, use the prefix "-Wl," to ensure it is passed to the linker correctly.</td>\r
  *   </tr>\r
  *   <tr>\r

- *    <td>Error &quot;<b><tt>avr-gcc: error: unrecognized option '<i>{X}</i>'</tt></b>&quot; shown when compiling.</td>\r
- *    <td>An unrecognised option was supplied to the compiler, usually in the <tt>C_FLAGS</tt>, <tt>CPP_FLAGS</tt>, <tt>ASM_FLAGS</tt> or <tt>CC_FLAGS</tt> configuration\r
- *        options. The nominated compiler switch may be invalid, or unsupported by the version of AVR-GCC on the host system. Remove the unrecognised flag if invalid, or\r
- *        upgrade to the latest AVR-GCC. If the option is a valid linker option, use the prefix "-Wl," to ensure it is passed to the linker correctly.</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td>Error &quot;<b><tt>makefile:{X}: {Y}.mk: No such file or directory</tt></b>&quot; shown when make is invoked.</td>\r
- *    <td>The path to the nominated makefile module was incorrect. This usually indicates that the makefile <tt>LUFA_PATH</tt> option is not set to a valid relative or\r
- *        absolute path to the LUFA library core.</td>\r
- *   </tr>\r
- *   <tr>\r

  *    <td>Error &quot;<b><tt>makefile:{X}: {Y}.mk: No such file or directory</tt></b>&quot; shown when make is invoked.</td>\r
  *    <td>The path to the nominated makefile module was incorrect. This usually indicates that the makefile <tt>LUFA_PATH</tt> option is not set to a valid relative or\r
  *        absolute path to the LUFA library core.</td>\r
  *    <td>Error &quot;<b><tt>makefile:{X}: {Y}.mk: No such file or directory</tt></b>&quot; shown when make is invoked.</td>\r
  *    <td>The path to the nominated makefile module was incorrect. This usually indicates that the makefile <tt>LUFA_PATH</tt> option is not set to a valid relative or\r
  *        absolute path to the LUFA library core.</td>\r


@@ -972,11 +961,6 @@
  *        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
  *        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

- *    <td>Error &quot;<b><tt>error: invalid suffix "x" on integer constant</tt></b>&quot; shown when compiling a bootloader.</td>\r
- *    <td>This is usually caused by the <tt>bc.exe</tt> application not being found in the system's <tt>PATH</tt> variable. Make sure you have the <tt>bc.exe</tt> tool\r
- *        installed correctly (see \ref Sec_Prerequisites).</td>\r
- *   </tr>\r
- *   <tr>\r

  *    <td>Error &quot;<b><tt>undefined reference to `<i>{X}</i>'</tt></b>&quot; shown when compiling.</td>\r
  *    <td>This is usually caused by a missing source file in the user application's <tt>SRC</tt> configuration parameter. If the indicated symbol is one from the LUFA\r
  *        library, you may be missing a LUFA source makefile module (see \ref Page_BuildModule_SOURCES).</td>\r
  *    <td>Error &quot;<b><tt>undefined reference to `<i>{X}</i>'</tt></b>&quot; shown when compiling.</td>\r
  *    <td>This is usually caused by a missing source file in the user application's <tt>SRC</tt> configuration parameter. If the indicated symbol is one from the LUFA\r
  *        library, you may be missing a LUFA source makefile module (see \ref Page_BuildModule_SOURCES).</td>\r