← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzr-man.py

  • Committer: Martin Pool
  • Date: 2005-08-05 19:23:12 UTC
  • Revision ID: mbp@sourcefrog.net-20050805192312-273968b3145cbcf6
- cleanup re-raise of exception

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzr-man.py
1
 
# Copyright (C) 2005-2010 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
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
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
 
from __future__ import absolute_import
25
 
 
26
 
PLUGINS_TO_DOCUMENT = ["launchpad"]
27
 
 
28
 
import textwrap
 
18
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
19
 
 
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
os.unsetenv(REINVOKE)
 
46
 
 
47
import bzrlib, bzrlib.help
 
48
 
 
49
#>>> code taken from bzr (C) Canonical
 
50
 
 
51
#<<< code by HUN
 
52
 
29
53
import time
30
 
 
31
 
import bzrlib
32
 
import bzrlib.help
33
 
import bzrlib.help_topics
34
 
import bzrlib.commands
35
 
 
36
 
from bzrlib.plugin import load_plugins
37
 
load_plugins()
38
 
 
39
 
 
40
 
def get_filename(options):
41
 
    """Provides name of manpage"""
42
 
    return "%s.1" % (options.bzr_name)
43
 
 
44
 
 
45
 
def infogen(options, outfile):
46
 
    """Assembles a man page"""
47
 
    t = time.time()
48
 
    tt = time.gmtime(t)
49
 
    params = \
50
 
           { "bzrcmd": options.bzr_name,
51
 
             "datestamp": time.strftime("%Y-%m-%d",tt),
52
 
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
53
 
             "version": bzrlib.__version__,
54
 
             }
55
 
    outfile.write(man_preamble % params)
56
 
    outfile.write(man_escape(man_head % params))
57
 
    outfile.write(man_escape(getcommand_list(params)))
58
 
    outfile.write(man_escape(getcommand_help(params)))
59
 
    outfile.write("".join(environment_variables()))
60
 
    outfile.write(man_escape(man_foot % params))
 
54
import re
61
55
 
62
56
 
63
57
def man_escape(string):
64
 
    """Escapes strings for man page compatibility"""
65
58
    result = string.replace("\\","\\\\")
66
 
    result = result.replace("`","\\'")
67
 
    result = result.replace("'","\\*(Aq")
 
59
    result = result.replace("`","\\`")
 
60
    result = result.replace("'","\\'")
68
61
    result = result.replace("-","\\-")
69
62
    return result
70
63
 
71
64
 
72
 
def command_name_list():
73
 
    """Builds a list of command names from bzrlib"""
74
 
    command_names = bzrlib.commands.builtin_command_names()
75
 
    for cmdname in bzrlib.commands.plugin_command_names():
76
 
        cmd_object = bzrlib.commands.get_cmd_object(cmdname)
77
 
        if (PLUGINS_TO_DOCUMENT is None or
78
 
            cmd_object.plugin_name() in PLUGINS_TO_DOCUMENT):
79
 
            command_names.append(cmdname)
80
 
    command_names.sort()
81
 
    return command_names
82
 
 
83
 
 
84
 
def getcommand_list (params):
85
 
    """Builds summary help for command names in manpage format"""
86
 
    bzrcmd = params["bzrcmd"]
87
 
    output = '.SH "COMMAND OVERVIEW"\n'
88
 
    for cmd_name in command_name_list():
89
 
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
90
 
        if cmd_object.hidden:
91
 
            continue
92
 
        cmd_help = cmd_object.help()
93
 
        if cmd_help:
94
 
            firstline = cmd_help.split('\n', 1)[0]
95
 
            usage = cmd_object._usage()
96
 
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
97
 
            output = output + tmp
98
 
        else:
99
 
            raise RuntimeError, "Command '%s' has no help text" % (cmd_name)
100
 
    return output
101
 
 
102
 
 
103
 
def getcommand_help(params):
104
 
    """Shows individual options for a bzr command"""
