Tweaked usage strings to increase consistency. Also added README.dev.

I tried to stick to CAPS for argument placeholders.

diff --git a/README.dev b/README.dev
new file mode 100644 (file)
index 0000000..bb39ba5
--- /dev/null
+++ b/README.dev
@@ -0,0 +1,28 @@
+Extending BE
+============
+
+To write a plugin, you simply create a new file in the becommands
+directory.  Take a look at one of the simpler plugins (e.g. open.py)
+for an example of how that looks, and to start getting a feel for the
+libbe interface.
+
+To fit into the current framework, your extension module should
+provide the following elements:
+  __desc__
+    A short string describing the purpose of your plugin
+  execute(args)
+    The entry function for your plugin.  args is everything from
+    sys.argv after the name of your plugin (e.g. for the command
+    `be open abc', args=['abc']).
+  help()
+     Return the string to be output by `be help <yourplugin>',
+     `be <yourplugin> --help', etc.
+
+While that's all that's strictly necessary, many plugins (all the
+current ones) use libbe.cmdutil.CmdOptionParser to provide a
+consistent interface
+  get_parser()
+    Return an instance of CmdOptionParser("<usage string>").  You can
+    alter the parser (e.g. add some more options) before returning it.
+
+Again, you can just browse around in becommands to get a feel for things.

diff --git a/becommands/assign.py b/becommands/assign.py
index b01c66a137cfea306f76c2e0c8472352d5a32a24..cb732b32bbe5e1d51de6e5f84deae472a38cdcc3 100644 (file)
--- a/becommands/assign.py
+++ b/becommands/assign.py
@@ -60,7 +60,7 @@ def execute(args):
     bd.save()
 
 def get_parser():
-    parser = cmdutil.CmdOptionParser("be assign bug-id [assignee]")
+    parser = cmdutil.CmdOptionParser("be assign BUG-ID [ASSIGNEE]")
     return parser
 
 longhelp = """

diff --git a/becommands/close.py b/becommands/close.py
index 67813f7943714f621dbdd0bbff24b30ac7ee5e87..8d2ccdb94cc01aae4f7f542e88932e1412b603b9 100644 (file)
--- a/becommands/close.py
+++ b/becommands/close.py
@@ -43,11 +43,11 @@ def execute(args):
     bd.save()
 
 def get_parser():
-    parser = cmdutil.CmdOptionParser("be close bug-id")
+    parser = cmdutil.CmdOptionParser("be close BUG-ID")
     return parser
 
 longhelp="""
-Close the bug identified by bug-id.
+Close the bug identified by BUG-ID.
 """
 
 def help():

diff --git a/becommands/diff.py b/becommands/diff.py
index 3a8b42aeed44a298b52d11fc828489ce0d54e22e..77194ffde6373357fa7dfbfba18e21cc0351cc6a 100644 (file)
--- a/becommands/diff.py
+++ b/becommands/diff.py
@@ -57,7 +57,7 @@ def execute(args):
         bd.remove_duplicate_bugdir()
 
 def get_parser():
-    parser = cmdutil.CmdOptionParser("be diff [specifier]")
+    parser = cmdutil.CmdOptionParser("be diff [SPECIFIER]")
     return parser
 
 longhelp="""

diff --git a/becommands/remove.py b/becommands/remove.py
index 6fddb1f3293e57a0e76c3dfc92be05c28a66db91..8f7c2c63f49f9159699ece4fdb35f9a1ce2abe24 100644 (file)
--- a/becommands/remove.py
+++ b/becommands/remove.py
@@ -45,7 +45,7 @@ def execute(args):
     print "Removed bug %s" % bug.uuid
 
 def get_parser():
-    parser = cmdutil.CmdOptionParser("be remove bug-id")
+    parser = cmdutil.CmdOptionParser("be remove BUG-ID")
     return parser
 
 longhelp="""

diff --git a/becommands/set.py b/becommands/set.py
index d556ea6f6ba5f8e5b67a29ddcf2eea010abd6d6a..287ceb4cef34a3c6df3f12627a7cffbdc08395e1 100644 (file)
--- a/becommands/set.py
+++ b/becommands/set.py
@@ -52,7 +52,7 @@ def execute(args):
         bd.save()
 
 def get_parser():
-    parser = cmdutil.CmdOptionParser("be set [name] [value]")
+    parser = cmdutil.CmdOptionParser("be set [NAME] [VALUE]")
     return parser
 
 longhelp="""

diff --git a/becommands/set_root.py b/becommands/set_root.py
index 9fb48cbd3044ea1331c9f7e804339502c236b894..e17bd87bd270713952413d7a7a903a6d829f9e47 100644 (file)
--- a/becommands/set_root.py
+++ b/becommands/set_root.py
@@ -88,7 +88,7 @@ This command initializes Bugs Everywhere support for the specified directory
 and all its subdirectories.  It will auto-detect any supported revision control
 system.  You can use "be set rcs_name" to change the rcs being used.
 
-DIRECTORY defaults to your current working directory.
+The directory defaults to your current working directory.
 
 It is usually a good idea to put the Bugs Everywhere root at the source code
 root, but you can put it anywhere.  If you run "be set-root" in a subdirectory,

diff --git a/becommands/severity.py b/becommands/severity.py
index 3f254453607d7bbe1b173e140ba681b701eb91a0..3adefaac12548b89cb135fb921ec973f42593472 100644 (file)
--- a/becommands/severity.py
+++ b/becommands/severity.py
@@ -51,7 +51,7 @@ def execute(args):
         bd.save()
 
 def get_parser():
-    parser = cmdutil.CmdOptionParser("be severity bug-id [severity]")
+    parser = cmdutil.CmdOptionParser("be severity BUG-ID [SEVERITY]")
     return parser
 
 longhelp=["""

diff --git a/becommands/show.py b/becommands/show.py
index 9e4e647cd869f430dee64d5f757ea2631ac25226..abec81319cb959951581dea54eecc20dd0fe99d8 100644 (file)
--- a/becommands/show.py
+++ b/becommands/show.py
@@ -44,7 +44,7 @@ def execute(args):
         print bug.string(show_comments=True)
 
 def get_parser():
-    parser = cmdutil.CmdOptionParser("be show bug-id [more bug-ids...]")
+    parser = cmdutil.CmdOptionParser("be show BUG-ID [BUG-ID ...]")
     return parser
 
 longhelp="""

diff --git a/becommands/status.py b/becommands/status.py
index 3dfd5485a67fd93643bf99c4608139e08f808b08..a30b3d6d8bb55a68f0a63608a352719bd43dfd0c 100644 (file)
--- a/becommands/status.py
+++ b/becommands/status.py
@@ -51,7 +51,7 @@ def execute(args):
         bd.save()
 
 def get_parser():
-    parser = cmdutil.CmdOptionParser("be status bug-id [status]")
+    parser = cmdutil.CmdOptionParser("be status BUG-ID [STATUS]")
     return parser
 
 longhelp=["""

diff --git a/becommands/target.py b/becommands/target.py
index 3ca7710ac73c829568cf43fb8c0d90023e278da9..dce100fda1239a676835d09a4a0d7f1d7b787e8a 100644 (file)
--- a/becommands/target.py
+++ b/becommands/target.py
@@ -52,13 +52,13 @@ def execute(args):
         bd.save()
 
 def get_parser():
-    parser = cmdutil.CmdOptionParser("be target bug-id [target]")
+    parser = cmdutil.CmdOptionParser("be target BUG-ID [TARGET]")
     return parser
 
 longhelp="""
 Show or change a bug's target for fixing.  
 
-If no target is specified, the current value is printed.  If a target 
+If no target is specified, the current value is printed.  If a target
 is specified, it will be assigned to the bug.
 
 Targets are freeform; any text may be specified.  They will generally be