← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/doc_generate/autodoc_man.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-02-06 01:45:28 UTC
  • mfrom: (3211.5.4 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080206014528-rb8v4hl04mgxulb7
(robertc) Tune RemoteRepository.get_parent_map to not send duplicate
        results, and to compress the data,
        reducing round trips further. (Robert Collins)

Show diffs side-by-side

added added

removed removed

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