Updated help strings, man page, and completions

diff --git a/be b/be
index fbe964fbd8bc6a7ff4b6f827745587d8717573af..ed1d7d758bd27580b686c2bbaadae53016d3d449 100755 (executable)
--- a/be
+++ b/be
@@ -27,7 +27,7 @@ if len(sys.argv) == 1 or sys.argv[1] in ('--help', '-h'):
 elif sys.argv[1] == '--complete':
     for command, module in cmdutil.iter_commands():
         print command
-    print '\n'.join(["--help","--complete","--options"])
+    print '\n'.join(["--help","--complete","--options","--version"])
 elif sys.argv[1] == '--version':
     print _version.version_info["revision_id"]
 else:

diff --git a/becommands/depend.py b/becommands/depend.py
index 8dbb2eb3a56cdfb48e9dfeea030b6e9d58baeeee..0e9ee97969dc456957c252aa70c0e19d3a79c680 100644 (file)
--- a/becommands/depend.py
+++ b/becommands/depend.py
@@ -13,7 +13,7 @@
 #    You should have received a copy of the GNU General Public License
 #    along with this program; if not, write to the Free Software
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-"""Add/remove bug dependencies."""
+"""Add/remove bug dependencies"""
 from libbe import cmdutil, bugdir
 import os, copy
 __desc__ = __doc__

diff --git a/becommands/tag.py b/becommands/tag.py
index 5a18a7c4478af001c83614b72c63779559d441df..ab0324e0c09015d0e3d0647cb5d2ae116391ad79 100644 (file)
--- a/becommands/tag.py
+++ b/becommands/tag.py
@@ -13,7 +13,7 @@
 #    You should have received a copy of the GNU General Public License
 #    along with this program; if not, write to the Free Software
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-"""Tag a bug, or search bugs for tags."""
+"""Tag a bug, or search bugs for tags"""
 from libbe import cmdutil, bugdir
 import os, copy
 __desc__ = __doc__

diff --git a/doc/be.1.sgml b/doc/be.1.sgml
index 5e6efc3c84aa5d5629795143439ab8e376df42a4..a2df21fca88b3416d92ec57aa6e1dbef8b00a955 100644 (file)
--- a/doc/be.1.sgml
+++ b/doc/be.1.sgml
@@ -18,7 +18,7 @@ be.1: be.1.sgml
   <!ENTITY dhfirstname "<firstname>Ben</firstname>">
   <!ENTITY dhsurname   "<surname>Finney</surname>">
   <!-- Please adjust the date whenever revising the manpage. -->
-  <!ENTITY dhdate      "<date>2008-04-21</date>">
+  <!ENTITY dhdate      "<date>2009-06-25</date>">
   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
        allowed: see man(7), man(1). -->
   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
@@ -45,7 +45,7 @@ be.1: be.1.sgml
       &dhsurname;
     </author>
     <copyright>
-      <year>2008</year>
+      <year>2009</year>
       <holder>&dhusername;</holder>
     </copyright>
     &dhdate;
@@ -88,125 +88,12 @@ be.1: be.1.sgml
   </refsect1>
   <refsect1>
     <title>COMMANDS</title>
-
     <variablelist>
-      <varlistentry>
-        <term><command>assign</command>
-        </term>
-        <listitem>
-          <para>Assign an individual or group to fix a bug
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>close</command>
-        </term>
-        <listitem>
-          <para>Close a bug
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>comment</command>
-        </term>
-        <listitem>
-          <para>Add a comment to a bug
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>diff</command>
-        </term>
-        <listitem>
-          <para>Compare bug reports with older tree
-          </para>
-        </listitem>
-      </varlistentry>
       <varlistentry>
         <term><command>help</command>
         </term>
         <listitem>
-          <para>Print help for given subcommand
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>inprogress</command>
-        </term>
-        <listitem>
-          <para>Bug fixing in progress
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>list</command>
-        </term>
-        <listitem>
-          <para>List bugs
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>new</command>
-        </term>
-        <listitem>
-          <para>Create a new bug
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>open</command>
-        </term>
-        <listitem>
-          <para>Re-open a bug
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>set</command>
-        </term>
-        <listitem>
-          <para>Change tree settings
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>set-root</command>
-        </term>
-        <listitem>
-          <para>Assign the root directory for bug tracking
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>severity</command>
-        </term>
-        <listitem>
-          <para>Show or change a bug's severity level
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>show</command>
-        </term>
-        <listitem>
-          <para>Show a particular bug
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>target</command>
-        </term>
-        <listitem>
-          <para>Show or change a bug's target for fixing
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><command>upgrade</command>
-        </term>
-        <listitem>
-          <para>Upgrade the bugs to the latest format
+          <para>Print help for be and a list of all available commands.
           </para>
         </listitem>
       </varlistentry>

diff --git a/libbe/cmdutil.py b/libbe/cmdutil.py
index 6be754078064a84b82b7d99bbf22732ecc4fd49d..587360797ffa8204826125e932a714a586668e4e 100644 (file)
--- a/libbe/cmdutil.py
+++ b/libbe/cmdutil.py
@@ -79,11 +79,17 @@ def help(cmd=None):
         for name, module in iter_commands():
             cmdlist.append((name, module.__desc__))
         longest_cmd_len = max([len(name) for name,desc in cmdlist])
-        ret = ["Bugs Everywhere - Distributed bug tracking\n",
+        ret = ["Bugs Everywhere - Distributed bug tracking",
+               "",
+               "usage: be [command]  [command_options ...]  [command_args ...]",
+               "or:    be help",
+               "or:    be help [command]",
+               "",
                "Supported commands"]
         for name, desc in cmdlist:
             numExtraSpaces = longest_cmd_len-len(name)
             ret.append("be %s%*s    %s" % (name, numExtraSpaces, "", desc))
+
         return "\n".join(ret)
 
 def completions(cmd):