← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/generate_release_notes.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-03 05:09:22 UTC
  • mto: (4634.39.1 pdf-chm-docs)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090903050922-ww3c7dk57x8q8dyz
Split Release Notes into topics so easier to navigate and print from chm & html

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/generate_release_notes.py
 
1
#!/usr/bin/python
 
2
 
 
3
# Copyright 2009 Canonical Ltd.
 
4
#
 
5
# This program is free software; you can redistribute it and/or modify
 
6
# it under the terms of the GNU General Public License as published by
 
7
# the Free Software Foundation; either version 2 of the License, or
 
8
# (at your option) any later version.
 
9
#
 
10
# This program is distributed in the hope that it will be useful,
 
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
# GNU General Public License for more details.
 
14
#
 
15
# You should have received a copy of the GNU General Public License
 
16
# along with this program; if not, write to the Free Software
 
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
18
 
 
19
import os
 
20
import sys
 
21
from optparse import OptionParser
 
22
 
 
23
sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
 
24
 
 
25
 
 
26
def split_into_topics(lines, out_file, out_dir):
 
27
    """Split a large NEWS file into topics, one per release.
 
28
 
 
29
    Releases are detected by matching headings that look like
 
30
    release names. Topics are created with matching names
 
31
    replacing spaces with dashes.
 
32
    """
 
33
    topic_file = None
 
34
    for index, line in enumerate(lines):
 
35
        maybe_new_topic = line[:4] in ['bzr ', 'bzr-0',]
 
36
        if maybe_new_topic and lines[index + 1].startswith('####'):
 
37
            release = line.strip()
 
38
            if topic_file is None:
 
39
                # First topic found
 
40
                out_file.write(".. toctree::\n   :maxdepth: 1\n\n")
 
41
            else:
 
42
                # close the current topic
 
43
                topic_file.close()
 
44
            topic_file = open_topic_file(out_file, out_dir, release)
 
45
        elif topic_file:
 
46
            topic_file.write(line)
 
47
        else:
 
48
            # Still in the header - dump content straight to output
 
49
            out_file.write(line)
 
50
 
 
51
 
 
52
def open_topic_file(out_file, out_dir, release):
 
53
    topic_name = release.replace(' ', '-')
 
54
    out_file.write("   %s\n" % (topic_name,))
 
55
    topic_path = os.path.join(out_dir, "%s.txt" % (topic_name,))
 
56
    result = open(topic_path, 'w')
 
57
    result.write("%s\n" % (release,))
 
58
    return result
 
59
 
 
60
 
 
61
def main(argv):
 
62
    # Check usage
 
63
    parser = OptionParser(usage="%prog SOURCE DESTINATION")
 
64
    (options, args) = parser.parse_args(argv)
 
65
    if len(args) != 2:
 
66
        parser.print_help()
 
67
        sys.exit(1)
 
68
 
 
69
    # Open the files and do the work
 
70
    infile_name = args[0]
 
71
    outfile_name = args[1]
 
72
    outdir = os.path.dirname(outfile_name)
 
73
    infile = open(infile_name, 'r')
 
74
    try:
 
75
        lines = infile.readlines()
 
76
    finally:
 
77
        infile.close()
 
78
    outfile = open(outfile_name, 'w')
 
79
    try:
 
80
        split_into_topics(lines, outfile, outdir)
 
81
    finally:
 
82
        outfile.close()
 
83
 
 
84
 
 
85
if __name__ == '__main__':
 
86
    main(sys.argv[1:])