diff options
| author | Chad Versace <chad.versace@linux.intel.com> | 2013-09-16 21:24:07 -0700 |
|---|---|---|
| committer | Chad Versace <chad.versace@linux.intel.com> | 2013-09-16 21:24:07 -0700 |
| commit | 1eb6e7b355bdc3615601deffa72c7e71e42dbf59 (patch) | |
| tree | 3726ef065b05825cc3e97b8d471daeffec97eb23 /man | |
| parent | 58a4d2a21c5f5ed91f4adae592ee3cd731e21c7e (diff) | |
man: Document new attrib WAFFLE_CONTEXT_DEBUG
The new attribute isn't implemented yet, but I like to commit
documentations before implementation. This attribute selects
a debug context.
Signed-off-by: Chad Versace <chad.versace@linux.intel.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/waffle_config.3.xml | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/man/waffle_config.3.xml b/man/waffle_config.3.xml index 42a92bc..46b0aa2 100644 --- a/man/waffle_config.3.xml +++ b/man/waffle_config.3.xml @@ -376,6 +376,34 @@ struct waffle_config; </varlistentry> <varlistentry> + <term><constant>WAFFLE_CONTEXT_DEBUG</constant></term> + <listitem> + <para> + This attribute, if true, instructs + <citerefentry><refentrytitle><function>waffle_context_create</function></refentrytitle><manvolnum>3</manvolnum></citerefentry> + to create a debug context. + + However, even if <function>waffle_config_choose()</function> + successfully returns a config for a debug context, the + native platform may later reject it when + <citerefentry><refentrytitle><function>waffle_context_create</function></refentrytitle><manvolnum>3</manvolnum></citerefentry> + is called. + </para> + <para> + Debug contexts are intended for use during application development, to provide additional runtime checking, + validation, and logging functionality while possibly incurring performance penalties. The additional + functionality provided by debug contexts may vary according to the implementation. In some cases a debug + context may be identical to a non-debug context. + </para> + <para> + This attribute is optional and its default value is false(0). + + Valid values are true(1), false(0), and <constant>WAFFLE_DONT_CARE</constant>. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><constant>WAFFLE_RED_SIZE</constant></term> <term><constant>WAFFLE_GREEN_SIZE</constant></term> <term><constant>WAFFLE_BLUE_SIZE</constant></term> |