← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/doc_generate/autodoc_man.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-23 08:22:05 UTC
  • mfrom: (5053.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100223082205-nn2nzonavf8sfuae
(mbp) merge 2.1 back to trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/doc_generate/autodoc_man.py
1
 
#!/usr/bin/python
2
 
 
3
 
# Copyright (C) 2005 by Hans Ulrich Niedermann
4
 
# Portions Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
5
2
 
6
3
# This program is free software; you can redistribute it and/or modify
7
4
# it under the terms of the GNU General Public License as published by
8
5
# the Free Software Foundation; either version 2 of the License, or
9
6
# (at your option) any later version.
10
 
 
 
7
#
11
8
# This program is distributed in the hope that it will be useful,
12
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
11
# GNU General Public License for more details.
15
 
 
 
12
#
16
13
# You should have received a copy of the GNU General Public License
17
14
# along with this program; if not, write to the Free Software
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
 
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
 
 
 
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
54
27
import time
55
 
import re
 
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))
56
55
 
57
56
 
58
57
def man_escape(string):
 
58
    """Escapes strings for man page compatibility"""
59
59
    result = string.replace("\\","\\\\")
60
60
    result = result.replace("`","\\`")
61
61
    result = result.replace("'","\\'")
63
63
    return result
64
64
 
65
65
 
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 line == '':
95
 
                return
96
 
        if m:
97
 
            if self.state == 0:
98
 
                if self.usage:
99
 
                    self.command_usage.append((self.command,self.usage,self.descr))
100
 
                    self.all_commands.append(self.command)
101
 
                self.usage = " ".join(line.split(" ")[1:])
102
 
                self.command = m.groups()[0]
103
 
            else:
104
 
                raise RuntimeError, "matching usage line in state %d" % state
105
 
            self.state = 1
106
 
            return
107
 
        m = self.descr_exp.match(line)
108
 
        if m:
109
 
            if self.state == 1:
110
 
                self.descr = m.groups()[0]
111
 
            else:
112
 
                raise RuntimeError, "matching descr line in state %d" % state
113
 
            self.state = 0
114
 
            return
115
 
        raise RuntimeError, "Cannot parse this line ('%s')." % line
116
 
 
117
 
    def end_parse(self):
118
 
        if self.state == 0:
119
 
            if self.usage:
120
 
                self.command_usage.append((self.command,self.usage,self.descr))
121
 
                self.all_commands.append(self.command)
122
 
        else:
123
 
            raise RuntimeError, "ending parse in state %d" % state
124
 
 
125
 
    def write_to_manpage(self, outfile):
126
 
        bzrcmd = self.params["bzrcmd"]
127
 
        outfile.write('.SH "COMMAND OVERVIEW"\n')
128
 
        for (command,usage,descr) in self.command_usage:
129
 
            outfile.write('.TP\n.B "%s %s"\n%s\n\n' % (bzrcmd, usage, descr))
130
 
 
131
 
 
132
 
class HelpReader:
133
 
 
134
 
    def __init__(self, parser):
135
 
        self.parser = parser
136
 
 
137
 
    def write(self, data):
138
 
        if data[-1] == '\n':
139
 
            data = data[:-1]
140
 
        for line in data.split('\n'):
141
 
            self.parser.parse_line(line)
142
 
 
143
 
 
144
 
def write_command_details(params, command, usage, descr, outfile):
145
 
    x = ('.SS "%s %s"\n.B "%s"\n.PP\n.B "Usage:"\n%s %s\n\n' %
146
 
         (params["bzrcmd"],
147
 
          command,
148
 
          descr,
149
 
          params["bzrcmd"],
150
 
          usage))
151
 
    outfile.write(man_escape(x))
 
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
152
157
 
153
158
 
154
159
man_preamble = """\
155
 
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
 
160
.\\\"Man page for Bazaar (%(bzrcmd)s)
156
161
.\\\"
157
162
.\\\" Large parts of this file are autogenerated from the output of
158
163
.\\\"     \"%(bzrcmd)s help commands\"
162
167
.\\\"
163
168
"""
164
169
 
165
 
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
166
 
