← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/doc_generate/autodoc_man.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-02-18 02:33:47 UTC
  • mfrom: (1534.1.24 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060218023347-0952c65f668bfd68
Merge Robert Collins integration.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_man.py
1
 
#!/usr/bin/python
2
 
 
3
 
# Copyright (C) 2005 by Hans Ulrich Niedermann
4
 
# Portions Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright 2005 Canonical Ltd.
5
2
 
6
3
# This program is free software; you can redistribute it and/or modify
7
4
# it under the terms of the GNU General Public License as published by
17
14
# along with this program; if not, write to the Free Software
18
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
16
 
20
 
#<<< code taken from bzr (C) Canonical
21
 
 
22
 
import os, sys
23
 
 
24
 
try:
25
 
    version_info = sys.version_info
26
 
except AttributeError:
27
 
    version_info = 1, 5 # 1.5 or older
28
 
 
29
 
 
30
 
REINVOKE = "__BZR_REINVOKE"    
31
 
NEED_VERS = (2, 3)
32
 
 
33
 
if version_info < NEED_VERS:
34
 
    if not os.environ.has_key(REINVOKE):
35
 
        # mutating os.environ doesn't work in old Pythons
36
 
        os.putenv(REINVOKE, "1")
37
 
        for python in 'python2.4', 'python2.3':
38
 
            try:
39
 
                os.execvp(python, [python] + sys.argv)
40
 
            except OSError:
41
 
                pass
42
 
    print >>sys.stderr, "bzr-man.py: error: cannot find a suitable python interpreter"
43
 
    print >>sys.stderr, "  (need %d.%d or later)" % NEED_VERS
44
 
    sys.exit(1)
45
 
if hasattr(os, "unsetenv"):
46
 
    os.unsetenv(REINVOKE)
47
 
 
48
 
import bzrlib, bzrlib.help
49
 
 
50
 
#>>> code taken from bzr (C) Canonical
51
 
 
52
 
#<<< code by HUN
53
 
 
 
17
"""man.py - create man page from built-in bzr help and static text
 
18
 
 
19
TODO:
 
20
  * use usage information instead of simple "bzr foo" in COMMAND OVERVIEW
 
21
  * add command aliases
 
22
"""
 
23
 
 
24
import os
 
25
import sys
 
26
import textwrap
54
27
import time
55
 
import re
 
28
 
 
29
import bzrlib
 
30
import bzrlib.help
 
31
import bzrlib.commands
 
32
 
 
33
 
 
34
def get_filename(options):
 
35
    """Provides name of manpage"""
 
36
    return "%s.1" % (options.bzr_name)
 
37
 
 
38
 
 
39
def infogen(options, outfile):
 
40
    """Assembles a man page"""
 
41
    t = time.time()
 
42
    tt = time.gmtime(t)
 
43
    params = \
 
44
           { "bzrcmd": options.bzr_name,
 
45
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
46
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
47
             "version": bzrlib.__version__,
 
48
             }
 
49
    outfile.write(man_preamble % params)
 
50
    outfile.write(man_escape(man_head % params))
 
51
    outfile.write(man_escape(getcommand_list(params)))
 
52
    outfile.write(man_escape(getcommand_help(params)))
 
53
    outfile.write(man_escape(man_foot % params))
56
54
 
57
55
 
58
56
def man_escape(string):
 
57
    """Escapes strings for man page compatibility"""
59
58
    result = string.replace("\\","\\\\")
60
59
    result = result.replace("`","\\`")
61
60
    result = result.replace("'","\\'")
63
62
    return result
64
63
 
65
64
 
66
 
class Parser:
67
 
 
68
 
    def parse_line(self, line):
69
 
        pass
70
 
 
71
 
 
72
 
class CommandListParser(Parser):
73
 
 
74
 
    """Parser for output of "bzr help commands".
75
 
 
76
 
    The parsed content can then be used to
77
 
    - write a "COMMAND OVERVIEW" section into a man page
78
 
    - provide a list of all commands
79
 
    """
80
 
 
81
 
    def __init__(self,params):
82
 
        self.params = params
83
 
        self.command_usage = []
84
 
        self.all_commands = []
85
 
        self.usage_exp = re.compile("([a-z0-9-]+).*")
86
 
        self.descr_exp = re.compile("    ([A-Z].*)\s*")
87
 
        self.state = 0
88
 
        self.command = None
89
 
        self.usage = None
90
 
        self.descr = None
91
 
 
92
 
    def parse_line(self, line):
93
 
        m = self.usage_exp.match(line)
94
 
        if line == '':
95
 
                return
96
 
        if m:
97
 
            if self.state == 0:
98
 
                if self.usage:
99
 
                    self.command_usage.append((self.command,self.usage,self.descr))
100
 
                    self.all_commands.append(self.command)
101
 
                self.usage = " ".join(line.split(" ")[1:])
102
 
                self.command = m.groups()[0]
103
 
            else:
104
 
                raise RuntimeError, "matching usage line in state %d" % state
105
 
            self.state = 1
106
 
            return
107
 
        m = self.descr_exp.match(line)
108
 
        if m:
109
 
            if self.state == 1:
110
 
                self.descr = m.groups()[0]
111
 
            else:
112
 
                raise RuntimeError, "matching descr line in state %d" % state
113
 
            self.state = 0
114
 
            return
115
 
        raise RuntimeError, "Cannot parse this line ('%s')." % line
116
 
 
117
 
    def end_parse(self):
118
 
        if self.state == 0:
119
 
            if self.usage:
120
 
                self.command_usage.append((self.command,self.usage,self.descr))
121
 
                self.all_commands.append(self.command)
 
65
def command_name_list():
 
66
    """Builds a list of command names from bzrlib"""
 
67
    command_names = bzrlib.commands.builtin_command_names()
 
68
    command_names.sort()
 
69
    return command_names
 
70
 
 
71
 
 
72
def getcommand_list (params):
 
73
    """Builds summary help for command names in manpage format"""
 
74
    bzrcmd = params["bzrcmd"]
 
75
    output = '.SH "COMMAND OVERVIEW"\n'
 
76
    for cmd_name in command_name_list():
 
77
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
78
        if cmd_object.hidden:
 
79
            continue
 
80
        cmd_help = cmd_object.help()
 
81
        if cmd_help:
 
82
            firstline = cmd_help.split('\n', 1)[0]
 
83
            usage = bzrlib.help.command_usage(cmd_object)
 
84
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
 
85
            output = output + tmp
122
86
        else:
123
 
            raise RuntimeError, "ending parse in state %d" % state
124
 
 
125
 
    def write_to_manpage(self, outfile):
126
 
        bzrcmd = self.params["bzrcmd"]
127
 
        outfile.write('.SH "COMMAND OVERVIEW"\n')
128
 
        for (command,usage,descr) in self.command_usage:
129
 
            outfile.write('.TP\n.B "%s %s"\n%s\n\n' % (bzrcmd, usage, descr))
130
 
 
131
 
 
132
 
class HelpReader:
133
 
 
134
 
    def __init__(self, parser):
135
 
        self.parser = parser
136
 
 
137
 
    def write(self, data):
138
 
        if data[-1] == '\n':
139
 
            data = data[:-1]
140
 
        for line in data.split('\n'):
141
 
            self.parser.parse_line(line)
142
 
 
143
 
 
144
 
def write_command_details(params, command, usage, descr, outfile):
145
 
    x = ('.SS "%s %s"\n.B "%s"\n.PP\n.B "Usage:"\n%s %s\n\n' %
146
 
         (params["bzrcmd"],
147
 
          command,
148
 
          descr,
149
 
          params["bzrcmd"],
150
 
          usage))
151
 
    outfile.write(man_escape(x))
 
87
            raise RuntimeError, "Command '%s' has no help text" % (cmd_name)
 
88
    return output
 
89
 
 
90
 
 
91
def getcommand_help(params):
 
92
    """Shows individual options for a bzr command"""
 
93
    output='.SH "COMMAND REFERENCE"\n'
 
94
    for cmd_name in command_name_list():
 
95
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
96
        if cmd_object.hidden:
 
97
            continue
 
98
        output = output + format_command(params, cmd_object)
 
99
    return output
 
100
 
 
101
 
 
102
def format_command (params, cmd):
 
103
    """Provides long help for each public command"""
 
104
    subsection_header = '.SS "%s"\n' % (bzrlib.help.command_usage(cmd))
 
105
    doc = "%s\n" % (cmd.__doc__)
 
106
    docsplit = cmd.__doc__.split('\n')
 
107
    doc = '\n'.join([docsplit[0]] + [line[4:] for line in docsplit[1:]])
 
108
    option_str = ""
 
109
    options = cmd.options()
 
110
    if options:
 
111
        option_str = "\nOptions:\n"
 
112
        for option_name, option in sorted(options.items()):
 
113
            l = '    --' + option_name
 
114
            if option.type is not None:
 
115
                l += ' ' + option.argname.upper()
 
116
            short_name = option.short_name()
 
117
            if short_name:
 
118
                assert len(short_name) == 1
 
119
                l += ', -' + short_name
 
120
            l += (30 - len(l)) * ' ' + option.help
 
121
            # TODO: Split help over multiple lines with
 
122
            # correct indenting and wrapping.
 
123
            wrapped = textwrap.fill(l, initial_indent='',
 
124
                                    subsequent_indent=30*' ')
 
125
            option_str = option_str + wrapped + '\n'       
 
126
    return subsection_header + option_str + "\n" + doc + "\n"
152
127
 
153
128
 
154
129
man_preamble = """\
155
 
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
 
130
Man page for %(bzrcmd)s (bazaar-ng)
156
131
.\\\"
157
132
.\\\" Large parts of this file are autogenerated from the output of
158
133
.\\\"     \"%(bzrcmd)s help commands\"
162
137
.\\\"
163
138
"""
164
139
 
165
 
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
166
 
# and is thus (C) Canonical
 
140
 
167
141
man_head = """\
168
142
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
169
143
.SH "NAME"
196
170
Path where
197
171
.B "%(bzrcmd)s"
198
172
is to look for external command.
199
 
 
200
173
.TP
201
174
.I "BZREMAIL"
202
 
E-Mail address of the user. Overrides
203
 
.I "~/.bzr.conf/email" and
204
 
.IR "EMAIL" .
205
 
Example content:
206
 
.I "John Doe <john@example.com>"
207
 
 
 
175
E-Mail address of the user. Overrides default user config.
208
176
.TP
209
177
.I "EMAIL"
210
 
E-Mail address of the user. Overridden by the content of the file
211
 
.I "~/.bzr.conf/email"
212
 
and of the environment variable
213
 
.IR "BZREMAIL" .
214
 
 
 
178
E-Mail address of the user. Overriddes default user config.
215
179
.SH "FILES"
216
180
.TP
217
 
.I "~/.bzr.conf/"
218
 
Directory where all the user\'s settings are stored.
219
 
.TP
220
 
.I "~/.bzr.conf/email"
221
 
Stores name and email address of the user. Overrides content of
222
 
.I "EMAIL"
223
 
environment variable. Example content:
224
 
.I "John Doe <john@example.com>"
225
 
 
 
181
.I "~/.bazaar/bazaar.conf/"
 
182
Contains the default user config. Only one section, [DEFAULT] is allowed. A 
 
183
typical default config file may be similiar to:
 
184
.br
 
185
.br
 
186
.B [DEFAULT]
 
187
.br
 
188
.B email=John Doe <jdoe@isp.com>
226
189
.SH "SEE ALSO"
 
190
.UR http://bazaar.canonical.com/
 
191
.BR http://bazaar.canonical.com/,
227
192
.UR http://www.bazaar-ng.org/
228
 
.BR http://www.bazaar-ng.org/,
229
 
.UR http://www.bazaar-ng.org/doc/
230
 
.BR http://www.bazaar-ng.org/doc/
 
193
.BR http://www.bazaar-ng.org/
231
194
"""
232
195
 
233
 
def main():
234
 
    t = time.time()
235
 
    tt = time.gmtime(t)
236
 
    params = \
237
 
           { "bzrcmd": "bzr",
238
 
             "datestamp": time.strftime("%Y-%m-%d",tt),
239
 
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
240
 
             "version": bzrlib.__version__,
241
 
             }
242
 
 
243
 
    clp = CommandListParser(params)
244
 
    bzrlib.help.help("commands", outfile=HelpReader(clp))
245
 
    clp.end_parse()
246
 
 
247
 
    filename = "bzr.1"
248
 
    if len(sys.argv) == 2:
249
 
        filename = sys.argv[1]
250
 
    if filename == "-":
251
 
        outfile = sys.stdout
252
 
    else:
253
 
        outfile = open(filename,"w")
254
 
 
255
 
    outfile.write(man_preamble % params)
256
 
    outfile.write(man_escape(man_head % params))
257
 
    clp.write_to_manpage(outfile)
258
 
 
259
 
    # FIXME:
260
 
    #   This doesn't do more than the summary so far.
261
 
    #outfile.write('.SH "DETAILED COMMAND DESCRIPTION"\n')
262
 
    #for (command,usage,descr) in clp.command_usage:
263
 
    #    write_command_details(params, command, usage, descr, outfile = outfile)
264
 
 
265
 
    outfile.write(man_escape(man_foot % params))
266
 
 
267
 
 
268
 
if __name__ == '__main__':
269
 
    main()
270
 
 
271
 
 
272
 
#>>> code by HUN