From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-6.0 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id B46E67D04D for ; Thu, 7 Feb 2019 17:50:32 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726454AbfBGRuc (ORCPT ); Thu, 7 Feb 2019 12:50:32 -0500 Received: from smtprelay0233.hostedemail.com ([216.40.44.233]:44600 "EHLO smtprelay.hostedemail.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1726319AbfBGRuc (ORCPT ); Thu, 7 Feb 2019 12:50:32 -0500 Received: from filter.hostedemail.com (clb03-v110.bra.tucows.net [216.40.38.60]) by smtprelay05.hostedemail.com (Postfix) with ESMTP id B3F641802F622; Thu, 7 Feb 2019 17:50:30 +0000 (UTC) X-Session-Marker: 6A6F6540706572636865732E636F6D X-HE-Tag: rifle02_78bca1c74ae14 X-Filterd-Recvd-Size: 2876 Received: from XPS-9350.home (unknown [47.151.153.53]) (Authenticated sender: joe@perches.com) by omf02.hostedemail.com (Postfix) with ESMTPA; Thu, 7 Feb 2019 17:50:29 +0000 (UTC) Message-ID: <77f029f635867f45e8c0192fc4db5928a00076ef.camel@perches.com> Subject: Re: Return: vs Returns: From: Joe Perches To: Matthew Wilcox Cc: Mike Rapoport , Markus Heiser , linux-doc@vger.kernel.org Date: Thu, 07 Feb 2019 09:50:27 -0800 In-Reply-To: <20190207173448.GZ21860@bombadil.infradead.org> References: <20190207135924.GV21860@bombadil.infradead.org> <20190207153056.GB9120@rapoport-lnx> <8cacba6c-32c1-f60b-dfb0-0c74ef09d53c@darmarit.de> <20190207161852.GC8040@rapoport-lnx> <596652fd8f0a3637649167b47805f1c6ac848f25.camel@perches.com> <20190207173448.GZ21860@bombadil.infradead.org> Content-Type: text/plain; charset="ISO-8859-1" User-Agent: Evolution 3.30.1-1build1 Mime-Version: 1.0 Content-Transfer-Encoding: 7bit Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Thu, 2019-02-07 at 09:34 -0800, Matthew Wilcox wrote: > On Thu, Feb 07, 2019 at 09:31:20AM -0800, Joe Perches wrote: > > It's not clear to me what you are asking checkpatch to do here. > > > > It may be reasonable for checkpatch to invoke kernel-doc on some > > portion of a patch, but I'm not sure how valuable it will be. > > I was just hoping to match: > > * Returns: > > Or to quote it properly for regexes ... > > ^ +\* *Returns: > > (I think ...) > > I can't see that matching C or assembler. checkpatch doesn't attempt to enforce any formatting standard on kernel-doc comments. There doesn't seem to be much standardization for kernel-doc in the first place. Just for the * return: case: $ git grep -P -i '^\s*\*\s*returns?\s*:' -- '*.[ch]' | \ grep -P -oh -i '\*\s*returns?\s*:' | \ sort | uniq -c | sort -rn 5153 * Return: 2534 * Returns: 1077 * RETURN: 358 * RETURNS: 173 * RETURNS: 171 * returns: 153 * return: 148 * Return : 72 * Returns : 61 * Returns: 37 * Returns: 30 * returns: 27 * return: 22 * Return: 20 * Returns : 19 * Return: 15 * RETURNS: 11 * return: 6 * return : 6 * return: 5 * returns : 3 *Returns: 3 * Returns : 3 * returns: 2 *RETURNS: 2 * Returns: 2 * Returns: 2 * returns: 2 * RETURN : 2 * Return: 2 * Return: 2 * return : 2 * return: 1 * RETURNS: 1 * RETURNs: 1 * Returns: 1 * Returns: 1 * Returns: 1 * RETURN: 1 * Return: 1 * Return: 1 * return : I think standarization is more something that scripts/kernel-doc could or should do.