From: Jarkko Hietaniemi <jhi@iki.fi>
Date: Tue, 29 Jul 2003 04:57:57 +0000 (+0000)
Subject: PerlIO_popped doc addition from NI-S.
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=868207c2a3ad164268f8e7339a6469fa1ce89c1b;p=p5sagit%2Fp5-mst-13.2.git

PerlIO_popped doc addition from NI-S.

p4raw-id: //depot/perl@20282
---

diff --git a/pod/perliol.pod b/pod/perliol.pod
index 94c0e98..8b33e02 100644
--- a/pod/perliol.pod
+++ b/pod/perliol.pod
@@ -420,6 +420,11 @@ struct.  It should also C<Unread()> any unconsumed data that has been
 read and buffered from the layer below back to that layer, so that it
 can be re-provided to what ever is now above.
 
+When a PerlIO * is destructed all the layers should pop back to
+leave a NULL. However if ->Popped() returns true then perlio.c
+assumes that either the layer has popped itself, or the layer is
+super special and needs to be retained for other reasons.
+
 Returns 0 on success and failure.
 
 =item Open