[MERGE] Add two new help topics

[Aaron Bentley]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

James Westby wrote:
>                  except errors.NotLocalUrl:
> -                    warning('This transport does not update the working '
> -                            'tree of: %s' % (br_to.base,))
> +                    warning("This transport does not update the working " 
> +                            "tree of: %s. See 'bzr help working-trees' for "
> +                            "more information." % br_to.base)

I think we should prefer double-quotes in user documentation, rather
than single-quotes.  For example: See "bzr help working-trees"

> +    If the --no-trees option is used then the branches in the repository
> +    will not have working trees by default.

I'd put a comma after "is used".

> === modified file 'bzrlib/help_topics.py'
> --- bzrlib/help_topics.py	2007-04-23 06:55:58 +0000
> +++ bzrlib/help_topics.py	2007-05-14 20:25:02 +0000
> @@ -276,6 +276,82 @@
>                commits are only made locally
>  """
>  
> +_repositories = \
> +"""Repositories
> +
> +Repositories in Bazaar are where committed information is stored. It is
> +possible to create a shared repository which allows multiple branches to
> +share their information in the same location. When a new branch is
> +created it will first look to see if there is a containing repository it
> +can share.

I would put a comma after "When a new branch is created".

> +within the repository) this translates in to a large time saving.

"in to" should be "into".

> +To create a shared repository use the init-repository command (or the alias

Comma after "To create a shared repository"

> +trees. Since the files in the branch will not be edited directly there is no
> +need to use up disk space for a working tree. To create a repository in which
> +the branches will not have working trees pass the '--no-trees' option to

Comma after "will not have working trees".

> The working tree is where you make changes to a
> +branch, and when you commit the current state of the working tree is the
> +snapshot that is recorded in the commit.

This sentence is a bit hard to read.  Maybe split it in two?

> +created. If one is already present the files will not be updated.

Comma after "is already present"

> +If you have a branch with no working tree you can use the 'checkout' command

Comma after "no working tree".  And most sentences beginning with "If".

> +  update       When a working tree is out of sync with it's associated branch

Should "with its associated branch,".


>  class HelpTopicIndex(object):
> @@ -355,3 +435,4 @@
>      def get_help_topic(self):
>          """Return the help topic this can be found under."""
>          return self.topic
> +

I think there's no need for an extra newline here.

Aaron
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFGTeT50F+nu1YWqI0RAnQ9AKCG5Juw16nozYEiI5eA8WIE8JWcOQCeMTwD
o8CC5VBmSpuAdzwojE4ERus=
=KVxV
-----END PGP SIGNATURE-----