← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzr_man.py

  • Committer: Robert Collins
  • Date: 2005-12-02 03:23:47 UTC
  • Revision ID: robertc@robertcollins.net-20051202032347-ba08123207a945a0
Test for Jeff Bailey.

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
 
import os
25
 
import sys
26
 
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
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.help_topics
32
 
import bzrlib.commands
33
 
 
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))
 
31
import re
55
32
 
56
33
 
57
34
def man_escape(string):
58
 
    """Escapes strings for man page compatibility"""
59
35
    result = string.replace("\\","\\\\")
60
36
    result = result.replace("`","\\`")
61
37
    result = result.replace("'","\\'")
63
39
    return result
64
40
 
65
41
 
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 = cmd_object._usage()
85
 
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
86
 
            output = output + tmp
87
 
        else:
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
 
    formatted = {}
96
 
    for cmd_name in command_name_list():
97
 
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
98
 
        if cmd_object.hidden:
99
 
            continue
100
 
        formatted[cmd_name] = format_command(params, cmd_object)
101
 
        for alias in cmd_object.aliases:
102
 
            formatted[alias] = format_alias(params, alias, cmd_name)
103
 
    for cmd_name in sorted(formatted):
104
 
        output += formatted[cmd_name]
105
 
    return output
106
 
 
107
 
 
108
 
def format_command (params, cmd):
109
 
    """Provides long help for each public command"""
110
 
    subsection_header = '.SS "%s"\n' % (cmd._usage())
111
 
    doc = "%s\n" % (cmd.__doc__)
112
 
    doc = bzrlib.help_topics.help_as_plain_text(cmd.help())
113
 
 
114
 
    option_str = ""
115
 
    options = cmd.options()
116
 
    if options:
117
 
        option_str = "\nOptions:\n"
118
 
        for option_name, option in sorted(options.items()):
119
 
            for name, short_name, argname, help in option.iter_switches():
120
 
                if option.is_hidden(name):
121
 
                    continue
122
 
                l = '    --' + name
123
 
                if argname is not None:
124
 
                    l += ' ' + argname
125
 
                if short_name:
126
 
                    l += ', -' + short_name
127
 
                l += (30 - len(l)) * ' ' + (help or '')
128
 
                wrapped = textwrap.fill(l, initial_indent='',
129
 
                    subsequent_indent=30*' ',
130
 
                    break_long_words=False,
131
 
                    )
132
 
                option_str = option_str + wrapped + '\n'       
133
 
 
134
 
    aliases_str = ""
135
 
    if cmd.aliases:
136
 
        if len(cmd.aliases) > 1:
137
 
            aliases_str += '\nAliases: '
138
 
        else:
139
 
            aliases_str += '\nAlias: '
140
 
        aliases_str += ', '.join(cmd.aliases)
141
 
        aliases_str += '\n'
142
 
 
143
 
    see_also_str = ""
144
 
    see_also = cmd.get_see_also()
145
 
    if see_also:
146
 
        see_also_str += '\nSee also: '
147
 
        see_also_str += ', '.join(see_also)
148
 
        see_also_str += '\n'
149
 
 
150
 
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
151
 
 
152
 
 
153
 
def format_alias(params, alias, cmd_name):
154
 
    help = '.SS "bzr %s"\n' % alias
155
 
    help += 'Alias for "%s", see "bzr %s".\n' % (cmd_name, cmd_name)
156
 
    return help
 
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))
157
128
 
158
129
 
159
130
man_preamble = """\
160
 
.\\\"Man page for Bazaar (%(bzrcmd)s)
 
131
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
161
132
.\\\"
162
133
.\\\" Large parts of this file are autogenerated from the output of
163
134
.\\\"     \"%(bzrcmd)s help commands\"
167
138
.\\\"
168
139
"""
169
140
 
170
 
 
 
141
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
 
142
# and is thus (C) Canonical
171
143
man_head = """\
172
 
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
 
144
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
173
145
.SH "NAME"
174
 
%(bzrcmd)s - Bazaar next-generation distributed version control
 
146
%(bzrcmd)s - bazaar-ng next-generation distributed version control
175
147
.SH "SYNOPSIS"
176
148
.B "%(bzrcmd)s"
177
149
.I "command"
186
158
.B "help"
187
159
.I "command"
188
160
.SH "DESCRIPTION"
189
 
Bazaar (or %(bzrcmd)s) is a project of Canonical to develop an free
190
 
distributed version control system that is powerful, friendly, and scalable.
191
 
Version control means a system that keeps track of previous revisions
192
 
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.
193
166
"""
194
167
 
195
168
man_foot = """\
198
171
.I "BZRPATH"
199
172
Path where
200
173
.B "%(bzrcmd)s"
201
 
is to look for shell plugin external commands.
 
174
is to look for external command.
202
175
.TP
203
 
.I "BZR_EMAIL"
204
 
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>"
205
182
.TP
206
183
.I "EMAIL"
207
 
E-Mail address of the user. Overrides default user config.
208
 
.TP
209
 
.I "BZR_EDITOR"
210
 
Editor for editing commit messages
211
 
.TP
212
 
.I "EDITOR"
213
 
Editor for editing commit messages
214
 
.TP
215
 
.I "BZR_PLUGIN_PATH"
216
 
Paths where bzr should look for plugins
217
 
.TP
218
 
.I "BZR_HOME"
219
 
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" .
220
188
.SH "FILES"
221
189
.TP
222
 
.I "~/.bazaar/bazaar.conf"
223
 
Contains the user's default configuration. The section
224
 
.B [DEFAULT]
225
 
is used to define general configuration that will be applied everywhere.
226
 
The section
227
 
.B [ALIASES]
228
 
can be used to create command aliases for
229
 
commonly used options.
230
 
 
231
 
A typical config file might look something like:
232
 
 
233
 
.br
234
 
[DEFAULT]
235
 
.br
236
 
email=John Doe <jdoe@isp.com>
237
 
.br
238
 
[ALIASES]
239
 
.br
240
 
commit = commit --strict
241
 
.br
242
 
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>"
243
198
.SH "SEE ALSO"
244
 
.UR http://bazaar.canonical.com/
245
 
.BR http://bazaar.canonical.com/
 
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/
246
203
"""
247
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