diff options
| author | Brad King <brad.king@kitware.com> | 2014-02-04 15:28:12 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-02-04 16:48:54 (GMT) |
| commit | ccc8704777a42a00dcb4a7d62fcbfa79702a8923 (patch) | |
| tree | 012566f3954b1c70e4c1052b76fbaf31d8331566 /Help/release/dev.txt | |
| parent | 70309e7083fa1428d429f4b1fba9441e8765588f (diff) | |
| download | CMake-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.txt')
| -rw-r--r-- | Help/release/dev.txt | 16 |
1 files changed, 16 insertions, 0 deletions
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/* |