Changes between Version 2 and Version 3 of CMakeLibraryProject

Timestamp:

May 23, 2008, 3:26:05 AM (14 years ago)

Author:

Douglas Gregor

Comment:

Document MODULAR, MAINTAINERS, AUTHORS, and DESCRIPTION options

CMakeLibraryProject

@@ -6 +6 @@
 boost_library_project(libname
                       [SRCDIRS srcdir1 srcdir2 ...] 
-                      [TESTDIRS testdir1 testdir2 ...])
+                      [TESTDIRS testdir1 testdir2 ...]
+                      [DESCRIPTION description]
+                      [AUTHORS author1 author2 ...]
+                      [MAINTAINERS maint1 maint2 ...]
+                      [MODULAR])
 }}}
 
@@ -14 +18 @@
 binaries), and `testdir1`, `testdir2`, etc, are subdirectories
 containing regression tests.
+
+A library marked MODULAR has all of its header files in its own
+subdirectory include/boost rather than the "global" boost
+subdirectory. These libraries can be added or removed from the tree
+freely; they do not need to be a part of the main repository.
+ 
+DESCRIPTION provides a brief description of the library, which can
+be used to summarize the behavior of the library for a user. AUTHORS
+lists the authors of the library, while MAINTAINERS lists the active
+maintainers. If MAINTAINERS is left empty, it is assumed that the 
+authors are still maintaining the library. Both authors and maintainers
+should have their name followed by their current e-mail address in
+angle brackets, with -at- instead of the at sign, e.g.,
+  Douglas Gregor <doug.gregor -at- gmail.com>
 
 For libraries that build actual library binaries, this macro adds a
@@ -33 +51 @@
   Thread
   SRCDIRS src 
-  TESTDIRS test
+  TESTDIRS test 
+  DESCRIPTION "Portable threading"
+  AUTHORS "Anthony Williams <anthony -at- justsoftwaresolutions.co.uk">
   )
 }}}
 
-This example is from [http://svn.boost.org/svn/boost/sandbox-branches/boost-cmake/boost_1_34_0/libs/thread/CMakeLists.txt libs/thread/CMakeLists.txt].
-
 == Where Defined ==
-This macro is defined in the Boost Core module in [http://svn.boost.org/svn/boost/sandbox-branches/boost-cmake/boost_1_34_0/tools/build/CMake/BoostCore.cmake tools/build/CMake/BoostCore.cmake]
+This macro is defined in the Boost Core module in [http://svn.boost.org/svn/boost/sandbox/CMake/release/tools/build/CMake/BoostCore.cmake tools/build/CMake/BoostCore.cmake]