From db5d160477acad5a6308a0d01c65b1ca7a94cf53 Mon Sep 17 00:00:00 2001 From: Marc Espie Date: Mon, 26 Mar 2007 23:36:27 +0000 Subject: even better wording. --- usr.sbin/pkg_add/pod/OpenBSD::Ustar.pod | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/usr.sbin/pkg_add/pod/OpenBSD::Ustar.pod b/usr.sbin/pkg_add/pod/OpenBSD::Ustar.pod index f44820e7217..b4d6cbe1665 100644 --- a/usr.sbin/pkg_add/pod/OpenBSD::Ustar.pod +++ b/usr.sbin/pkg_add/pod/OpenBSD::Ustar.pod @@ -1,4 +1,4 @@ -$OpenBSD: OpenBSD::Ustar.pod,v 1.10 2007/03/26 23:26:50 espie Exp $ +$OpenBSD: OpenBSD::Ustar.pod,v 1.11 2007/03/26 23:36:26 espie Exp $ =head1 NAME @@ -83,18 +83,20 @@ C<$v = $o-Econtents()>. Actual writing is performed through C<$o-Ewrite()> and is not mandatory either. -Archives should be closed using C<$wrarc-Eclose()>. +Archives should be closed using C<$wrarc-Eclose()>, which will +pad the archive as needed and close the underlying file handle. In particular, this is mandatory for write access, since valid archives require blank-filled blocks. -Alternately, calling C<$wrarc-Epad()> after archiving -all the entries will complete the archive with blank-filled blocks, -in case one wants to close the associated file handle manually. +This is equivalent to calling C<$wrarc-Epad()>, which will +complete the archive with blank-filled blocks, then closing the +associated file handle manually. Client code may decide to abort archive extraction early, or to run it through until C<$arc-Enext()> returns false. The C object doesn't -hold any resources and doesn't need any specific clean-up. However, client -code is responsible for closing the underlying filehandle and +hold any hidden resources and doesn't need any specific clean-up. + +Client code is only responsible for closing the underlying filehandle and terminating any associated pipe process. An object C<$o> returned through C or through C holds all -- cgit v1.2.3