Update documentation

Coverage.cmake

@@ -1,4 +1,7 @@
 # Code coverage reporting
+#   ENABLE_COVERAGE has to be set since code coverage compiler flags
+#   may break downstream projects. Use Buildyard 'make coverage'
+#   target.
 
 option(ENABLE_COVERAGE "Enable code coverage testing" OFF)
 if(ENABLE_COVERAGE)

GNUModules.cmake

@@ -1,8 +1,12 @@
 
 # Copyright (c) 2012-2013 Daniel Nachbaur <daniel.nachbaur@epfl.ch>
 
-# Offers a target named 'module' to create a GNU module
-# (http://modules.sourceforge.net/) of your software.
+# Offers 'module' and 'snapshot' targets to create a GNU module
+# (http://modules.sourceforge.net/) of your software. A regular module
+# requires dependencies to be available as their own modules, whereas
+# a snapshot module contains all dependencies. The first one is meant
+# for full toolchain releases, the second one for intermediate feature
+# snapshots.
 #
 # The GNUModules.cmake is supposed to be included after Common.cmake,
 # CPackConfig.cmake and all targets to gather required variables from

GitTargets.cmake

@@ -5,6 +5,23 @@
 #  GITTARGETS_RELEASE_BRANCH current | even_minor | minor
 #      create tags on the current, the next even minor version (e.g. 1.6) or for
 #      each minor version
+#
+# Targets:
+# * branch: Create a new branch for developing the current version and
+#   push it to origin. The branch is name MAJOR.MINOR, where the minor
+#   version * is rounded up to the next even version. Odd minor
+#   numbers are * considered development versions, and might still be
+#   used when * releasing a pre-release version (e.g., 1.3.9 used for
+#   1.4-beta).
+# * cut: Delete the current version branch locally and remote.
+# * tag: Create the version branch if needed, and create a tag
+#   release-VERSION on the version branch HEAD. Pushes tag to the
+#   origin repository.
+# * erase: Delete the current tag locally and remote
+# * retag: Move an existing tag to HEAD
+# * tarball: Create an archive of LAST_RELEASE
+
+Removes the release-VERSION locally and remotely.
 
 if(GITTARGETS_FOUND)
   return()

README.md

@@ -20,27 +20,31 @@ origin/master version.
 ## Documentation
 
 * [Common](Common.cmake) does a common CMake setup, including:
-    * [BuildLibrary](BuildLibrary.cmake) provides a build_library
-      function to build a shared library using a standard recipe.
-    * **DoxygenRule**: *doxygen* target to build documentation into
-      CMAKE_BINARY_DIR/doc. Optional *github* target to copy result to
-      ../GITHUB_ORGANIZATION/Project-M.m/.
+    * [CommonLibrary](CommonLibrary.cmake) *common_library* function to
+      build a shared library using a standard recipe.
+    * [CommonApplication](CommonApplication.cmake) *common_application*
+      function to build an application using a standard recipe.
     * **GNUModules**: *module* target to create a
-      [GNU module](http://modules.sourceforge.net/). See file for details.
-    * [GitTargets documentation](doc/GitTargets.md)
-    * **UpdateFile**: *update_file* CMake function which uses configure_file
-      but leaves target untouched if unchanged. Uses @ONLY.
-    * **CppcheckTargets**: *cppcheck* target for static code analysis. Also
-      adds all cppcheck targets to tests.
-    * **Compiler**: Compiler flags, useful default warnings and 'safe'
-      C++11 features.
+      [GNUModules](GNUModules.cmake) *module* and *snapshot* targets to
+      create [GNU modules](http://modules.sourceforge.net/).
+    * [GitTargets](GitTargets.cmake) *branch*, *cut*, *tag*, *erase*,
+      *retag*, *tarball* targets.
+    * [UpdateFile]: *update_file* function using configure_file
+      but leaves an unchanged target untouched. Uses @ONLY.
+    * [Compiler](Compiler.cmake): Default compiler flags, useful default
+      warnings and 'safe' C++11 features.
+    * [GitInfo](GitInfo.cmake) sets variables with information about the
+      git source tree.
 * [CommonCTest](CommonCTest.cmake) does a common CTest setup, including
     * Automatically adding all .cpp files as tests
-    * **Coverage**: Create code coverage report as html, if
+    * [Coverage](Coverage.cmake) Create code coverage report as html, if
       ENABLE_COVERAGE is set. Buildyard has 'make Coverage' target to
       enable this in a separate build, since coverage flags may break
       downstream projects.
-    * **CppcheckTargets**: Hook library and executable sources into
-        cppcheck target and add them as unit tests.
-* [DoxygenRule](DoxygenRule.cmake) provides the doxygen and doxygit
-  targets. Must be included after all targets.
+    * [CppcheckTargets](CppcheckTargets.cmake): *cppcheck* target for
+      static code analysis. Also adds all cppcheck targets to tests.
+* [DoxygenRule](DoxygenRule.cmake): *doxygen* target to build
+  documentation into CMAKE_BINARY_DIR/doc. Optional *doxygit* target to
+  copy result to ../GITHUB_ORGANIZATION/Project-M.m/. Must be included
+  after all targets.
+* Find scripts for non-CMake projects.