Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Message-ID: <1c86e75bb56693bc2343d30e5baba09c783b02a2.camel@perches.com>
Subject: Re: [PATCH] checkpatch: add NL_SET_ERR_MSG to 80 column exceptions
From:   Joe Perches <joe@perches.com>
To:     Jacob Keller <jacob.e.keller@intel.com>,
        linux-kernel@vger.kernel.org
Cc:     Jakub Kicinski <kuba@kernel.org>,
        Andy Whitcroft <apw@canonical.com>
Date:   Fri, 01 May 2020 17:30:19 -0700
In-Reply-To: <5a1da586-0cc0-1900-477f-6fef61af7f95@intel.com>
References: <20200501231131.2389319-1-jacob.e.keller@intel.com>
         <e1e12e3f6992c00c005ba2b3bcf671c033a1dccc.camel@perches.com>
         <5a1da586-0cc0-1900-477f-6fef61af7f95@intel.com>
Content-Type: text/plain; charset="ISO-8859-1"
User-Agent: Evolution 3.36.1-2 
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Fri, 2020-05-01 at 17:19 -0700, Jacob Keller wrote:
> 
> On 5/1/2020 4:42 PM, Joe Perches wrote:
> > On Fri, 2020-05-01 at 16:11 -0700, Jacob Keller wrote:
> > > NL_SET_ERR_MSG and NL_SET_ERR_MSG_MOD are used to report extended error
> > > responses about failure of a netlink command. These strings often end up
> > > going over the 80-column limit. Just like logging messages, it is
> > > preferred to leave the message all on a single line.
> > > 
> > > Add these to the exception list so that checkpatch.pl will no longer
> > > complain about the long lines due to use of these macros.
> > > 
> > > Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
> > > Cc: Jakub Kicinski <kuba@kernel.org>
> > > Cc: Andy Whitcroft <apw@canonical.com>
> > > Cc: Joe Perches <joe@perches.com>
> > > ---
> > >  scripts/checkpatch.pl | 3 ++-
> > >  1 file changed, 2 insertions(+), 1 deletion(-)
> > > 
> > > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> > > index eac40f0abd56..5da3b06fbeaa 100755
> > > --- a/scripts/checkpatch.pl
> > > +++ b/scripts/checkpatch.pl
> > > @@ -471,7 +471,8 @@ our $logFunctions = qr{(?x:
> > >  	WARN(?:_RATELIMIT|_ONCE|)|
> > >  	panic|
> > >  	MODULE_[A-Z_]+|
> > > -	seq_vprintf|seq_printf|seq_puts
> > > +	seq_vprintf|seq_printf|seq_puts|
> > > +	NL_SET_ERR_MSG(?:_MOD)?
> > >  )};
> > >  
> > >  our $allocFunctions = qr{(?x:
> > 
> > <shrug>  OK I guess.
> > 
> > What about GENL_SET_ERR_MSG ?
> > 
> 
> This appears in far fewer locations, but it does seem reasonable to add
> it to this list as well.
> 
> > btw:
> > 
> > There are some uses with what appear to be unnecessary newlines.
> > Maybe these newlines should be removed.
> 
> Yea, there's a number of places which seem to have put a newline break
> after the extack pointer.
> 
> A quick search shows that there are about 970 or so uses where we don't
> put a newline, and around 220 where we do.
> 
> I suppose I can make a series that cleans all of those up along with
> this patch.

That's not what I meant.
I don't care if there are multiple source lines used.
In fact, I think it's mostly nicer with multiple lines.

The ones I specified previously use:

	NL_SET_ERR_MSG_MOD(extack, "message\n");

where all the others uses are:

	NL_SET_ERR_MSG_MOD(extack, "message");

without the \n termination of the message.