diff options
| author | Brad King <brad.king@kitware.com> | 2014-02-05 14:34:30 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2014-02-05 14:34:30 (GMT) |
| commit | 0bae76b43959e9f96f19101dd673ac6d72736e84 (patch) | |
| tree | fe39baa4563df07a5f1cd8199ec8578fbd2d4e1d /Help | |
| parent | c475b42a66ba5a35e7a84273aca118d5037dd54d (diff) | |
| parent | ccc8704777a42a00dcb4a7d62fcbfa79702a8923 (diff) | |
| download | CMake-0bae76b43959e9f96f19101dd673ac6d72736e84.zip CMake-0bae76b43959e9f96f19101dd673ac6d72736e84.tar.gz CMake-0bae76b43959e9f96f19101dd673ac6d72736e84.tar.bz2 | |
Merge topic 'release-notes'
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
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/index.rst | 10 | ||||
| -rw-r--r-- | Help/release/dev.txt | 16 | ||||
| -rw-r--r-- | Help/release/dev/0-sample-topic.rst | 7 | ||||
| -rw-r--r-- | Help/release/index.rst | 14 |
4 files changed, 47 insertions, 0 deletions
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/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 new file mode 100644 index 0000000..f8367d7 --- /dev/null +++ b/Help/release/index.rst @@ -0,0 +1,14 @@ +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 |