]> git.donarmstrong.com Git - qmk_firmware.git/blob - protocol/lufa/LUFA-120730/LUFA/DoxygenPages/BuildingLinkableLibraries.txt
Squashed 'tmk_core/' content from commit 05caacc
[qmk_firmware.git] / protocol / lufa / LUFA-120730 / LUFA / DoxygenPages / BuildingLinkableLibraries.txt
1 /** \file\r
2  *\r
3  *  This file contains special DoxyGen information for the generation of the main page and other special\r
4  *  documentation pages. It is not a project source file.\r
5  */\r
6 \r
7 /** \page Page_BuildLibrary Building as a Linkable Library\r
8  *\r
9  *  The LUFA library can be built as a proper linkable library (with the extention .a) under AVR-GCC, so that\r
10  *  the library does not need to be recompiled with each revision of a user project. Instructions for creating\r
11  *  a library from a given source tree can be found in the AVR-GCC user manual included in the WinAVR install\r
12  *  /Docs/ directory.\r
13  *\r
14  *  However, building the library is <b>not recommended</b>, as the static (compile-time) options will be\r
15  *  unable to be changed without a recompilation of the LUFA code. Therefore, if the library is to be built\r
16  *  from the LUFA source, it should be made to be application-specific and compiled with the static options\r
17  *  that are required for each project (which should be recorded along with the library).\r
18  *\r
19  *  Normal library use has the library components compiled in at the same point as the application code, as\r
20  *  demonstrated in the library demos and applications. This is the preferred method, as the library is recompiled\r
21  *  each time to ensure that all static options for a particular application are applied.\r
22  */\r
23 \r