Workflows Archive mirror
 help / color / mirror / Atom feed
From: Joe Perches <joe@perches.com>
To: Jakub Kicinski <kuba@kernel.org>
Cc: krzk@kernel.org, geert@linux-m68k.org, netdev@vger.kernel.org,
	workflows@vger.kernel.org, mario.limonciello@amd.com
Subject: Re: [PATCH] scripts: checkpatch: steer people away from using file paths
Date: Tue, 25 Jul 2023 23:28:24 -0700	[thread overview]
Message-ID: <cd8771cb54c48e504d89d69fe18c1347d93def19.camel@perches.com> (raw)
In-Reply-To: <20230725151552.723f1e3f@kernel.org>

On Tue, 2023-07-25 at 15:15 -0700, Jakub Kicinski wrote:
> On Tue, 25 Jul 2023 14:18:15 -0700 Joe Perches wrote:
> > > @@ -544,7 +546,13 @@ foreach my $file (@ARGV) {
> > >      if ($from_filename && (vcs_exists() && !vcs_file_exists($file))) {
> > >  	warn "$P: file '$file' not found in version control $!\n";
> > >      }
> > > -    if ($from_filename || ($file ne "&STDIN" && vcs_file_exists($file))) {
> > > +    if ($from_filename) {
> > > +	if (!$silence_file_warning) {
> > > +	    warn "$P: WARNING: Prefer running the script on patches as "
> > > +	        . "generated by git format-patch. Selecting paths is known "
> > > +		. "to miss recipients!\n";  
> > 
> > Don't separate a single output message into multiple lines.
> > Coalesce the string elements.
> > 
> > Also, this should show some reason why this isn't appropriate
> > as a patch to a single file would not have this issue.
> > 
> > e.g.:	When a patch series touches multiple files, showing all maintainers is useful. see:  <some process doc>
> 
> I tried to do that in --help. Added the "multiple files" one there, too.

It'd be more useful in the warning message.
Hardly anyone reads help.

> 
> > > @@ -1089,6 +1098,10 @@ version: $V
> > >     --pattern-depth=0 --remove-duplicates --rolestats]
> > >  
> > >  Notes:
> > > +  Using "-f file" is generally discouraged, running the script on a filepatch
> > > +      (as generated by git format-patch) is usually the right thing to do.
> > > +      Commit message is an integral part of the change and $P
> > > +      will extract additional information from it (keywords, Fixes tags etc.)  
> > 
> > "filepatch" doesn't appear in the kernel at all. Use "patch file".
> 
> I got it the wrong way around. I'll use patchfile (no space) for v2
> since that's what's what get_maintainer uses in two other places.


      reply	other threads:[~2023-07-26  6:28 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20230721062617.9810-1-boon.khai.ng@intel.com>
     [not found] ` <20230721062617.9810-2-boon.khai.ng@intel.com>
     [not found]   ` <e552cea3-abbb-93e3-4167-aebe979aac6b@kernel.org>
     [not found]     ` <DM8PR11MB5751EAB220E28AECF6153522C13FA@DM8PR11MB5751.namprd11.prod.outlook.com>
     [not found]       ` <8e2f9c5f-6249-4325-58b2-a14549eb105d@kernel.org>
     [not found]         ` <20230721185557.199fb5b8@kernel.org>
     [not found]           ` <c690776ce6fd247c2b2aeb805744d5779b6293ab.camel@perches.com>
2023-07-25  1:04             ` [Enable Designware XGMAC VLAN Stripping Feature 1/2] dt-bindings: net: snps,dwmac: Add description for rx-vlan-offload Jakub Kicinski
2023-07-25  3:53               ` Joe Perches
2023-07-25  7:33                 ` Geert Uytterhoeven
2023-07-25 13:19                   ` Mario Limonciello
2023-07-25 13:43                     ` Joe Perches
2023-07-25 14:37                       ` Krzysztof Kozlowski
2023-07-25 15:59                         ` [PATCH] scripts: checkpatch: steer people away from using file paths Jakub Kicinski
2023-07-25 16:53                           ` Greg KH
2023-07-25 17:10                             ` Jakub Kicinski
2023-07-25 17:25                               ` Greg KH
2023-07-25 19:52                                 ` Jakub Kicinski
2023-07-25 21:01                                   ` Joe Perches
2023-07-25 16:57                           ` Krzysztof Kozlowski
2023-07-25 21:18                           ` Joe Perches
2023-07-25 22:15                             ` Jakub Kicinski
2023-07-26  6:28                               ` Joe Perches [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=cd8771cb54c48e504d89d69fe18c1347d93def19.camel@perches.com \
    --to=joe@perches.com \
    --cc=geert@linux-m68k.org \
    --cc=krzk@kernel.org \
    --cc=kuba@kernel.org \
    --cc=mario.limonciello@amd.com \
    --cc=netdev@vger.kernel.org \
    --cc=workflows@vger.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 read-only IMAP folder(s) and NNTP newsgroup(s).