← 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

merge improvements to doc-generator: show aliases, more environment variables

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_man.py
105
105
    doc = "%s\n" % (cmd.__doc__)
106
106
    docsplit = cmd.__doc__.split('\n')
107
107
    doc = '\n'.join([docsplit[0]] + [line[4:] for line in docsplit[1:]])
 
108
 
108
109
    option_str = ""
109
110
    options = cmd.options()
110
111
    if options:
123
124
            wrapped = textwrap.fill(l, initial_indent='',
124
125
                                    subsequent_indent=30*' ')
125
126
            option_str = option_str + wrapped + '\n'       
126
 
    return subsection_header + option_str + "\n" + doc + "\n"
 
127
 
 
128
    aliases_str = ""
 
129
    if cmd.aliases:
 
130
        if len(cmd.aliases) > 1:
 
131
            aliases_str += '\nAliases: '
 
132
        else:
 
133
            aliases_str += '\nAlias: '
 
134
        aliases_str += ', '.join(cmd.aliases)
 
135
        aliases_str += '\n'
 
136
 
 
137
    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
127
138
 
128
139
 
129
140
man_preamble = """\
174
185
.TP
175
186
.I "EMAIL"
176
187
E-Mail address of the user. Overriddes 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
177
200
.SH "FILES"
178
201
.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:
 
202
.I "~/.bazaar/bazaar.conf"
 
203
Contains the default user config. At least one section, [DEFAULT] is required.
 
204
A typical default config file may be similiar to:
182
205
.br
183
206
.br
184
207
.B [DEFAULT]