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

Thomas Wood thomas.wood at intel.com
Wed Jun 11 12:36:02 CEST 2014


On 10 June 2014 15:47, Daniel Vetter <daniel at ffwll.ch> wrote:
> On Tue, Jun 10, 2014 at 03:30:57PM +0100, Thomas Wood wrote:
>> Signed-off-by: Thomas Wood <thomas.wood at 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 at 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 at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/intel-gfx



More information about the Intel-gfx mailing list