← 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: Vincent Ladeuil
  • Date: 2012-03-16 11:10:03 UTC
  • mto: This revision was merged to the branch mainline in revision 6511.
  • Revision ID: v.ladeuil+lp@free.fr-20120316111003-a3fsp7hi8wo86e3a
https://launchpad.net/bugs/956860
Ensures the format registry is not empty when generating docs for sphinx

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
 
import bzrlib, bzrlib.help
25
 
 
26
 
#>>> code taken from bzr (C) Canonical
27
 
 
28
 
#<<< code by HUN
29
 
 
 
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
30
29
import time
31
 
import re
 
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(man_escape(man_foot % params))
32
60
 
33
61
 
34
62
def man_escape(string):
 
63
    """Escapes strings for man page compatibility"""
35
64
    result = string.replace("\\","\\\\")
36
 
    result = result.replace("`","\\`")
37
 
    result = result.replace("'","\\'")
 
65
    result = result.replace("`","\\'")
 
66
    result = result.replace("'","\\*(Aq")
38
67
    result = result.replace("-","\\-")
39
68
    return result
40
69
 
41
70
 
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))
 
71
def command_name_list():
 
72
    """Builds a list of command names from bzrlib"""
 
73
    command_names = bzrlib.commands.builtin_command_names()
 
74
    for cmdname in bzrlib.commands.plugin_command_names():
 
75
        cmd_object = bzrlib.commands.get_cmd_object(cmdname)
 
76
        if (PLUGINS_TO_DOCUMENT is None or
 
77
            cmd_object.plugin_name() in PLUGINS_TO_DOCUMENT):
 
78
            command_names.append(cmdname)
 
79
    command_names.sort()
 
80
    return command_names
 
81
 
 
82
 
 
83
def getcommand_list (params):
 
84
    """Builds summary help for command names in manpage format"""
 
85
    bzrcmd = params["bzrcmd"]
 
86
    output = '.SH "COMMAND OVERVIEW"\n'
 
87
    for cmd_name in command_name_list():
 
88
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
89
        if cmd_object.hidden:
 
90
            continue
 
91
        cmd_help = cmd_object.help()
 
92
        if cmd_help:
 
93
            firstline = cmd_help.split('\n', 1)[0]
 
94
            usage = cmd_object._usage()
 
95
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
 
96
            output = output + tmp
 
97
        else:
 
98
            raise RuntimeError, "Command '%s' has no help text" % (cmd_name)
 
99
    return output
 
100
 
 
101
 
 
102
def getcommand_help(params):
 
103
    """Shows individual options for a bzr command"""
 
104
    output='.SH "COMMAND REFERENCE"\n'
 
105
    formatted = {}
 
106
    for cmd_name in command_name_list():
 
107
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
108
        if cmd_object.hidden:
 
109
            continue
 
110
        formatted[cmd_name] = format_command(params, cmd_object)
 
111
        for alias in cmd_object.aliases:
 
112
            formatted[alias] = format_alias(params, alias, cmd_name)
 
113
    for cmd_name in sorted(formatted):
 
114
        output += formatted[cmd_name]
 
115
    return output
 
116
 
 
117
 
 
118
def format_command(params, cmd):
 
119
    """Provides long help for each public command"""
 
120
    subsection_header = '.SS "%s"\n' % (cmd._usage())
 
121
    doc = "%s\n" % (cmd.__doc__)
 
122
    doc = bzrlib.help_topics.help_as_plain_text(cmd.help())
 
123
 
 
124
    # A dot at the beginning of a line is interpreted as a macro.
 
125
    # Simply join lines that begin with a dot with the previous
 
126
    # line to work around this.
 
127
    doc = doc.replace("\n.", ".")
 
128
 
 
129
    option_str = ""
 
130
    options = cmd.options()
 
131
    if options:
 
132
        option_str = "\nOptions:\n"
 
133
        for option_name, option in sorted(options.items()):
 
134
            for name, short_name, argname, help in option.iter_switches():
 
135
                if option.is_hidden(name):
 
136
                    continue
 
137
                l = '    --' + name
 
138
                if argname is not None:
 
139
                    l += ' ' + argname
 
140
                if short_name:
 
141
                    l += ', -' + short_name
 
142
                l += (30 - len(l)) * ' ' + (help or '')
 
143
                wrapped = textwrap.fill(l, initial_indent='',
 
144
                    subsequent_indent=30*' ',
 
145
                    break_long_words=False,
 
146
                    )
 
