diff options
Diffstat (limited to 'lib/lufa/LUFA/DoxygenPages/BuildingLinkableLibraries.txt')
| -rw-r--r-- | lib/lufa/LUFA/DoxygenPages/BuildingLinkableLibraries.txt | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/lib/lufa/LUFA/DoxygenPages/BuildingLinkableLibraries.txt b/lib/lufa/LUFA/DoxygenPages/BuildingLinkableLibraries.txt new file mode 100644 index 000000000..cbbae4b8e --- /dev/null +++ b/lib/lufa/LUFA/DoxygenPages/BuildingLinkableLibraries.txt | |||
| @@ -0,0 +1,23 @@ | |||
| 1 | /** \file | ||
| 2 | * | ||
| 3 | * This file contains special DoxyGen information for the generation of the main page and other special | ||
| 4 | * documentation pages. It is not a project source file. | ||
| 5 | */ | ||
| 6 | |||
| 7 | /** \page Page_BuildLibrary Building as a Linkable Library | ||
| 8 | * | ||
| 9 | * The LUFA library can be built as a proper linkable library (with the extension .a) under AVR-GCC, so that | ||
| 10 | * the library does not need to be recompiled with each revision of a user project. Instructions for creating | ||
| 11 | * a library from a given source tree can be found in the AVR-GCC user manual included in the WinAVR install | ||
| 12 | * /Docs/ directory. | ||
| 13 | * | ||
| 14 | * However, building the library is <b>not recommended</b>, as the static (compile-time) options will be | ||
| 15 | * unable to be changed without a recompilation of the LUFA code. Therefore, if the library is to be built | ||
| 16 | * from the LUFA source, it should be made to be application-specific and compiled with the static options | ||
| 17 | * that are required for each project (which should be recorded along with the library). | ||
| 18 | * | ||
| 19 | * Normal library use has the library components compiled in at the same point as the application code, as | ||
| 20 | * demonstrated in the library demos and applications. This is the preferred method, as the library is recompiled | ||
| 21 | * each time to ensure that all static options for a particular application are applied. | ||
| 22 | */ | ||
| 23 | |||
