/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzr_man.py

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzr_man.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
#!/usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 by Hans Ulrich Niedermann
 
4
# Portions Copyright (C) 2005 by Canonical Ltd
2
5
 
3
6
# This program is free software; you can redistribute it and/or modify
4
7
# it under the terms of the GNU General Public License as published by
5
8
# the Free Software Foundation; either version 2 of the License, or
6
9
# (at your option) any later version.
7
 
#
 
10
 
8
11
# This program is distributed in the hope that it will be useful,
9
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
14
# GNU General Public License for more details.
12
 
#
 
15
 
13
16
# You should have received a copy of the GNU General Public License
14
17
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
"""man.py - create man page from built-in brz help and static text
18
 
 
19
 
TODO:
20
 
  * use usage information instead of simple "brz foo" in COMMAND OVERVIEW
21
 
  * add command aliases
22
 
"""
23
 
 
24
 
PLUGINS_TO_DOCUMENT = ["launchpad"]
25
 
 
26
 
import textwrap
27
 
 
28
 
import breezy
29
 
import breezy.help
30
 
import breezy.help_topics
31
 
import breezy.commands
32
 
from breezy.doc_generate import get_autodoc_datetime
33
 
 
34
 
from breezy.plugin import load_plugins
35
 
load_plugins()
36
 
 
37
 
 
38
 
def get_filename(options):
39
 
    """Provides name of manpage"""
40
 
    return "%s.1" % (options.brz_name)
41
 
 
42
 
 
43
 
def infogen(options, outfile):
44
 
    """Assembles a man page"""
45
 
    d = get_autodoc_datetime()
46
 
    params = \
47
 
        {"brzcmd": options.brz_name,
48
 
         "datestamp": d.strftime("%Y-%m-%d"),
49
 
         "timestamp": d.strftime("%Y-%m-%d %H:%M:%S +0000"),
50
 
         "version": breezy.__version__,
51
 
         }
52
 
    outfile.write(man_preamble % params)
53
 
    outfile.write(man_escape(man_head % params))
54
 
    outfile.write(man_escape(getcommand_list(params)))
55
 
    outfile.write(man_escape(getcommand_help(params)))
56
 
    outfile.write("".join(environment_variables()))
57
 
    outfile.write(man_escape(man_foot % params))
 
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
 
 
30
import time
 
31
import re
58
32
 
59
33
 
60
34
def man_escape(string):
61
 
    """Escapes strings for man page compatibility"""
62
 
    result = string.replace("\\", "\\\\")
63
 
    result = result.replace("`", "\\'")
64
 
    result = result.replace("'", "\\*(Aq")
65
 
    result = result.replace("-", "\\-")
 
35
    result = string.replace("\\","\\\\")
 
36
    result = result.replace("`","\\`")
 
37
    result = result.replace("'","\\'")
 
38
    result = result.replace("-","\\-")
66
39
    return result
67
40
 
68
41
 
69
 
def command_name_list():
70
 
    """Builds a list of command names from breezy"""
71
 
    command_names = breezy.commands.builtin_command_names()
72
 
    for cmdname in breezy.commands.plugin_command_names():
73
 
        cmd_object = breezy.commands.get_cmd_object(cmdname)
74
 
        if (PLUGINS_TO_DOCUMENT is None or
75
 
                cmd_object.plugin_name() in PLUGINS_TO_DOCUMENT):
76
 
            command_names.append(cmdname)
77
 
    command_names.sort()
78
 
    return command_names
79
 
 
80
 
 
81
 
def getcommand_list(params):
82
 
    """Builds summary help for command names in manpage format"""
83
 
    brzcmd = params["brzcmd"]
84
 
    output = '.SH "COMMAND OVERVIEW"\n'
85
 
    for cmd_name in command_name_list():
86
 
        cmd_object = breezy.commands.get_cmd_object(cmd_name)
87
 
        if cmd_object.hidden:
88
 
            continue
89
 
        cmd_help = cmd_object.help()
90
 
        if cmd_help:
91
 
            firstline = cmd_help.split('\n', 1)[0]
92
 
            usage = cmd_object._usage()
93
 
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
94
 
            output = output + tmp
95
 
        else:
96
 
            raise RuntimeError("Command '%s' has no help text" % (cmd_name))
97
 
    return output
