summaryrefslogtreecommitdiffstats
path: root/Help/release/dev
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-02-04 15:28:12 (GMT)
committerBrad King <brad.king@kitware.com>2014-02-04 16:48:54 (GMT)
commitccc8704777a42a00dcb4a7d62fcbfa79702a8923 (patch)
tree012566f3954b1c70e4c1052b76fbaf31d8331566 /Help/release/dev
parent70309e7083fa1428d429f4b1fba9441e8765588f (diff)
downloadCMake-ccc8704777a42a00dcb4a7d62fcbfa79702a8923.zip
CMake-ccc8704777a42a00dcb4a7d62fcbfa79702a8923.tar.gz
CMake-ccc8704777a42a00dcb4a7d62fcbfa79702a8923.tar.bz2
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.
Diffstat (limited to 'Help/release/dev')
-rw-r--r--Help/release/dev/0-sample-topic.rst7
1 files changed, 7 insertions, 0 deletions
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.