← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/doc_generate/autodoc_rstx.py

Don't encode unicode messages to UTF-8 in mutter() (the stream writer does it).

Use a codec wrapped log file in tests to match the real environment.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_rstx.py
1
 
# Copyright 2006 Canonical Ltd.
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
"""Generate ReStructuredText source for manual.
18
 
Based on manpage generator autodoc_man.py
19
 
 
20
 
Written by Alexander Belchenko
21
 
"""
22
 
 
23
 
import os
24
 
import sys
25
 
import textwrap
26
 
import time
27
 
 
28
 
import bzrlib
29
 
import bzrlib.help
30
 
import bzrlib.commands
31
 
 
32
 
 
33
 
def get_filename(options):
34
 
    """Provides name of manual"""
35
 
    return "%s_man.txt" % (options.bzr_name)
36
 
 
37
 
 
38
 
def infogen(options, outfile):
39
 
    """Create manual in RSTX format"""
40
 
    t = time.time()
41
 
    tt = time.gmtime(t)
42
 
    params = \
43
 
           { "bzrcmd": options.bzr_name,
44
 
             "datestamp": time.strftime("%Y-%m-%d",tt),
45
 
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
46
 
             "version": bzrlib.__version__,
47
 
             }
48
 
    outfile.write(rstx_preamble % params)
49
 
    outfile.write(rstx_head % params)
50
 
    outfile.write(getcommand_list(params))
51
 
    outfile.write(getcommand_help(params))
52
 
    outfile.write(rstx_foot % params)
53
 
 
54
 
 
55
 
def command_name_list():
56
 
    """Builds a list of command names from bzrlib"""
57
 
    command_names = bzrlib.commands.builtin_command_names()
58
 
    command_names.sort()
59
 
    return command_names
60
 
 
61
 
 
62
 
def getcommand_list (params):
63
 
    """Builds summary help for command names in RSTX format"""
64
 
    bzrcmd = params["bzrcmd"]
65
 
    output = """
66
 
Command overview
67
 
================
68
 
"""
69
 
    for cmd_name in command_name_list():
70
 
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
71
 
        if cmd_object.hidden:
72
 
            continue
73
 
        cmd_help = cmd_object.help()
74
 
        if cmd_help:
75
 
            firstline = cmd_help.split('\n', 1)[0]
76
 
            usage = cmd_object._usage()
77
 
            tmp = '**%s**\n\t%s\n\n' % (usage, firstline)
78
 
            output = output + tmp
79
 
        else:
80
 
            raise RuntimeError, "Command '%s' has no help text" % (cmd_name)
81
 
    return output
82
 
 
83
 
 
84
 
def getcommand_help(params):
85
 
    """Shows individual options for a bzr command"""
86
 
    output="""
87
 
Command reference
88
 
=================
89
 
"""
90
 
    for cmd_name in command_name_list():
91
 
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
92
 
        if cmd_object.hidden:
93
 
            continue
94
 
        output = output + format_command(params, cmd_object, cmd_name)
95
 
    return output
96
 
 
97
 
 
98
 
def format_command (params, cmd, name):
99
 
    """Provides long help for each public command"""
100
 
    usage = cmd._usage()
101
 
    subsection_header = """
102
 
%s
103
 
%s
104
 
::
105
 
""" % (usage, '-'*len(usage))
106
 
 
107
 
    docsplit = cmd.help().split('\n')
108
 
    doc = '\n'.join([' '*4+line for line in docsplit])
109
 
        
110
 
    option_str = ""
111
 
    options = cmd.options()
112
 
    if options:
113
 
        option_str = "\n    Options:\n"
114
 
        for option_name, option in sorted(options.items()):
115
 
            for name, short_name, argname, help in option.iter_switches():
116
 
                l = '    --' + name
117
 
                if argname is not None:
118
 
                    l += ' ' + argname
119
 
                if short_name:
120
 
                    assert len(short_name) == 1
121
 
                    l += ', -' + short_name
122
 
                l += (30 - len(l)) * ' ' + (help or '')
123
 
                # TODO: Split help over multiple lines with
124
 
                # correct indenting and wrapping.
