← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics.py

Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics.py
446
446
               this will update the tree to match the branch.
447
447
"""
448
448
 
 
449
 
 
450
_branches = \
 
451
"""Branches
 
452
 
 
453
A branch consists of the state of a project, including all of its
 
454
history. All branches have a repository associated (which is where the
 
455
branch history is stored), but multiple branches may share the same
 
456
repository (a shared repository). Branches can be copied and merged.
 
457
 
 
458
Related commands::
 
459
 
 
460
  init    Make a directory into a versioned branch.
 
461
  branch  Create a new copy of a branch.
 
462
  merge   Perform a three-way merge.
 
463
"""
 
464
 
 
465
 
 
466
_standalone_trees = \
 
467
"""Standalone Trees
 
468
 
 
469
A standalone tree is a working tree with an associated repository. It
 
470
is an independently usable branch, with no dependencies on any other.
 
471
Creating a standalone tree (via bzr init) is the quickest way to put
 
472
an existing project under version control.
 
473
 
 
474
Related Commands::
 
475
 
 
476
  init    Make a directory into a versioned branch.
 
477
"""
 
478
 
 
479
 
449
480
_status_flags = \
450
481
"""Status Flags
451
482
 
516
547
"""
517
548
 
518
549
 
 
550
# Register help topics
519
551
topic_registry.register("revisionspec", _help_on_revisionspec,
520
552
                        "Explain how to use --revision")
521
553
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
528
560
                        'Options that can be used with any command')
529
561
topic_registry.register('global-options', _global_options,
530
562
                    'Options that control how Bazaar runs')
531
 
topic_registry.register('checkouts', _checkouts,
532
 
                        'Information on what a checkout is', SECT_CONCEPT)
533
563
topic_registry.register('urlspec', _help_on_transport,
534
564
                        "Supported transport protocols")
535
565
topic_registry.register('status-flags', _status_flags,
538
568
    from bzrlib import bugtracker
539
569
    return "Bug Trackers\n\n" + bugtracker.tracker_registry.help_topic(topic)
540
570
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
 
571
topic_registry.register('env-variables', _env_variables,
 
572
                        'Environment variable names and values')
 
573
topic_registry.register('files', _files,
 
574
                        'Information on configuration and log files')
 
575
 
 
576
 
 
577
# Register concept topics.
 
578
# Note that we might choose to remove these from the online help in the
 
579
# future or implement them via loading content from files. In the meantime,
 
580
# please keep them concise.
 
581
topic_registry.register('branches', _branches,
 
582
                        'Information on what a branch is', SECT_CONCEPT)
 
583
topic_registry.register('checkouts', _checkouts,
 
584
                        'Information on what a checkout is', SECT_CONCEPT)
541
585
topic_registry.register('repositories', _repositories,
542
586
                        'Basic information on shared repositories.',
543
587
                        SECT_CONCEPT)
 
588
topic_registry.register('standalone-trees', _standalone_trees,
 
589
                        'Information on what a standalone tree is',
 
590
                        SECT_CONCEPT)
544
591
topic_registry.register('working-trees', _working_trees,
545
592
                        'Information on working trees', SECT_CONCEPT)
546
 
topic_registry.register('env-variables', _env_variables,
547
 
                        'Environment variable names and values')
548
 
topic_registry.register('files', _files,
549
 
                        'Information on configuration and log files')
550
593
 
551
594
 
552
595
class HelpTopicIndex(object):