[{"id":29232,"web_url":"https://patchwork.libcamera.org/comment/29232/","msgid":"<171326854159.2468918.5455461907498595452@ping.linuxembedded.co.uk>","date":"2024-04-16T11:55:41","subject":"Re: [PATCH 2/2] utils: checkstyle.py: Drop period at end of Doxygen\n\tone liners","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Quoting Laurent Pinchart (2024-04-16 11:20:04)\n> The libcamera documentation style calls for no period at the end of the\n> Doxygen one-liner commands (\\brief, \\param and \\return). Extend the\n> DoxygenFormatter class to drop the period.\n> \n> Signed-off-by: Laurent Pinchart \n> ---\n> utils/checkstyle.py | 2 ++\n> 1 file changed, 2 insertions(+)\n> \n> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> index 2ab7e50fb0b6..88078a6171b7 100755\n> --- a/utils/checkstyle.py\n> +++ b/utils/checkstyle.py\n> @@ -753,6 +753,7 @@ class CLangFormatter(Formatter):\n> class DoxygenFormatter(Formatter):\n> patterns = ('*.c', '*.cpp')\n> \n> + oneliner_regex = re.compile(r'^ +\\* +\\\\(brief|param|return)\\b.*\\.$')\n\nInteresting, That was easier than I expected.\n\n> return_regex = re.compile(r' +\\* +\\\\return +[a-z]')\n> \n> @classmethod\n> @@ -768,6 +769,7 @@ class DoxygenFormatter(Formatter):\n> lines.append(line)\n> continue\n> \n> + line = cls.oneliner_regex.sub(lambda m: m.group(0)[:-1], line)\n\n\nReviewed-by: Kieran Bingham \n\n> line = cls.return_regex.sub(lambda m: m.group(0)[:-1] + m.group(0)[-1].upper(), line)\n> \n> if line.find('*/') != -1:\n> -- \n> Regards,\n> \n> Laurent Pinchart\n>","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id D1954C3213\n\tfor ;\n\tTue, 16 Apr 2024 11:55:46 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id E7B486333E;\n\tTue, 16 Apr 2024 13:55:45 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id A167D61B75\n\tfor ;\n\tTue, 16 Apr 2024 13:55:44 +0200 (CEST)","from pendragon.ideasonboard.com\n\t(cpc89244-aztw30-2-0-cust6594.18-1.cable.virginm.net [86.31.185.195])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 3AD09512;\n\tTue, 16 Apr 2024 13:54:58 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"qUjyDE37\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1713268498;\n\tbh=BU4AhQNDJub7qqvEsp8eHCldxccIR210Y6cR3H3WMGk=;\n\th=In-Reply-To:References:Subject:From:To:Date:From;\n\tb=qUjyDE379pB5EpWmZHDpzzoGOptSulc+P16vCYxZQfJ5TJorURn/XSlYIRYtRxmb5\n\to5QujiallpQ2c4FRdFFkHNVfXWZEqporiah5TIyNhKU0wP1+n6aam5GoHkOK7pd1tb\n\tguWnVsIxe82h1mamycPsYLx4ykdviV8llZUSRuTM=","Content-Type":"text/plain; charset=\"utf-8\"","MIME-Version":"1.0","Content-Transfer-Encoding":"quoted-printable","In-Reply-To":"<20240416102004.10617-3-laurent.pinchart@ideasonboard.com>","References":"<20240416102004.10617-1-laurent.pinchart@ideasonboard.com>\n\t<20240416102004.10617-3-laurent.pinchart@ideasonboard.com>","Subject":"Re: [PATCH 2/2] utils: checkstyle.py: Drop period at end of Doxygen\n\tone liners","From":"Kieran Bingham ","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","Date":"Tue, 16 Apr 2024 12:55:41 +0100","Message-ID":"<171326854159.2468918.5455461907498595452@ping.linuxembedded.co.uk>","User-Agent":"alot/0.10","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":29275,"web_url":"https://patchwork.libcamera.org/comment/29275/","msgid":"<20240419093549.GA16778@pendragon.ideasonboard.com>","date":"2024-04-19T09:35:49","subject":"Re: [PATCH 2/2] utils: checkstyle.py: Drop period at end of Doxygen\n\tone liners","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Tue, Apr 16, 2024 at 12:55:41PM +0100, Kieran Bingham wrote:\n> Quoting Laurent Pinchart (2024-04-16 11:20:04)\n> > The libcamera documentation style calls for no period at the end of the\n> > Doxygen one-liner commands (\\brief, \\param and \\return). Extend the\n> > DoxygenFormatter class to drop the period.\n> > \n> > Signed-off-by: Laurent Pinchart \n> > ---\n> > utils/checkstyle.py | 2 ++\n> > 1 file changed, 2 insertions(+)\n> > \n> > diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> > index 2ab7e50fb0b6..88078a6171b7 100755\n> > --- a/utils/checkstyle.py\n> > +++ b/utils/checkstyle.py\n> > @@ -753,6 +753,7 @@ class CLangFormatter(Formatter):\n> > class DoxygenFormatter(Formatter):\n> > patterns = ('*.c', '*.cpp')\n> > \n> > + oneliner_regex = re.compile(r'^ +\\* +\\\\(brief|param|return)\\b.*\\.$')\n> \n> Interesting, That was easier than I expected.\n\nIt's not fool-proof, it doesn't catch doxygen commands that span\nmultiple lines, but I'll worry about that later if needed.\n\n> > return_regex = re.compile(r' +\\* +\\\\return +[a-z]')\n> > \n> > @classmethod\n> > @@ -768,6 +769,7 @@ class DoxygenFormatter(Formatter):\n> > lines.append(line)\n> > continue\n> > \n> > + line = cls.oneliner_regex.sub(lambda m: m.group(0)[:-1], line)\n> \n> \n> Reviewed-by: Kieran Bingham \n> \n> > line = cls.return_regex.sub(lambda m: m.group(0)[:-1] + m.group(0)[-1].upper(), line)\n> > \n> > if line.find('*/') != -1:","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 9E0E3C3200\n\tfor ;\n\tFri, 19 Apr 2024 09:36:00 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 9D3B4633ED;\n\tFri, 19 Apr 2024 11:35:59 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4B05061B3D\n\tfor ;\n\tFri, 19 Apr 2024 11:35:57 +0200 (CEST)","from pendragon.ideasonboard.com\n\t(117.145-247-81.adsl-dyn.isp.belgacom.be [81.247.145.117])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id C023255;\n\tFri, 19 Apr 2024 11:35:08 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"B6P24+60\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1713519308;\n\tbh=+ygvvJcZEgHUbrc1LgzS31Zygm1fAVWfxiq0OEdX1c8=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=B6P24+60R6Oz4LLDFAcCfmoy1MikFKZP5k2c8g93akxWld9dydYf3Ij0JhxFnDrsV\n\trtckubA3HABWjbRH2RiFlNM0r2vkIpbqXcJj5NCrSip+awRa5TNdD3UnO+Z5Ps1MJ9\n\tFoRW/DUT5UBDaxnkHCwTWIC54etkjF0gLXSLUhVU=","Date":"Fri, 19 Apr 2024 12:35:49 +0300","From":"Laurent Pinchart ","To":"Kieran Bingham ","Cc":"libcamera-devel@lists.libcamera.org","Subject":"Re: [PATCH 2/2] utils: checkstyle.py: Drop period at end of Doxygen\n\tone liners","Message-ID":"<20240419093549.GA16778@pendragon.ideasonboard.com>","References":"<20240416102004.10617-1-laurent.pinchart@ideasonboard.com>\n\t<20240416102004.10617-3-laurent.pinchart@ideasonboard.com>\n\t<171326854159.2468918.5455461907498595452@ping.linuxembedded.co.uk>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<171326854159.2468918.5455461907498595452@ping.linuxembedded.co.uk>","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]