[73790] trunk/doc-new/guide/xml/portfiledev.xml

[Ryan Schmidt]

On Nov 25, 2010, at 02:54, and.damore at macports.org wrote:

> Revision: 73790
>          http://trac.macports.org/changeset/73790
> Author:   and.damore at macports.org
> Date:     2010-11-25 00:54:38 -0800 (Thu, 25 Nov 2010)
> Log Message:
> -----------
> correcting directory creation example for phase overriding in "Development" section of Guide
> 
> Modified Paths:
> --------------
>    trunk/doc-new/guide/xml/portfiledev.xml
> 
> Modified: trunk/doc-new/guide/xml/portfiledev.xml
> ===================================================================
> --- trunk/doc-new/guide/xml/portfiledev.xml	2010-11-25 06:20:39 UTC (rev 73789)
> +++ trunk/doc-new/guide/xml/portfiledev.xml	2010-11-25 08:54:38 UTC (rev 73790)
> @@ -342,8 +342,8 @@
>       define your own installation phases as shown in this example.</para>
> 
>       <programlisting>destroot {
> -    xinstall -m 755 -d ${destroot}${prefix}/bin
> -    xinstall -m 755 ${worksrcpath}/cdpr ${destroot}${prefix}/bin
> +    xinstall -m 755 -d ${destroot}${prefix}/share/doc/${name}
> +    xinstall -m 755 ${worksrcpath}/README ${destroot}${prefix}/share/doc/${name}
> }</programlisting>
>     </section>

This wasn't a good change.

Previously, this documented a complete correct example of overriding the destroot phase: it showed a port that installs only a single binary (cdpr) into the bin directory. This is a valid thing for a port to do and I'm sure we have several actual ports that do this. (The example also unnecessarily created the bin directory first; that line could have been removed to simplify it.)

After your changes, it shows an incorrect example: it shows a port that installs nothing but a README file. It would be very unusual for a port to install nothing but a README file. (There are some ports like that in our tree, but this is an unusual case, not one we should be documenting in the guide as the norm.)