98
 
 
99
 
 
100
 
def getcommand_help(params):
101
 
    """Shows individual options for a brz command"""
102
 
    output = '.SH "COMMAND REFERENCE"\n'
103
 
    formatted = {}
104
 
    for cmd_name in command_name_list():
105
 
        cmd_object = breezy.commands.get_cmd_object(cmd_name)
106
 
        if cmd_object.hidden:
107
 
            continue
108
 
        formatted[cmd_name] = format_command(params, cmd_object)
109
 
        for alias in cmd_object.aliases:
110
 
            formatted[alias] = format_alias(params, alias, cmd_name)
111
 
    for cmd_name in sorted(formatted):
112
 
        output += formatted[cmd_name]
113
 
    return output
114
 
 
115
 
 
116
 
def format_command(params, cmd):
117
 
    """Provides long help for each public command"""
118
 
    subsection_header = '.SS "%s"\n' % (cmd._usage())
119
 
    doc = "%s\n" % (cmd.__doc__)
120
 
    doc = breezy.help_topics.help_as_plain_text(cmd.help())
121
 
 
122
 
    # A dot at the beginning of a line is interpreted as a macro.
123
 
    # Simply join lines that begin with a dot with the previous
124
 
    # line to work around this.
125
 
    doc = doc.replace("\n.", ".")
126
 
 
127
 
    option_str = ""
128
 
    options = cmd.options()
129
 
    if options:
130
 
        option_str = "\nOptions:\n"
131
 
        for option_name, option in sorted(options.items()):
132
 
            for name, short_name, argname, help in option.iter_switches():
133
 
                if option.is_hidden(name):
134
 
                    continue
135
 
                l = '    --' + name
136
 
                if argname is not None:
137
 
                    l += ' ' + argname
138
 
                if short_name:
139
 
                    l += ', -' + short_name
140
 
                l += (30 - len(l)) * ' ' + (help or '')
141
 
                wrapped = textwrap.fill(l, initial_indent='',
142
 
                                        subsequent_indent=30 * ' ',
143
 
                                        break_long_words=False,
144
 
                                        )
145
 
                option_str += wrapped + '\n'
146
 
 
147
 
    aliases_str = ""
148
 
    if cmd.aliases:
149
 
        if len(cmd.aliases) > 1:
150
 
            aliases_str += '\nAliases: '
151
 
        else:
152
 
            aliases_str += '\nAlias: '
153
 
        aliases_str += ', '.join(cmd.aliases)
154
 
        aliases_str += '\n'
155
 
 
156
 
    see_also_str = ""
157
 
    see_also = cmd.get_see_also()
158
 
    if see_also:
159
 
        see_also_str += '\nSee also: '
160
 
        see_also_str += ', '.join(see_also)
161
 
        see_also_str += '\n'
162
 
 
163
 
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
164
 
 
165
 
 
166
 
def format_alias(params, alias, cmd_name):
167
 
    help = '.SS "brz %s"\n' % alias
168
 
    help += 'Alias for "%s", see "brz %s".\n' % (cmd_name, cmd_name)
169
 
    return help
170
 
 
171
 
 
172
 
def environment_variables():
173
 
    yield ".SH \"ENVIRONMENT\"\n"
174
 
 
175
 
    from breezy.help_topics import known_env_variables
176
 
    for k, desc in known_env_variables:
177
 
        yield ".TP\n"
178
 
        yield ".I \"%s\"\n" % k
179
 
        yield man_escape(desc) + "\n"
 
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))
180
128
 
181
129
 
182
130
man_preamble = """\
183
 
.\\\"Man page for Breezy (%(brzcmd)s)
 
131
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
184
132
.\\\"
185
133
.\\\" Large parts of this file are autogenerated from the output of
186
 
.\\\"     \"%(brzcmd)s help commands\"
187
 
.\\\"     \"%(brzcmd)s help <cmd>\"
188
 
.\\\"
189
 
 
190
 
.ie \\n(.g .ds Aq \\(aq
191
 
.el .ds Aq '
 
134
.\\\"     \"%(bzrcmd)s help commands\"
 
135
.\\\"     \"%(bzrcmd)s help <cmd>\"
 
136
.\\\"
 
137
.\\\" Generation time: %(timestamp)s
 
138
.\\\"
192
139
"""
193
140
 
