Clean up unnecessary CPPCheck static analysis suppression comments, force Doxygen...
[pub/lufa.git] / LUFA / DoxygenPages / BuildSystem.txt
index 1394c21..3ee524b 100644 (file)
@@ -25,7 +25,7 @@
  *  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_AppConfigParams for a copy of the sample LUFA project makefile.\r
+ *  \see \ref Sec_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
  *    <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>Flags to pass to the linker, after the automatically generated flags.</td>\r
  *   </tr>\r
  *   <tr>\r
+ *    <td><tt>LINKER_RELAXATIONS</tt></td>\r
+ *    <td>Enables or disables linker relaxations when linking the application binary. This can reduce the total size\r
+ *        of the application by replacing full \c CALL instructions with smaller \c RCALL instructions where possible.\r
+ *        \note On some unpatched versions of binutils, this can cause link failures in some circumstances. If you\r
+ *              receive a link error <tt>relocation truncated to fit: R_AVR_13_PCREL</tt>, disable this setting.</td>\r
+ *   </tr>\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 <b>must</b> be unique.</td>\r
  *\r
  *  \section SSec_BuildModule_DOXYGEN_Requirements Requirements\r
  *  This module requires the <tt>doxygen</tt> utility from the Doxygen website\r
- *  (<a>http://www.stack.nl/~dimitri/doxygen/</a>) to be available in your system's <b>PATH</b>\r
- *  variable. On *nix systems the <tt>doxygen</tt> utility can be installed via the project's source\r
- *  code or through the package manager.\r
+ *  (<a>http://www.doxygen.org/</a>) to be available in your system's <b>PATH</b> variable. On *nix\r
+ *  systems the <tt>doxygen</tt> utility can be installed via the project's source code or through\r
+ *  the package manager.\r
  *\r
  *  \section SSec_BuildModule_DOXYGEN_Targets Targets\r
  *\r
  *    <td><tt>doxygen</tt></td>\r
  *    <td>Generate project documentation.</td>\r
  *   </tr>\r
+ *   <tr>\r
+ *    <td><tt>doxygen_create</tt></td>\r
+ *    <td>Create a new Doxygen configuration file using the latest template.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><tt>doxygen_upgrade</tt></td>\r
+ *    <td>Upgrade an existing Doxygen configuration file to the latest template</td>\r
+ *   </tr>\r
  *  </table>\r
  *\r
  *  \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters\r