Automatic tying of fastbufs to resources.

[libucw.git] / ucw / doc / fastbuf.txt

diff --git a/ucw/doc/fastbuf.txt b/ucw/doc/fastbuf.txt
index 894d078053f759176d26df5d92d16450b8305df7..86ab55d923dba0b55026c31489b4e050d4e9dfc9 100644 (file)
--- a/ucw/doc/fastbuf.txt
+++ b/ucw/doc/fastbuf.txt
@@ -18,6 +18,12 @@ inbetween and remember that the file position reported by @btell() points after
 the flushed buffer, which is not necessarily the same as after the data you've
 really read.
 
 the flushed buffer, which is not necessarily the same as after the data you've
 really read.
 

+Most fastbuf back-ends also participate in the libucw resource management system.
+If you have a resource pool active, newly created fastbufs are automatically tied
+to resources in the pool, so when the pool gets cleaned up, the fastbufs are
+freed, too. The bclose() function is still available and it removes the tie
+as needed.
+

 .Back-ends:
 - <<fbparam,Files (parametrized)>>
 - <<fbfile,Regular files>>
 .Back-ends:
 - <<fbparam,Files (parametrized)>>
 - <<fbfile,Regular files>>


@@ -60,4 +66,4 @@ Invalid codes are replaced by `UNI_REPLACEMENT` when reading.
 ucw/ff-binary.h
 ---------------
 
 ucw/ff-binary.h
 ---------------
 

-Reading and writing of binary values.
+!!ucw/ff-binary.h