194
 
 
 
141
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
 
142
# and is thus (C) Canonical
195
143
man_head = """\
196
 
.TH brz 1 "%(datestamp)s" "%(version)s" "Breezy"
 
144
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
197
145
.SH "NAME"
198
 
%(brzcmd)s - Breezy next-generation distributed version control
 
146
%(bzrcmd)s - bazaar-ng next-generation distributed version control
199
147
.SH "SYNOPSIS"
200
 
.B "%(brzcmd)s"
 
148
.B "%(bzrcmd)s"
201
149
.I "command"
202
150
[
203
151
.I "command_options"
204
152
]
205
153
.br
206
 
.B "%(brzcmd)s"
 
154
.B "%(bzrcmd)s"
207
155
.B "help"
208
156
.br
209
 
.B "%(brzcmd)s"
 
157
.B "%(bzrcmd)s"
210
158
.B "help"
211
159
.I "command"
212
160
.SH "DESCRIPTION"
213
 
 
214
 
Breezy (or %(brzcmd)s) is a distributed version control system that is powerful,
215
 
friendly, and scalable.  Breezy is a fork of the Bazaar version control system.
216
 
 
217
 
Breezy keeps track of changes to software source code (or similar information);
218
 
lets you explore who changed it, when, and why; merges concurrent changes; and
219
 
helps people work together in a team.
 
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.
220
166
"""
221
167
 
222
168
man_foot = """\
 
169
.SH "ENVIRONMENT"
 
170
.TP
 
171
.I "BZRPATH"
 
172
Path where
 
173
.B "%(bzrcmd)s"
 
174
is to look for external command.
 
175
.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>"
 
182
.TP
 
183
.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" .
223
188
.SH "FILES"
224
189
.TP
225
 
.I "~/.config/breezy/breezy.conf"
226
 
Contains the user's default configuration. The section
227
 
.B [DEFAULT]
228
 
is used to define general configuration that will be applied everywhere.
229
 
The section
230
 
.B [ALIASES]
231
 
can be used to create command aliases for
232
 
commonly used options.
233
 
 
234
 
A typical config file might look something like:
235
 
 
236
 
.br
237
 
[DEFAULT]
238
 
.br
239
 
email=John Doe <jdoe@isp.com>
240
 
.br
241
 
[ALIASES]
242
 
.br
243
 
commit = commit --strict
244
 
.br
245
 
log10 = log --short -r -10..-1
 
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>"
246
198
.SH "SEE ALSO"
247
 
.UR https://www.breezy-vcs.org/
248
 
.BR https://www.breezy-vcs.org/
 
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/
249
203
"""
 
204
 
 
205
def main(args=[]):
 
206
    """ main function
 
207
    :param  args:   command-line arguments (sys.argv[1:])
 
208
    :type   args:   list
 
209
    """
 
210
    t = time.time()
 
211
    tt = time.gmtime(t)
 
212
    params = \
 
213
           { "bzrcmd": "bzr",
 
214
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
215
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
216
             "version": bzrlib.__version__,
 
217
             }
 
218
 
 
219
    clp = CommandListParser(params)
 
220
    bzrlib.help.help("commands", outfile=HelpReader(clp))
 
221
    clp.end_parse()
 
222
 
 
223
    filename = "bzr.1"
 
224
    if len(args) == 1:
 
225
        filename = args[0]
 
226
    if filename == "-":
 
227
        outfile = sys.stdout
 
228
    else:
 
229
        outfile = open(filename,"w")
 
230
 
 
231
    outfile.write(man_preamble % params)
 
232
    outfile.write(man_escape(man_head % params))
 
233
    clp.write_to_manpage(outfile)
 
234
 
 
235
    # FIXME:
 
236
    #   This doesn't do more than the summary so far.
 
237
    #outfile.write('.SH "DETAILED COMMAND DESCRIPTION"\n')
 
238
    #for (command,usage,descr) in clp.command_usage:
 
239
    #    write_command_details(params, command, usage, descr, outfile = outfile)
 
240
 
 
241
    outfile.write(man_escape(man_foot % params))
 
242
 
 
243
 
 
244
if __name__ == '__main__':
 
245
    main(sys.argv[1:])
 
246
 
 
247
 
 
248
#>>> code by HUN