← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/doc_generate/autodoc_rstx.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_rstx.py
124
124
            # correct indenting and wrapping.
125
125
            wrapped = textwrap.fill(l, initial_indent='',
126
126
                                    subsequent_indent=30*' ')
127
 
            option_str = option_str + wrapped + '\n'       
128
 
    return subsection_header + option_str + "\n" + doc + "\n"
 
127
            option_str = option_str + wrapped + '\n'
 
128
 
 
129
    aliases_str = ""
 
130
    if cmd.aliases:
 
131
        if len(cmd.aliases) > 1:
 
132
            aliases_str += '\n    Aliases: '
 
133
        else:
 
134
            aliases_str += '\n    Alias: '
 
135
        aliases_str += ', '.join(cmd.aliases)
 
136
        aliases_str += '\n'
 
137
 
 
138
    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
129
139
 
130
140
 
131
141
##
186
196
**EMAIL**
187
197
                E-Mail address of the user. Overriddes default user config.
188
198
 
 
199
**BZR_EDITOR**
 
200
                Editor for editing commit messages
 
201
 
 
202
**EDITOR**
 
203
                Editor for editing commit messages
 
204
 
 
205
**BZR_PLUGIN_PATH**
 
206
                Paths where bzr should look for plugins
 
207
 
 
208
**BZR_HOME**
 
209
                Home directory for bzr
 
210
 
 
211
 
189
212
Files
190
213
=====
191
214
 
193
216
 
194
217
**On Windows**: ``C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf``
195
218
 
196
 
Contains the default user config. Only one section, ``[DEFAULT]`` is allowed.
 
219
Contains the default user config. At least one section, ``[DEFAULT]`` is required.
197
220
A typical default config file may be similiar to::
198
221
 
199
222
    [DEFAULT]