← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzr_man.py

ignore BRANCH-INFO file

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
 
 
190
 
Bazaar (or %(bzrcmd)s) is a distributed version control system that is powerful, 
191
 
friendly, and scalable.  Bazaar is a project of Canonical Ltd and part of 
192
 
the GNU Project to develop a free operating system.
193
 
 
194
 
Bazaar keeps track of changes to software source code (or similar information);
195
 
lets you explore who changed it, when, and why; merges concurrent changes; and
196
 
helps people work together in a team.
 
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.
197
166
"""
198
167
 
199
168
man_foot = """\
 
169
.SH "EXAMPLES"
 
170
See
 
171
.UR http://bazaar.canonical.com/IntroductionToBzr
 
172
.BR http://bazaar.canonical.com/IntroductionToBzr
200
173
.SH "ENVIRONMENT"
201
174
.TP
 
175
.I "BZR_HOME"
 
176
Per-user \'home\' directory. Default on Unix like systems is
 
177
.I "~"
 
178
.TP
202
179
.I "BZRPATH"
203
180
Path where
204
181
.B "%(bzrcmd)s"
205
 
is to look for shell plugin external commands.
 
182
is to look for external command.
206
183
.TP
207
 
.I "BZR_EMAIL"
208
 
E-Mail address of the user. Overrides default user config.
 
184
.I "BZREMAIL"
 
185
E-Mail address of the user. Overrides settings from
 
186
.I "~/.bazaar/bazaar.conf" and
 
187
.IR "EMAIL" .
 
188
Example content:
 
189
  John Doe <john@example.com>
209
190
.TP
210
191
.I "EMAIL"
211
 
E-Mail address of the user. Overrides default user config.
212
 
.TP
213
 
.I "BZR_EDITOR"
214
 
Editor for editing commit messages
215
 
.TP
216
 
.I "EDITOR"
217
 
Editor for editing commit messages
218
 
.TP
219
 
.I "BZR_PLUGIN_PATH"
220
 
Paths where bzr should look for plugins
221
 
.TP
222
 
.I "BZR_HOME"
223
 
Home directory for bzr
 
192
E-Mail address of the user. Overridden by the settings in the file
 
193
.I "~/.bazaar/bazaar.conf"
 
194
and of the environment variable
 
195
.IR "BZREMAIL" .
224
196
.SH "FILES"
225
197
.TP
 
198
.I "~/.bazaar/"
 
199
Directory where all the user\'s settings are stored.
 
200
.TP
226
201
.I "~/.bazaar/bazaar.conf"
227
 
Contains the user's default configuration. The section
228
 
.B [DEFAULT]
229
 
is used to define general configuration that will be applied everywhere.
230
 
The section
231
 
.B [ALIASES]
232
 
can be used to create command aliases for
233
 
commonly used options.
234
 
 
235
 
A typical config file might look something like:
236
 
 
237
 
.br
238
 
[DEFAULT]
239
 
.br
240
 
email=John Doe <jdoe@isp.com>
241
 
.br
242
 
[ALIASES]
243
 
.br
244
 
commit = commit --strict
245
 
.br
246
 
log10 = log --short -r -10..-1
 
202
Stores default settings like name and email address of the
 
203
user. Settings in this file override the content of
 
204
.I "EMAIL"
 
205
environment variable. Example content:
 
206
 
 
207
  [DEFAULT]
 
208
  email=John Doe <john@example.com>
 
209
  editor=/usr/bin/vim
 
210
  check_signatures=check-available
 
211
  create_signatures=when-required
 
212
 
247
213
.SH "SEE ALSO"
248
 
.UR http://bazaar.canonical.com/
249
 
.BR http://bazaar.canonical.com/
 
214
.UR http://www.bazaar-ng.org/
 
215
.BR http://www.bazaar-ng.org/,
 
216
.UR http://www.bazaar-ng.org/doc/
 
217
.BR http://www.bazaar-ng.org/doc/,
 
218
.UR http://bazaar.canonical.com/BzrDocumentation
 
219
.BR http://bazaar.canonical.com/BzrDocumentation
250
220
"""
251
221
 
 
222
def main():
 
223
    t = time.time()
 
224
    tt = time.gmtime(t)
 
225
    params = \
 
226
           { "bzrcmd": "bzr",
 
227
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
228
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
229
             "version": bzrlib.__version__,
 
230
             }
 
231
 
 
232
    clp = CommandListParser(params)
 
233
    bzrlib.help.help("commands", outfile=HelpReader(clp))
 
234
    clp.end_parse()
 
235
 
 
236
    filename = "bzr.1"
 
237
    if len(sys.argv) == 2:
 
238
        filename = sys.argv[1]
 
239
    if filename == "-":
 
240
        outfile = sys.stdout
 
241
    else:
 
242
        outfile = open(filename,"w")
 
243
 
 
244
    outfile.write(man_preamble % params)
 
245
    outfile.write(man_escape(man_head % params))
 
246
    clp.write_to_manpage(outfile)
 
247
 
 
248
    # FIXME:
 
249
    #   This doesn't do more than the summary so far.
 
250
    #outfile.write('.SH "DETAILED COMMAND DESCRIPTION"\n')
 
251
    #for (command,usage,descr) in clp.command_usage:
 
252
    #    write_command_details(params, command, usage, descr, outfile = outfile)
 
253
 
 
254
    outfile.write(man_escape(man_foot % params))
 
255
 
 
256
 
 
257
if __name__ == '__main__':
 
258
    main()
 
259
 
 
260
 
 
261
#>>> code by HUN