Re: [PATCH v2] x86/resctrl: Fix kernel-doc in pseudo_lock.c

From: Reinette Chatre
Date: Tue Jun 15 2021 - 14:47:38 EST


Hi Fabio

On 6/14/2021 7:52 AM, Fabio M. De Francesco wrote:

For what is related to style, if you agree with me, I'd like to have it
consistent: always capitalize the first word which describes a parameter, and
always use consistent punctuation among different lines and comments, so I'd
prepare a patch (or a series) to the files in resctrl. I could called them
"Make consistent use of capitalization and punctuation". What about it?

While I surely would consider such a submission I wonder if your energy may not be better spent on other areas where there are higher priority work needed? What is your goal with this work? I understand that you are new to Linux kernel development and want to learn but it is not clear to me fixing capitalization and punctuation would be a good use of your energy.

I've also noticed some minor grammar issues (e.g., exist -> exits (in
pseudo_lock.c, line 752 - pseudo-lock -> pseudo-locked in many other lines).
What do you think if I make a "Fix English grammar" patch? So what about this
other too?

This work would make the comments easier to read and a welcome addition. Please consider this a lower priority if you come across functional issues that could benefit your attention.

Thank you very much

Reinette