← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzr_man.py

Don't encode unicode messages to UTF-8 in mutter() (the stream writer does it).

Use a codec wrapped log file in tests to match the real environment.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzr_man.py
1
 
# Copyright 2005 Canonical Ltd.
 
1
#!/usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 by Hans Ulrich Niedermann
 
4
# Portions Copyright (C) 2005 by Canonical Ltd
2
5
 
3
6
# This program is free software; you can redistribute it and/or modify
4
7
# it under the terms of the GNU General Public License as published by
5
8
# the Free Software Foundation; either version 2 of the License, or
6
9
# (at your option) any later version.
7
 
#
 
10
 
8
11
# This program is distributed in the hope that it will be useful,
9
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
14
# GNU General Public License for more details.
12
 
#
 
15
 
13
16
# You should have received a copy of the GNU General Public License
14
17
# along with this program; if not, write to the Free Software
15
18
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
19
 
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
 
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
 
27
30
import time
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))
 
31
import re
54
32
 
55
33
 
56
34
def man_escape(string):
57
 
    """Escapes strings for man page compatibility"""
58
35
    result = string.replace("\\","\\\\")
59
36
    result = result.replace("`","\\`")
60
37
    result = result.replace("'","\\'")
62
39
    return result
63
40
 
64
41
 
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 = cmd_object._usage()
84
 
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
85
 
            output = output + tmp
86
 
        else:
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' % (cmd._usage())
105
 
    doc = "%s\n" % (cmd.__doc__)
106
 
    doc = cmd.help()
107
 
 
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
 
            for name, short_name, argname, help in option.iter_switches():
114
 
                l = '    --' + name
115
 
                if argname is not None:
116
 
                    l += ' ' + argname
117
 
                if short_name:
118
 
                    assert len(short_name) == 1
119
 
                    l += ', -' + short_name
120
 
                l += (30 - len(l)) * ' ' + (help or '')
121
 
                wrapped = textwrap.fill(l, initial_indent='',
122
 
                                        subsequent_indent=30*' ')
123
 
                option_str = option_str + wrapped + '\n'       
124
 
 
125
 
    aliases_str = ""
126
 
    if cmd.aliases:
127
 
        if len(cmd.aliases) > 1:
128
 
            aliases_str += '\nAliases: '
129
 
        else:
130
 
            aliases_str += '\nAlias: '
131
 
        aliases_str += ', '.join(cmd.aliases)
132
 
        aliases_str += '\n'
133
 
 
134
 
    see_also_str = ""
135
 
    see_also = cmd.get_see_also()
136
 
    if see_also:
137
 
        see_also_str += '\nSee also: '
138
 
        see_also_str += ', '.join(see_also)
139
 
        see_also_str += '\n'
140
 
 
141
 
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
 
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)
 
98
        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))
142
128
 
143
129
 
144
130
man_preamble = """\
145
 
Man page for Bazaar (%(bzrcmd)s)
 
131
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
146
132
.\\\"
147
133
.\\\" Large parts of this file are autogenerated from the output of
148
134
.\\\"     \"%(bzrcmd)s help commands\"
152
138
.\\\"
153
139
"""
154
140
 
155
 
 
 
141
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
 
142
# and is thus (C) Canonical
156
143
man_head = """\
157
 
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
 
144
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
158
145
.SH "NAME"
159
 
Bazaar (%(bzrcmd)s) - next-generation distributed version control
 
146
%(bzrcmd)s - bazaar-ng next-generation distributed version control
160
147
.SH "SYNOPSIS"
161
148
.B "%(bzrcmd)s"
162
149
.I "command"
171
158
.B "help"
172
159
.I "command"
173
160
.SH "DESCRIPTION"
174
 
Bazaar (or %(bzrcmd)s) is a project of Canonical to develop an open source
175
 
distributed version control system that is powerful, friendly, and scalable.
176
 
Version control means a system that keeps track of previous revisions
177
 
of software source code or similar information and helps people work on it in teams.
 
161
bazaar-ng (or
 
162
.B "%(bzrcmd)s"
 
163
) is a project of Canonical to develop an open source distributed version control system that is powerful, friendly, and scalable. Version control means a system that keeps track of previous revisions of software source code or similar information and helps people work on it in teams.
 
164
.SS "Warning"
 
165
bazaar-ng is at an early stage of development, and the design is still changing from week to week. This man page here may be inconsistent with itself, with other documentation or with the code, and sometimes refer to features that are planned but not yet written. Comments are still very welcome; please send them to bazaar-ng@lists.canonical.com.
178
166
"""
179
167
 
