linux-kernel - Re: [PATCH 1/2] docs: *-regressions.rst: Use collon after regzbot introduced command

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: <2d666b8c-96c7-4789-8282-6b28cd932920@notapiano>
Date: Mon, 11 Mar 2024 09:57:56 -0400
From: Nícolas F. R. A. Prado <nfraprado@...labora.com>
To: Thorsten Leemhuis <regressions@...mhuis.info>
Cc: Jonathan Corbet <corbet@....net>, kernel@...labora.com,
	regressions@...ts.linux.dev, linux-doc@...r.kernel.org,
	linux-kernel@...r.kernel.org, workflows@...r.kernel.org
Subject: Re: [PATCH 1/2] docs: *-regressions.rst: Use collon after regzbot
 introduced command

On Mon, Mar 11, 2024 at 02:39:46PM +0100, Thorsten Leemhuis wrote:
> Thx for this!
> 
> On 08.03.24 15:09, Nícolas F. R. A. Prado wrote:
> > All the examples in the reference documentation for regzbot have a
> > collon
> 
> s/collon/colon/ here and a few lines below as well. And in the subject
> as well. Speaking of which: something like "docs: *-regressions.rst:
> add colon to regzbot commands" might be better.
> 
> > after the "introduced" command, while on the kernel documentation
> > some have and others don't. This suggests both are acceptable,
> 
> Yup.
> 
> > but in
> > order to avoid confusion, add collons after all the commands to match
> > the reference docs.
> 
> Yeah, good idea. I likely would have done this myself soon while doing a
> few other changes I plan, but whatever. :-D
> 
> > Link: https://gitlab.com/knurd42/regzbot/-/blob/main/docs/reference.md
> > Signed-off-by: Nícolas F. R. A. Prado <nfraprado@...labora.com>
> 
> With the changes above:
> 
> Reviewed-by: Thorsten Leemhuis <linux@...mhuis.info>
> 
> Side note: I wonder if the commit message could come a bit quicker to
> the point (something along the lines of "Use colons as command
> terminator everywhere for consistency, even if it not strictly
> necessary. That way it will also match regzbot's reference
> documentation.". But not really important I guess. Up to John.

Yep, all great suggestions, thanks. Will apply them for v2.

Thanks,
Nícolas