[Cmake-commits] CMake branch, next, updated. v2.8.12.2-7413-gdec888b
Brad King
brad.king at kitware.com
Tue Feb 4 11:55:22 EST 2014
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 dec888b59e550ef6cbe39583b571c4a867c21cda (commit)
via ccc8704777a42a00dcb4a7d62fcbfa79702a8923 (commit)
via 70309e7083fa1428d429f4b1fba9441e8765588f (commit)
via 34ea1f1520a290fbe19d0f9fbe413f50157120a9 (commit)
from 468279520fae07a9b07c47476ed7080ac2c1d20a (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=dec888b59e550ef6cbe39583b571c4a867c21cda
commit dec888b59e550ef6cbe39583b571c4a867c21cda
Merge: 4682795 ccc8704
Author: Brad King <brad.king at kitware.com>
AuthorDate: Tue Feb 4 11:55:21 2014 -0500
Commit: CMake Topic Stage <kwrobot at kitware.com>
CommitDate: Tue Feb 4 11:55:21 2014 -0500
Merge topic 'release-notes' into next
ccc87047 Help: Add documents to collect notes between releases
70309e70 Help: Add documents for release notes
34ea1f15 Utilities/Sphinx: Add option to build 'text' format
http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=ccc8704777a42a00dcb4a7d62fcbfa79702a8923
commit ccc8704777a42a00dcb4a7d62fcbfa79702a8923
Author: Brad King <brad.king at kitware.com>
AuthorDate: Tue Feb 4 10:28:12 2014 -0500
Commit: Brad King <brad.king at kitware.com>
CommitDate: Tue Feb 4 11:48:54 2014 -0500
Help: Add documents to collect notes between releases
Add a release/dev.txt file and include it from release/index.rst in
development versions. Add a "Changes Since Release" section with a
toctree that globs adjacent "dev/*" documents. Add a sample topic
document explaining how topic-specific release note documents work.
This approach will allow developers to write release notes for their
changes as they are made. The release manager may then consolidate and
organize the notes for a specific release version.
diff --git a/Help/release/dev.txt b/Help/release/dev.txt
new file mode 100644
index 0000000..2cf9193
--- /dev/null
+++ b/Help/release/dev.txt
@@ -0,0 +1,16 @@
+..
+ This file should be included by the adjacent "index.rst"
+ in development versions but not in release versions.
+
+Changes Since Release
+=====================
+
+The following noteworthy changes have been made in this development
+version since the preceding release but have not yet been consolidated
+into notes for a specific release version:
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ dev/*
diff --git a/Help/release/dev/0-sample-topic.rst b/Help/release/dev/0-sample-topic.rst
new file mode 100644
index 0000000..e4cc01e
--- /dev/null
+++ b/Help/release/dev/0-sample-topic.rst
@@ -0,0 +1,7 @@
+0-sample-topic
+--------------
+
+* This is a sample release note for the change in a topic.
+ Developers should add similar notes for each topic branch
+ making a noteworthy change. Each document should be named
+ and titled to match the topic name to avoid merge conflicts.
diff --git a/Help/release/index.rst b/Help/release/index.rst
index 52fedc1..f8367d7 100644
--- a/Help/release/index.rst
+++ b/Help/release/index.rst
@@ -1,6 +1,12 @@
CMake Release Notes
*******************
+..
+ This file should include the adjacent "dev.txt" file
+ in development versions but not in release versions.
+
+.. include:: dev.txt
+
Releases
========
http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=70309e7083fa1428d429f4b1fba9441e8765588f
commit 70309e7083fa1428d429f4b1fba9441e8765588f
Author: Brad King <brad.king at kitware.com>
AuthorDate: Tue Feb 4 10:13:35 2014 -0500
Commit: Brad King <brad.king at kitware.com>
CommitDate: Tue Feb 4 11:15:12 2014 -0500
Help: Add documents for release notes
Add a release/index.rst document titled "CMake Release Notes" to hold
the toctree for release notes. Add a "Release Notes" section to the
top-level html document index to link to the new document.
diff --git a/Help/index.rst b/Help/index.rst
index 7fce223..a4abfbf 100644
--- a/Help/index.rst
+++ b/Help/index.rst
@@ -39,6 +39,16 @@ Reference Manuals
/manual/cmake-toolchains.7
/manual/cmake-variables.7
+.. only:: html or text
+
+ Release Notes
+ #############
+
+ .. toctree::
+ :maxdepth: 1
+
+ /release/index
+
.. only:: html
Index and Search
diff --git a/Help/release/index.rst b/Help/release/index.rst
new file mode 100644
index 0000000..52fedc1
--- /dev/null
+++ b/Help/release/index.rst
@@ -0,0 +1,8 @@
+CMake Release Notes
+*******************
+
+Releases
+========
+
+.. toctree::
+ :maxdepth: 1
http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=34ea1f1520a290fbe19d0f9fbe413f50157120a9
commit 34ea1f1520a290fbe19d0f9fbe413f50157120a9
Author: Brad King <brad.king at kitware.com>
AuthorDate: Tue Feb 4 10:09:40 2014 -0500
Commit: Brad King <brad.king at kitware.com>
CommitDate: Tue Feb 4 10:29:05 2014 -0500
Utilities/Sphinx: Add option to build 'text' format
Add SPHINX_TEXT to enable the Sphinx 'text' builder. Mark it as
advanced and do not add install rules. This is intended for use
by the release manager to build the release notes in text format
suitable for email.
diff --git a/Utilities/Sphinx/CMakeLists.txt b/Utilities/Sphinx/CMakeLists.txt
index c60788f..23dc6ae 100644
--- a/Utilities/Sphinx/CMakeLists.txt
+++ b/Utilities/Sphinx/CMakeLists.txt
@@ -24,12 +24,15 @@ project(CMakeHelp NONE)
option(SPHINX_MAN "Build man pages with Sphinx" OFF)
option(SPHINX_HTML "Build html help with Sphinx" OFF)
+option(SPHINX_TEXT "Build text help with Sphinx (not installed)" OFF)
find_program(SPHINX_EXECUTABLE
NAMES sphinx-build
DOC "Sphinx Documentation Builder (sphinx-doc.org)"
)
-if(NOT SPHINX_MAN AND NOT SPHINX_HTML)
+mark_as_advanced(SPHINX_TEXT)
+
+if(NOT SPHINX_MAN AND NOT SPHINX_HTML AND NOT SPHINX_TEXT)
return()
elseif(NOT SPHINX_EXECUTABLE)
message(FATAL_ERROR "SPHINX_EXECUTABLE (sphinx-build) is not found!")
@@ -57,6 +60,9 @@ endif()
if(SPHINX_MAN)
list(APPEND doc_formats man)
endif()
+if(SPHINX_TEXT)
+ list(APPEND doc_formats text)
+endif()
set(doc_format_outputs "")
set(doc_format_last "")
-----------------------------------------------------------------------
Summary of changes:
Help/index.rst | 10 ++++++++++
Help/release/dev.txt | 16 ++++++++++++++++
Help/release/dev/0-sample-topic.rst | 7 +++++++
Help/release/index.rst | 14 ++++++++++++++
Utilities/Sphinx/CMakeLists.txt | 8 +++++++-
5 files changed, 54 insertions(+), 1 deletion(-)
create mode 100644 Help/release/dev.txt
create mode 100644 Help/release/dev/0-sample-topic.rst
create mode 100644 Help/release/index.rst
hooks/post-receive
--
CMake
More information about the Cmake-commits
mailing list