mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Joe Perches <joe@perches.com>
To: Patrick Miller <paddymills@proton.me>
Cc: a.hindborg@samsung.com, alex.gaynor@gmail.com,
	aliceryhl@google.com,  apw@canonical.com, benno.lossin@proton.me,
	bjorn3_gh@protonmail.com,  boqun.feng@gmail.com,
	dwaipayanray1@gmail.com, gary@garyguo.net,
	 linux-kernel@vger.kernel.org, lukas.bulwahn@gmail.com,
	ojeda@kernel.org,  rust-for-linux@vger.kernel.org,
	tmgross@umich.edu, wedsonaf@gmail.com
Subject: Re: [PATCH 2/2] checkpatch: warn on known non-plural rust doc headers
Date: Sat, 07 Sep 2024 08:33:00 -0700	[thread overview]
Message-ID: <d13c59eb55ad4822878eac47dd2ad339a95f5cb9.camel@perches.com> (raw)
In-Reply-To: <M4qWISlO9z_OnOQGC5Gqb0ROgBLsxM35tR9HU_DMJKExPFpJrEYTuBa2mO5YQqvQK4h65hZrNB165qJlOnexLXaDscRuZcmAkOC0AH4SO04=@proton.me>

On Sat, 2024-09-07 at 14:22 +0000, Patrick Miller wrote:
> > > > +# check that document section headers are plural in rust files
> > > > + if ($realfile =~ /\.rs$/
> > > > + && $rawline =~ /^\+\s*\/\/\/\s+#+\s+(Example|Invariant|Guarantee|Panic)\s*$/) {
> > > > + WARN( "RUST_DOC_HEADER",
> > > > + "Rust doc headers should be plural\n" . $herecurr );
[]
> > There is no autoformatter for checkpatch/perl/etc.
> Can you elaborate on what you mean by this? I'm not following.
> Is there documentation you can point me to that I need to review?
> > 
> 

[]
> > Will fix this. Is there a code style document for the perl scripts?

No.  It mostly follows the c style though.

  reply	other threads:[~2024-09-07 15:33 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-06 18:05 Patrick Miller
2024-09-07 10:53 ` Joe Perches
2024-09-07 11:57   ` Patrick Miller
2024-09-07 14:22     ` Patrick Miller
2024-09-07 15:33       ` Joe Perches [this message]
2024-09-09 16:24   ` Benno Lossin
2024-09-09 16:31 ` Benno Lossin
2024-09-09 16:38   ` Benno Lossin
  -- strict thread matches above, loose matches on Subject: below --
2024-09-06 16:45 Patrick Miller
2024-09-06 17:00 ` Greg KH
2024-09-06 17:29   ` Patrick Miller
2024-09-06 17:56     ` Greg KH

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=d13c59eb55ad4822878eac47dd2ad339a95f5cb9.camel@perches.com \
    --to=joe@perches.com \
    --cc=a.hindborg@samsung.com \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=apw@canonical.com \
    --cc=benno.lossin@proton.me \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=dwaipayanray1@gmail.com \
    --cc=gary@garyguo.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=ojeda@kernel.org \
    --cc=paddymills@proton.me \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=tmgross@umich.edu \
    --cc=wedsonaf@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®