[Cmake-commits] CMake branch, next, updated. v2.8.4-1324-gf32e4ff

[Brad King]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMake".

The branch, next has been updated
       via  f32e4ff62d614c1609247453902427b4dc292c09 (commit)
       via  ede46d9d91485c224d4b2ca36c8c864263923eec (commit)
      from  ba026f8e6c14b57dcecddc2108cfa5762e82f1d8 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=f32e4ff62d614c1609247453902427b4dc292c09
commit f32e4ff62d614c1609247453902427b4dc292c09
Merge: ba026f8 ede46d9
Author:     Brad King <brad.king at kitware.com>
AuthorDate: Fri Apr 1 13:49:02 2011 -0400
Commit:     CMake Topic Stage <kwrobot at kitware.com>
CommitDate: Fri Apr 1 13:49:02 2011 -0400

    Merge topic 'module-readme' into next
    
    ede46d9 Modules: Add comment and copyright notice validation to readme.txt


http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=ede46d9d91485c224d4b2ca36c8c864263923eec
commit ede46d9d91485c224d4b2ca36c8c864263923eec
Author:     Brad King <brad.king at kitware.com>
AuthorDate: Fri Apr 1 13:46:36 2011 -0400
Commit:     Brad King <brad.king at kitware.com>
CommitDate: Fri Apr 1 13:46:36 2011 -0400

    Modules: Add comment and copyright notice validation to readme.txt
    
    Document for module authors how to format the copyright notice and
    test it.  Also provide a hint for previewing the module documentation
    formatting.

diff --git a/Modules/readme.txt b/Modules/readme.txt
index dd52000..e2d7f06 100644
--- a/Modules/readme.txt
+++ b/Modules/readme.txt
@@ -64,10 +64,32 @@ For example:
 #  VAR_REALLY_COOL - cool right?
 #
 
+Test the documentation formatting by running "cmake --help-module FindXXX".
+Edit the comments until the output of this command looks satisfactory.
+
 To have a .cmake file in this directory NOT show up in the
 modules documentation, you should start the file with a blank
 line.
 
+After the documentation, leave a *BLANK* line, and then add a
+copyright and licence notice block like this one:
+
+#=============================================================================
+# Copyright 2009-2011 Your Name
+#
+# Distributed under the OSI-approved BSD License (the "License");
+# see accompanying file Copyright.txt for details.
+#
+# This software is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the License for more information.
+#=============================================================================
+# (To distribute this file outside of CMake, substitute the full
+#  License text for the above reference.)
+
+The layout of the notice block is strictly enforced by the ModuleNotices test.
+Only the year range and name may be changed freely.
+
 A FindXXX.cmake module will typically be loaded by the command
 
   FIND_PACKAGE(XXX [major[.minor[.patch[.tweak]]]] [EXACT]

-----------------------------------------------------------------------

Summary of changes:
 Modules/readme.txt |   22 ++++++++++++++++++++++
 1 files changed, 22 insertions(+), 0 deletions(-)


hooks/post-receive
-- 
CMake