← 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: Martin Pool
  • Date: 2006-08-10 01:16:16 UTC
  • mto: (1904.1.2 0.9)
  • mto: This revision was merged to the branch mainline in revision 1913.
  • Revision ID: mbp@sourcefrog.net-20060810011616-d74881eba696e746
compare_trees is deprecated in 0.9 not 0.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_man.py
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
 
    doc = cmd.help()
107
 
 
 
106
    docsplit = cmd.__doc__.split('\n')
 
107
    doc = '\n'.join([docsplit[0]] + [line[4:] for line in docsplit[1:]])
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
 
            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
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
 
 
127
 
    aliases_str = ""
128
 
    if cmd.aliases:
129
 
        if len(cmd.aliases) > 1:
130
 
            aliases_str += '\nAliases: '
131
 
        else:
132
 
            aliases_str += '\nAlias: '
133
 
        aliases_str += ', '.join(cmd.aliases)
134
 
        aliases_str += '\n'
135
 
 
136
 
    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
 
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"
137
127
 
138
128
 
139
129
man_preamble = """\
140
 
Man page for Bazaar (%(bzrcmd)s)
 
130
Man page for %(bzrcmd)s (bazaar-ng)
141
131
.\\\"
142
132
.\\\" Large parts of this file are autogenerated from the output of
143
133
.\\\"     \"%(bzrcmd)s help commands\"
149
139
 
150
140
 
151
141
man_head = """\
152
 
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
 
142
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
153
143
.SH "NAME"
154
 
Bazaar (%(bzrcmd)s) - next-generation distributed version control
 
144
%(bzrcmd)s - bazaar-ng next-generation distributed version control
155
145
.SH "SYNOPSIS"
156
146
.B "%(bzrcmd)s"
157
147
.I "command"
166
156
.B "help"
167
157
.I "command"
168
158
.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.
 
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.
173
162
"""
174
163
 
175
164
man_foot = """\
180
169
.B "%(bzrcmd)s"
181
170
is to look for external command.
182
171
.TP
183
 
.I "BZR_EMAIL"
 
172
.I "BZREMAIL"
184
173
E-Mail address of the user. Overrides default user config.
185
174
.TP
186
175
.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
 
176
E-Mail address of the user. Overriddes default user config.
200
177
.SH "FILES"
201
178
.TP
202
 
.I "~/.bazaar/bazaar.conf"
203
 
Contains the users default configuration. The section
 
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
204
184
.B [DEFAULT]
205
 
is used to define general configuration that will be applied everywhere.
206
 
The section
207
 
.B [ALIASES]
208
 
can be used to create command aliases for
209
 
commonly used options.
210
 
 
211
 
A typical config file might look something like:
212
 
 
213
 
.br
214
 
[DEFAULT]
215
 
.br
216
 
email=John Doe <jdoe@isp.com>
217
 
.br
218
 
[ALIASES]
219
 
.br
220
 
commit = commit --strict
221
 
.br
222
 
log10 = log --short -r -10..-1
 
185
.br
 
186
.B email=John Doe <jdoe@isp.com>
223
187
.SH "SEE ALSO"
224
188
.UR http://www.bazaar-vcs.org/
225
189
.BR http://www.bazaar-vcs.org/