← 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

[merge] James Blackwell, Hans Ulrich Niedermann: manpage fixes

Show diffs side-by-side

added added

removed removed

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