180
168
man_foot = """\
183
171
.I "BZRPATH"
184
172
Path where
185
173
.B "%(bzrcmd)s"
186
 
is to look for shell plugin external commands.
 
174
is to look for external command.
187
175
.TP
188
 
.I "BZR_EMAIL"
189
 
E-Mail address of the user. Overrides default user config.
 
176
.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>"
190
182
.TP
191
183
.I "EMAIL"
192
 
E-Mail address of the user. Overrides default user config.
193
 
.TP
194
 
.I "BZR_EDITOR"
195
 
Editor for editing commit messages
196
 
.TP
197
 
.I "EDITOR"
198
 
Editor for editing commit messages
199
 
.TP
200
 
.I "BZR_PLUGIN_PATH"
201
 
Paths where bzr should look for plugins
202
 
.TP
203
 
.I "BZR_HOME"
204
 
Home directory for bzr
 
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" .
205
188
.SH "FILES"
206
189
.TP
207
 
.I "~/.bazaar/bazaar.conf"
208
 
Contains the user's default configuration. The section
209
 
.B [DEFAULT]
210
 
is used to define general configuration that will be applied everywhere.
211
 
The section
212
 
.B [ALIASES]
213
 
can be used to create command aliases for
214
 
commonly used options.
215
 
 
216
 
A typical config file might look something like:
217
 
 
218
 
.br
219
 
[DEFAULT]
220
 
.br
221
 
email=John Doe <jdoe@isp.com>
222
 
.br
223
 
[ALIASES]
224
 
.br
225
 
commit = commit --strict
226
 
.br
227
 
log10 = log --short -r -10..-1
 
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>"
228
198
.SH "SEE ALSO"
229
 
.UR http://www.bazaar-vcs.org/
230
 
.BR http://www.bazaar-vcs.org/
 
199
.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/
231
203
"""
232
204
 
 
205
def main():
 
206
    t = time.time()
 
207
    tt = time.gmtime(t)
 
208
    params = \
 
209
           { "bzrcmd": "bzr",
 
210
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
211
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
212
             "version": bzrlib.__version__,
 
213
             }
 
214
 
 
215
    clp = CommandListParser(params)
 
216
    bzrlib.help.help("commands", outfile=HelpReader(clp))
 
217
    clp.end_parse()
 
218
 
 
219
    filename = "bzr.1"
 
220
    if len(sys.argv) == 2:
 
221
        filename = sys.argv[1]
 
222
    if filename == "-":
 
223
        outfile = sys.stdout
 
224
    else:
 
225
        outfile = open(filename,"w")
 
226
 
 
227
    outfile.write(man_preamble % params)
 
228
    outfile.write(man_escape(man_head % params))
 
229
    clp.write_to_manpage(outfile)
 
230
 
 
231
    # FIXME:
 
232
    #   This doesn't do more than the summary so far.
 
233
    #outfile.write('.SH "DETAILED COMMAND DESCRIPTION"\n')
 
234
    #for (command,usage,descr) in clp.command_usage:
 
235
    #    write_command_details(params, command, usage, descr, outfile = outfile)
 
236
 
 
237
    outfile.write(man_escape(man_foot % params))
 
238
 
 
239
 
 
240
if __name__ == '__main__':
 
241
    main()
 
242
 
 
243
 
 
244
#>>> code by HUN