From cd146c650e092dcbf91adf60ef697608c2ac7fa2 Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 15 Mar 2012 08:53:27 -0400 Subject: Document OBJECT library type in add_library command Describe the OBJECT library signature of add_library and the $ expressions needed to use object libraries. Also document the what is not allowed for object library targets. --- Source/cmAddLibraryCommand.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/Source/cmAddLibraryCommand.h b/Source/cmAddLibraryCommand.h index 9ca9cbe..b1ae202 100644 --- a/Source/cmAddLibraryCommand.h +++ b/Source/cmAddLibraryCommand.h @@ -112,6 +112,26 @@ public: "(and its per-configuration version IMPORTED_LOCATION_) " "which specifies the location of the main library file on disk. " "See documentation of the IMPORTED_* properties for more information." + "\n" + "The signature\n" + " add_library( OBJECT ...)\n" + "creates a special \"object library\" target. " + "An object library compiles source files but does not archive or link " + "their object files into a library. " + "Instead other targets created by add_library or add_executable may " + "reference the objects using an expression of the form " + "$ as a source, where \"objlib\" is the " + "object library name. " + "For example:\n" + " add_library(... $ ...)\n" + " add_executable(... $ ...)\n" + "will include objlib's object files in a library and an executable " + "along with those compiled from their own sources. " + "Object libraries may contain only sources (and headers) that compile " + "to object files. " + "They may contain custom commands generating such sources, but not " + "PRE_BUILD, PRE_LINK, or POST_BUILD commands. " + "Object libraries cannot be imported, exported, installed, or linked." ; } -- cgit v0.12