147
                option_str += wrapped + '\n'
 
148
 
 
149
    aliases_str = ""
 
150
    if cmd.aliases:
 
151
        if len(cmd.aliases) > 1:
 
152
            aliases_str += '\nAliases: '
 
153
        else:
 
154
            aliases_str += '\nAlias: '
 
155
        aliases_str += ', '.join(cmd.aliases)
 
156
        aliases_str += '\n'
 
157
 
 
158
    see_also_str = ""
 
159
    see_also = cmd.get_see_also()
 
160
    if see_also:
 
161
        see_also_str += '\nSee also: '
 
162
        see_also_str += ', '.join(see_also)
 
163
        see_also_str += '\n'
 
164
 
 
165
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
 
166
 
 
167
 
 
168
def format_alias(params, alias, cmd_name):
 
169
    help = '.SS "bzr %s"\n' % alias
 
170
    help += 'Alias for "%s", see "bzr %s".\n' % (cmd_name, cmd_name)
 
171
    return help
128
172
 
129
173
 
130
174
man_preamble = """\
131
 
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
 
175
.\\\"Man page for Bazaar (%(bzrcmd)s)
132
176
.\\\"
133
177
.\\\" Large parts of this file are autogenerated from the output of
134
178
.\\\"     \"%(bzrcmd)s help commands\"
136
180
.\\\"
137
181
.\\\" Generation time: %(timestamp)s
138
182
.\\\"
 
183
 
 
184
.ie \\n(.g .ds Aq \\(aq
 
185
.el .ds Aq '
139
186
"""
140
187
 
141
 
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
142
 
# and is thus (C) Canonical
 
188
 
143
189
man_head = """\
144
 
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
 
190
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
145
191
.SH "NAME"
146
 
%(bzrcmd)s - bazaar-ng next-generation distributed version control
 
192
%(bzrcmd)s - Bazaar next-generation distributed version control
147
193
.SH "SYNOPSIS"
148
194
.B "%(bzrcmd)s"
149
195
.I "command"
158
204
.B "help"
159
205
.I "command"
160
206
.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.
 
207
 
 
208
Bazaar (or %(bzrcmd)s) is a distributed version control system that is powerful, 
 
209
friendly, and scalable.  Bazaar is a project of Canonical Ltd and part of 
 
210
the GNU Project to develop a free operating system.
 
211
 
 
212
Bazaar keeps track of changes to software source code (or similar information);
 
213
lets you explore who changed it, when, and why; merges concurrent changes; and
 
214
helps people work together in a team.
166
215
"""
167
216
 
168
217
man_foot = """\
171
220
.I "BZRPATH"
172
221
Path where
173
222
.B "%(bzrcmd)s"
174
 
is to look for external command.
 
223
is to look for shell plugin external commands.
175
224
.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>"
 
225
.I "BZR_EMAIL"
 
226
E-Mail address of the user. Overrides default user config.
182
227
.TP
183
228
.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" .
 
229
E-Mail address of the user. Overrides default user config.
 
230
.TP
 
231
.I "BZR_EDITOR"
 
232
Editor for editing commit messages
 
233
.TP
 
234
.I "EDITOR"
 
235
Editor for editing commit messages
 
236
.TP
 
237
.I "BZR_PLUGIN_PATH"
 
238
Paths where bzr should look for plugins
 
239
.TP
 
240
.I "BZR_HOME"
 
241
Home directory for bzr
188
242
.SH "FILES"
189
243
.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>"
 
244
.I "~/.bazaar/bazaar.conf"
 
245
Contains the user's default configuration. The section
 
246
.B [DEFAULT]
 
247
is used to define general configuration that will be applied everywhere.
 
248
The section
 
249
.B [ALIASES]
 
250
can be used to create command aliases for
 
251
commonly used options.
 
252
 
 
253
A typical config file might look something like:
 
254
 
 
255
.br
 
256
[DEFAULT]
 
257
.br
 
258
email=John Doe <jdoe@isp.com>
 
259
.br
 
260
[ALIASES]
 
261
.br
 
262
commit = commit --strict
 
263
.br
 
264
log10 = log --short -r -10..-1
198
265
.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/
 
266
.UR http://bazaar.canonical.com/
 
267
.BR http://bazaar.canonical.com/
203
268
"""
204
269
 
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