linux-kernel-mentees.lists.linuxfoundation.org archive mirror
 help / color / mirror / Atom feed
From: Saheed Bolarinwa <refactormyself@gmail.com>
To: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: linux-doc@vger.kernel.org,
	linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [Linux-kernel-mentees] Clarification on the behaviour of checkpatch.pl
Date: Tue, 21 Apr 2020 10:44:41 +0200	[thread overview]
Message-ID: <db880a02-6dc8-7844-254b-682aa41fd54f@gmail.com> (raw)
In-Reply-To: <20200420085641.5d8f1a0b@coco.lan>


On 4/20/20 8:56 AM, Mauro Carvalho Chehab wrote:
> Em Mon, 20 Apr 2020 02:20:19 +0200
> Saheed Bolarinwa <refactormyself@gmail.com> escreveu:
>
>> Hello,
>>
>> My experience is that checkpatch.pl will not flag some warnings when I use
>>
>> the '-f' flag. This especially true for .rst files. My understanding is
>> that this flag
>>
>> is needed to use it with a raw source file instead of a patch.
>>
>> Please, I will like to confirm if this is a normal behaviour or is it my
>> system setup.
>>
>> Below is an example from the current stable release linux-5.6.y
>>
>>      [saheed@net linux-stable]$ perl ./scripts/checkpatch.pl -f
>>      ./Documentation/admin-guide/hw-vuln/tsx_async_abort.rst
>>      total: 0 errors, 0 warnings, 279 lines checked
>>
>>      ./Documentation/admin-guide/hw-vuln/tsx_async_abort.rst has no
>>      obvious style problems and is ready for submission.
>>
>>
>>      [saheed@net linux-stable]$ perl ./scripts/checkpatch.pl
>>      ./Documentation/admin-guide/hw-vuln/tsx_async_abort.rst
>>      WARNING: Possible unwrapped commit description (prefer a maximum 75
>>      chars per line)
>>      #6:
>>      TAA is a hardware vulnerability that allows unprivileged speculative
>>      access to
>>
>>      ERROR: Does not appear to be a unified-diff format patch
>>
>>      total: 1 errors, 1 warnings, 0 lines checked
> If you don't use "-f" flag, then you need to pass a patch to checkpatch,
> e. g.:
>
> 	git show --pretty=email | ./scripts/checkpatch.pl
>
> That's btw what you need to do with all patches you would submit upstream.
>
> The "-f" flag is used only when you want to run a check on an entire file
> (and not to the lines modified by a patch).
>
>
Thank you for the clarification.

Saheed

_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

      reply	other threads:[~2020-04-21  9:44 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-20  0:20 [Linux-kernel-mentees] Clarification on the behaviour of checkpatch.pl Saheed Bolarinwa
2020-04-20  6:56 ` Mauro Carvalho Chehab
2020-04-21  8:44   ` Saheed Bolarinwa [this message]

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=db880a02-6dc8-7844-254b-682aa41fd54f@gmail.com \
    --to=refactormyself@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=mchehab@kernel.org \
    /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;
as well as URLs for NNTP newsgroup(s).