From: Martin Mares <mj@ucw.cz>
Date: Wed, 6 Sep 2017 20:52:35 +0000 (+0200)
Subject: Doc: Added explanation of FB exceptions vs. fb_tie()
X-Git-Tag: v6.5.5
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=refs%2Ftags%2Fv6.5.5;p=libucw.git

Doc: Added explanation of FB exceptions vs. fb_tie()
---

diff --git a/ucw/doc/fastbuf.txt b/ucw/doc/fastbuf.txt
index 0d0456f9..57c827d0 100644
--- a/ucw/doc/fastbuf.txt
+++ b/ucw/doc/fastbuf.txt
@@ -82,8 +82,9 @@ ucw/fw-hex.h [[fwhex]]
 Exceptions [[fbexc]]
 --------------------
 
-All standard back-ends and front-ends raise exceptions on errors. All such
-exceptions live in the `ucw.fb` subtree. The following exceptions are defined:
+All standard back-ends and front-ends raise exceptions on errors if the fastbuf
+is tied to a resource pool by @fb_tie().
+All such exceptions live in the `ucw.fb` subtree. The following exceptions are defined:
 
 `ucw.fb.eof`:: Unexpected end of file (e.g., when the @FB_DIE_ON_EOF flag is set)
 `ucw.fb.mmap`:: Memory mapping failed (e.g., the `mmap` syscall has failed)