diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-02-23 07:08:22 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-02-23 07:08:22 +0000 |
| commit | 6a10d6b465be27db090d760dc0fbe722c94e4344 (patch) | |
| tree | 963c02b6e6d6bcafd4dbf0828377d751625d884c /LUFA/BuildingLinkableLibraries.txt | |
| parent | 9991321321d30ca9383d795ea7e796098c92045f (diff) | |
| download | lufa-6a10d6b465be27db090d760dc0fbe722c94e4344.tar.gz lufa-6a10d6b465be27db090d760dc0fbe722c94e4344.tar.bz2 lufa-6a10d6b465be27db090d760dc0fbe722c94e4344.zip | |
Moved all source to the trunk directory.
Diffstat (limited to 'LUFA/BuildingLinkableLibraries.txt')
| -rw-r--r-- | LUFA/BuildingLinkableLibraries.txt | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/LUFA/BuildingLinkableLibraries.txt b/LUFA/BuildingLinkableLibraries.txt new file mode 100644 index 000000000..51fb973b3 --- /dev/null +++ b/LUFA/BuildingLinkableLibraries.txt @@ -0,0 +1,22 @@ +/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/** \page Page_BuildLibrary Building as a Linkable Library
+ *
+ * The LUFA library can be built as a proper linkable library (with the extention .a) under AVR-GCC, so that
+ * the library does not need to be recompiled with each revision of a user project. Instructions for creating
+ * a library from a given source tree can be found in the AVR-GCC user manual included in the WinAVR install
+ * /Docs/ directory.
+ *
+ * However, building the library is <b>not recommended</b>, as the static (compile-time) options will be
+ * unable to be changed without a recompilation of the LUFA code. Therefore, if the library is to be built
+ * from the LUFA source, it should be made to be application-specific and compiled with the static options
+ * that are required for each project (which should be recorded along with the library).
+ *
+ * Normal library use has the library components compiled in at the same point as the application code, as
+ * demonstrated in the library demos and applications. This is the preferred method, as the library is recompiled
+ * each time to ensure that all static options for a particular application are applied.
+ */
|