summaryrefslogtreecommitdiff
path: root/pod/perliol.pod
diff options
context:
space:
mode:
authorJarkko Hietaniemi <jhi@iki.fi>2003-07-29 04:57:57 +0000
committerJarkko Hietaniemi <jhi@iki.fi>2003-07-29 04:57:57 +0000
commit868207c2a3ad164268f8e7339a6469fa1ce89c1b (patch)
tree1ffb7caac2f1fe2c7a1773bb5389ae8614600ada /pod/perliol.pod
parent8d8eebbfbaf69416c8b03806075dd4952f30f6a8 (diff)
downloadperl-868207c2a3ad164268f8e7339a6469fa1ce89c1b.tar.gz
PerlIO_popped doc addition from NI-S.
p4raw-id: //depot/perl@20282
Diffstat (limited to 'pod/perliol.pod')
-rw-r--r--pod/perliol.pod5
1 files changed, 5 insertions, 0 deletions
diff --git a/pod/perliol.pod b/pod/perliol.pod
index 94c0e98f8c..8b33e0253d 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