document new method

1 files changed, 12 insertions, 2 deletions

diff --git a/usr.sbin/pkg_add/pod/OpenBSD::RequiredBy.pod b/usr.sbin/pkg_add/pod/OpenBSD::RequiredBy.pod
index 6eb4d648762..096168e52fe 100644
--- a/usr.sbin/pkg_add/pod/OpenBSD::RequiredBy.pod
+++ b/usr.sbin/pkg_add/pod/OpenBSD::RequiredBy.pod
@@ -1,4 +1,4 @@
-$OpenBSD: OpenBSD::RequiredBy.pod,v 1.1 2005/08/17 11:02:10 espie Exp $
+$OpenBSD: OpenBSD::RequiredBy.pod,v 1.2 2005/08/17 18:53:08 espie Exp $
 
 =head1 NAME
 
@@ -27,6 +27,9 @@ OpenBSD::RequiredBy - manage installed package dependencies
     # forget some cache entry
     OpenBSD::RequiredBy->forget(installed_info($pkgname));
 
+    # compute the transitive closure of some dependencies
+    my @fulldeps = OpenBSD::Requiring->compute_closure($pkg1, $pkg2);
+
 
 =head1 DESCRIPTION
 
@@ -45,9 +48,16 @@ C<$o =OpenBSD::Requiring-E<gt>new($pkgname)>  gives access to the forward
 dependencies.
 
 Such an object can be used to list the dependencies C<$o-E<gt>list()>,
-add names to them C<$o-E<gt>add(name1, name2,...)> or remove name from
+add names to them C<$o-E<gt>add(name1, name2, ...)> or remove name from
 them C<$o-E<gt>delete(name1, name2, ...)>.
 
+The full list of forward dependencies (transitive closure) from a set of
+packages is given by 
+C<OpenBSD::RequiredBy-E<gt>compute_closure($name1, name2, ...)>.
+Likewise,
+C<OpenBSD::Requiring-E<gt>compute_closure($name1, name2, ...)>
+yields the list of reverse dependencies.
+
 Those lists of dependencies trim duplicates and, unless C<$main::not> is true,
 disk files are automatically synchronized whenever the lists change.