<!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>[129847] trunk/doc-new/guide/xml/portfiledev.xml</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/129847">129847</a></dd>
<dt>Author</dt> <dd>raimue@macports.org</dd>
<dt>Date</dt> <dd>2014-12-21 07:37:47 -0800 (Sun, 21 Dec 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Copy over some details from portstyle(7) and clarify contradictions before
getting rid of the man page.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkdocnewguidexmlportfiledevxml">trunk/doc-new/guide/xml/portfiledev.xml</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkdocnewguidexmlportfiledevxml"></a>
<div class="modfile"><h4>Modified: trunk/doc-new/guide/xml/portfiledev.xml (129846 => 129847)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/doc-new/guide/xml/portfiledev.xml 2014-12-21 15:10:56 UTC (rev 129846)
+++ trunk/doc-new/guide/xml/portfiledev.xml 2014-12-21 15:37:47 UTC (rev 129847)
</span><span class="lines">@@ -4,9 +4,21 @@
</span><span class="cx"> <chapter id="development">
</span><span class="cx"> <title>Portfile Development</title>
</span><span class="cx">
</span><del>- <para>This chapter covers a brief introduction to Portfiles, how to create a
- local Portfile repository for development, and creating Portfiles.</para>
</del><ins>+ <para>A port is a distribution of software that can be compiled and
+ installed using MacPorts. A <filename>Portfile</filename> describes all
+ the required steps such as where to get the source code from upstream,
+ which patches have to be applied and which other tools and commands are
+ required to build the source code.</para>
</ins><span class="cx">
</span><ins>+ <para>Each port consists of multiple files in a directory, usually within
+ a category subdirectory of the root of a ports tree. The MacPorts
+ Project distributes the main ports tree that is by default
+ <link linkend="internals.configuration-files.sources-conf">configured</link>
+ in all installations of MacPorts. This section serves as a reference for
+ the directory structure of a single port and the layout of the files
+ within. The only required file in a port is the
+ <filename>Portfile</filename>.</para>
+
</ins><span class="cx"> <section id="development.introduction">
</span><span class="cx"> <title>Portfile Introduction</title>
</span><span class="cx">
</span><span class="lines">@@ -793,12 +805,17 @@
</span><span class="cx"> <section id="development.practices.portstyle">
</span><span class="cx"> <title>Port Style</title>
</span><span class="cx">
</span><del>- <para>Portfiles may be thought of as a table of keys and values in two
- columns separated by spaces (not tabs), so you should set your editor to
- use soft tabs, which are tabs emulated by spaces. By default, the top
- line of all Portfiles should use a modeline that defines soft tabs for
- the vim and emacs editors as shown.</para>
</del><ins>+ <para>Portfiles may be thought of as a set of declarations rather than
+ a piece of code. It is best to format the port file is if it were
+ a table consisting of keys and values. In fact, the simplest of ports
+ will only contain a small block of values. Nicely formatted compact
+ tables will result in more values being visible at the same time.</para>
</ins><span class="cx">
</span><ins>+ <para>The two columns should be separated by spaces (not tabs), so you
+ should set your editor to use soft tabs, which are tabs emulated by
+ spaces. By default, the top line of all Portfiles should use
+ a modeline that defines soft tabs for the vim and emacs editors as shown.</para>
+
</ins><span class="cx"> <programlisting># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:fenc=utf-8:ft=tcl:et:sw=4:ts=4:sts=4</programlisting>
</span><span class="cx">
</span><span class="cx"> <para>The left column should consist of single words, and will be
</span><span class="lines">@@ -807,11 +824,27 @@
</span><span class="cx"> may be considered a single word on the left side, with a single space
</span><span class="cx"> between words.</para>
</span><span class="cx">
</span><del>- <programlisting>set libver "8.5"
</del><ins>+ <programlisting>set libver "8.5"</programlisting>
</ins><span class="cx">
</span><ins>+ <para>When items require multiple lines with line continuation, they can
+ be separated from the previous and next items with a blank line.
+ Indent the additional lines to the same column that the right side
+ begins on in the first line.</para>
</ins><span class="cx">
</span><del>-variant mysql5 { ... }</programlisting>
</del><ins>+ <programlisting>checksums rmd160 7bbfce4fecc2a8e1ca081169e70c1a298ab1b75a \
+ sha256 2829fcb7393bac85925090b286b1f9c3cd3fbbf8e7f35796ef4131322509aa53</programlisting>
+
+ <para>Should a key item such as a phase or variant require braces, the
+ opening brace should appear on the same line and the closing brace should
+ be on its own line. The block formed by the braces is indented for visual
+ clearance. Braces merely quoting strings, for example the description of
+ variants, are placed on the same line without line breaks.</para>
</ins><span class="cx">
</span><ins>+ <programlisting>variant mysql5 description {Enable support for MySQL 5} {
+ depends_lib-append port:mysql5
+ configure.args-replace --without-mysql5 --with-mysql5
+}</programlisting>
+
</ins><span class="cx"> <para>Frequently multiple items are necessary in the second column. For
</span><span class="cx"> example, to set multiple source download locations, multiple
</span><span class="cx"> <code>master_sites</code> must be defined. Unless the second column
</span></span></pre>
</div>
</div>
</body>
</html>