From 3f1f10136b39cb3146521dcd5f0183f3d06c1f16 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Sun, 5 Aug 2012 20:08:37 +0000
Subject: Fix buf-size extension documentation.

---
 lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

(limited to 'lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl')

diff --git a/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl b/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl
index 67dd7fa..46f2432 100644
--- a/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl
+++ b/lv2/lv2plug.in/ns/ext/buf-size/buf-size.ttl
@@ -32,12 +32,13 @@ block length (the sample_count parameter of LV2_Descriptor::run) and
 port buffer sizes, as well as several features which can be used to restrict
 the block length.</p>
 
-<p>Access to the relevant information is provided by the bufsz:access feature,
-which may be used alone.  To express restrictions on the block length,
-additional data-only features are defined: bufsz:boundedBlockLength,
-bufsz:powerOf2BlockLength, and bufsz:fixedBlockLength.  There is currently no
-facility for requiring specific values for the block length, this may be added
-in the future if need arises.</p>
+<p>The host provides access to all the relevant information via the
+bufsz:access feature.</p>
+
+<p>To require restrictions on the block length, plugins can require additional
+features: bufsz:boundedBlockLength, bufsz:powerOf2BlockLength, and
+bufsz:fixedBlockLength.  These features are data-only, that is they merely
+indicate a restriction and do not carry any data or API.</p>
 """ .
 
 bufsz:access
@@ -45,7 +46,7 @@ bufsz:access
 	lv2:documentation """
 <p>The feature that provides access to buffer size information.  This feature
 is the only one in this extension which carries data: to implement it the host
-passes a feature with URI LV2_BUF_SIZE__access and an LV2_Buf_Size_Feature
+passes a feature with URI LV2_BUF_SIZE__access and an LV2_Buf_Size_Access
 for data, which provides functions the plugin can call to investigate the
 buffer size.</p>
 """ .
@@ -54,13 +55,13 @@ bufsz:boundedBlockLength
 	a lv2:Feature ;
 	lv2:documentation """
 <p>A feature that indicates the host will provide a minimum and maximum block
-length via LV2_Buf_Size_Feature::get_sample_count().  Plugins that copy data
+length via LV2_Buf_Size_Access::get_sample_count().  Plugins that copy data
 from audio inputs can require this feature to ensure they know how much space
 is required for auxilliary buffers.  Note the minimum may be zero, this feature
 is mainly useful to ensure a maximum is available.</p>
 
 <p>All hosts SHOULD support this feature, since it is simple to support and
-necessary for several relatively straightforward use cases.</p>
+necessary for plugins to create auxiliary buffers.</p>
 """ .
 
 bufsz:fixedBlockLength
@@ -68,7 +69,7 @@ bufsz:fixedBlockLength
 	lv2:documentation """
 <p>A feature that indicates the host will always call LV2_Descriptor::run()
 with the same value for sample_count.  If available,
-LV2_Buf_Size_Feature::get_sample_count() must report this value for both min
+LV2_Buf_Size_Access::get_sample_count() must report this value for both min
 and max.</p>
 
 <p>Note that requiring this feature may severely limit the number of hosts
@@ -80,7 +81,7 @@ bufsz:powerOf2BlockLength
 	lv2:documentation """
 <p>A feature that indicates the host will always call LV2_Descriptor::run()
 with a power of two sample_count.  If available,
-LV2_Buf_Size_Feature::get_sample_count() must report this value for both min
+LV2_Buf_Size_Access::get_sample_count() must report this value for both min
 and max.  Note this feature does not guarantee the value is the same each call,
 to ensure that the plugin must require both this feature and
 bufsz:fixedBlockLength.</p>
-- 
cgit v1.2.1