Merge lp:~ian-clatworthy/bzr-scmproj/changes-for-plugins-guide into lp:bzr-scmproj

[Ian Clatworthy]

[Ian Clatworthy (ian-clatworthy)]

This patch makes various documentation improvements to improve formatting and content in the Plugins Guide: http://doc.bazaar-vcs.org/plugins/en/scmproj-plugin.html

[Alexander Belchenko (bialix)]

Thanks, I'll merge.

review: Approve

=== modified file '__init__.py'
--- __init__.py	2009-10-23 11:48:51 +0000
+++ __init__.py	2009-11-20 11:40:24 +0000
@@ -8,7 +8,27 @@
 # Implementation of LazyCommandProxy:
 #   (C) 2008 Lukáš Lalinský <lalinsky AT gmail com>
 
-"""Organizing collection of vcs branches as complex project."""
+"""Organise and manage a collection of VCS branches as a complex project.
+
+Here is a summary of the commands added.
+
+====================    =======================================================
+Command                 Description
+====================    =======================================================
+project-init            Initialize new project meta-directory
+project-get             Get a copy of an existing project on your local disk
+project-commit          Commit changes in components working copies
+project-info            Show info summary for project
+project-update          Update components of the project from their origins
+project-publish         Publish (push back) changes from components branches
+                        and control branch
+project-command         Run some command(s) for project components
+chdir                   Run bzr command in another directory
+====================    =======================================================
+
+For tutorials, developer documentation and comparisons with other systems,
+see http://bialix.com/scmproj/docs/.
+"""
 
 version_info = (0, 4, 6, 'dev', 0)
 

=== modified file 'cli.py'
--- cli.py	2009-03-26 13:19:35 +0000
+++ cli.py	2009-11-20 11:40:24 +0000
@@ -66,17 +66,17 @@
     create ./proj.
 
     To get both project control branch and component branches use command
-    without --control-branch-only option:
+    without --control-branch-only option::
 
         bzr project-get FROM_LOCATION [TO_LOCATION]
 
-    To get only control branch of the project use command as:
+    To get only control branch of the project use command as::
 
         bzr project-get --control-branch-only FROM_LOCATION [TO_LOCATION]
 
     When you already have a local copy of a project with a control branch
     but without its components, and want to get component branches, then
-    run this command from project root directory:
+    run this command from project root directory::
 
         bzr project-get --components-only
 
@@ -255,11 +255,13 @@
 class cmd_project_command(Command):
     """Run some command(s) for project components.
 
-    NOTE: run this command from the root of local project copy.
+    .. note::
+    
+       Run this command from the root of local project copy.
 
     Option --cd-relpath (-C) will force execution of command(s) in the
     components working directories. It's equal to have "cd {RELPATH}"
-    prefixed to each command. This is default behavior, if you need
+    prefixed to each command. This is default behavior. If you need
     to suppress automatic directory change, please use --no-cd option.
     """
     _see_also = ['chdir']
@@ -288,12 +290,12 @@
 class cmd_chdir(Command):
     """Run bzr command in another directory.
 
-    This command change current directory for another one and then
-    launch the bzr command provided as argument, e.g.:
+    This command changes the current directory to another one and then
+    launches the bzr command provided as the argument, e.g.::
 
         bzr chdir foo/bar -- missing http://example.com/spam
 
-    This equals to:
+    This is equivalent to::
 
         # remember $CWD
         cd foo/bar
@@ -304,13 +306,16 @@
     features in core bzr commands for batch processing.
     Intended to use with command `project-command`.
 
-    NOTE: You always should use '--' after directory you want to cd
-    and before actual subcommand you want to execute in that directory.
-    Otherwise it's not possible to pass options to the subcommand, e.g.
+    .. note::
+    
+       You always should use ``--`` after directory you want to cd
+       and before actual subcommand you want to execute in that directory.
+       Otherwise it's not possible to pass options to the subcommand, e.g.::
 
         bzr chdir foo/bar -- missing --line http://example.com/spam
 
-    This command will not work without '--' between 'foo/bar' and 'missing'.
+       This command will not work without ``--`` between ``foo/bar``
+       and ``missing``.
     """
     aliases = ['cd']
     takes_args = ['directory', 'argv+']