# and is thus (C) Canonical
 
170
 
167
171
man_head = """\
168
 
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
 
172
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
169
173
.SH "NAME"
170
 
%(bzrcmd)s - bazaar-ng next-generation distributed version control
 
174
%(bzrcmd)s - Bazaar next-generation distributed version control
171
175
.SH "SYNOPSIS"
172
176
.B "%(bzrcmd)s"
173
177
.I "command"
182
186
.B "help"
183
187
.I "command"
184
188
.SH "DESCRIPTION"
185
 
bazaar-ng (or
186
 
.B "%(bzrcmd)s"
187
 
) 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.
188
 
.SS "Warning"
189
 
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.
 
189
Bazaar (or %(bzrcmd)s) is a project of Canonical to develop an open source
 
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.
190
193
"""
191
194
 
192
195
man_foot = """\
195
198
.I "BZRPATH"
196
199
Path where
197
200
.B "%(bzrcmd)s"
198
 
is to look for external command.
199
 
 
 
201
is to look for shell plugin external commands.
200
202
.TP
201
 
.I "BZREMAIL"
202
 
E-Mail address of the user. Overrides
203
 
.I "~/.bzr.conf/email" and
204
 
.IR "EMAIL" .
205
 
Example content:
206
 
.I "John Doe <john@example.com>"
207
 
 
 
203
.I "BZR_EMAIL"
 
204
E-Mail address of the user. Overrides default user config.
208
205
.TP
209
206
.I "EMAIL"
210
 
E-Mail address of the user. Overridden by the content of the file
211
 
.I "~/.bzr.conf/email"
212
 
and of the environment variable
213
 
.IR "BZREMAIL" .
214
 
 
 
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
215
220
.SH "FILES"
216
221
.TP
217
 
.I "~/.bzr.conf/"
218
 
Directory where all the user\'s settings are stored.
219
 
.TP
220
 
.I "~/.bzr.conf/email"
221
 
Stores name and email address of the user. Overrides content of
222
 
.I "EMAIL"
223
 
environment variable. Example content:
224
 
.I "John Doe <john@example.com>"
225
 
 
 
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
226
243
.SH "SEE ALSO"
227
 
.UR http://www.bazaar-ng.org/
228
 
.BR http://www.bazaar-ng.org/,
229
 
.UR http://www.bazaar-ng.org/doc/
230
 
.BR http://www.bazaar-ng.org/doc/
 
244
.UR http://www.bazaar.canonical.com/
 
245
.BR http://www.bazaar.canonical.com/
231
246
"""
232
247
 
233
 
def main():
234
 
    t = time.time()
235
 
    tt = time.gmtime(t)
236
 
    params = \
237
 
           { "bzrcmd": "bzr",
238
 
             "datestamp": time.strftime("%Y-%m-%d",tt),
239
 
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
240
 
             "version": bzrlib.__version__,
241
 
             }
242
 
 
243
 
    clp = CommandListParser(params)
244
 
    bzrlib.help.help("commands", outfile=HelpReader(clp))
245
 
    clp.end_parse()
246
 
 
247
 
    filename = "bzr.1"
248
 
    if len(sys.argv) == 2:
249
 
        filename = sys.argv[1]
250
 
    if filename == "-":
251
 
        outfile = sys.stdout
252
 
    else:
253
 
        outfile = open(filename,"w")
254
 
 
255
 
    outfile.write(man_preamble % params)
256
 
    outfile.write(man_escape(man_head % params))
257
 
    clp.write_to_manpage(outfile)
258
 
 
259
 
    # FIXME:
260
 
    #   This doesn't do more than the summary so far.
261
 
    #outfile.write('.SH "DETAILED COMMAND DESCRIPTION"\n')
262
 
    #for (command,usage,descr) in clp.command_usage:
263
 
    #    write_command_details(params, command, usage, descr, outfile = outfile)
264
 
 
265
 
    outfile.write(man_escape(man_foot % params))
266
 
 
267
 
 
268
 
if __name__ == '__main__':
269
 
    main()
270
 
 
271
 
 
272
 
#>>> code by HUN