CMake/Help/release/index.rst

CMake Release Notes
*******************

..
  This file should include the adjacent "dev.txt" file
  in development versions but not in release versions.

.. include:: dev.txt

Releases
========

.. toctree::
   :maxdepth: 1

   3.1.0 <3.1.0>
   3.0.0 <3.0.0>
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. 2014-02-04 19:13:35 +04:00			`CMake Release Notes`
			`*******************`

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. 2014-02-04 19:28:12 +04:00			`..`
			`This file should include the adjacent "dev.txt" file`
			`in development versions but not in release versions.`

Begin post-3.1 development 2014-10-14 17:29:53 +04:00			`.. include:: dev.txt`

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. 2014-02-04 19:13:35 +04:00			`Releases`
			`========`

			`.. toctree::`
			`:maxdepth: 1`
Help: Add CMake 3.0 Release Notes Manually read through version control history since the 2.8.12.2 release and write release notes for important user-facing changes. Co-Author: Stephen Kelly <steveire@gmail.com> 2014-02-07 01:40:03 +04:00
Help: Consolidate 3.1 release notes Move all development release notes into a new version-specific document: tail -q -n +3 Help/release/dev/* > Help/release/3.1.0.rst git rm -- Help/release/dev/* except the sample topic: git checkout HEAD -- Help/release/dev/0-sample-topic.rst Reference the new document from the release notes index document. Add a title and intro sentence to the new document by hand. 2014-10-10 23:13:52 +04:00			`3.1.0 <3.1.0>`
Help: Rename 3.0 release notes to 3.0.0 Bug-fix releases 3.0.x may have their own notes so this will look more consistent. 2014-02-19 17:42:01 +04:00			`3.0.0 <3.0.0>`