[72884] trunk/doc-new/guide/xml

[Ryan Schmidt]

On Oct 29, 2010, at 15:05, mk at macports.org wrote:

> Revision: 72884
>          http://trac.macports.org/changeset/72884
> Author:   mk at macports.org
> Date:     2010-10-29 13:05:50 -0700 (Fri, 29 Oct 2010)
> Log Message:
> -----------
> guide: insert an introduction to port groups


> Added: trunk/doc-new/guide/xml/portgroups.xml
> ===================================================================
> --- trunk/doc-new/guide/xml/portgroups.xml	                        (rev 0)
> +++ trunk/doc-new/guide/xml/portgroups.xml	2010-10-29 20:05:50 UTC (rev 72884)
> @@ -0,0 +1,31 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
> +"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
> +<section id="reference.portgroup.gnustep">
> +
> +  <title>PortGroup introduction</title>
> +
> +  <para>Port groups allow for efficient porting of open source software using the GNU objective-C runtime that defines options for the configuration, build, and destroot phases, and also defines some values for a specific software.

PortGroups have nothing to do specifically with open source software, nor with the GNU Objective-C runtime. PortGroups are simply include files. They can define as much or as little as a portgroup author feels is necessary to provide a set of definitions or behaviors common to a group of portfiles, in order that those portfiles can be expressed as simply as possible with minimum redundancy.


> A minimum Portfile using a PortGroup class needs to only define the fetch and the checksum phases.</para>

That's not necessarily true; the requirements of a minimum portfile using a portgroup varies by portgroup. The sections in the guide devoted to each portgroup (or, for portgroups not documented there yet, the comments in the header of the portgroup file itself) should provide guidance on how each portgroup is used. Prospective MacPorts developers are also encouraged to examine existing portfiles that use these portgroups.


> +  <para>See the following folder for currently defined port groups:</para>
> +  <filename>${prefix}/var/macports/sources/rsync.macports.org/release/ports/_resources/port1.0/group/</filename>
> +
> +  <para>This folder contains various tcl files which are describing all port groups.

I think this sentence can probably be deleted, since the preceding one said pretty much the same thing.


> It follows an examplary (incomplete) listing:</para>

I think you mean something like "A sample listing follows:"