r27307 - /trunk/dh-make-perl/dh-make-perl

[dmn at users.alioth.debian.org]

Author: dmn
Date: Wed Nov 26 13:04:52 2008
New Revision: 27307

URL: http://svn.debian.org/wsvn/pkg-perl/?sc=1&rev=27307
Log:
Dep: add documentation

Modified:
    trunk/dh-make-perl/dh-make-perl

Modified: trunk/dh-make-perl/dh-make-perl
URL: http://svn.debian.org/wsvn/pkg-perl/trunk/dh-make-perl/dh-make-perl?rev=27307&op=diff
==============================================================================
--- trunk/dh-make-perl/dh-make-perl (original)
+++ trunk/dh-make-perl/dh-make-perl Wed Nov 26 13:04:52 2008
@@ -249,6 +249,28 @@
 
 1;
 
+# The C<Dep> class represent a dependency relationship in an opaque way
+#
+# SYNOPSIS
+#
+#   my $d = Dep->new( 'perl' );             # simple dependency
+#   my $d = Dep->new( 'perl', '5.10' );     # dependency with a version
+#   print $d->pkg;  # 'perl'
+#   print $d->ver;  # '5.10
+#
+#                                   # for people who like to type much
+#   my $d = Dep->new( { pkg => 'perl', ver => '5.10' } );
+#
+#   # stringification
+#   print "$d"      # 'perl (>= 5.10)'
+#
+#   # parsing lists
+#   my @list = Dep->parse_list( 'perl (>= 5.10), libc (>= 2.7)' );
+#   print $list[0]->ver;    # '5.10'
+#
+#                                                       # <= relationship
+#   my @list = Dep->parse_list( 'perl (<= 5.11)' );     # UNSUPPORTED
+#
 package Dep;
 
 use base qw(Class::Accessor);