[152564] contrib/mp-buildbot/README.md

[larryv at macports.org]

Revision: 152564
          https://trac.macports.org/changeset/152564
Author:   larryv at macports.org
Date:     2016-09-12 10:42:50 -0700 (Mon, 12 Sep 2016)
Log Message:
-----------
mpbb: Update README for new help system

Modified Paths:
--------------
    contrib/mp-buildbot/README.md

Modified: contrib/mp-buildbot/README.md
===================================================================
--- contrib/mp-buildbot/README.md	2016-09-12 17:36:32 UTC (rev 152563)
+++ contrib/mp-buildbot/README.md	2016-09-12 17:42:50 UTC (rev 152564)
@@ -63,15 +63,17 @@
 `mpbb-SUBCOMMAND` must define these two shell functions:
 
 -   `SUBCOMMAND()`:
-      Perform the subcommand's work when invoked by the driver.
--   `SUBCOMMAND-help()`:
-      Print a brief summary of the subcommand's purpose to standard
-      output, but do not `exit`. The driver converts newlines to spaces
-      in the final output.
+      Perform the subcommand's work and return zero on success and
+      nonzero on failure.
+-   `SUBCOMMAND-usage()`:
+      Print to standard out a usage summary, a description of the
+      subcommand's purpose, and the subcommand's options, but do not
+      `exit`. The output is passed through `fmt(1)`, so single newlines
+      are not preserved.
 
 Scripts may define additional functions as desired. For example, the
 `mpbb-list-subports` script defines the required `list-subports` and
-`list-subports-help` functions, as well as a `print-subports` helper.
+`list-subports-usage` functions, as well as a `print-subports` helper.
 
 Subcommand scripts may use but not modify these global shell parameters:
 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20160912/fade7019/attachment.html>