linux-kernel - Re: [PATCH v2] x86/resctrl: Fix kernel-doc in pseudo

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <371b8786-6ed5-ae75-efb3-bd1631491a20@intel.com>
Date:   Tue, 15 Jun 2021 11:47:27 -0700
From:   Reinette Chatre <reinette.chatre@...el.com>
To:     "Fabio M. De Francesco" <fmdefrancesco@...il.com>,
        Fenghua Yu <fenghua.yu@...el.com>,
        Thomas Gleixner <tglx@...utronix.de>,
        Ingo Molnar <mingo@...hat.com>, Borislav Petkov <bp@...en8.de>,
        "H. Peter Anvin" <hpa@...or.com>, x86@...nel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] x86/resctrl: Fix kernel-doc in pseudo_lock.c

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