[PATCH 1/1] RSB: Mitigate too short error reports

[Frank Kühndel]

On 12/21/22 00:06, Chris Johns wrote:
> On 21/12/2022 3:44 am, Frank Kuehndel wrote:
>> From: Frank Kühndel<frank.kuehndel at embedded-brains.de>
>>
>> Close #4642
>> ---
>>   source-builder/sb/ereport.py | 4 ++++
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/source-builder/sb/ereport.py b/source-builder/sb/ereport.py
>> index d8fb5f6..d391917 100755
>> --- a/source-builder/sb/ereport.py
>> +++ b/source-builder/sb/ereport.py
>> @@ -55,6 +55,10 @@ def generate(name, opts, header = None, footer = None):
>>               with open(name, 'w') as l:
>>                   l.write(os.linesep.join(r))
>>               log.notice('  See error report: %s' % (name))
>> +            log.notice('  (Hint: The first error may be in front of a '
>> +                'line containing\n'
>> +                '  "Error 1" [GNU make] and may be only in the whole log '
> Is this too specific to GNU make? What ifs a package uses cmake or something else?

As the text indicates, this is specific to GNU make. For those using 
something else reading this text will still hint that the first error 
may not be in the end of the report "and may be only in the whole log".

Another weak point in this text is that by far not all errors 
originating from "make". Yet, the true trouble is the original "See 
error report: %s" where it can sometimes happen that the error is not in 
this "error report" at all.

I found it difficult to find a wording which is short, clear and helpful 
to the reader and at the same time not confusing. I am not perfectly 
happy with the notice above. I just found it a reasonable compromise.

If you prefer more generic texts - such as the examples below - I will 
send a new patch with the suggested test.

     "Hint: The first error may be far way from the end of the
     report and in cases can only be found in the whole build log."

     "Hint: The error is most likely in the error report otherwise
     see the whole build log [--log option]."

If you find any such change might cause more confusion than it might be 
helpful, I think it better to close this bug than to try to fix it.

Greetings,
Frank

-- 
embedded brains GmbH
Herr Frank KÜHNDEL
Dornierstr. 4
82178 Puchheim
Germany
email: frank.kuehndel at embedded-brains.de
phone:  +49-89-18 94 741 - 23
mobile: +49-176-15 22 06 - 11
fax:    +49-89-18 94 741 - 08

Registergericht: Amtsgericht München
Registernummer: HRB 157899
Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
Unsere Datenschutzerklärung finden Sie hier:
https://embedded-brains.de/datenschutzerklaerung/