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

larryv at macports.org larryv at macports.org
Tue Aug 9 10:44:51 PDT 2016


Revision: 151187
          https://trac.macports.org/changeset/151187
Author:   larryv at macports.org
Date:     2016-08-09 10:44:50 -0700 (Tue, 09 Aug 2016)
Log Message:
-----------
mp-buildbot: Reformat unordered lists in README

Make them look like description lists in the source (since that's
basically what they are) while rendering as normal unordered lists.
Unfortunately, Markdown does not (to my knowledge) have a way to create
true HTML `dl` elements, and I'm not about to use raw HTML here.

Nearly all processors render this correctly [*].

[*] http://johnmacfarlane.net/babelmark2/?text=-+++%60name%60%3A%0A++++++definition%0A-+++%60name%60%3A%0A++++++definition

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

Modified: contrib/mp-buildbot/README.md
===================================================================
--- contrib/mp-buildbot/README.md	2016-08-09 17:44:48 UTC (rev 151186)
+++ contrib/mp-buildbot/README.md	2016-08-09 17:44:50 UTC (rev 151187)
@@ -69,25 +69,36 @@
 
 Step provider scripts are sourced and should provide a number of functions:
 
--   $command: Run the actual command.
--   help: Should print a help message to stderr. Does not need to deal with
+-   `$command`:
+      Run the actual command.
+-   `help`:
+      Should print a help message to stderr. Does not need to deal with
       ending the execution.
 
 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
+-   `$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_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
+-   `$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_staging_dir is the folder where archives that are distributable
+-   `$option_staging_dir`:
+      is the folder where archives that are distributable
       and should be upload must be put.
--   $option_svn is the path to the svn binary to use.
--   $option_svn_revision is the revision number to checkout in the given
+-   `$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
+-   `$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
+-   `$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/20160809/6c1d7a18/attachment.html>


More information about the macports-changes mailing list