[PATCH] GDB hooks: improve documentation

Martin Liška mliska@suse.cz
Wed Dec 2 10:30:26 GMT 2020


On 12/2/20 10:47 AM, Alexander Monakov wrote:
> Hi,
> 
> On Wed, 2 Dec 2020, Martin Liška wrote:
> 
>> Hey.
>>
>> I see the current help description of GCC hooks not much useful:
>>
>> $ help user-defined
> [snip]
>> trt -- GCC hook: trt [tree]
>>
>> It's quite hard to be familiar what each hooks means and rather suggest:
>>
> [snip]
>> trt -- GCC hook: TREE_TYPE (tree)
>>
>> Thoughts?
> 
> Yes please! I did not know about 'help user-defined' when updating those
> mini-doc snippets. I think your patch is a nice improvement.

Thanks! To be honest I use the help command quite often.

> 
> It seems you are leaving 'pp' unchanged:
> 
>> pp -- GCC hook: pp [any]
> 
> I'd suggest perhaps "GCC hook: debug (<multiple overloads>)".

Yep!

> 
> And one nit:
> 
>> @@ -69,7 +69,7 @@ call debug_rtx_list ($debug_arg, debug_rtx_count)
>>   end
>>    document prl
>> -GCC hook: prl [rtx]
>> +GCC hook: prl debug_rtx_list (rtx)
> 
> I think 'prl' before 'debug_rtx_list' should have been deleted.

Changed that as well.

I'm going to push the commit.
Martin

> 
> Thanks.
> Alexander
> 



More information about the Gcc-patches mailing list