← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/doc_generate/autodoc_man.py

  • Committer: Robert Collins
  • Date: 2007-03-08 04:06:06 UTC
  • mfrom: (2323.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2442.
  • Revision ID: robertc@robertcollins.net-20070308040606-84gsniv56huiyjt4
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_man.py
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
103
103
    """Provides long help for each public command"""
104
104
    subsection_header = '.SS "%s"\n' % (bzrlib.help.command_usage(cmd))
105
105
    doc = "%s\n" % (cmd.__doc__)
106
 
    docsplit = cmd.__doc__.split('\n')
107
 
    doc = '\n'.join([docsplit[0]] + [line[4:] for line in docsplit[1:]])
 
106
    doc = cmd.help()
 
107
 
108
108
    option_str = ""
109
109
    options = cmd.options()
110
110
    if options:
111
111
        option_str = "\nOptions:\n"
112
112
        for option_name, option in sorted(options.items()):
113
 
            l = '    --' + option_name
114
 
            if option.type is not None:
115
 
                l += ' ' + option.argname.upper()
116
 
            short_name = option.short_name()
117
 
            if short_name:
118
 
                assert len(short_name) == 1
119
 
                l += ', -' + short_name
120
 
            l += (30 - len(l)) * ' ' + option.help
121
 
            # TODO: Split help over multiple lines with
122
 
            # correct indenting and wrapping.
123
 
            wrapped = textwrap.fill(l, initial_indent='',
124
 
                                    subsequent_indent=30*' ')
125
 
            option_str = option_str + wrapped + '\n'       
126
 
    return subsection_header + option_str + "\n" + doc + "\n"
 
113
            for name, short_name, argname, help in option.iter_switches():
 
114
                l = '    --' + name
 
115
                if argname is not None:
 
116
                    l += ' ' + argname
 
117
                if short_name:
 
118
                    assert len(short_name) == 1
 
119
                    l += ', -' + short_name
 
120
                l += (30 - len(l)) * ' ' + (help or '')
 
121
                wrapped = textwrap.fill(l, initial_indent='',
 
122
                                        subsequent_indent=30*' ')
 
123
                option_str = option_str + wrapped + '\n'       
 
124
 
 
125
    aliases_str = ""
 
126
    if cmd.aliases:
 
127
        if len(cmd.aliases) > 1:
 
128
            aliases_str += '\nAliases: '
 
129
        else:
 
130
            aliases_str += '\nAlias: '
 
131
        aliases_str += ', '.join(cmd.aliases)
 
132
        aliases_str += '\n'
 
133
 
 
134
    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
127
135
 
128
136
 
129
137
man_preamble = """\
130
 
Man page for %(bzrcmd)s (bazaar-ng)
 
138
Man page for Bazaar (%(bzrcmd)s)
131
139
.\\\"
132
140
.\\\" Large parts of this file are autogenerated from the output of
133
141
.\\\"     \"%(bzrcmd)s help commands\"
139
147
 
140
148
 
141
149
man_head = """\
142
 
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
 
150
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
143
151
.SH "NAME"
144
 
%(bzrcmd)s - bazaar-ng next-generation distributed version control
 
152
Bazaar (%(bzrcmd)s) - next-generation distributed version control
145
153
.SH "SYNOPSIS"
146
154
.B "%(bzrcmd)s"
147
155
.I "command"
156
164
.B "help"
157
165
.I "command"
158
166
.SH "DESCRIPTION"
159
 
bazaar-ng (or
160
 
.B "%(bzrcmd)s"
161
 
) 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.
 
167
Bazaar (or %(bzrcmd)s) is a project of Canonical to develop an open source
 
168
distributed version control system that is powerful, friendly, and scalable.
 
169
Version control means a system that keeps track of previous revisions
 
170
of software source code or similar information and helps people work on it in teams.
162
171
"""
163
172
 
164
173
man_foot = """\
169
178
.B "%(bzrcmd)s"
170
179
is to look for external command.
171
180
.TP
172
 
.I "BZREMAIL"
 
181
.I "BZR_EMAIL"
173
182
E-Mail address of the user. Overrides default user config.
174
183
.TP
175
184
.I "EMAIL"
176
 
E-Mail address of the user. Overriddes default user config.
 
185
E-Mail address of the user. Overrides default user config.
 
186
.TP
 
187
.I "BZR_EDITOR"
 
188
Editor for editing commit messages
 
189
.TP
 
190
.I "EDITOR"
 
191
Editor for editing commit messages
 
192
.TP
 
193
.I "BZR_PLUGIN_PATH"
 
194
Paths where bzr should look for plugins
 
195
.TP
 
196
.I "BZR_HOME"
 
197
Home directory for bzr
177
198
.SH "FILES"
178
199
.TP
179
 
.I "~/.bazaar/bazaar.conf/"
180
 
Contains the default user config. Only one section, [DEFAULT] is allowed. A 
181
 
typical default config file may be similiar to:
182
 
.br
183
 
.br
 
200
.I "~/.bazaar/bazaar.conf"
 
201
Contains the users default configuration. The section
184
202
.B [DEFAULT]
185
 
.br
186
 
.B email=John Doe <jdoe@isp.com>
 
203
is used to define general configuration that will be applied everywhere.
 
204
The section
 
205
.B [ALIASES]
 
206
can be used to create command aliases for
 
207
commonly used options.
 
208
 
 
209
A typical config file might look something like:
 
210
 
 
211
.br
 
212
[DEFAULT]
 
213
.br
 
214
email=John Doe <jdoe@isp.com>
 
215
.br
 
216
[ALIASES]
 
217
.br
 
218
commit = commit --strict
 
219
.br
 
220
log10 = log --short -r -10..-1
187
221
.SH "SEE ALSO"
188
222
.UR http://www.bazaar-vcs.org/
189
223
.BR http://www.bazaar-vcs.org/