Re: [PATCH v12 1/2] Apply coding guidelines

["Maciej W. Rozycki" <macro@orcam.me.uk>]

On Wed, 19 Feb 2025, Kevin Buettner wrote:

> > Format mips-tdep.c code as described on links:
> > https://sourceware.org/gdb/wiki/Internals%20GDB-C-Coding-Standards
> > https://www.gnu.org/prep/standards/standards.html#Comments
> > ---
> >  gdb/mips-tdep.c | 395 +++++++++++++++++++++++++++---------------------
> >  1 file changed, 221 insertions(+), 174 deletions(-)
> 
> This is okay.

 Kevin, thank you for your review.

 However I wasn't happy with some aspects of the proposal, so I have split 
it into pieces by the category, making individual commits self-contained, 
easy to navigate and consequently obvious to the reader.  I'll appreciate 
if any future changes of this kind made to the MIPS backend follow this 
pattern.

 Strictly speaking I reckon our new-line rule for block comments preceding 
variable definitions only applies to ones outside functions, but I don't 
care either way, so I have retained these changes.  I also made a couple 
of small adjustments which were missed around the places poked at.

 Unlike adding or removing new lines there is ongoing cost to code changes 
made as it affects `git blame' output.  Therefore I have applied changes 
to places with actual style issues, but I decided against making block 
statements out of comments along with the single statements that follow 
them each in conditional blocks.  I think the benefit outweighs the 
ongoing cost of their appearance in `git blame' output that requires an 
extra step to bypass this noise.  I have no objection to using this style 
of course with new code or code that has to be otherwise changed anyway.

 Last but not least I can see no reason to merge adjacent comments into 
single block comments.  There is no such requirement and there was often a 
reason to do it this way, such as to emphasize separation.  So I have not 
applied this part either.

 I have adjusted commit headings and descriptions accordingly and posted 
the changes applied for easier reference.

 Milica, thank you for your contribution.

  Maciej