Changeset 2d415cc for commands.c

Timestamp:

May 24, 2011, 9:22:25 PM (13 years ago)

Author:

David Benjamin <davidben@mit.edu>

Branches:

master, release-1.10, release-1.8, release-1.9

Children:

78f6c35

Parents:

b848e30

git-author:

David Benjamin <davidben@mit.edu> (03/27/11 15:48:08)

git-committer:

David Benjamin <davidben@mit.edu> (05/24/11 21:22:25)

Message:

Fix the documentation for punt/unpunt

The full extent of the horrors of these commands' syntax had not quite
been correctly documented.

File:

• commands.c (modified) (2 diffs)

commands.c

@@ -281 +281 @@
   OWLCMD_ARGS("punt", owl_command_punt, OWL_CTX_ANY,
               "suppress an arbitrary filter",
-              "punt <filter-text>",
-              "punt <filter-text (multiple words)>\n"
+              "punt <filter-name>\n"
+              "punt <filter-text (multiple words)>",
               "The punt command will suppress messages to the specified\n"
               "filter\n\n"
@@ -289 +289 @@
   OWLCMD_ARGS("unpunt", owl_command_unpunt, OWL_CTX_ANY,
               "remove an entry from the punt list",
-              "unpunt <filter-text>\n"
-              "unpunt <filter-text>\n"
-              "unpunt <number>\n",
+              "unpunt <number>\n"
+              "unpunt <filter-name>\n"
+              "unpunt <filter-text (multiple words)>",
               "The unpunt command will remove an entry from the puntlist.\n"
-              "The first two forms correspond to the first two forms of the :punt\n"
-              "command. The latter allows you to remove a specific entry from the\n"
+              "The last two forms correspond to the two forms of the :punt\n"
+              "command. The first allows you to remove a specific entry from\n"
               "the list (see :show zpunts)\n\n"
               "SEE ALSO:  punt, zpunt, zunpunt, show zpunts\n"),