summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorChad Versace <chad.versace@linux.intel.com>2013-09-18 19:50:23 -0700
committerChad Versace <chad.versace@linux.intel.com>2013-09-19 10:33:13 -0700
commit85a0e16e58ff7ef30fff39bd169895697ac3c2b0 (patch)
tree039119cdd5a739dd08e20fb292371b350aae9e0d /man
parentb5a1e63673e1dd9fbdff1c5546d082e8c1bdffd8 (diff)
man: Add feature macro WAFFLE_API_EXPERIMENTAL
waffle_window_resize() is proving difficult to implement because Waffle lacks an event model. We need a way to prevent clients from accidentally using it, on the master branch as well in stable releases, until it gets fixed or removed. All future API additions that I have strong doubts about will get guarded by WAFFLE_API_EXPERIMENTAL. Signed-off-by: Chad Versace <chad.versace@linux.intel.com>
Diffstat (limited to 'man')
-rw-r--r--man/waffle_feature_test_macros.7.xml11
1 files changed, 11 insertions, 0 deletions
diff --git a/man/waffle_feature_test_macros.7.xml b/man/waffle_feature_test_macros.7.xml
index 4e4298c..4ef68db 100644
--- a/man/waffle_feature_test_macros.7.xml
+++ b/man/waffle_feature_test_macros.7.xml
@@ -36,6 +36,7 @@
<refsynopsisdiv>
<synopsis>
<constant>WAFFLE_API_VERSION</constant>
+<constant>WAFFLE_API_EXPERIMENTAL</constant>
</synopsis>
</refsynopsisdiv>
@@ -81,6 +82,16 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><constant>WAFFLE_API_EXPERIMENTAL</constant></term>
+ <listitem>
+ <para>
+ This macro exposes experimental features in Waffle's headers.
+
+ Experimental features may be altered or removed without notice and do not belong to Waffle's stable API.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect2>