105
 
    output='.SH "COMMAND REFERENCE"\n'
106
 
    formatted = {}
107
 
    for cmd_name in command_name_list():
108
 
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
109
 
        if cmd_object.hidden:
110
 
            continue
111
 
        formatted[cmd_name] = format_command(params, cmd_object)
112
 
        for alias in cmd_object.aliases:
113
 
            formatted[alias] = format_alias(params, alias, cmd_name)
114
 
    for cmd_name in sorted(formatted):
115
 
        output += formatted[cmd_name]
116
 
    return output
117
 
 
118
 
 
119
 
def format_command(params, cmd):
120
 
    """Provides long help for each public command"""
121
 
    subsection_header = '.SS "%s"\n' % (cmd._usage())
122
 
    doc = "%s\n" % (cmd.__doc__)
123
 
    doc = bzrlib.help_topics.help_as_plain_text(cmd.help())
124
 
 
125
 
    # A dot at the beginning of a line is interpreted as a macro.
126
 
    # Simply join lines that begin with a dot with the previous
127
 
    # line to work around this.
128
 
    doc = doc.replace("\n.", ".")
129
 
 
130
 
    option_str = ""
131
 
    options = cmd.options()
132
 
    if options:
133
 
        option_str = "\nOptions:\n"
134
 
        for option_name, option in sorted(options.items()):
135
 
            for name, short_name, argname, help in option.iter_switches():
136
 
                if option.is_hidden(name):
137
 
                    continue
138
 
                l = '    --' + name
139
 
                if argname is not None:
140
 
                    l += ' ' + argname
141
 
                if short_name:
142
 
                    l += ', -' + short_name
143
 
                l += (30 - len(l)) * ' ' + (help or '')
144
 
                wrapped = textwrap.fill(l, initial_indent='',
145
 
                    subsequent_indent=30*' ',
146
 
                    break_long_words=False,
147
 
                    )
148
 
                option_str += wrapped + '\n'
149
 
 
150
 
    aliases_str = ""
151
 
    if cmd.aliases:
152
 
        if len(cmd.aliases) > 1:
153
 
            aliases_str += '\nAliases: '
154
 
        else:
155
 
            aliases_str += '\nAlias: '
156
 
        aliases_str += ', '.join(cmd.aliases)
157
 
        aliases_str += '\n'
158
 
 
159
 
    see_also_str = ""
160
 
    see_also = cmd.get_see_also()
161
 
    if see_also:
162
 
        see_also_str += '\nSee also: '
163
 
        see_also_str += ', '.join(see_also)
164
 
        see_also_str += '\n'
165
 
 
166
 
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
167
 
 
168
 
 
169
 
def format_alias(params, alias, cmd_name):
170
 
    help = '.SS "bzr %s"\n' % alias
171
 
    help += 'Alias for "%s", see "bzr %s".\n' % (cmd_name, cmd_name)
172
 
    return help
173
 
 
174
 
 
175
 
def environment_variables():
176
 
    yield ".SH \"ENVIRONMENT\"\n"
177
 
 
178
 
    from bzrlib.help_topics import known_env_variables
179
 
    for k, desc in known_env_variables:
180
 
        yield ".TP\n"
181
 
        yield ".I \"%s\"\n" % k
182
 
        yield man_escape(desc) + "\n"
 
65
class Parser:
 
66
 
 
67
    def parse_line(self, line):
 
68
        pass
 
69
 
 
70
 
 
71
class CommandListParser(Parser):
 
72
 
 
73
    """Parser for output of "bzr help commands".
 
74
 
 
75
    The parsed content can then be used to
 
76
    - write a "COMMAND OVERVIEW" section into a man page
 
77
    - provide a list of all commands
 
78
    """
 
79
 
 
80
    def __init__(self,params):
 
81
        self.params = params
 
82
        self.command_usage = []
 
83
        self.all_commands = []
 
84
        self.usage_exp = re.compile("([a-z0-9-]+).*")
 
