[Intel-gfx] [i-g-t 3/7] README: update the section on modifying and rebuilding documentation

[Thomas Wood]

On 10 June 2014 15:38, Daniel Vetter <daniel at ffwll.ch> wrote:
> On Tue, Jun 10, 2014 at 03:30:53PM +0100, Thomas Wood wrote:
>> Signed-off-by: Thomas Wood <thomas.wood at intel.com>
>> ---
>>  README | 12 +++++-------
>>  1 file changed, 5 insertions(+), 7 deletions(-)
>>
>> diff --git a/README b/README
>> index cfa186d..5e98565 100644
>> --- a/README
>> +++ b/README
>> @@ -108,16 +108,14 @@ docs/
>>       reference documenation in docs/reference/ You need to have the gtk doc
>>       tools installed to generate this API documentation.
>>
>> -     Note that the currrent gtk-docs integration sucks a bit wrt regenerating
>> -     the html files. You need at least
>> +     To regenerate the html files when updating documentation, use:
>>
>>       $ make clean -C docs && make -C docs
>>
>> -     to regenerate them on any change. If you've added/changed/removed a
>> -     symbol or anything else that changes the overall structure or indexes,
>> -     you need a full rebuild:
>> -
>> -     $ git clean -dfx && ./autogen.sh --enable-gtk-doc && make -C docs
>
> This is still requried afaik when you add new .c/.h files with api docs in
> them.
> -Daniel

Running make clean && make is enough for symbols to be added or
removed, even in new source files. The sections file will still need
to be updated to reflect the changes (e.g. new sections added when new
files are added).


>
>> +     If you've added/changed/removed a symbol or anything else that changes
>> +     the overall structure or indexes, this needs to be reflected in
>> +     intel-gpu-tools-sections.txt. Entirely new sections will also need to be
>> +     added to intel-gpu-tools-docs.xml in the appropriate place.
>>
>>  DEPENDENCIES
>>       This is a non-exchaustive list of package dependencies required for
>> --
>> 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