/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to tools/generate_docs.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2019-07-07 19:22:03 UTC
  • mfrom: (7358.8.5 diff-binary-weird)
  • Revision ID: breezy.the.bot@gmail.com-20190707192203-n32v0wih963qdi6i
Don't include datestamps in filenames when reporting on binary files.

Merged from https://code.launchpad.net/~jelmer/brz/diff-binary-weird/+merge/369474

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/generate_docs.py
1
1
#!/usr/bin/python
2
2
 
3
3
# Copyright 2005 Canonical Ltd.
4
 
 
 
4
#
5
5
# This program is free software; you can redistribute it and/or modify
6
6
# it under the terms of the GNU General Public License as published by
7
7
# the Free Software Foundation; either version 2 of the License, or
8
8
# (at your option) any later version.
9
 
 
 
9
#
10
10
# This program is distributed in the hope that it will be useful,
11
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
13
# GNU General Public License for more details.
14
 
 
 
14
#
15
15
# You should have received a copy of the GNU General Public License
16
16
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
 
"""%(prog)s - generate information from built-in bzr help
19
 
 
20
 
%(prog)s creates a file with information on bzr in one of
 
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
18
 
 
19
"""%(prog)s - generate information from built-in brz help
 
20
 
 
21
%(prog)s creates a file with information on brz in one of
21
22
several different output formats:
22
23
 
23
24
    man              man page
24
25
    bash_completion  bash completion script
25
26
    ...
26
27
 
27
 
Examples: 
 
28
Examples:
28
29
 
29
 
    python2.4 generated-docs.py man
30
 
    python2.4 generated-docs.py bash_completion
 
30
    python generated-docs.py man
 
31
    python generated-docs.py bash_completion
31
32
 
32
33
Run "%(prog)s --help" for the option reference.
33
34
"""
34
 
 
 
35
import os
35
36
import sys
36
37
from optparse import OptionParser
37
38
 
38
 
import tools.doc_generate
 
39
sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
 
40
 
 
41
import breezy
 
42
from breezy import (
 
43
    commands,
 
44
    doc_generate,
 
45
    )
 
46
 
39
47
 
40
48
def main(argv):
41
 
    parser = OptionParser(usage="%prog [options] OUTPUT_FORMAT")
 
49
    parser = OptionParser(usage="""%prog [options] OUTPUT_FORMAT
 
50
 
 
51
Available OUTPUT_FORMAT:
 
52
 
 
53
    man              man page
 
54
    rstx             man page in ReStructuredText format
 
55
    bash_completion  bash completion script""")
42
56
 
43
57
    parser.add_option("-s", "--show-filename",
44
58
                      action="store_true", dest="show_filename", default=False,
47
61
    parser.add_option("-o", "--output", dest="filename", metavar="FILE",
48
62
                      help="write output to FILE")
49
63
 
50
 
    parser.add_option("-b", "--bzr-name",
51
 
                      dest="bzr_name", default="bzr", metavar="EXEC_NAME",
52
 
                      help="name of bzr executable")
 
64
    parser.add_option("-b", "--brz-name",
 
65
                      dest="brz_name", default="brz", metavar="EXEC_NAME",
 
66
                      help="name of brz executable")
53
67
 
54
68
    parser.add_option("-e", "--examples",
55
69
                      action="callback", callback=print_extended_help,
62
76
        parser.print_help()
63
77
        sys.exit(1)
64
78
 
65
 
    infogen_type = args[1]
66
 
    infogen_mod = tools.doc_generate.get_module(infogen_type)
67
 
 
68
 
    if options.filename:
69
 
        outfilename = options.filename
70
 
    else:
71
 
        outfilename = infogen_mod.get_filename(options)
72
 
 
73
 
    if outfilename == "-":
74
 
        outfile = sys.stdout
75
 
    else:
76
 
        outfile = open(outfilename,"w")
77
 
 
78
 
    if options.show_filename and (outfilename != "-"):
79
 
        print >>sys.stdout, outfilename
80
 
    
81
 
    infogen_mod.infogen(options, outfile)
 
79
    with breezy.initialize():
 
80
        # Import breezy.bzr for format registration, see <http://pad.lv/956860>
 
81
        from breezy import bzr as _
 
82
        commands.install_bzr_command_hooks()
 
83
        infogen_type = args[1]
 
84
        infogen_mod = doc_generate.get_module(infogen_type)
 
85
        if options.filename:
 
86
            outfilename = options.filename
 
87
        else:
 
88
            outfilename = infogen_mod.get_filename(options)
 
89
        if outfilename == "-":
 
90
            outfile = sys.stdout
 
91
        else:
 
92
            outfile = open(outfilename, "w")
 
93
        if options.show_filename and (outfilename != "-"):
 
94
            sys.stdout.write(outfilename)
 
95
            sys.stdout.write('\n')
 
96
        infogen_mod.infogen(options, outfile)
 
97
 
82
98
 
83
99
def print_extended_help(option, opt, value, parser):
84
100
    """ Program help examples
85
101
 
86
 
    Prints out the examples stored in the docstring. 
 
102
    Prints out the examples stored in the docstring.
87
103
 
88
104
    """
89
 
    print >>sys.stdout, __doc__ % {"prog":sys.argv[0]}
 
105
    sys.stdout.write(__doc__ % {"prog": sys.argv[0]})
 
106
    sys.stdout.write('\n')
90
107
    sys.exit(0)
91
108
 
92
109
if __name__ == '__main__':