85
        self.descr_exp = re.compile("    ([A-Z].*)\s*")
 
86
        self.state = 0
 
87
        self.command = None
 
88
        self.usage = None
 
89
        self.descr = None
 
90
 
 
91
    def parse_line(self, line):
 
92
        m = self.usage_exp.match(line)
 
93
        if m:
 
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
                self.usage = line
 
99
                self.command = m.groups()[0]
 
100
            else:
 
101
                raise Error, "matching usage line in state %d" % state
 
102
            self.state = 1
 
103
            return
 
104
        m = self.descr_exp.match(line)
 
105
        if m:
 
106
            if self.state == 1:
 
107
                self.descr = m.groups()[0]
 
108
            else:
 
109
                raise Error, "matching descr line in state %d" % state
 
110
            self.state = 0
 
111
            return
 
112
        raise Error, "Cannot parse this line"
 
113
 
 
114
    def end_parse(self):
 
115
        if self.state == 0:
 
116
            if self.usage:
 
117
                self.command_usage.append((self.command,self.usage,self.descr))
 
118
                self.all_commands.append(self.command)
 
119
        else:
 
120
            raise Error, "ending parse in state %d" % state
 
121
 
 
122
    def write_to_manpage(self, outfile):
 
123
        bzrcmd = self.params["bzrcmd"]
 
124
        outfile.write('.SH "COMMAND OVERVIEW"\n')
 
125
        for (command,usage,descr) in self.command_usage:
 
126
            outfile.write('.TP\n.B "%s %s"\n%s\n\n' % (bzrcmd, usage, descr))
 
127
 
 
128
 
 
129
class HelpReader:
 
130
 
 
131
    def __init__(self, parser):
 
132
        self.parser = parser
 
133
 
 
134
    def write(self, data):
 
135
        if data[-1] == '\n':
 
136
            data = data[:-1]
 
137
        for line in data.split('\n'):
 
138
            self.parser.parse_line(line)
 
139
 
 
140
 
 
141
def write_command_details(params, command, usage, descr, outfile):
 
142
    x = ('.SS "%s %s"\n.B "%s"\n.PP\n.B "Usage:"\n%s %s\n\n' %
 
143
         (params["bzrcmd"],
 
144
          command,
 
145
          descr,
 
146
          params["bzrcmd"],
 
147
          usage))
 
148
    outfile.write(man_escape(x))
183
149
 
184
150
 
185
151
man_preamble = """\
186
 
.\\\"Man page for Bazaar (%(bzrcmd)s)
 
152
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
187
153
.\\\"
188
154
.\\\" Large parts of this file are autogenerated from the output of
189
155
.\\\"     \"%(bzrcmd)s help commands\"
190
156
.\\\"     \"%(bzrcmd)s help <cmd>\"
191
157
.\\\"
192
 
 
193
 
.ie \\n(.g .ds Aq \\(aq
194
 
.el .ds Aq '
 
158
.\\\" Generation time: %(timestamp)s
 
159
.\\\"
195
160
"""
196
161
 
197
 
 
 
162
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
 
163
# and is thus (C) Canonical
198
164
man_head = """\
199
 
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
 
165
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
200
166
.SH "NAME"
201
 
%(bzrcmd)s - Bazaar next-generation distributed version control
 
167
%(bzrcmd)s - bazaar-ng next-generation distributed version control
202
168
.SH "SYNOPSIS"
203
169
.B "%(bzrcmd)s"
204
170
.I "command"
213
179
.B "help"
214
180
.I "command"
215
181
.SH "DESCRIPTION"
216
 
 
217
 
Bazaar (or %(bzrcmd)s) is a distributed version control system that is powerful, 
218
 
friendly, and scalable.  Bazaar is a project of Canonical Ltd and part of 
219
 
the GNU Project to develop a free operating system.
220
 
 
221
 
Bazaar keeps track of changes to software source code (or similar information);
222
 
lets you explore who changed it, when, and why; merges concurrent changes; and
223
 
helps people work together in a team.
 
182
bazaar-ng (or
 
183
.B "%(bzrcmd)s"
 
184
) 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.
 
185
.SS "Warning"
 
186
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.
224
187
"""
225
188
 
