← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics.py

(Aaron Bentley) Document global options

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics.py
127
127
"""
128
128
 
129
129
 
 
130
_global_options =\
 
131
"""Global Options
 
132
 
 
133
These options may be used with any command, and may appear in front of any
 
134
command.  (e.g. "bzr --quiet help").
 
135
 
 
136
--quiet        Suppress informational output; only print errors and warnings
 
137
--version      Print the version number
 
138
 
 
139
--no-aliases   Do not process command aliases when running this command
 
140
--builtin      Use the built-in version of a command, not the plugin version.
 
141
               This does not suppress other plugin effects
 
142
--no-plugins   Do not process any plugins
 
143
 
 
144
--Derror       Instead of normal error handling, always print a traceback on
 
145
               error.
 
146
--profile      Profile execution using the hotshot profiler
 
147
--lsprof       Profile execution using the lsprof profiler
 
148
--lsprof-file  Profile execution using the lsprof profiler, and write the
 
149
               results to a specified file.
 
150
 
 
151
Note: --version must be supplied before any command.
 
152
"""
 
153
 
 
154
 
130
155
topic_registry.register("revisionspec", _help_on_revisionspec,
131
156
                        "Explain how to use --revision")
132
157
topic_registry.register('basic', _basic_help, "Basic commands")
135
160
    from bzrlib import bzrdir
136
161
    return bzrdir.format_registry.help_topic(topic)
137
162
topic_registry.register('formats', get_format_topic, 'Directory formats')
 
163
topic_registry.register('global-options', _global_options, 
 
164
                        'Options that can be used with any command')