Typo fix: "cl_program_buid_info" should be: "cl_program_build_info"
Fixes https://github.com/KhronosGroup/OpenCL-Docs/issues/69
diff --git a/sdk/1.0/docs/man/clGetProgramBuildInfo.xml b/sdk/1.0/docs/man/clGetProgramBuildInfo.xml
index 6b6259f..8f4e574 100644
--- a/sdk/1.0/docs/man/clGetProgramBuildInfo.xml
+++ b/sdk/1.0/docs/man/clGetProgramBuildInfo.xml
@@ -4,21 +4,21 @@
<refentry>
<refentryinfo>
<keywordset>
- <keyword>
+ <keyword>
clGetProgramBuildInfo
</keyword>
</keywordset>
</refentryinfo>
<refmeta>
- <refentrytitle>
+ <refentrytitle>
clGetProgramBuildInfo
</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2009</year>
- <holder>The Khronos Group Inc.
+ <holder>The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
@@ -30,21 +30,21 @@
</copyright>
</refmiscinfo>
<manvolnum>2</manvolnum>
-
+
</refmeta>
-<!-- ================================ SYNOPSIS -->
+<!-- ================================ SYNOPSIS -->
<refnamediv id="clGetProgramBuildInfo">
- <refname>
+ <refname>
clGetProgramBuildInfo
- </refname>
+ </refname>
- <refpurpose>
+ <refpurpose>
Returns build information for each device in the program object.
- </refpurpose>
- </refnamediv>
+ </refpurpose>
+ </refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
@@ -54,19 +54,19 @@
<function>clGetProgramBuildInfo</function>
</funcdef>
- <paramdef><link xlink:href="abstractDataTypes.html">cl_program</link> <parameter>program</parameter></paramdef>,
- <paramdef>cl_device_id <parameter>device</parameter></paramdef>,
- <paramdef><link xlink:href="enums.html#cl_command_queue_properties">cl_program_build_info</link> <parameter>param_name</parameter></paramdef>,
- <paramdef><link xlink:href="scalarDataTypes.html">size_t</link> <parameter>param_value_size</parameter></paramdef>,
- <paramdef><link xlink:href="scalarDataTypes.html">void</link> <parameter>*param_value</parameter></paramdef>,
- <paramdef><link xlink:href="scalarDataTypes.html">size_t</link> <parameter>*param_value_size_ret</parameter></paramdef>
+ <paramdef><link xlink:href="abstractDataTypes.html">cl_program</link> <parameter>program</parameter></paramdef>,
+ <paramdef>cl_device_id <parameter>device</parameter></paramdef>,
+ <paramdef><link xlink:href="enums.html#cl_command_queue_properties">cl_program_build_info</link> <parameter>param_name</parameter></paramdef>,
+ <paramdef><link xlink:href="scalarDataTypes.html">size_t</link> <parameter>param_value_size</parameter></paramdef>,
+ <paramdef><link xlink:href="scalarDataTypes.html">void</link> <parameter>*param_value</parameter></paramdef>,
+ <paramdef><link xlink:href="scalarDataTypes.html">size_t</link> <parameter>*param_value_size_ret</parameter></paramdef>
</funcprototype>
- </funcsynopsis>
+ </funcsynopsis>
</refsynopsisdiv>
-<!-- ================================ PARAMETERS -->
+<!-- ================================ PARAMETERS -->
<refsect1 id="parameters">
<title>Parameters</title>
@@ -78,136 +78,136 @@
</varlistentry>
<varlistentry>
- <term><varname>device</varname></term>
+ <term><varname>device</varname></term>
<listitem><para>
- Specifies the device for which build information is being queried.
- <varname>device</varname> must be a valid device associated with <varname>program</varname>.
- </para></listitem>
+ Specifies the device for which build information is being queried.
+ <varname>device</varname> must be a valid device associated with <varname>program</varname>.
+ </para></listitem>
</varlistentry>
- <varlistentry>
- <term><varname>
+ <varlistentry>
+ <term><varname>
param_name
- </varname></term>
+ </varname></term>
<listitem>
- <para>
+ <para>
Specifies the information to query. The list of supported <varname>param_name</varname> types and the
- information returned in <varname>param_value</varname> by <function>clGetProgramBuildInfo</function> is described in the table below.
+ information returned in <varname>param_value</varname> by <function>clGetProgramBuildInfo</function> is described in the table below.
</para>
- <informaltable frame="all">
+ <informaltable frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="col1" colnum="1" />
<colspec colname="col2" colnum="2" />
<thead>
<row>
- <entry>cl_program_buid_info</entry>
- <entry>Return Type and Info. returned in <varname>param_value</varname></entry>
+ <entry>cl_program_build_info</entry>
+ <entry>Return Type and Info. returned in <varname>param_value</varname></entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>CL_PROGRAM_BUILD_STATUS</constant></entry>
- <entry>Return type: cl_build_status
- <para>
- Returns the build status of <varname>program</varname> for a specific device as given by <varname>device</varname>. This can be one of the following:
- </para>
- <para>
- <errorname>CL_BUILD_NONE</errorname>. The build status returned if no build has been performed on the specified program object for <varname>device</varname>.
- </para>
- <para>
- <errorname>CL_BUILD_ERROR</errorname>. The build status returned if the last call to clBuildProgram on the specified program object for <varname>device</varname> generated an error.
- </para>
- <para>
- <errorname>CL_BUILD_SUCCESS</errorname>. The build status retrned if the last call to <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> on the specified program object for <varname>device</varname> was successful.
- </para>
- <para>
- <errorname>CL_BUILD_IN_PROGRESS</errorname>. The build status returned if the last call to <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> on the specified program object for <varname>device</varname> has not finished.
- </para>
+ <entry>Return type: cl_build_status
+ <para>
+ Returns the build status of <varname>program</varname> for a specific device as given by <varname>device</varname>. This can be one of the following:
+ </para>
+ <para>
+ <errorname>CL_BUILD_NONE</errorname>. The build status returned if no build has been performed on the specified program object for <varname>device</varname>.
+ </para>
+ <para>
+ <errorname>CL_BUILD_ERROR</errorname>. The build status returned if the last call to clBuildProgram on the specified program object for <varname>device</varname> generated an error.
+ </para>
+ <para>
+ <errorname>CL_BUILD_SUCCESS</errorname>. The build status retrned if the last call to <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> on the specified program object for <varname>device</varname> was successful.
+ </para>
+ <para>
+ <errorname>CL_BUILD_IN_PROGRESS</errorname>. The build status returned if the last call to <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> on the specified program object for <varname>device</varname> has not finished.
+ </para>
</entry>
</row>
-
+
<row>
<entry><errorname>CL_PROGRAM_BUILD_OPTIONS</errorname></entry>
<entry>Return type: char[]
- <para>
- Return the build options specified by the <varname>options</varname> argument in <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> for <varname>device</varname>.
- </para>
- <para>
- If build status of <varname>program</varname> for <varname>device</varname> is <errorname>CL_BUILD_NONE</errorname>, an empty string is returned.
- </para>
- </entry>
+ <para>
+ Return the build options specified by the <varname>options</varname> argument in <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> for <varname>device</varname>.
+ </para>
+ <para>
+ If build status of <varname>program</varname> for <varname>device</varname> is <errorname>CL_BUILD_NONE</errorname>, an empty string is returned.
+ </para>
+ </entry>
</row>
<row>
<entry><errorname>CL_PROGRAM_BUILD_LOG</errorname></entry>
- <entry>Return type: char[]
- <para>
- Return the build log when
- <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> was called for <varname>device</varname>. If build status of <varname>program</varname> for <varname>device</varname> is <errorname>CL_BUILD_NONE</errorname>, an empty string is returned.</para>
- </entry>
+ <entry>Return type: char[]
+ <para>
+ Return the build log when
+ <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> was called for <varname>device</varname>. If build status of <varname>program</varname> for <varname>device</varname> is <errorname>CL_BUILD_NONE</errorname>, an empty string is returned.</para>
+ </entry>
</row>
- </tbody>
+ </tbody>
</tgroup>
- </informaltable>
+ </informaltable>
</listitem>
- </varlistentry>
-
+ </varlistentry>
+
<varlistentry>
<term><varname>param_value</varname></term>
- <listitem><para>
- A pointer to memory where the appropriate result being queried is returned.
- If <varname>param_value</varname> is NULL, it is ignored.
- </para></listitem>
+ <listitem><para>
+ A pointer to memory where the appropriate result being queried is returned.
+ If <varname>param_value</varname> is NULL, it is ignored.
+ </para></listitem>
</varlistentry>
-
+
<varlistentry>
<term><varname>param_value_size</varname></term>
<listitem><para>
Specifies the size in bytes of memory pointed to by <varname>param_value</varname>. This size must be greater than or equal to the size of return type as described in the table above.
- </para></listitem>
+ </para></listitem>
</varlistentry>
-
+
<varlistentry>
<term><varname>param_value_size_ret</varname></term>
- <listitem><para>
- Returns the actual size in bytes of data copied to <varname>param_value</varname>. If <varname>param_value_size_ret</varname> is NULL, it is ignored.
- </para></listitem>
+ <listitem><para>
+ Returns the actual size in bytes of data copied to <varname>param_value</varname>. If <varname>param_value_size_ret</varname> is NULL, it is ignored.
+ </para></listitem>
</varlistentry>
</variablelist>
</refsect1>
-
-<!-- ================================ NOTES -->
+
+<!-- ================================ NOTES -->
<!-- <refsect1 id="notes"><title>Notes</title>
<para>
- </para>
- </refsect1>
--->
+ </para>
+ </refsect1>
+-->
-<!-- ================================ ERRORS -->
+<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
<para>Returns <errorname>CL_SUCCESS</errorname> if the function is executed successfully. Otherwise it returns the following:
</para>
<itemizedlist mark="disc">
- <listitem>
- Returns <errorname>CL_INVALID_DEVICE</errorname> if <varname>device</varname> is not in the list of devices associated with program.
- </listitem>
- <listitem>
- Returns <errorname>CL_INVALID_VALUE</errorname> if <varname>param_name</varname> is not valid, or if size in bytes specified by <varname>param_value_size</varname> is less than size of return type and <varname>param_value</varname> is not NULL.
- </listitem>
- <listitem>
- Returns <errorname>CL_INVALID_PROGRAM</errorname> if <varname>program</varname> is a not a valid program object.
- </listitem>
- </itemizedlist>
+ <listitem>
+ Returns <errorname>CL_INVALID_DEVICE</errorname> if <varname>device</varname> is not in the list of devices associated with program.
+ </listitem>
+ <listitem>
+ Returns <errorname>CL_INVALID_VALUE</errorname> if <varname>param_name</varname> is not valid, or if size in bytes specified by <varname>param_value_size</varname> is less than size of return type and <varname>param_value</varname> is not NULL.
+ </listitem>
+ <listitem>
+ Returns <errorname>CL_INVALID_PROGRAM</errorname> if <varname>program</varname> is a not a valid program object.
+ </listitem>
+ </itemizedlist>
</refsect1>
-
-<!-- ================================ EXAMPLE -->
+
+<!-- ================================ EXAMPLE -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
-<!--
+<!--
<refsect2 id="example1">
<title>
Example
@@ -224,28 +224,28 @@
</row>
</tbody>
</tgroup>
- </informaltable>
- </refsect2>
--->
+ </informaltable>
+ </refsect2>
+-->
-<!-- ================================ SPECIFICATION -->
+<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
--->
+-->
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
-
-
+
+
<olink uri="clGetProgramBuildInfo">OpenCL Specification</olink>
</para>
- </refsect1>
+ </refsect1>
-<!-- ================================ ALSO SEE -->
-
+<!-- ================================ ALSO SEE -->
+
<refsect1 id="seealso"><title>Also see</title>
<para>
@@ -254,14 +254,14 @@
</refsect1>
-<!-- ================================ COPYRIGHT -->
+<!-- ================================ COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->
-
+
<refsect3 id="Copyright"><title></title>
- <imageobject>
+ <imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
</imageobject>
- <para />
+ <para />
</refsect3>
</refentry>
diff --git a/sdk/1.0/docs/man/xhtml/clGetProgramBuildInfo.html b/sdk/1.0/docs/man/xhtml/clGetProgramBuildInfo.html
index 11479a9..99f2dda 100644
--- a/sdk/1.0/docs/man/xhtml/clGetProgramBuildInfo.html
+++ b/sdk/1.0/docs/man/xhtml/clGetProgramBuildInfo.html
@@ -215,7 +215,7 @@
</style>
<title>clGetProgramBuildInfo</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
- <meta name="keywords" content=" clGetProgramBuildInfo " />
+ <meta name="keywords" content=" clGetProgramBuildInfo " />
</head>
<body>
<div class="refentry">
@@ -223,10 +223,10 @@
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<a xmlns="http://www.w3.org/1999/xhtml" id="clGetProgramBuildInfo"></a>
- <h1>
+ <h1>
clGetProgramBuildInfo
</h1>
- <p>
+ <p>
Returns build information for each device in the program object.
</p>
</div>
@@ -286,21 +286,21 @@
</dt>
<dd>
<p>
- Specifies the device for which build information is being queried.
- <code class="varname">device</code> must be a valid device associated with <code class="varname">program</code>.
- </p>
+ Specifies the device for which build information is being queried.
+ <code class="varname">device</code> must be a valid device associated with <code class="varname">program</code>.
+ </p>
</dd>
<dt>
<span class="term">
- <code class="varname">
+ <code class="varname">
param_name
- </code>
+ </code>
</span>
</dt>
<dd>
- <p>
+ <p>
Specifies the information to query. The list of supported <code class="varname">param_name</code> types and the
- information returned in <code class="varname">param_value</code> by <code class="function">clGetProgramBuildInfo</code> is described in the table below.
+ information returned in <code class="varname">param_value</code> by <code class="function">clGetProgramBuildInfo</code> is described in the table below.
</p>
<div class="informaltable">
<table class="informaltable" border="1">
@@ -310,7 +310,7 @@
</colgroup>
<thead>
<tr>
- <th align="left">cl_program_buid_info</th>
+ <th align="left">cl_program_build_info</th>
<th align="left">Return Type and Info. returned in <code class="varname">param_value</code></th>
</tr>
</thead>
@@ -320,21 +320,21 @@
<code class="constant">CL_PROGRAM_BUILD_STATUS</code>
</td>
<td align="left">Return type: cl_build_status
- <p>
- Returns the build status of <code class="varname">program</code> for a specific device as given by <code class="varname">device</code>. This can be one of the following:
- </p>
- <p>
- <span class="errorname">CL_BUILD_NONE</span>. The build status returned if no build has been performed on the specified program object for <code class="varname">device</code>.
- </p>
- <p>
- <span class="errorname">CL_BUILD_ERROR</span>. The build status returned if the last call to clBuildProgram on the specified program object for <code class="varname">device</code> generated an error.
- </p>
- <p>
- <span class="errorname">CL_BUILD_SUCCESS</span>. The build status retrned if the last call to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the specified program object for <code class="varname">device</code> was successful.
- </p>
- <p>
- <span class="errorname">CL_BUILD_IN_PROGRESS</span>. The build status returned if the last call to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the specified program object for <code class="varname">device</code> has not finished.
- </p>
+ <p>
+ Returns the build status of <code class="varname">program</code> for a specific device as given by <code class="varname">device</code>. This can be one of the following:
+ </p>
+ <p>
+ <span class="errorname">CL_BUILD_NONE</span>. The build status returned if no build has been performed on the specified program object for <code class="varname">device</code>.
+ </p>
+ <p>
+ <span class="errorname">CL_BUILD_ERROR</span>. The build status returned if the last call to clBuildProgram on the specified program object for <code class="varname">device</code> generated an error.
+ </p>
+ <p>
+ <span class="errorname">CL_BUILD_SUCCESS</span>. The build status retrned if the last call to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the specified program object for <code class="varname">device</code> was successful.
+ </p>
+ <p>
+ <span class="errorname">CL_BUILD_IN_PROGRESS</span>. The build status returned if the last call to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the specified program object for <code class="varname">device</code> has not finished.
+ </p>
</td>
</tr>
<tr>
@@ -342,23 +342,23 @@
<span class="errorname">CL_PROGRAM_BUILD_OPTIONS</span>
</td>
<td align="left">Return type: char[]
- <p>
- Return the build options specified by the <code class="varname">options</code> argument in <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> for <code class="varname">device</code>.
- </p>
- <p>
- If build status of <code class="varname">program</code> for <code class="varname">device</code> is <span class="errorname">CL_BUILD_NONE</span>, an empty string is returned.
- </p>
- </td>
+ <p>
+ Return the build options specified by the <code class="varname">options</code> argument in <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> for <code class="varname">device</code>.
+ </p>
+ <p>
+ If build status of <code class="varname">program</code> for <code class="varname">device</code> is <span class="errorname">CL_BUILD_NONE</span>, an empty string is returned.
+ </p>
+ </td>
</tr>
<tr>
<td align="left">
<span class="errorname">CL_PROGRAM_BUILD_LOG</span>
</td>
<td align="left">Return type: char[]
- <p>
- Return the build log when
- <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> was called for <code class="varname">device</code>. If build status of <code class="varname">program</code> for <code class="varname">device</code> is <span class="errorname">CL_BUILD_NONE</span>, an empty string is returned.</p>
- </td>
+ <p>
+ Return the build log when
+ <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> was called for <code class="varname">device</code>. If build status of <code class="varname">program</code> for <code class="varname">device</code> is <span class="errorname">CL_BUILD_NONE</span>, an empty string is returned.</p>
+ </td>
</tr>
</tbody>
</table>
@@ -370,10 +370,10 @@
</span>
</dt>
<dd>
- <p>
- A pointer to memory where the appropriate result being queried is returned.
- If <code class="varname">param_value</code> is NULL, it is ignored.
- </p>
+ <p>
+ A pointer to memory where the appropriate result being queried is returned.
+ If <code class="varname">param_value</code> is NULL, it is ignored.
+ </p>
</dd>
<dt>
<span class="term">
@@ -383,7 +383,7 @@
<dd>
<p>
Specifies the size in bytes of memory pointed to by <code class="varname">param_value</code>. This size must be greater than or equal to the size of return type as described in the table above.
- </p>
+ </p>
</dd>
<dt>
<span class="term">
@@ -391,9 +391,9 @@
</span>
</dt>
<dd>
- <p>
- Returns the actual size in bytes of data copied to <code class="varname">param_value</code>. If <code class="varname">param_value_size_ret</code> is NULL, it is ignored.
- </p>
+ <p>
+ Returns the actual size in bytes of data copied to <code class="varname">param_value</code>. If <code class="varname">param_value_size_ret</code> is NULL, it is ignored.
+ </p>
</dd>
</dl>
</div>
@@ -406,14 +406,14 @@
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem" style="list-style-type: disc">
- Returns <span class="errorname">CL_INVALID_DEVICE</span> if <code class="varname">device</code> is not in the list of devices associated with program.
- </li>
+ Returns <span class="errorname">CL_INVALID_DEVICE</span> if <code class="varname">device</code> is not in the list of devices associated with program.
+ </li>
<li class="listitem" style="list-style-type: disc">
- Returns <span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">param_name</code> is not valid, or if size in bytes specified by <code class="varname">param_value_size</code> is less than size of return type and <code class="varname">param_value</code> is not NULL.
- </li>
+ Returns <span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">param_name</code> is not valid, or if size in bytes specified by <code class="varname">param_value_size</code> is less than size of return type and <code class="varname">param_value</code> is not NULL.
+ </li>
<li class="listitem" style="list-style-type: disc">
- Returns <span class="errorname">CL_INVALID_PROGRAM</span> if <code class="varname">program</code> is a not a valid program object.
- </li>
+ Returns <span class="errorname">CL_INVALID_PROGRAM</span> if <code class="varname">program</code> is a not a valid program object.
+ </li>
</ul>
</div>
</div>
@@ -422,8 +422,8 @@
<h2>Specification</h2>
<p>
<img src="pdficon_small1.gif" />
-
-
+
+
<a href="http://www.khronos.org/registry/cl/specs/opencl-1.0.pdf#page=98" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
diff --git a/sdk/1.1/docs/man/clGetProgramBuildInfo.xml b/sdk/1.1/docs/man/clGetProgramBuildInfo.xml
index 37d05fe..d6b7b69 100644
--- a/sdk/1.1/docs/man/clGetProgramBuildInfo.xml
+++ b/sdk/1.1/docs/man/clGetProgramBuildInfo.xml
@@ -4,21 +4,21 @@
<refentry>
<refentryinfo>
<keywordset>
- <keyword>
+ <keyword>
clGetProgramBuildInfo
</keyword>
</keywordset>
</refentryinfo>
<refmeta>
- <refentrytitle>
+ <refentrytitle>
clGetProgramBuildInfo
</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2010</year>
- <holder>The Khronos Group Inc.
+ <holder>The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
@@ -30,21 +30,21 @@
</copyright>
</refmiscinfo>
<manvolnum>3</manvolnum>
-
+
</refmeta>
-<!-- ================================ SYNOPSIS -->
+<!-- ================================ SYNOPSIS -->
<refnamediv id="clGetProgramBuildInfo">
- <refname>
+ <refname>
clGetProgramBuildInfo
- </refname>
+ </refname>
- <refpurpose>
+ <refpurpose>
Returns build information for each device in the program object.
- </refpurpose>
- </refnamediv>
+ </refpurpose>
+ </refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
@@ -59,14 +59,14 @@
<paramdef><link xlink:href="enums.html#cl_command_queue_properties">cl_program_build_info</link> <parameter>param_name</parameter></paramdef>,
<paramdef><link xlink:href="scalarDataTypes.html">size_t</link> <parameter>param_value_size</parameter></paramdef>,
<paramdef><link xlink:href="scalarDataTypes.html">void</link> <parameter>*param_value</parameter></paramdef>,
- <paramdef><link xlink:href="scalarDataTypes.html">size_t</link> <parameter>*param_value_size_ret</parameter></paramdef>
+ <paramdef><link xlink:href="scalarDataTypes.html">size_t</link> <parameter>*param_value_size_ret</parameter></paramdef>
</funcprototype>
- </funcsynopsis>
+ </funcsynopsis>
</refsynopsisdiv>
-<!-- ================================ PARAMETERS -->
+<!-- ================================ PARAMETERS -->
<refsect1 id="parameters">
<title>Parameters</title>
@@ -80,20 +80,20 @@
<varlistentry>
<term><varname>device</varname></term>
<listitem><para>
- Specifies the device for which build information is being queried.
+ Specifies the device for which build information is being queried.
<varname>device</varname> must be a valid device associated with <varname>program</varname>.
</para></listitem>
</varlistentry>
<varlistentry>
- <term><varname>
+ <term><varname>
param_name
</varname></term>
<listitem>
- <para>
+ <para>
Specifies the information to query. The list of supported <varname>param_name</varname> types and the
- information returned in <varname>param_value</varname> by <function>clGetProgramBuildInfo</function> is
+ information returned in <varname>param_value</varname> by <function>clGetProgramBuildInfo</function> is
described in the table below.
</para>
<informaltable frame="all">
@@ -102,7 +102,7 @@
<colspec colname="col2" colnum="2" />
<thead>
<row>
- <entry>cl_program_buid_info</entry>
+ <entry>cl_program_build_info</entry>
<entry>Return Type and Info. returned in <varname>param_value</varname></entry>
</row>
</thead>
@@ -111,41 +111,41 @@
<entry><constant>CL_PROGRAM_BUILD_STATUS</constant></entry>
<entry>Return type: cl_build_status
<para>
- Returns the build status of <varname>program</varname> for a specific device
+ Returns the build status of <varname>program</varname> for a specific device
as given by <varname>device</varname>. This can be one of the following:
</para>
<para>
- <errorname>CL_BUILD_NONE</errorname>. The build status returned if no build has
+ <errorname>CL_BUILD_NONE</errorname>. The build status returned if no build has
been performed on the specified program object for <varname>device</varname>.
</para>
<para>
- <errorname>CL_BUILD_ERROR</errorname>. The build status returned if the last call
- to <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> on the specified program object for <varname>device</varname>
+ <errorname>CL_BUILD_ERROR</errorname>. The build status returned if the last call
+ to <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> on the specified program object for <varname>device</varname>
generated an error.
</para>
<para>
- <errorname>CL_BUILD_SUCCESS</errorname>. The build status returned if the last call
- to <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> on the
+ <errorname>CL_BUILD_SUCCESS</errorname>. The build status returned if the last call
+ to <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> on the
specified program object for <varname>device</varname> was successful.
</para>
<para>
- <errorname>CL_BUILD_IN_PROGRESS</errorname>. The build status returned if the last call
- to <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> on the
+ <errorname>CL_BUILD_IN_PROGRESS</errorname>. The build status returned if the last call
+ to <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> on the
specified program object for <varname>device</varname> has not finished.
</para>
</entry>
</row>
-
+
<row>
<entry><errorname>CL_PROGRAM_BUILD_OPTIONS</errorname></entry>
<entry>Return type: char[]
<para>
- Return the build options specified by the <varname>options</varname> argument
- in <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry>
+ Return the build options specified by the <varname>options</varname> argument
+ in <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry>
for <varname>device</varname>.
</para>
<para>
- If build status of <varname>program</varname> for <varname>device</varname>
+ If build status of <varname>program</varname> for <varname>device</varname>
is <errorname>CL_BUILD_NONE</errorname>, an empty string is returned.
</para>
</entry>
@@ -155,93 +155,93 @@
<entry>Return type: char[]
<para>
Return the build log when
- <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> was called
- for <varname>device</varname>. If build status of <varname>program</varname>
- for <varname>device</varname> is <errorname>CL_BUILD_NONE</errorname>, an empty string
+ <citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry> was called
+ for <varname>device</varname>. If build status of <varname>program</varname>
+ for <varname>device</varname> is <errorname>CL_BUILD_NONE</errorname>, an empty string
is returned.</para>
</entry>
</row>
- </tbody>
+ </tbody>
</tgroup>
- </informaltable>
+ </informaltable>
</listitem>
- </varlistentry>
-
+ </varlistentry>
+
<varlistentry>
<term><varname>param_value</varname></term>
- <listitem><para>
- A pointer to memory where the appropriate result being queried is returned.
+ <listitem><para>
+ A pointer to memory where the appropriate result being queried is returned.
If <varname>param_value</varname> is NULL, it is ignored.
</para></listitem>
</varlistentry>
-
+
<varlistentry>
<term><varname>param_value_size</varname></term>
<listitem><para>
- Specifies the size in bytes of memory pointed to by <varname>param_value</varname>. This size
+ Specifies the size in bytes of memory pointed to by <varname>param_value</varname>. This size
must be greater than or equal to the size of return type as described in the table above.
</para></listitem>
</varlistentry>
-
+
<varlistentry>
<term><varname>param_value_size_ret</varname></term>
- <listitem><para>
- Returns the actual size in bytes of data copied to <varname>param_value</varname>.
+ <listitem><para>
+ Returns the actual size in bytes of data copied to <varname>param_value</varname>.
If <varname>param_value_size_ret</varname> is NULL, it is ignored.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
-
-<!-- ================================ NOTES -->
+
+<!-- ================================ NOTES -->
<!-- <refsect1 id="notes"><title>Notes</title>
<para>
</para>
</refsect1>
--->
+-->
-<!-- ================================ ERRORS -->
+<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
<para>
- Returns <errorname>CL_SUCCESS</errorname> if the function is executed successfully.
+ Returns <errorname>CL_SUCCESS</errorname> if the function is executed successfully.
Otherwise it returns the following:
</para>
<itemizedlist mark="disc">
<listitem>
- Returns <errorname>CL_INVALID_DEVICE</errorname> if <varname>device</varname>
+ Returns <errorname>CL_INVALID_DEVICE</errorname> if <varname>device</varname>
is not in the list of devices associated with <varname>program</varname>.
</listitem>
<listitem>
- Returns <errorname>CL_INVALID_VALUE</errorname> if <varname>param_name</varname>
- is not valid, or if size in bytes specified by <varname>param_value_size</varname>
- is less than size of return type
+ Returns <errorname>CL_INVALID_VALUE</errorname> if <varname>param_name</varname>
+ is not valid, or if size in bytes specified by <varname>param_value_size</varname>
+ is less than size of return type
and <varname>param_value</varname> is not NULL.
</listitem>
<listitem>
- Returns <errorname>CL_INVALID_PROGRAM</errorname> if <varname>program</varname>
+ Returns <errorname>CL_INVALID_PROGRAM</errorname> if <varname>program</varname>
is a not a valid program object.
</listitem>
<listitem>
- <errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
- resources required by the
+ <errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
+ resources required by the
OpenCL implementation on the device.
</listitem>
<listitem>
- <errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
- resources required by
+ <errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
+ resources required by
the OpenCL implementation on the host.
</listitem>
</itemizedlist>
</refsect1>
-
-<!-- ================================ EXAMPLE -->
+
+<!-- ================================ EXAMPLE -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
-<!--
+<!--
<refsect2 id="example1">
<title>
Example
@@ -258,28 +258,28 @@
</row>
</tbody>
</tgroup>
- </informaltable>
- </refsect2>
--->
+ </informaltable>
+ </refsect2>
+-->
-<!-- ================================ SPECIFICATION -->
+<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
--->
+-->
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
-
-
+
+
<olink uri="clGetProgramBuildInfo">OpenCL Specification</olink>
</para>
- </refsect1>
+ </refsect1>
-<!-- ================================ ALSO SEE -->
-
+<!-- ================================ ALSO SEE -->
+
<refsect1 id="seealso"><title>Also see</title>
<para>
@@ -288,9 +288,9 @@
</refsect1>
-<!-- ================================ COPYRIGHT -->
+<!-- ================================ COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->
-
+
<refsect3 id="Copyright"><title></title>
<imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
diff --git a/sdk/1.1/docs/man/xhtml/clGetProgramBuildInfo.html b/sdk/1.1/docs/man/xhtml/clGetProgramBuildInfo.html
index 92365c1..2ca6e9f 100644
--- a/sdk/1.1/docs/man/xhtml/clGetProgramBuildInfo.html
+++ b/sdk/1.1/docs/man/xhtml/clGetProgramBuildInfo.html
@@ -214,8 +214,8 @@
</style>
<title>clGetProgramBuildInfo</title>
- <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
- <meta name="keywords" content=" clGetProgramBuildInfo " />
+ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
+ <meta name="keywords" content=" clGetProgramBuildInfo " />
</head>
<body>
<div class="refentry">
@@ -223,10 +223,10 @@
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<a xmlns="http://www.w3.org/1999/xhtml" id="clGetProgramBuildInfo"></a>
- <h1>
+ <h1>
clGetProgramBuildInfo
</h1>
- <p>
+ <p>
Returns build information for each device in the program object.
</p>
</div>
@@ -286,32 +286,32 @@
</dt>
<dd>
<p>
- Specifies the device for which build information is being queried.
+ Specifies the device for which build information is being queried.
<code class="varname">device</code> must be a valid device associated with <code class="varname">program</code>.
</p>
</dd>
<dt>
<span class="term">
- <code class="varname">
+ <code class="varname">
param_name
</code>
</span>
</dt>
<dd>
- <p>
+ <p>
Specifies the information to query. The list of supported <code class="varname">param_name</code> types and the
- information returned in <code class="varname">param_value</code> by <code class="function">clGetProgramBuildInfo</code> is
+ information returned in <code class="varname">param_value</code> by <code class="function">clGetProgramBuildInfo</code> is
described in the table below.
</p>
<div class="informaltable">
- <table border="1">
+ <table class="informaltable" border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
</colgroup>
<thead>
<tr>
- <th align="left">cl_program_buid_info</th>
+ <th align="left">cl_program_build_info</th>
<th align="left">Return Type and Info. returned in <code class="varname">param_value</code></th>
</tr>
</thead>
@@ -322,26 +322,26 @@
</td>
<td align="left">Return type: cl_build_status
<p>
- Returns the build status of <code class="varname">program</code> for a specific device
+ Returns the build status of <code class="varname">program</code> for a specific device
as given by <code class="varname">device</code>. This can be one of the following:
</p>
<p>
- <span class="errorname">CL_BUILD_NONE</span>. The build status returned if no build has
+ <span class="errorname">CL_BUILD_NONE</span>. The build status returned if no build has
been performed on the specified program object for <code class="varname">device</code>.
</p>
<p>
- <span class="errorname">CL_BUILD_ERROR</span>. The build status returned if the last call
- to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the specified program object for <code class="varname">device</code>
+ <span class="errorname">CL_BUILD_ERROR</span>. The build status returned if the last call
+ to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the specified program object for <code class="varname">device</code>
generated an error.
</p>
<p>
- <span class="errorname">CL_BUILD_SUCCESS</span>. The build status returned if the last call
- to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the
+ <span class="errorname">CL_BUILD_SUCCESS</span>. The build status returned if the last call
+ to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the
specified program object for <code class="varname">device</code> was successful.
</p>
<p>
- <span class="errorname">CL_BUILD_IN_PROGRESS</span>. The build status returned if the last call
- to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the
+ <span class="errorname">CL_BUILD_IN_PROGRESS</span>. The build status returned if the last call
+ to <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> on the
specified program object for <code class="varname">device</code> has not finished.
</p>
</td>
@@ -352,12 +352,12 @@
</td>
<td align="left">Return type: char[]
<p>
- Return the build options specified by the <code class="varname">options</code> argument
- in <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a>
+ Return the build options specified by the <code class="varname">options</code> argument
+ in <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a>
for <code class="varname">device</code>.
</p>
<p>
- If build status of <code class="varname">program</code> for <code class="varname">device</code>
+ If build status of <code class="varname">program</code> for <code class="varname">device</code>
is <span class="errorname">CL_BUILD_NONE</span>, an empty string is returned.
</p>
</td>
@@ -369,9 +369,9 @@
<td align="left">Return type: char[]
<p>
Return the build log when
- <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> was called
- for <code class="varname">device</code>. If build status of <code class="varname">program</code>
- for <code class="varname">device</code> is <span class="errorname">CL_BUILD_NONE</span>, an empty string
+ <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> was called
+ for <code class="varname">device</code>. If build status of <code class="varname">program</code>
+ for <code class="varname">device</code> is <span class="errorname">CL_BUILD_NONE</span>, an empty string
is returned.</p>
</td>
</tr>
@@ -385,8 +385,8 @@
</span>
</dt>
<dd>
- <p>
- A pointer to memory where the appropriate result being queried is returned.
+ <p>
+ A pointer to memory where the appropriate result being queried is returned.
If <code class="varname">param_value</code> is NULL, it is ignored.
</p>
</dd>
@@ -397,7 +397,7 @@
</dt>
<dd>
<p>
- Specifies the size in bytes of memory pointed to by <code class="varname">param_value</code>. This size
+ Specifies the size in bytes of memory pointed to by <code class="varname">param_value</code>. This size
must be greater than or equal to the size of return type as described in the table above.
</p>
</dd>
@@ -407,8 +407,8 @@
</span>
</dt>
<dd>
- <p>
- Returns the actual size in bytes of data copied to <code class="varname">param_value</code>.
+ <p>
+ Returns the actual size in bytes of data copied to <code class="varname">param_value</code>.
If <code class="varname">param_value_size_ret</code> is NULL, it is ignored.
</p>
</dd>
@@ -419,31 +419,31 @@
<a id="errors"></a>
<h2>Errors</h2>
<p>
- Returns <span class="errorname">CL_SUCCESS</span> if the function is executed successfully.
+ Returns <span class="errorname">CL_SUCCESS</span> if the function is executed successfully.
Otherwise it returns the following:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem" style="list-style-type: disc">
- Returns <span class="errorname">CL_INVALID_DEVICE</span> if <code class="varname">device</code>
+ Returns <span class="errorname">CL_INVALID_DEVICE</span> if <code class="varname">device</code>
is not in the list of devices associated with <code class="varname">program</code>.
</li>
<li class="listitem" style="list-style-type: disc">
- Returns <span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">param_name</code>
- is not valid, or if size in bytes specified by <code class="varname">param_value_size</code>
- is less than size of return type
+ Returns <span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">param_name</code>
+ is not valid, or if size in bytes specified by <code class="varname">param_value_size</code>
+ is less than size of return type
and <code class="varname">param_value</code> is not NULL.
</li>
<li class="listitem" style="list-style-type: disc">
- Returns <span class="errorname">CL_INVALID_PROGRAM</span> if <code class="varname">program</code>
+ Returns <span class="errorname">CL_INVALID_PROGRAM</span> if <code class="varname">program</code>
is a not a valid program object.
</li>
- <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate
- resources required by the
+ <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate
+ resources required by the
OpenCL implementation on the device.
</li>
- <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
- resources required by
+ <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
+ resources required by
the OpenCL implementation on the host.
</li>
</ul>
@@ -454,8 +454,8 @@
<h2>Specification</h2>
<p>
<img src="pdficon_small1.gif" />
-
-
+
+
<a href="http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf#page=120" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
diff --git a/sdk/1.2/docs/man/clGetProgramBuildInfo.xml b/sdk/1.2/docs/man/clGetProgramBuildInfo.xml
index eddd09e..8303462 100644
--- a/sdk/1.2/docs/man/clGetProgramBuildInfo.xml
+++ b/sdk/1.2/docs/man/clGetProgramBuildInfo.xml
@@ -103,7 +103,7 @@
<colspec colname="col2" colnum="2" />
<thead>
<row>
- <entry>cl_program_buid_info</entry>
+ <entry>cl_program_build_info</entry>
<entry>Return Type and Info. returned in <varname>param_value</varname></entry>
</row>
</thead>
diff --git a/sdk/1.2/docs/man/xhtml/clGetProgramBuildInfo.html b/sdk/1.2/docs/man/xhtml/clGetProgramBuildInfo.html
index 8c56acd..6cf00ed 100644
--- a/sdk/1.2/docs/man/xhtml/clGetProgramBuildInfo.html
+++ b/sdk/1.2/docs/man/xhtml/clGetProgramBuildInfo.html
@@ -214,7 +214,7 @@
</style>
<title>clGetProgramBuildInfo</title>
- <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
+ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content=" clGetProgramBuildInfo " />
</head>
<body>
@@ -305,14 +305,14 @@
is described in the table below.
</p>
<div class="informaltable">
- <table border="1">
+ <table class="informaltable" border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
</colgroup>
<thead>
<tr>
- <th align="left">cl_program_buid_info</th>
+ <th align="left">cl_program_build_info</th>
<th align="left">Return Type and Info. returned in <code class="varname">param_value</code></th>
</tr>
</thead>