226
189
man_foot = """\
 
190
.SH "ENVIRONMENT"
 
191
.TP
 
192
.I "BZRPATH"
 
193
Path where
 
194
.B "%(bzrcmd)s"
 
195
is to look for external command.
 
196
 
 
197
.TP
 
198
.I "BZREMAIL"
 
199
E-Mail address of the user. Overrides
 
200
.I "~/.bzr.conf/email" and
 
201
.IR "EMAIL" .
 
202
Example content:
 
203
.I "John Doe <john@example.com>"
 
204
 
 
205
.TP
 
206
.I "EMAIL"
 
207
E-Mail address of the user. Overridden by the content of the file
 
208
.I "~/.bzr.conf/email"
 
209
and of the environment variable
 
210
.IR "BZREMAIL" .
 
211
 
227
212
.SH "FILES"
228
213
.TP
229
 
.I "~/.bazaar/bazaar.conf"
230
 
Contains the user's default configuration. The section
231
 
.B [DEFAULT]
232
 
is used to define general configuration that will be applied everywhere.
233
 
The section
234
 
.B [ALIASES]
235
 
can be used to create command aliases for
236
 
commonly used options.
237
 
 
238
 
A typical config file might look something like:
239
 
 
240
 
.br
241
 
[DEFAULT]
242
 
.br
243
 
email=John Doe <jdoe@isp.com>
244
 
.br
245
 
[ALIASES]
246
 
.br
247
 
commit = commit --strict
248
 
.br
249
 
log10 = log --short -r -10..-1
 
214
.I "~/.bzr.conf/"
 
215
Directory where all the user\'s settings are stored.
 
216
.TP
 
217
.I "~/.bzr.conf/email"
 
218
Stores name and email address of the user. Overrides content of
 
219
.I "EMAIL"
 
220
environment variable. Example content:
 
221
.I "John Doe <john@example.com>"
 
222
 
250
223
.SH "SEE ALSO"
251
 
.UR http://bazaar.canonical.com/
252
 
.BR http://bazaar.canonical.com/
 
224
.UR http://www.bazaar-ng.org/
 
225
.BR http://www.bazaar-ng.org/,
 
226
.UR http://www.bazaar-ng.org/doc/
 
227
.BR http://www.bazaar-ng.org/doc/
253
228
"""
254
229
 
 
230
def main():
 
231
    t = time.time()
 
232
    tt = time.gmtime(t)
 
233
    params = \
 
234
           { "bzrcmd": "bzr",
 
235
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
236
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
237
             "version": bzrlib.__version__,
 
238
             }
 
239
 
 
240
    clp = CommandListParser(params)
 
241
    bzrlib.help.help("commands", outfile=HelpReader(clp))
 
242
    clp.end_parse()
 
243
 
 
244
    filename = "bzr.1"
 
245
    if len(sys.argv) == 2:
 
246
        filename = sys.argv[1]
 
247
    if filename == "-":
 
248
        outfile = sys.stdout
 
249
    else:
 
250
        outfile = open(filename,"w")
 
251
 
 
252
    outfile.write(man_preamble % params)
 
253
    outfile.write(man_escape(man_head % params))
 
254
    clp.write_to_manpage(outfile)
 
255
 
 
256
    # FIXME:
 
257
    #   This doesn't do more than the summary so far.
 
258
    #outfile.write('.SH "DETAILED COMMAND DESCRIPTION"\n')
 
259
    #for (command,usage,descr) in clp.command_usage:
 
260
    #    write_command_details(params, command, usage, descr, outfile = outfile)
 
261
 
 
262
    outfile.write(man_escape(man_foot % params))
 
263
 
 
264
 
 
265
if __name__ == '__main__':
 
266
    main()
 
267
 
 
268
 
 
269
#>>> code by HUN