From 53600ea4a4167d535ece96701a217d9617774997 Mon Sep 17 00:00:00 2001 From: Martin Mares Date: Wed, 6 Sep 2017 22:52:35 +0200 Subject: [PATCH] Doc: Added explanation of FB exceptions vs. fb_tie() --- ucw/doc/fastbuf.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) 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) -- 2.39.2