Rev 2807: branches and standalone-trees documentation (Ian Clatworthy) in file:///home/pqm/archives/thelove/bzr/%2Btrunk/

[Canonical.com Patch Queue Manager]

At file:///home/pqm/archives/thelove/bzr/%2Btrunk/

------------------------------------------------------------
revno: 2807
revision-id: pqm at pqm.ubuntu.com-20070910085701-36pk2aye9gf2vc0t
parent: pqm at pqm.ubuntu.com-20070910054843-evbkt0bivtk6tpqu
parent: ian.clatworthy at internode.on.net-20070910080059-yzwto88w0irifgk6
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Mon 2007-09-10 09:57:01 +0100
message:
  branches and standalone-trees documentation (Ian Clatworthy)
modified:
  NEWS                           NEWS-20050323055033-4e00b5db738777ff
  bzrlib/help_topics.py          help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
    ------------------------------------------------------------
    revno: 2806.1.1
    merged: ian.clatworthy at internode.on.net-20070910080059-yzwto88w0irifgk6
    parent: pqm at pqm.ubuntu.com-20070910054843-evbkt0bivtk6tpqu
    parent: ian.clatworthy at internode.on.net-20070907034241-vt2rgf4lqqwjbttm
    committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
    branch nick: ianc-integration
    timestamp: Mon 2007-09-10 18:00:59 +1000
    message:
      branches and standalone-trees documentation (Ian Clatworthy)
    ------------------------------------------------------------
    revno: 2804.2.1
    merged: ian.clatworthy at internode.on.net-20070907034241-vt2rgf4lqqwjbttm
    parent: pqm at pqm.ubuntu.com-20070906063814-iiwx3hccoukt499k
    committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
    branch nick: bzr.concepts
    timestamp: Fri 2007-09-07 13:42:41 +1000
    message:
      add branches and standalone-trees as help topics
=== modified file 'NEWS'
--- a/NEWS	2007-09-10 05:06:24 +0000
+++ b/NEWS	2007-09-10 08:00:59 +0000
@@ -176,6 +176,10 @@
    * HACKING has been extended with a large section on core developer tasks.
      (Ian Clatworthy)
 
+   * Add ``branches`` and ``standalone-trees`` as online help topics and
+     include them as Concepts within the User Reference.
+     (Paul Moore, Ian Clatworthy)
+
   API BREAKS:
 
    * ``Branch.append_revision`` is removed altogether; please use 

=== modified file 'bzrlib/help_topics.py'
--- a/bzrlib/help_topics.py	2007-09-03 01:33:49 +0000
+++ b/bzrlib/help_topics.py	2007-09-07 03:42:41 +0000
@@ -446,6 +446,37 @@
                this will update the tree to match the branch.
 """
 
+
+_branches = \
+"""Branches
+
+A branch consists of the state of a project, including all of its
+history. All branches have a repository associated (which is where the
+branch history is stored), but multiple branches may share the same
+repository (a shared repository). Branches can be copied and merged.
+
+Related commands::
+
+  init    Make a directory into a versioned branch.
+  branch  Create a new copy of a branch.
+  merge   Perform a three-way merge.
+"""
+
+
+_standalone_trees = \
+"""Standalone Trees
+
+A standalone tree is a working tree with an associated repository. It
+is an independently usable branch, with no dependencies on any other.
+Creating a standalone tree (via bzr init) is the quickest way to put
+an existing project under version control.
+
+Related Commands::
+
+  init    Make a directory into a versioned branch.
+"""
+
+
 _status_flags = \
 """Status Flags
 
@@ -516,6 +547,7 @@
 """
 
 
+# Register help topics
 topic_registry.register("revisionspec", _help_on_revisionspec,
                         "Explain how to use --revision")
 topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
@@ -528,8 +560,6 @@
                         'Options that can be used with any command')
 topic_registry.register('global-options', _global_options,
                     'Options that control how Bazaar runs')
-topic_registry.register('checkouts', _checkouts,
-                        'Information on what a checkout is', SECT_CONCEPT)
 topic_registry.register('urlspec', _help_on_transport,
                         "Supported transport protocols")
 topic_registry.register('status-flags', _status_flags,
@@ -538,15 +568,28 @@
     from bzrlib import bugtracker
     return "Bug Trackers\n\n" + bugtracker.tracker_registry.help_topic(topic)
 topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
+topic_registry.register('env-variables', _env_variables,
+                        'Environment variable names and values')
+topic_registry.register('files', _files,
+                        'Information on configuration and log files')
+
+
+# Register concept topics.
+# Note that we might choose to remove these from the online help in the
+# future or implement them via loading content from files. In the meantime,
+# please keep them concise.
+topic_registry.register('branches', _branches,
+                        'Information on what a branch is', SECT_CONCEPT)
+topic_registry.register('checkouts', _checkouts,
+                        'Information on what a checkout is', SECT_CONCEPT)
 topic_registry.register('repositories', _repositories,
                         'Basic information on shared repositories.',
                         SECT_CONCEPT)
+topic_registry.register('standalone-trees', _standalone_trees,
+                        'Information on what a standalone tree is',
+                        SECT_CONCEPT)
 topic_registry.register('working-trees', _working_trees,
                         'Information on working trees', SECT_CONCEPT)
-topic_registry.register('env-variables', _env_variables,
-                        'Environment variable names and values')
-topic_registry.register('files', _files,
-                        'Information on configuration and log files')
 
 
 class HelpTopicIndex(object):