125
 
                wrapped = textwrap.fill(l, initial_indent='',
126
 
                                        subsequent_indent=30*' ')
127
 
                option_str = option_str + wrapped + '\n'       
128
 
 
129
 
    aliases_str = ""
130
 
    if cmd.aliases:
131
 
        if len(cmd.aliases) > 1:
132
 
            aliases_str += '\n    Aliases: '
133
 
        else:
134
 
            aliases_str += '\n    Alias: '
135
 
        aliases_str += ', '.join(cmd.aliases)
136
 
        aliases_str += '\n'
137
 
 
138
 
    see_also_str = ""
139
 
    see_also = cmd.get_see_also()
140
 
    if see_also:
141
 
        see_also_str += '\n    See also: '
142
 
        see_also_str += ', '.join(see_also)
143
 
        see_also_str += '\n'
144
 
 
145
 
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
146
 
 
147
 
 
148
 
##
149
 
# TEMPLATES
150
 
 
151
 
rstx_preamble = """.. Large parts of this file are autogenerated from the output of
152
 
..     %(bzrcmd)s help commands
153
 
..     %(bzrcmd)s help <cmd>
154
 
..
155
 
.. Generation time: %(timestamp)s
156
 
 
157
 
=============================================
158
 
Man page for Bazaar (%(bzrcmd)s)
159
 
=============================================
160
 
 
161
 
:Date: %(datestamp)s
162
 
 
163
 
`Index <#id1>`_
164
 
 
165
 
-----
166
 
 
167
 
"""
168
 
 
169
 
 
170
 
rstx_head = """\
171
 
Name
172
 
====
173
 
Bazaar (%(bzrcmd)s) - next-generation distributed version control
174
 
 
175
 
Synopsis
176
 
========
177
 
**%(bzrcmd)s** *command* [ *command_options* ]
178
 
 
179
 
**%(bzrcmd)s help**
180
 
 
181
 
**%(bzrcmd)s help** *command*
182
 
 
183
 
 
184
 
Description
185
 
===========
186
 
Bazaar (or **%(bzrcmd)s**) is a project of Canonical to develop
187
 
an open source distributed version control system that is powerful,
188
 
friendly, and scalable. Version control means a system
189
 
that keeps track of previous revisions of software source code
190
 
or similar information and helps people work on it in teams.
191
 
"""
192
 
 
193
 
 
194
 
rstx_foot = """
195
 
Environment
196
 
===========
197
 
**BZRPATH**
198
 
                Path where **%(bzrcmd)s** is to look for shell plugin external commands.
199
 
 
200
 
**BZR_EMAIL**
201
 
                E-Mail address of the user. Overrides default user config.
202
 
 
203
 
**EMAIL**
204
 
                E-Mail address of the user. Overrides default user config.
205
 
 
206
 
**BZR_EDITOR**
207
 
                Editor for editing commit messages
208
 
 
209
 
**EDITOR**
210
 
                Editor for editing commit messages
211
 
 
212
 
**BZR_PLUGIN_PATH**
213
 
                Paths where bzr should look for plugins
214
 
 
215
 
**BZR_HOME**
216
 
                Home directory for bzr
217
 
 
218
 
 
219
 
Files
220
 
=====
221
 
 
222
 
**On Linux**:  ``~/.bazaar/bazaar.conf``
223
 
 
224
 
**On Windows**: ``C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf``
225
 
 
226
 
Contains the user's default configuration. The section ``[DEFAULT]`` is
227
 
used to define general configuration that will be applied everywhere.
228
 
The section ``[ALIASES]`` can be used to create command aliases for
229
 
commonly used options.
230
 
 
231
 
A typical config file might look something like::
232
 
 
233
 
  [DEFAULT]
234
 
  email=John Doe <jdoe@isp.com>
235
 
 
236
 
  [ALIASES]
237
 
  commit = commit --strict
238
 
  log10 = log --short -r -10..-1
239
 
 
240
 
 
241
 
See also
242
 
========
243
 
http://www.bazaar-vcs.org/
244
 
 
245
 
--------------------
246
 
 
247
 
.. Contents::
248
 
    **Index**
249
 
"""