← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzr-man.py

merge merge tweaks from aaron, which includes latest .dev

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
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
 
27
54
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))
 
55
import re
54
56
 
55
57
 
56
58
def man_escape(string):
57
 
    """Escapes strings for man page compatibility"""
58
59
    result = string.replace("\\","\\\\")
59
60
    result = result.replace("`","\\`")
60
61
    result = result.replace("'","\\'")
62
63
    return result
63
64
 
64
65
 
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"
 
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 m:
 
95
            if self.state == 0:
 
96
                if self.usage:
 
97
                    self.command_usage.append((self.command,self.usage,self.descr))
 
98
                    self.all_commands.append(self.command)
 
99
                self.usage = line
 
100
                self.command = m.groups()[0]
 
101
            else:
 
102
                raise Error, "matching usage line in state %d" % state
 
103
            self.state = 1
 
104
            return
 
105
        m = self.descr_exp.match(line)
 
106
        if m:
 
107
            if self.state == 1:
 
108
                self.descr = m.groups()[0]
 
109
            else:
 
110
                raise Error, "matching descr line in state %d" % state
 
111
            self.state = 0
 
112
            return
 
113
        raise Error, "Cannot parse this line"
 
114
 
 
115
    def end_parse(self):
 
116
        if self.state == 0:
 
117
            if self.usage:
 
118
                self.command_usage.append((self.command,self.usage,self.descr))
 
119
                self.all_commands.append(self.command)
 
120
        else:
 
121
            raise Error, "ending parse in state %d" % state
 
122
 
 
123
    def write_to_manpage(self, outfile):
 
124
        bzrcmd = self.params["bzrcmd"]
 
125
        outfile.write('.SH "COMMAND OVERVIEW"\n')
 
126
        for (command,usage,descr) in self.command_usage:
 
127
            outfile.write('.TP\n.B "%s %s"\n%s\n\n' % (bzrcmd, usage, descr))
 
128
 
 
129
 
 
130
class HelpReader:
 
131
 
 
132
    def __init__(self, parser):
 
133
        self.parser = parser
 
134
 
 
135
    def write(self, data):
 
136
        if data[-1] == '\n':
 
137
            data = data[:-1]
 
138
        for line in data.split('\n'):
 
139
            self.parser.parse_line(line)
 
140
 
 
141
 
 
142
def write_command_details(params, command, usage, descr, outfile):
 
143
    x = ('.SS "%s %s"\n.B "%s"\n.PP\n.B "Usage:"\n%s %s\n\n' %
 
144
         (params["bzrcmd"],
 
145
          command,
 
146
          descr,
 
147
          params["bzrcmd"],
 
148
          usage))
 
149
    outfile.write(man_escape(x))
142
150
 
143
151
 
144
152
man_preamble = """\
145
 
Man page for Bazaar (%(bzrcmd)s)
 
153
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
146
154
.\\\"
147
155
.\\\" Large parts of this file are autogenerated from the output of
148
156
.\\\"     \"%(bzrcmd)s help commands\"
152
160
.\\\"
153
161
"""
154
162
 
155
 
 
 
163
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
 
164
# and is thus (C) Canonical
156
165
man_head = """\
157
 
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
 
166
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
158
167
.SH "NAME"
159
 
Bazaar (%(bzrcmd)s) - next-generation distributed version control
 
168
%(bzrcmd)s - bazaar-ng next-generation distributed version control
160
169
.SH "SYNOPSIS"
161
170
.B "%(bzrcmd)s"
162
171
.I "command"
171
180
.B "help"
172
181
.I "command"
173
182
.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.
 
183
bazaar-ng (or
 
184
.B "%(bzrcmd)s"
 
185
) 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.
 
186
.SS "Warning"
 
187
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
188
"""
179
189
 
180
190
man_foot = """\
183
193
.I "BZRPATH"
184
194
Path where
185
195
.B "%(bzrcmd)s"
186
 
is to look for shell plugin external commands.
 
196
is to look for external command.
 
197
 
187
198
.TP
188
 
.I "BZR_EMAIL"
189
 
E-Mail address of the user. Overrides default user config.
 
199
.I "BZREMAIL"
 
200
E-Mail address of the user. Overrides
 
201
.I "~/.bzr.conf/email" and
 
202
.IR "EMAIL" .
 
203
Example content:
 
204
.I "John Doe <john@example.com>"
 
205
 
190
206
.TP
191
207
.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
 
208
E-Mail address of the user. Overridden by the content of the file
 
209
.I "~/.bzr.conf/email"
 
210
and of the environment variable
 
211
.IR "BZREMAIL" .
 
212
 
205
213
.SH "FILES"
206
214
.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
 
215
.I "~/.bzr.conf/"
 
216
Directory where all the user\'s settings are stored.
 
217
.TP
 
218
.I "~/.bzr.conf/email"
 
219
Stores name and email address of the user. Overrides content of
 
220
.I "EMAIL"
 
221
environment variable. Example content:
 
222
.I "John Doe <john@example.com>"
 
223
 
228
224
.SH "SEE ALSO"
229
 
.UR http://www.bazaar-vcs.org/
230
 
.BR http://www.bazaar-vcs.org/
 
225
.UR http://www.bazaar-ng.org/
 
226
.BR http://www.bazaar-ng.org/,
 
227
.UR http://www.bazaar-ng.org/doc/
 
228
.BR http://www.bazaar-ng.org/doc/
231
229
"""
232
230
 
 
231
def main():
 
232
    t = time.time()
 
233
    tt = time.gmtime(t)
 
234
    params = \
 
235
           { "bzrcmd": "bzr",
 
236
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
237
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
238
             "version": bzrlib.__version__,
 
239
             }
 
240
 
 
241
    clp = CommandListParser(params)
 
242
    bzrlib.help.help("commands", outfile=HelpReader(clp))
 
243
    clp.end_parse()
 
244
 
 
245
    filename = "bzr.1"
 
246
    if len(sys.argv) == 2:
 
247
        filename = sys.argv[1]
 
248
    if filename == "-":
 
249
        outfile = sys.stdout
 
250
    else:
 
251
        outfile = open(filename,"w")
 
252
 
 
253
    outfile.write(man_preamble % params)
 
254
    outfile.write(man_escape(man_head % params))
 
255
    clp.write_to_manpage(outfile)
 
256
 
 
257
    # FIXME:
 
258
    #   This doesn't do more than the summary so far.
 
259
    #outfile.write('.SH "DETAILED COMMAND DESCRIPTION"\n')
 
260
    #for (command,usage,descr) in clp.command_usage:
 
261
    #    write_command_details(params, command, usage, descr, outfile = outfile)
 
262
 
 
263
    outfile.write(man_escape(man_foot % params))
 
264
 
 
265
 
 
266
if __name__ == '__main__':
 
267
    main()
 
268
 
 
269
 
 
270
#>>> code by HUN