diff mbox

[i-g-t,7/7] docs: add missing sections to intel-gpu-tools-docs.xml

Message ID 1402410657-4768-7-git-send-email-thomas.wood@intel.com (mailing list archive)
State New, archived
Headers show

Commit Message

Thomas Wood June 10, 2014, 2:30 p.m. UTC
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
---
 docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Daniel Vetter June 10, 2014, 2:47 p.m. UTC | #1
On Tue, Jun 10, 2014 at 03:30:57PM +0100, Thomas Wood wrote:
> Signed-off-by: Thomas Wood <thomas.wood@intel.com>

I've intentionally left these out since they're not really part of the
core test library ... E.g. all public rendercopy functions are documented
as part of the "intel batchbuffer" library.
-Daniel

> ---
>  docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
> index dcfff33..96cf77f 100644
> --- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
> +++ b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
> @@ -15,6 +15,7 @@
>  
>    <chapter>
>      <title>Intel GPU Tools</title>
> +    <xi:include href="xml/debug.xml"/>
>      <xi:include href="xml/drmtest.xml"/>
>      <xi:include href="xml/igt_core.xml"/>
>      <xi:include href="xml/igt_debugfs.xml"/>
> @@ -22,9 +23,12 @@
>      <xi:include href="xml/igt_fb.xml"/>
>      <xi:include href="xml/igt_aux.xml"/>
>      <xi:include href="xml/ioctl_wrappers.xml"/>
> +    <xi:include href="xml/instdone.xml"/>
>      <xi:include href="xml/intel_batchbuffer.xml"/>
>      <xi:include href="xml/intel_chipset.xml"/>
>      <xi:include href="xml/intel_io.xml"/>
> +    <xi:include href="xml/media_fill.xml"/>
> +    <xi:include href="xml/rendercopy.xml"/>
>  
>    </chapter>
>    <index id="api-index-full">
> -- 
> 1.9.3
> 
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/intel-gfx
Thomas Wood June 11, 2014, 10:36 a.m. UTC | #2
On 10 June 2014 15:47, Daniel Vetter <daniel@ffwll.ch> wrote:
> On Tue, Jun 10, 2014 at 03:30:57PM +0100, Thomas Wood wrote:
>> Signed-off-by: Thomas Wood <thomas.wood@intel.com>
>
> I've intentionally left these out since they're not really part of the
> core test library ... E.g. all public rendercopy functions are documented
> as part of the "intel batchbuffer" library.
> -Daniel

These functions currently appear in the API index and therefore
produce warnings that there is no link for them. If they are private
then they can be left out of the documentation altogether and their
headers added to the IGNORE_HEADERS directive instead.


>
>> ---
>>  docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml | 4 ++++
>>  1 file changed, 4 insertions(+)
>>
>> diff --git a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
>> index dcfff33..96cf77f 100644
>> --- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
>> +++ b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
>> @@ -15,6 +15,7 @@
>>
>>    <chapter>
>>      <title>Intel GPU Tools</title>
>> +    <xi:include href="xml/debug.xml"/>
>>      <xi:include href="xml/drmtest.xml"/>
>>      <xi:include href="xml/igt_core.xml"/>
>>      <xi:include href="xml/igt_debugfs.xml"/>
>> @@ -22,9 +23,12 @@
>>      <xi:include href="xml/igt_fb.xml"/>
>>      <xi:include href="xml/igt_aux.xml"/>
>>      <xi:include href="xml/ioctl_wrappers.xml"/>
>> +    <xi:include href="xml/instdone.xml"/>
>>      <xi:include href="xml/intel_batchbuffer.xml"/>
>>      <xi:include href="xml/intel_chipset.xml"/>
>>      <xi:include href="xml/intel_io.xml"/>
>> +    <xi:include href="xml/media_fill.xml"/>
>> +    <xi:include href="xml/rendercopy.xml"/>
>>
>>    </chapter>
>>    <index id="api-index-full">
>> --
>> 1.9.3
>>
>> _______________________________________________
>> Intel-gfx mailing list
>> Intel-gfx@lists.freedesktop.org
>> http://lists.freedesktop.org/mailman/listinfo/intel-gfx
>
> --
> Daniel Vetter
> Software Engineer, Intel Corporation
> +41 (0) 79 365 57 48 - http://blog.ffwll.ch
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/intel-gfx
diff mbox

Patch

diff --git a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
index dcfff33..96cf77f 100644
--- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
+++ b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
@@ -15,6 +15,7 @@ 
 
   <chapter>
     <title>Intel GPU Tools</title>
+    <xi:include href="xml/debug.xml"/>
     <xi:include href="xml/drmtest.xml"/>
     <xi:include href="xml/igt_core.xml"/>
     <xi:include href="xml/igt_debugfs.xml"/>
@@ -22,9 +23,12 @@ 
     <xi:include href="xml/igt_fb.xml"/>
     <xi:include href="xml/igt_aux.xml"/>
     <xi:include href="xml/ioctl_wrappers.xml"/>
+    <xi:include href="xml/instdone.xml"/>
     <xi:include href="xml/intel_batchbuffer.xml"/>
     <xi:include href="xml/intel_chipset.xml"/>
     <xi:include href="xml/intel_io.xml"/>
+    <xi:include href="xml/media_fill.xml"/>
+    <xi:include href="xml/rendercopy.xml"/>
 
   </chapter>
   <index id="api-index-full">