← 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: 2016-02-01 19:56:05 UTC
  • mfrom: (6615.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20160201195605-o7rl92wf6uyum3fk
(vila) Open trunk again as 2.8b1 (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/doc_generate/autodoc_man.py
1
 
# Copyright 2005 Canonical Ltd.
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""man.py - create man page from built-in bzr help and static text
18
18
 
21
21
  * add command aliases
22
22
"""
23
23
 
24
 
import os
25
 
import sys
 
24
from __future__ import absolute_import
 
25
 
 
26
PLUGINS_TO_DOCUMENT = ["launchpad"]
 
27
 
26
28
import textwrap
27
29
import time
28
30
 
29
31
import bzrlib
30
32
import bzrlib.help
 
33
import bzrlib.help_topics
31
34
import bzrlib.commands
32
35
 
 
36
from bzrlib.plugin import load_plugins
 
37
load_plugins()
 
38
 
33
39
 
34
40
def get_filename(options):
35
41
    """Provides name of manpage"""
50
56
    outfile.write(man_escape(man_head % params))
51
57
    outfile.write(man_escape(getcommand_list(params)))
52
58
    outfile.write(man_escape(getcommand_help(params)))
 
59
    outfile.write("".join(environment_variables()))
53
60
    outfile.write(man_escape(man_foot % params))
54
61
 
55
62
 
56
63
def man_escape(string):
57
64
    """Escapes strings for man page compatibility"""
58
65
    result = string.replace("\\","\\\\")
59
 
    result = result.replace("`","\\`")
60
 
    result = result.replace("'","\\'")
 
66
    result = result.replace("`","\\'")
 
67
    result = result.replace("'","\\*(Aq")
61
68
    result = result.replace("-","\\-")
62
69
    return result
63
70
 
65
72
def command_name_list():
66
73
    """Builds a list of command names from bzrlib"""
67
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)
68
80
    command_names.sort()
69
81
    return command_names
70
82
 
80
92
        cmd_help = cmd_object.help()
81
93
        if cmd_help:
82
94
            firstline = cmd_help.split('\n', 1)[0]
83
 
            usage = bzrlib.help.command_usage(cmd_object)
 
95
            usage = cmd_object._usage()
84
96
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
85
97
            output = output + tmp
86
98
        else:
91
103
def getcommand_help(params):
92
104
    """Shows individual options for a bzr command"""
93
105
    output='.SH "COMMAND REFERENCE"\n'
 
106
    formatted = {}
94
107
    for cmd_name in command_name_list():
95
108
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
96
109
        if cmd_object.hidden:
97
110
            continue
98
 
        output = output + format_command(params, cmd_object)
 
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]
99
116
    return output
100
117
 
101
118
 
102
 
def format_command (params, cmd):
 
119
def format_command(params, cmd):
103
120
    """Provides long help for each public command"""
104
 
    subsection_header = '.SS "%s"\n' % (bzrlib.help.command_usage(cmd))
 
121
    subsection_header = '.SS "%s"\n' % (cmd._usage())
105
122
    doc = "%s\n" % (cmd.__doc__)
106
 
    doc = cmd.help()
 
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.", ".")
107
129
 
108
130
    option_str = ""
109
131
    options = cmd.options()
111
133
        option_str = "\nOptions:\n"
112
134
        for option_name, option in sorted(options.items()):
113
135
            for name, short_name, argname, help in option.iter_switches():
 
136
                if option.is_hidden(name):
 
137
                    continue
114
138
                l = '    --' + name
115
139
                if argname is not None:
116
140
                    l += ' ' + argname
117
141
                if short_name:
118
 
                    assert len(short_name) == 1
119
142
                    l += ', -' + short_name
120
 
                l += (30 - len(l)) * ' ' + help
121
 
                # TODO: Split help over multiple lines with
122
 
                # correct indenting and wrapping.
 
143
                l += (30 - len(l)) * ' ' + (help or '')
123
144
                wrapped = textwrap.fill(l, initial_indent='',
124
 
                                        subsequent_indent=30*' ')
125
 
                option_str = option_str + wrapped + '\n'       
 
145
                    subsequent_indent=30*' ',
 
146
                    break_long_words=False,
 
147
                    )
 
148
                option_str += wrapped + '\n'
126
149
 
127
150
    aliases_str = ""
128
151
    if cmd.aliases:
133
156
        aliases_str += ', '.join(cmd.aliases)
134
157
        aliases_str += '\n'
135
158
 
136
 
    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
 
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"
137
183
 
138
184
 
139
185
man_preamble = """\
140
 
Man page for Bazaar (%(bzrcmd)s)
 
186
.\\\"Man page for Bazaar (%(bzrcmd)s)
141
187
.\\\"
142
188
.\\\" Large parts of this file are autogenerated from the output of
143
189
.\\\"     \"%(bzrcmd)s help commands\"
144
190
.\\\"     \"%(bzrcmd)s help <cmd>\"
145
191
.\\\"
146
 
.\\\" Generation time: %(timestamp)s
147
 
.\\\"
 
192
 
 
193
.ie \\n(.g .ds Aq \\(aq
 
194
.el .ds Aq '
148
195
"""
149
196
 
150
197
 
151
198
man_head = """\
152
199
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
153
200
.SH "NAME"
154
 
Bazaar (%(bzrcmd)s) - next-generation distributed version control
 
201
%(bzrcmd)s - Bazaar next-generation distributed version control
155
202
.SH "SYNOPSIS"
156
203
.B "%(bzrcmd)s"
157
204
.I "command"
166
213
.B "help"
167
214
.I "command"
168
215
.SH "DESCRIPTION"
169
 
Bazaar (or %(bzrcmd)s) is a project of Canonical to develop an open source
170
 
distributed version control system that is powerful, friendly, and scalable.
171
 
Version control means a system that keeps track of previous revisions
172
 
of software source code or similar information and helps people work on it in teams.
 
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.
173
224
"""
174
225
 
175
226
man_foot = """\
176
 
.SH "ENVIRONMENT"
177
 
.TP
178
 
.I "BZRPATH"
179
 
Path where
180
 
.B "%(bzrcmd)s"
181
 
is to look for external command.
182
 
.TP
183
 
.I "BZR_EMAIL"
184
 
E-Mail address of the user. Overrides default user config.
185
 
.TP
186
 
.I "EMAIL"
187
 
E-Mail address of the user. Overrides default user config.
188
 
.TP
189
 
.I "BZR_EDITOR"
190
 
Editor for editing commit messages
191
 
.TP
192
 
.I "EDITOR"
193
 
Editor for editing commit messages
194
 
.TP
195
 
.I "BZR_PLUGIN_PATH"
196
 
Paths where bzr should look for plugins
197
 
.TP
198
 
.I "BZR_HOME"
199
 
Home directory for bzr
200
227
.SH "FILES"
201
228
.TP
202
229
.I "~/.bazaar/bazaar.conf"
203
 
Contains the users default configuration. The section
 
230
Contains the user's default configuration. The section
204
231
.B [DEFAULT]
205
232
is used to define general configuration that will be applied everywhere.
206
233
The section
221
248
.br
222
249
log10 = log --short -r -10..-1
223
250
.SH "SEE ALSO"
224
 
.UR http://www.bazaar-vcs.org/
225
 
.BR http://www.bazaar-vcs.org/
 
251
.UR http://bazaar.canonical.com/
 
252
.BR http://bazaar.canonical.com/
226
253
"""
227
254