<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[151188] contrib/mp-buildbot/README.md</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="https://trac.macports.org/changeset/151188">151188</a></dd>
<dt>Author</dt> <dd>larryv@macports.org</dd>
<dt>Date</dt> <dd>2016-08-09 10:44:52 -0700 (Tue, 09 Aug 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>mp-buildbot: Rewrite second half of README</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#contribmpbuildbotREADMEmd">contrib/mp-buildbot/README.md</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="contribmpbuildbotREADMEmd"></a>
<div class="modfile"><h4>Modified: contrib/mp-buildbot/README.md (151187 => 151188)</h4>
<pre class="diff"><span>
<span class="info">--- contrib/mp-buildbot/README.md 2016-08-09 17:44:50 UTC (rev 151187)
+++ contrib/mp-buildbot/README.md 2016-08-09 17:44:52 UTC (rev 151188)
</span><span class="lines">@@ -65,40 +65,43 @@
</span><span class="cx"> mpbb cleanup --prefix /opt/local
</span><span class="cx">
</span><span class="cx">
</span><del>-## Step Implementation API ##
</del><ins>+## Subcommand API ##
</ins><span class="cx">
</span><del>-Step provider scripts are sourced and should provide a number of functions:
</del><ins>+Subcommand scripts are sourced by the `mpbb` driver. A script named
+`mpbb-SUBCOMMAND` must define these two shell functions:
</ins><span class="cx">
</span><del>-- `$command`:
- Run the actual command.
-- `help`:
- Should print a help message to stderr. Does not need to deal with
- ending the execution.
</del><ins>+- `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.
</ins><span class="cx">
</span><del>-Some shell variables are available for usage in your subcommand:
</del><ins>+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.
</ins><span class="cx">
</span><ins>+Subcommand scripts may use but not modify these global shell parameters:
+
</ins><span class="cx"> - `$command`:
</span><del>- is the name of the subcommand
</del><ins>+ The name of the subcommand.
</ins><span class="cx"> - `$option_archive_site`:
</span><del>- is the URL to the packages archive that will be used
- to check for existing uploaded packages.
</del><ins>+ The URL of the mirror to check for preexisting archives.
</ins><span class="cx"> - `$option_port`:
</span><del>- is the port that should be installed in the run of mpbb.
</del><ins>+ The name of the port to install.
</ins><span class="cx"> - `$option_prefix`:
</span><del>- is the path to the MacPorts installation to use, as passed
- with --prefix.
</del><ins>+ The prefix of the MacPorts installation.
</ins><span class="cx"> - `$option_staging_dir`:
</span><del>- is the folder where archives that are distributable
- and should be upload must be put.
</del><ins>+ The directory for staging distributable archives for upload.
</ins><span class="cx"> - `$option_svn`:
</span><del>- is the path to the svn binary to use.
</del><ins>+ The path to the Subversion executable.
</ins><span class="cx"> - `$option_svn_revision`:
</span><del>- is the revision number to checkout in the given
- Subversion repository.
</del><ins>+ The revision to checkout from the `$option_svn_url` repository.
</ins><span class="cx"> - `$option_svn_url`:
</span><del>- is a URL pointing to a Subversion repository that
- contains the dports and base subdirectories.
</del><ins>+ The URL of a Subversion repository containing the MacPorts `base`
+ and `dports` directory trees.
</ins><span class="cx"> - `$option_workdir`:
</span><del>- is a path to a directory that can be used to store
- temporary data. This data is retained between builds. You can, for
- example, store a Subversion checkout there.
</del><ins>+ A directory for storing temporary data. It is guaranteed to
+ persist for the duration of an `mpbb` run, so it may be used to
+ share ancillary files (e.g., a Subversion checkout of the ports
+ tree) between builds of different ports.
</ins></span></pre>
</div>
</div>
</body>
</html>