19
19
Help topics are meant to be help for items that aren't commands, but will
20
20
help bzr become fully learnable without referring to a tutorial.
22
Limited formatting of help text is permitted to make the text useful
23
both within the reference manual (reStructuredText) and on the screen.
24
The help text should be reStructuredText with formatting kept to a
25
minimum and, in particular, no headings. The onscreen renderer applies
26
the following simple rules before rendering the text:
28
1. A '::' appearing on the end of a line is replaced with ':'.
29
2. Lines starting with a ':' have it stripped.
31
These rules mean that literal blocks and field lists respectively can
32
be used in the help text, producing sensible input to a manual while
33
rendering on the screen naturally.
45
# Section identifiers (map topics to the right place in the manual)
46
SECT_COMMAND = "command"
47
SECT_CONCEPT = "concept"
48
SECT_HIDDEN = "hidden"
50
SECT_PLUGIN = "plugin"
23
from bzrlib import registry
53
26
class HelpTopicRegistry(registry.Registry):
54
27
"""A Registry customized for handling help topics."""
56
def register(self, topic, detail, summary, section=SECT_LIST):
29
def register(self, topic, detail, summary):
57
30
"""Register a new help topic.
59
32
:param topic: Name of documentation entry
60
33
:param detail: Function or string object providing detailed
61
34
documentation for topic. Function interface is detail(topic).
62
35
This should return a text string of the detailed information.
63
See the module documentation for details on help text formatting.
64
36
:param summary: String providing single-line documentation for topic.
65
:param section: Section in reference manual - see SECT_* identifiers.
67
# The detail is stored as the 'object' and the metadata as the info
68
info=(summary,section)
69
super(HelpTopicRegistry, self).register(topic, detail, info=info)
38
# The detail is stored as the 'object' and the
39
super(HelpTopicRegistry, self).register(topic, detail, info=summary)
71
def register_lazy(self, topic, module_name, member_name, summary,
41
def register_lazy(self, topic, module_name, member_name, summary):
73
42
"""Register a new help topic, and import the details on demand.
75
44
:param topic: Name of documentation entry
76
45
:param module_name: The module to find the detailed help.
77
46
:param member_name: The member of the module to use for detailed help.
78
47
:param summary: String providing single-line documentation for topic.
79
:param section: Section in reference manual - see SECT_* identifiers.
81
# The detail is stored as the 'object' and the metadata as the info
82
info=(summary,section)
83
49
super(HelpTopicRegistry, self).register_lazy(topic, module_name,
84
member_name, info=info)
50
member_name, info=summary)
86
52
def get_detail(self, topic):
87
53
"""Get the detailed help on a given topic."""
255
178
"""Global Options
257
180
These options may be used with any command, and may appear in front of any
258
command. (e.g. "bzr --profile help").
260
--version Print the version number. Must be supplied before the command.
261
--no-aliases Do not process command aliases when running this command.
181
command. (e.g. "bzr --quiet help").
183
--quiet Suppress informational output; only print errors and warnings
184
--version Print the version number
186
--no-aliases Do not process command aliases when running this command
262
187
--builtin Use the built-in version of a command, not the plugin version.
263
This does not suppress other plugin effects.
264
--no-plugins Do not process any plugins.
188
This does not suppress other plugin effects
189
--no-plugins Do not process any plugins
266
--profile Profile execution using the hotshot profiler.
267
--lsprof Profile execution using the lsprof profiler.
191
-Derror Instead of normal error handling, always print a traceback on
193
--profile Profile execution using the hotshot profiler
194
--lsprof Profile execution using the lsprof profiler
268
195
--lsprof-file Profile execution using the lsprof profiler, and write the
269
results to a specified file. If the filename ends with ".txt",
270
text format will be used. If the filename either starts with
271
"callgrind.out" or end with ".callgrind", the output will be
272
formatted for use with KCacheGrind. Otherwise, the output
274
--coverage Generate line coverage report in the specified directory.
276
See doc/developers/profiling.txt for more information on profiling.
277
A number of debug flags are also available to assist troubleshooting and
280
-Dauth Trace authentication sections used.
281
-Derror Instead of normal error handling, always print a traceback
283
-Devil Capture call sites that do expensive or badly-scaling
285
-Dfetch Trace history copying between repositories.
286
-Dhashcache Log every time a working file is read to determine its hash.
287
-Dhooks Trace hook execution.
288
-Dhpss Trace smart protocol requests and responses.
289
-Dhttp Trace http connections, requests and responses
290
-Dindex Trace major index operations.
291
-Dknit Trace knit operations.
292
-Dlock Trace when lockdir locks are taken or released.
293
-Dmerge Emit information for debugging merges.
294
-Dpack Emit information about pack operations.
297
_standard_options = \
300
Standard options are legal for all commands.
302
--help, -h Show help message.
303
--verbose, -v Display more information.
304
--quiet, -q Only display errors and warnings.
306
Unlike global options, standard options can be used in aliases.
196
results to a specified file.
198
Note: --version must be supplied before any command.
385
276
commits are only made locally
391
Repositories in Bazaar are where committed information is stored. There is
392
a repository associated with every branch.
394
Repositories are a form of database. Bzr will usually maintain this for
395
good performance automatically, but in some situations (e.g. when doing
396
very many commits in a short time period) you may want to ask bzr to
397
optimise the database indices. This can be done by the 'bzr pack' command.
399
By default just running 'bzr init' will create a repository within the new
400
branch but it is possible to create a shared repository which allows multiple
401
branches to share their information in the same location. When a new branch is
402
created it will first look to see if there is a containing shared repository it
405
When two branches of the same project share a repository, there is
406
generally a large space saving. For some operations (e.g. branching
407
within the repository) this translates in to a large time saving.
409
To create a shared repository use the init-repository command (or the alias
410
init-repo). This command takes the location of the repository to create. This
411
means that 'bzr init-repository repo' will create a directory named 'repo',
412
which contains a shared repository. Any new branches that are created in this
413
directory will then use it for storage.
415
It is a good idea to create a repository whenever you might create more
416
than one branch of a project. This is true for both working areas where you
417
are doing the development, and any server areas that you use for hosting
418
projects. In the latter case, it is common to want branches without working
419
trees. Since the files in the branch will not be edited directly there is no
420
need to use up disk space for a working tree. To create a repository in which
421
the branches will not have working trees pass the '--no-trees' option to
426
init-repository Create a shared repository. Use --no-trees to create one
427
in which new branches won't get a working tree.
434
A working tree is the contents of a branch placed on disk so that you can
435
see the files and edit them. The working tree is where you make changes to a
436
branch, and when you commit the current state of the working tree is the
437
snapshot that is recorded in the commit.
439
When you push a branch to a remote system, a working tree will not be
440
created. If one is already present the files will not be updated. The
441
branch information will be updated and the working tree will be marked
442
as out-of-date. Updating a working tree remotely is difficult, as there
443
may be uncommitted changes or the update may cause content conflicts that are
444
difficult to deal with remotely.
446
If you have a branch with no working tree you can use the 'checkout' command
447
to create a working tree. If you run 'bzr checkout .' from the branch it will
448
create the working tree. If the branch is updated remotely, you can update the
449
working tree by running 'bzr update' in that directory.
451
If you have a branch with a working tree that you do not want the 'remove-tree'
452
command will remove the tree if it is safe. This can be done to avoid the
453
warning about the remote working tree not being updated when pushing to the
454
branch. It can also be useful when working with a '--no-trees' repository
455
(see 'bzr help repositories').
457
If you want to have a working tree on a remote machine that you push to you
458
can either run 'bzr update' in the remote branch after each push, or use some
459
other method to update the tree during the push. There is an 'rspush' plugin
460
that will update the working tree using rsync as well as doing a push. There
461
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
466
checkout Create a working tree when a branch does not have one.
467
remove-tree Removes the working tree from a branch when it is safe to do so.
468
update When a working tree is out of sync with it's associated branch
469
this will update the tree to match the branch.
476
A branch consists of the state of a project, including all of its
477
history. All branches have a repository associated (which is where the
478
branch history is stored), but multiple branches may share the same
479
repository (a shared repository). Branches can be copied and merged.
483
init Change a directory into a versioned branch.
484
branch Create a new copy of a branch.
485
merge Perform a three-way merge.
489
_standalone_trees = \
492
A standalone tree is a working tree with an associated repository. It
493
is an independently usable branch, with no dependencies on any other.
494
Creating a standalone tree (via bzr init) is the quickest way to put
495
an existing project under version control.
499
init Make a directory into a versioned branch.
506
Status flags are used to summarise changes to the working tree in a concise
507
manner. They are in the form::
511
where the columns' meanings are as follows.
513
Column 1 - versioning/renames::
520
P Entry for a pending merge (not a file)
522
Column 2 - contents::
531
* The execute bit was changed
536
"""Environment Variables
538
================ =================================================================
539
BZRPATH Path where bzr is to look for shell plugin external commands.
540
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
541
EMAIL E-Mail address of the user.
542
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
543
EDITOR Editor for editing commit messages.
544
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
545
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
546
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
547
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
548
BZR_SSH SSH client: paramiko (default), openssh, ssh, plink.
549
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
550
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
551
================ =================================================================
558
:On Linux: ~/.bazaar/bazaar.conf
559
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
561
Contains the user's default configuration. The section ``[DEFAULT]`` is
562
used to define general configuration that will be applied everywhere.
563
The section ``[ALIASES]`` can be used to create command aliases for
564
commonly used options.
566
A typical config file might look something like::
569
email=John Doe <jdoe@isp.com>
572
commit = commit --strict
573
log10 = log --short -r -10..-1
579
A criss-cross in the branch history can cause the default merge technique
580
to emit more conflicts than would normally be expected.
582
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
583
better results. You may wish to ``bzr revert`` the working tree and merge
584
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
586
Criss-crosses occur in a branch's history if two branches merge the same thing
587
and then merge one another, or if two branches merge one another at the same
588
time. They can be avoided by having each branch only merge from or into a
589
designated central branch (a "star topology").
591
Criss-crosses cause problems because of the way merge works. Bazaar's default
592
merge is a three-way merger; in order to merge OTHER into THIS, it must
593
find a basis for comparison, BASE. Using BASE, it can determine whether
594
differences between THIS and OTHER are due to one side adding lines, or
595
from another side removing lines.
597
Criss-crosses mean there is no good choice for a base. Selecting the recent
598
merge points could cause one side's changes to be silently discarded.
599
Selecting older merge points (which Bazaar does) mean that extra conflicts
602
The ``weave`` merge type is not affected by this problem because it uses
603
line-origin detection instead of a basis revision to determine the cause of
607
_branches_out_of_sync = """Branches out of sync
609
When reconfiguring a checkout, tree or branch into a lightweight checkout,
610
a local branch must be destroyed. (For checkouts, this is the local branch
611
that serves primarily as a cache.) If the branch-to-be-destroyed does not
612
have the same last revision as the new reference branch for the lightweight
613
checkout, data could be lost, so Bazaar refuses.
615
How you deal with this depends on *why* the branches are out of sync.
617
If you have a checkout and have done local commits, you can get back in sync
618
by running "bzr update" (and possibly "bzr commit").
620
If you have a branch and the remote branch is out-of-date, you can push
621
the local changes using "bzr push". If the local branch is out of date, you
622
can do "bzr pull". If both branches have had changes, you can merge, commit
623
and then push your changes. If you decide that some of the changes aren't
624
useful, you can "push --overwrite" or "pull --overwrite" instead.
628
# Register help topics
629
280
topic_registry.register("revisionspec", _help_on_revisionspec,
630
281
"Explain how to use --revision")
631
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
632
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
282
topic_registry.register('basic', _basic_help, "Basic commands")
283
topic_registry.register('topics', _help_on_topics, "Topics list")
633
284
def get_format_topic(topic):
634
285
from bzrlib import bzrdir
635
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
286
return bzrdir.format_registry.help_topic(topic)
636
287
topic_registry.register('formats', get_format_topic, 'Directory formats')
637
topic_registry.register('standard-options', _standard_options,
288
topic_registry.register('global-options', _global_options,
638
289
'Options that can be used with any command')
639
topic_registry.register('global-options', _global_options,
640
'Options that control how Bazaar runs')
290
topic_registry.register('checkouts', _checkouts,
291
'Information on what a checkout is')
641
292
topic_registry.register('urlspec', _help_on_transport,
642
293
"Supported transport protocols")
643
topic_registry.register('status-flags', _status_flags,
644
"Help on status flags")
645
294
def get_bugs_topic(topic):
646
295
from bzrlib import bugtracker
647
return ("Bug Tracker Settings\n\n" +
648
bugtracker.tracker_registry.help_topic(topic))
649
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
650
topic_registry.register('env-variables', _env_variables,
651
'Environment variable names and values')
652
topic_registry.register('files', _files,
653
'Information on configuration and log files')
655
# Load some of the help topics from files
656
topic_registry.register('authentication', _load_from_file,
657
'Information on configuring authentication')
658
topic_registry.register('configuration', _load_from_file,
659
'Details on the configuration settings available')
660
topic_registry.register('conflicts', _load_from_file,
661
'Types of conflicts and what to do about them')
662
topic_registry.register('hooks', _load_from_file,
663
'Points at which custom processing can be added')
666
# Register concept topics.
667
# Note that we might choose to remove these from the online help in the
668
# future or implement them via loading content from files. In the meantime,
669
# please keep them concise.
670
topic_registry.register('branches', _branches,
671
'Information on what a branch is', SECT_CONCEPT)
672
topic_registry.register('checkouts', _checkouts,
673
'Information on what a checkout is', SECT_CONCEPT)
674
topic_registry.register('patterns', _load_from_file,
675
'Information on the pattern syntax',
677
topic_registry.register('repositories', _repositories,
678
'Basic information on shared repositories.',
680
topic_registry.register('rules', _load_from_file,
681
'Information on defining rule-based preferences',
683
topic_registry.register('standalone-trees', _standalone_trees,
684
'Information on what a standalone tree is',
686
topic_registry.register('working-trees', _working_trees,
687
'Information on working trees', SECT_CONCEPT)
688
topic_registry.register('criss-cross', _criss_cross,
689
'Information on criss-cross merging', SECT_CONCEPT)
690
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
691
'Information on criss-cross merging', SECT_CONCEPT)
296
return bugtracker.tracker_registry.help_topic(topic)
297
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
694
300
class HelpTopicIndex(object):
added
removed
bzrlib/help_topics.py
