X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/b7e3c86e4e5d4262a608163176d0b01c0cc54b29..c93259fbdbfec154b37fd4c3a4e1b43f5b7265e5:/LUFA/DoxygenPages/BuildSystem.txt diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt index 3ecb9459a..57dec5424 100644 --- a/LUFA/DoxygenPages/BuildSystem.txt +++ b/LUFA/DoxygenPages/BuildSystem.txt @@ -15,14 +15,15 @@ * 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: + * To use a LUFA build system module, simply add an include to your project makefile. All user projects + * should at a minimum include \ref Page_BuildModule_CORE for base functionality: * \code * include $(LUFA_PATH)/Build/lufa_core.mk * \endcode * - * And the associated build module targets will be added to your project's build makefile automatically. - * To call a build target, run make {TARGET_NAME} from the command line, substituting in - * the appropriate target name. + * Once included in your project makefile, the associated build module targets will be added to your + * project's build makefile targets automatically. To call a build target, run make {TARGET_NAME} + * from the command line, substituting in the appropriate target name. * * \see \ref Sec_AppConfigParams for a copy of the sample LUFA project makefile. * @@ -49,7 +50,7 @@ * * The BUILD LUFA build system module, providing targets for the compilation, * assembling and linking of an application from source code into binary files - * suitable for programming into a target device. + * suitable for programming into a target device, using the GCC compiler. * * To use this module in your application makefile, add the following code: * \code @@ -57,7 +58,7 @@ * \endcode * * \section SSec_BuildModule_BUILD_Requirements Requirements - * This module requires the the architecture appropriate binaries of the GCC compiler are available in your + * This module requires the the architecture appropriate binaries of the GCC compiler are available in your * system's PATH variable. The GCC compiler and associated toolchain is distributed in Atmel AVR Studio * 5.x and Atmel Studio 6.x installation directories, as well as in many third party distribution packages. * @@ -73,10 +74,6 @@ * Display a size-sorted list of symbols from the compiled application, in decimal bytes. * * - * check-source - * Display a list of input SRC source files which cannot be found (if any). - * - * * lib * Build and archive all source files into a library A binary file. * @@ -104,6 +101,10 @@ * mostlyclean * Remove all intermediatary files but preserve any binary output files. * + * + * <filename>.s + * Create an assembly listing of a given input C/C++ source file. + * * * * \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters @@ -155,6 +156,14 @@ * Version of the C++ standard to apply when compiling C++ source files (see GCC manual). * * + * DEBUG_FORMAT + * Format of the debug information to embed in the generated object files (see GCC manual). + * + * + * DEBUG_LEVEL + * Level of the debugging information to embed in the generated object files (see GCC manual). + * + * * F_CPU * Speed of the processor CPU clock, in Hz. * @@ -172,7 +181,7 @@ * * * CC_FLAGS - * Common flags to pass to the compiler, assembler and linker, after the automatically generated flags. + * Common flags to pass to the C/C++ compiler and assembler, after the automatically generated flags. * * * LD_FLAGS @@ -373,7 +382,7 @@ * \section SSec_BuildModule_AVRDUDE_Requirements Requirements * This module requires the avrdude utility to be available in your system's PATH * variable. The avrdude utility is distributed in the old WinAVR project releases for - * Windows (winavr.sourceforge.net) or can be installed on *nix systems via the project's + * Windows (http://winavr.sourceforge.net) or can be installed on *nix systems via the project's * source code (https://savannah.nongnu.org/projects/avrdude) or through the package manager. * * \section SSec_BuildModule_AVRDUDE_Targets Targets @@ -384,7 +393,7 @@ * Program the device FLASH memory with the application's executable data. * * - * avrdude + * avrdude-ee * Program the device EEPROM memory with the application's EEPROM data. * * @@ -410,11 +419,11 @@ * Name of the programmer or debugger tool to communicate with (e.g. jtagicemkii). * * - * ATPROGRAM_PORT + * AVRDUDE_PORT * Name of the communication port to use when when programming with the connected tool (e.g. COM2, /dev/ttyUSB0 or usb). * * - * ATPROGRAM_FLAGS + * AVRDUDE_FLAGS * Additional flags to pass to avrdude when programming, applied after the automatically generated flags. * * @@ -618,9 +627,9 @@ * * \section SSec_BuildModule_DOXYGEN_Requirements Requirements * This module requires the doxygen utility from the Doxygen website - * (http://www.stack.nl/~dimitri/doxygen/) to be available in your system's PATH - * variable. On *nix systems the doxygen utility can be installed via the project's source - * code or through the package manager. + * (http://www.doxygen.org/) to be available in your system's PATH variable. On *nix + * systems the doxygen utility can be installed via the project's source code or through + * the package manager. * * \section SSec_BuildModule_DOXYGEN_Targets Targets * @@ -629,6 +638,14 @@ * doxygen * Generate project documentation. * + * + * doxygen_create + * Create a new Doxygen configuration file using the latest template. + * + * + * doxygen_upgrade + * Upgrade an existing Doxygen configuration file to the latest template + * * * * \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters