[svn:parrot] r40019 - branches/darwin2hints/config/init/hints

jkeenan at svn.parrot.org jkeenan at svn.parrot.org
Sun Jul 12 15:58:45 UTC 2009


Author: jkeenan
Date: Sun Jul 12 15:58:43 2009
New Revision: 40019
URL: https://trac.parrot.org/parrot/changeset/40019

Log:
Add documentation to package.

Modified:
   branches/darwin2hints/config/init/hints/darwin.pm

Modified: branches/darwin2hints/config/init/hints/darwin.pm
==============================================================================
--- branches/darwin2hints/config/init/hints/darwin.pm	Sun Jul 12 15:39:59 2009	(r40018)
+++ branches/darwin2hints/config/init/hints/darwin.pm	Sun Jul 12 15:58:43 2009	(r40019)
@@ -1,4 +1,4 @@
-# Copyright (C) 2005, Parrot Foundation.
+# Copyright (C) 2005-2009, Parrot Foundation.
 # $Id$
 
 package init::hints::darwin;
@@ -270,6 +270,28 @@
 
 1;
 
+################### DOCUMENTATION ###################
+
+=head1 NAME
+
+init::hints::Darwin - hints for the Darwin compiler
+
+=head1 DESCRIPTION
+
+The functionality in this package is run automatically during configuration
+step F<init::hints> when run on Darwin.
+
+Among other things, this step probes for Fink and Macports libraries --
+functionality previously provided by configuration steps F<auto::fink> and
+F<auto::macports>, which have now been eliminated.
+
+Should you not want to search for either of these packages, you may specify
+the command-line options C<darwin_no_fink> and/or C<darwin_no_macports>.
+
+The functionality is tested in F<t/steps/init/hints/darwin-01.t>.
+
+=cut
+
 # Local Variables:
 #   mode: cperl
 #   cperl-indent-level: 4


More information about the parrot-commits mailing list