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.4 <3.4>
   3.3 <3.3>
   3.2 <3.2>
   3.1 <3.1>
   3.0 <3.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.4 development 2015-10-05 17:16:03 +03: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.4 release notes Move all development release notes into a new version-specific document: tail -q -n +3 Help/release/dev/* > Help/release/3.4.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. 2015-10-02 17:16:36 +03:00			`3.4 <3.4>`
Help: Consolidate 3.3 release notes Move all development release notes into a new version-specific document: tail -q -n +3 Help/release/dev/* > Help/release/3.3.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. 2015-06-02 16:09:53 +03:00			`3.3 <3.3>`
Help: Rename 3.x.0 release notes to 3.x In commit v3.0.0-rc1~9 (Help: Rename 3.0 release notes to 3.0.0, 2014-02-19) we anticipated the possibility of bugfix-only release notes. However, in practice we have no release notes for bug fix releases because we do not cover bug fixes in release notes at all, only new features. Instead we've been updating the feature-level release notes document in bug fix releases, treating errors in the document as bugs. It makes more sense to maintain release notes at the feature-release level, so rename the documents accordingly. Also update the document titles and intro text to refer only to feature versions and not bugfix versions. 2015-02-05 17:47:52 +03:00			`3.2 <3.2>`
			`3.1 <3.1>`
			`3.0 <3.0>`