diff options
author | W. Trevor King <wking@drexel.edu> | 2009-06-25 21:57:02 -0400 |
---|---|---|
committer | W. Trevor King <wking@drexel.edu> | 2009-06-25 21:57:02 -0400 |
commit | 033a4446c1522c9ff288afa6bc47c3d15d290216 (patch) | |
tree | 16b6d96ee59275b796e6a82e40995301824af3c4 | |
parent | 3cc479535865e3e1948ce8812f12e1d0a34031c8 (diff) | |
download | bugseverywhere-033a4446c1522c9ff288afa6bc47c3d15d290216.tar.gz |
Updated help strings, man page, and completions
-rwxr-xr-x | be | 2 | ||||
-rw-r--r-- | becommands/depend.py | 2 | ||||
-rw-r--r-- | becommands/tag.py | 2 | ||||
-rw-r--r-- | doc/be.1.sgml | 119 | ||||
-rw-r--r-- | libbe/cmdutil.py | 8 |
5 files changed, 13 insertions, 120 deletions
@@ -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 8dbb2eb..0e9ee97 100644 --- 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 5a18a7c..ab0324e 100644 --- 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 5e6efc3..a2df21f 100644 --- 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 6be7540..5873607 100644 --- 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): |