[151156] contrib/mp-buildbot

larryv at macports.org larryv at macports.org
Mon Aug 8 20:17:47 PDT 2016


Revision: 151156
          https://trac.macports.org/changeset/151156
Author:   larryv at macports.org
Date:     2016-08-08 20:17:47 -0700 (Mon, 08 Aug 2016)
Log Message:
-----------
mp-buildbot: Rewrite README in portable Markdown

It was practically there already; just needed some tweaking.

- Balance number signs in headers, for aesthetics.

- Don't indent top-level lists.

- Indent list-item text four spaces deeper than the bullet/number [1].

Notes:

- Backslashes in code blocks are interpreted by MultiMarkdown [2].

- Interleaving paragraph text with code blocks in list items doesn't
  work with s9e\TextFormatter and produces extra code indenting with
  Gambas [3].

- Probably other things I've forgotten or overlooked.

References:
[1] http://brettterpstra.com/2015/08/24/write-better-markdown/#indentation
[2] http://johnmacfarlane.net/babelmark2/?text=++++this+is+%5C%0A++++code
[3] http://johnmacfarlane.net/babelmark2/?text=1.++text%0A1.++text%0A%0A++++++++code%0A%0A++++text%0A%0A++++++++code

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

Removed Paths:
-------------
    contrib/mp-buildbot/README

Deleted: contrib/mp-buildbot/README
===================================================================
--- contrib/mp-buildbot/README	2016-08-09 02:30:31 UTC (rev 151155)
+++ contrib/mp-buildbot/README	2016-08-09 03:17:47 UTC (rev 151156)
@@ -1,90 +0,0 @@
-# MacPorts Buildbot Scripts
-
-This folder contains a collection of scripts that will be run by the MacPorts
-buildbot buildslaves for continuous integration and package precompilation.
-
-
-## General structure
-
-There is a driver script mpbb (Macports buildbot) would call the scripts for
-the separated steps, using mpbb <step>. The single steps are provided by
-separate scripts using the following scheme: mpbb-<step>. The steps that are
-needed to be executed to build are the following ones:
-
-    1. Update base without updating the portindex.
-
-            mpbb selfupdate --prefix /opt/local
-
-    2. Checkout ports tree and update the portindex.
-
-            mpbb checkout \
-                --prefix /opt/local \
-                --workdir "$workdir" \
-                --svn-url "$svnurl" \
-                --svn-revision "$svnrev"
-
-    3. Print to standard out a list of all subports for one port...
-
-            mpbb list-subports --prefix /opt/local --port "$port"
-
-       ...or for several.
-
-            mpbb list-subports --prefix /opt/local "$port1" "$port2" ...
-
-    4. For each subport listed in step 3:
-
-        a. Install dependencies.
-
-                mpbb install-dependencies \
-                    --prefix /opt/local \
-                    --port "$subport"
-
-        b. Install the subport itself.
-
-                mpbb install-port --prefix /opt/local --port "$subport"
-
-        c. Gather archives.
-
-                mpbb gather-archives \
-                    --prefix /opt/local \
-                    --port "$port" \
-                    --workdir "$workdir" \
-                    --archive-site "$archive_site" \
-                    --staging-dir "$(pwd)/archive-staging"
-
-        d. Upload. Must be implemented in the buildmaster.
-
-        e. Deploy. Must be implemented in the buildmaster.
-
-        f. Clean up. This must always be run, even if a previous step
-           failed.
-
-                mpbb cleanup --prefix /opt/local
-
-
-## Step Implementation API
-
-Step provider scripts are sourced and should provide a number of functions:
-
-    - help: Should print a help message to stderr. Does not need to deal with
-      ending the execution.
-    - $command: Run the actual command.
-
-Some shell variables are available for usage in your subcommand:
-
-    - $command is the name of the subcommand
-    - $option_archive_site is the URL to the packages archive that will be used
-      to check for existing uploaded packages.
-    - $option_staging_dir is the folder where archives that are distributable
-      and should be upload must be put.
-    - $option_port is the port that should be installed in the run of mpbb.
-    - $option_prefix is the path to the MacPorts installation to use, as passed
-      with --prefix.
-    - $option_svn is the path to the svn binary to use.
-    - $option_svn_revision is the revision number to checkout in the given
-      Subversion repository.
-    - $option_svn_url is a URL pointing to a Subversion repository that
-      contains the dports and base subdirectories.
-    - $option_workdir 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.

Copied: contrib/mp-buildbot/README.md (from rev 151155, contrib/mp-buildbot/README)
===================================================================
--- contrib/mp-buildbot/README.md	                        (rev 0)
+++ contrib/mp-buildbot/README.md	2016-08-09 03:17:47 UTC (rev 151156)
@@ -0,0 +1,90 @@
+# MacPorts Buildbot Scripts #
+
+This folder contains a collection of scripts that will be run by the MacPorts
+buildbot buildslaves for continuous integration and package precompilation.
+
+
+## General structure ##
+
+There is a driver script mpbb (Macports buildbot) would call the scripts for
+the separated steps, using mpbb <step>. The single steps are provided by
+separate scripts using the following scheme: mpbb-<step>. The steps that are
+needed to be executed to build are the following ones:
+
+1.  Update base without updating the portindex.
+
+        mpbb selfupdate --prefix /opt/local
+
+2.  Checkout ports tree and update the portindex.
+
+        mpbb checkout \
+            --prefix /opt/local \
+            --workdir "$workdir" \
+            --svn-url "$svnurl" \
+            --svn-revision "$svnrev"
+
+3.  Print to standard out a list of all subports for one port...
+
+        mpbb list-subports --prefix /opt/local --port "$port"
+
+    ...or for several.
+
+        mpbb list-subports --prefix /opt/local "$port1" "$port2" ...
+
+4.  For each subport listed in step 3:
+
+    a.  Install dependencies.
+
+            mpbb install-dependencies \
+                --prefix /opt/local \
+                --port "$subport"
+
+    b.  Install the subport itself.
+
+            mpbb install-port --prefix /opt/local --port "$subport"
+
+    c.  Gather archives.
+
+            mpbb gather-archives \
+                --prefix /opt/local \
+                --port "$port" \
+                --workdir "$workdir" \
+                --archive-site "$archive_site" \
+                --staging-dir "$(pwd)/archive-staging"
+
+    d.  Upload. Must be implemented in the buildmaster.
+
+    e.  Deploy. Must be implemented in the buildmaster.
+
+    f.  Clean up. This must always be run, even if a previous step
+        failed.
+
+            mpbb cleanup --prefix /opt/local
+
+
+## Step Implementation API ##
+
+Step provider scripts are sourced and should provide a number of functions:
+
+    -   help: Should print a help message to stderr. Does not need to deal with
+        ending the execution.
+    -   $command: Run the actual command.
+
+Some shell variables are available for usage in your subcommand:
+
+    -   $command is the name of the subcommand
+    -   $option_archive_site is the URL to the packages archive that will be used
+        to check for existing uploaded packages.
+    -   $option_staging_dir is the folder where archives that are distributable
+        and should be upload must be put.
+    -   $option_port is the port that should be installed in the run of mpbb.
+    -   $option_prefix is the path to the MacPorts installation to use, as passed
+        with --prefix.
+    -   $option_svn is the path to the svn binary to use.
+    -   $option_svn_revision is the revision number to checkout in the given
+        Subversion repository.
+    -   $option_svn_url is a URL pointing to a Subversion repository that
+        contains the dports and base subdirectories.
+    -   $option_workdir 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.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20160808/102edd48/attachment.html>


More information about the macports-changes mailing list