← 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: Patch Queue Manager
  • Date: 2015-10-05 13:45:00 UTC
  • mfrom: (6603.3.1 bts794146)
  • Revision ID: pqm@pqm.ubuntu.com-20151005134500-v244rho557tv0ukd
(vila) Resolve Bug #1480015: Test failure: hexify removed from paramiko
 (Andrew Starr-Bochicchio) (Andrew Starr-Bochicchio)

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