[Mesa-dev] [PATCH] docs: update MESA_DEBUG envvar documentation.

[Alejandro Piñeiro]

On 27/06/16 15:45, Brian Paul wrote:
> On 06/27/2016 02:10 AM, Alejandro Piñeiro wrote:
>> silent, flush, incomplete_tex and incomplete_fbo flags were not
>> documented (see src/mesa/main.debug.c for more info).
>>
>> FP is not checked anymore.
>> ---
>>
>> Didn't know about the flush option for MESA_DEBUG until Grazvydas
>> Ignotas
>> mentioned it on a freedesktop bug comment (thanks), so this patch
>> documents
>> it.
>>
>> CCing Eric Anholt because MESA_DEBUG=flush and VC4_DEBUG=always_flush
>> seems
>> to have basically the same purpose, in case one needs to be removed.
>>
>> CCing Brian because he added the incomplete_tex and incomplete_fbo flags
>> with commit 93bcf7, and I just added a really basic documentation
>> line for
>> those options, just in case it is worth more details.
>>
>> Note that I assume that all the specific flags for MESA_DEBUG are
>> handled
>> at debuc.c:set_debug_flags. As it is not taking into account FP, Im also
>> dropping the FP line with this patch.
>>
>>
>>   docs/envvars.html | 9 +++++++--
>>   1 file changed, 7 insertions(+), 2 deletions(-)
>>
>> diff --git a/docs/envvars.html b/docs/envvars.html
>> index ed957bd..abd8a72 100644
>> --- a/docs/envvars.html
>> +++ b/docs/envvars.html
>> @@ -50,8 +50,13 @@ sometimes be useful for debugging end-user issues.
>>      if the application generates a GL_INVALID_ENUM error, a
>> corresponding error
>>      message indicating where the error occurred, and possibly why,
>> will be
>>      printed to stderr.<br>
>> -   If the value of MESA_DEBUG is 'FP' floating point arithmetic
>> errors will
>> -   generate exceptions.
>> +  In addition to just set it, MESA_DEBUG accepts the following flags:
>
> The first part of that sentence doesn't sound right.

Ok, will try to find an alternative language.

>
>> +  <ul>
>> +    <li>silent - turn off debug messages</li>
>> +    <li>flush - flush after each drawing command</li>
>> +    <li>incomplete_tex - extra debug messages when a texture is
>> incomplete</li>
>> +    <li>incomplete_fbo - extra debug messages when a fbo is
>> incomplete</li>
>> +  </ul>
>
> I don't even remember, does MESA_DEBUG take a comma-separated list of
> these value?

Ok, I will check that.

>
> Some obscure env vars/settings haven't been documented because they're
> of limited use to end users.

Well, it is a MESA_DEBUG envvar after all, it is intended for
developers. INTEL_DEBUG and VC4_DEBUG are documented in detail, I don't
see why we can't do the same with MESA_DEBUG.

>
> Also, isn't MESA_DEBUG ignored in release builds?  Maybe you can check
> on that.

Ok, I will also check that.

I will not be able to do all those checks today, will try to take a look
during the week.

>
> -Brian
>
>
>>   <li>MESA_LOG_FILE - specifies a file name for logging all errors,
>> warnings,
>>   etc., rather than stderr
>>   <li>MESA_TEX_PROG - if set, implement conventional texture env
>> modes with
>>
>
>