[{"id":2143,"web_url":"https://patchwork.libcamera.org/comment/2143/","msgid":"<20190703225945.GA17912@bigcity.dyn.berto.se>","date":"2019-07-03T22:59:45","subject":"Re: [libcamera-devel] [PATCH] utils: checkstyle.py: Add Doxygen\n\tformatter","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/people/5/","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"content":"Hi Laurent,\n\nThanks for your work.\n\nOn 2019-07-04 00:13:58 +0300, Laurent Pinchart wrote:\n> Add a formatter for doxygen comments. In its initial implementation the\n> formatter ensures that the first word of a \\return statement starts with\n> an uppercase letter.\n> \n> Signed-off-by: Laurent Pinchart \n\nRegexp and lambda function, reviewing is fun!\n\nReviewed-by: Niklas Söderlund \n\n> ---\n> utils/checkstyle.py | 28 ++++++++++++++++++++++++++++\n> 1 file changed, 28 insertions(+)\n> \n> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> index bc631d405007..fab4b116d2ff 100755\n> --- a/utils/checkstyle.py\n> +++ b/utils/checkstyle.py\n> @@ -350,6 +350,34 @@ class CLangFormatter(Formatter):\n> return ret.stdout.decode('utf-8')\n> \n> \n> +class DoxygenFormatter(Formatter):\n> + patterns = ('*.c', '*.cpp')\n> +\n> + return_regex = re.compile(' +\\\\* +\\\\\\\\return +[a-z]')\n> +\n> + @classmethod\n> + def format(cls, filename, data):\n> + lines = []\n> + in_doxygen = False\n> +\n> + for line in data.split('\\n'):\n> + if line.find('/**') != -1:\n> + in_doxygen = True\n> +\n> + if not in_doxygen:\n> + lines.append(line)\n> + continue\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> + in_doxygen = False\n> +\n> + lines.append(line)\n> +\n> + return '\\n'.join(lines)\n> +\n> +\n> class StripTrailingSpaceFormatter(Formatter):\n> patterns = ('*.c', '*.cpp', '*.h', '*.py', 'meson.build')\n> \n> -- \n> Regards,\n> \n> Laurent Pinchart\n> \n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"","Received":["from mail-lj1-x242.google.com (mail-lj1-x242.google.com\n\t[IPv6:2a00:1450:4864:20::242])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 848C260C01\n\tfor ;\n\tThu, 4 Jul 2019 00:59:47 +0200 (CEST)","by mail-lj1-x242.google.com with SMTP id h10so4208028ljg.0\n\tfor ;\n\tWed, 03 Jul 2019 15:59:47 -0700 (PDT)","from localhost (customer-145-14-112-32.stosn.net. [145.14.112.32])\n\tby smtp.gmail.com with ESMTPSA id\n\tr20sm739188ljr.20.2019.07.03.15.59.46\n\t(version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256);\n\tWed, 03 Jul 2019 15:59:46 -0700 (PDT)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=ragnatech-se.20150623.gappssmtp.com; s=20150623;\n\th=date:from:to:cc:subject:message-id:references:mime-version\n\t:content-disposition:content-transfer-encoding:in-reply-to\n\t:user-agent; bh=HMinzqO+ofQ3G3hftNOW3Bo0iurZAAtfJa+y+72rX5E=;\n\tb=Wvh9ki+zbYdWu2meyHpklEdFEeqPD4S8y9dn78Lgk7idBc/wh1s5ZaUO/8gcMEiWcK\n\trOSecOFFV+jldpQ20ol0q+NQRh4EL1QNl4Nmg0jN/eflbrw/1/9GUGvD22vu8pqK5oaH\n\t6U1qy0JZm4Z6lD7jz9sjanL+JySmB1TOjgA9Qi1v/FH5BLdkLNIIj5buvEzFknr+qiHn\n\tHYVdojmbH0ory23KTiZeLm3Gz6eirDqUV0BBLPkrLDIXW0n1IlcmRhBeG5sLJYHpYvT+\n\tn3V22i4uKxQlQiufHjH/7X5DXQ+ZVh38xoCXHTjpWrRo0KceKAQFAyUgcMmO0rossJdn\n\tXFwQ==","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:date:from:to:cc:subject:message-id:references\n\t:mime-version:content-disposition:content-transfer-encoding\n\t:in-reply-to:user-agent;\n\tbh=HMinzqO+ofQ3G3hftNOW3Bo0iurZAAtfJa+y+72rX5E=;\n\tb=pMxWNIN6Ecfuz//4GQ9dlUJ3DNTWNx/CSqSA/63nQeD17HUuVrcgAZgKUEbk9PuTed\n\teCokiyiuiNhGZMtJ56b525Cri/1g8FyV3WtaWpU2JH+0cOpoc1Ui9EN5Wazbx2RADOGE\n\tDn/9XAFTn4eymJsvqTKIHyJ9CawCrGdKv482CogYQKKAkX8ZTDshSKAck6+CUqPzUnrg\n\tKw20I+0JzkztO6w4ZHdZV/EKLO+bxOgt0TKqN972i+aJ+mBVo99+Morkjvg1PVYLfltK\n\tkBUPdBxvgc6AJideYFR86CTaO9iPsxgRBscZN4N3wGwIVKeoXnZ1YDdLDRLGfPp1mBQQ\n\tLCaA==","X-Gm-Message-State":"APjAAAXrmpyioDp5/OBnRgDh4wasKHYwcHSyr89ayiwG/SYd8HsEECR7\n\t4KA/4mlmD0iq09m0izbLYCCeTw==","X-Google-Smtp-Source":"APXvYqzKIlZggpqnrIntStWj9TU1zVKws6xBqWYHsrtUVF3B/P3qgopRh9J8yGt6bxbrD261lJWKMw==","X-Received":"by 2002:a2e:7619:: with SMTP id\n\tr25mr22352656ljc.199.1562194786694; \n\tWed, 03 Jul 2019 15:59:46 -0700 (PDT)","Date":"Thu, 4 Jul 2019 00:59:45 +0200","From":"Niklas =?iso-8859-1?q?S=F6derlund?= ","To":"Laurent Pinchart ","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20190703225945.GA17912@bigcity.dyn.berto.se>","References":"<20190703211358.2362-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=iso-8859-1","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20190703211358.2362-1-laurent.pinchart@ideasonboard.com>","User-Agent":"Mutt/1.12.1 (2019-06-15)","Subject":"Re: [libcamera-devel] [PATCH] utils: checkstyle.py: Add Doxygen\n\tformatter","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Wed, 03 Jul 2019 22:59:47 -0000"}},{"id":2150,"web_url":"https://patchwork.libcamera.org/comment/2150/","msgid":"<1f5b3610-6c20-1f2b-2667-22eff46a8cad@ideasonboard.com>","date":"2019-07-04T09:39:19","subject":"Re: [libcamera-devel] [PATCH] utils: checkstyle.py: Add Doxygen\n\tformatter","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Laurent,\n\nOn 03/07/2019 22:13, Laurent Pinchart wrote:\n> Add a formatter for doxygen comments. In its initial implementation the\n> formatter ensures that the first word of a \\return statement starts with\n> an uppercase letter.\n\nThanks this looks good, I initially thought that the '/**' and '*/'\nshould be regexes to validate that they are '^/**$' and '^ */$', but\nthen I realised that I think we could have indented doxygen statements.\n\nSo this looks good.\n\nI ran pep8 on your patch, and while pep8 reports quite a few issues on\ncheckstyle.py, none of them are in your hunk.\n\nSo then I wrote a patch to add a pep8 checker, to, well, - check itself.\n\n--\n\nAnyway,\n\nReviewed-by: Kieran Bingham \n\n\n> Signed-off-by: Laurent Pinchart \n> ---\n> utils/checkstyle.py | 28 ++++++++++++++++++++++++++++\n> 1 file changed, 28 insertions(+)\n> \n> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> index bc631d405007..fab4b116d2ff 100755\n> --- a/utils/checkstyle.py\n> +++ b/utils/checkstyle.py\n> @@ -350,6 +350,34 @@ class CLangFormatter(Formatter):\n> return ret.stdout.decode('utf-8')\n> \n> \n> +class DoxygenFormatter(Formatter):\n> + patterns = ('*.c', '*.cpp')\n> +\n> + return_regex = re.compile(' +\\\\* +\\\\\\\\return +[a-z]')\n> +\n> + @classmethod\n> + def format(cls, filename, data):\n> + lines = []\n> + in_doxygen = False\n> +\n> + for line in data.split('\\n'):\n> + if line.find('/**') != -1:\n> + in_doxygen = True\n> +\n> + if not in_doxygen:\n> + lines.append(line)\n> + continue\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> + in_doxygen = False\n> +\n> + lines.append(line)\n> +\n> + return '\\n'.join(lines)\n> +\n> +\n> class StripTrailingSpaceFormatter(Formatter):\n> patterns = ('*.c', '*.cpp', '*.h', '*.py', 'meson.build')\n> \n>","headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id CEFB160B2D\n\tfor ;\n\tThu, 4 Jul 2019 11:39:22 +0200 (CEST)","from [192.168.0.20]\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 33D8B24B;\n\tThu, 4 Jul 2019 11:39:22 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1562233162;\n\tbh=fFMPJInGsvlep48KuGlX76uzZvebx/bn3xKCmYFrOdI=;\n\th=Reply-To:Subject:To:References:From:Date:In-Reply-To:From;\n\tb=v5ROORdK8aKu0nyVQfrMxZoqN+L9vilOFpLnz3kEa9gU/Amtw4BlASvZieJEB0z07\n\tQXGvuxApPyxOT2NTpogX0pmveGFLPzOnYgI4THkiJjJL+Bj+CMBQ+tJEnJjiNaZJ3r\n\tx1B+Hq7EEXP9fJCg1bohjao4+dm2jBIivaRCNEks=","Reply-To":"kieran.bingham@ideasonboard.com","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20190703211358.2362-1-laurent.pinchart@ideasonboard.com>","From":"Kieran Bingham ","Openpgp":"preference=signencrypt","Autocrypt":"addr=kieran.bingham@ideasonboard.com; keydata=\n\tmQINBFYE/WYBEACs1PwjMD9rgCu1hlIiUA1AXR4rv2v+BCLUq//vrX5S5bjzxKAryRf0uHat\n\tV/zwz6hiDrZuHUACDB7X8OaQcwhLaVlq6byfoBr25+hbZG7G3+5EUl9cQ7dQEdvNj6V6y/SC\n\trRanWfelwQThCHckbobWiQJfK9n7rYNcPMq9B8e9F020LFH7Kj6YmO95ewJGgLm+idg1Kb3C\n\tpotzWkXc1xmPzcQ1fvQMOfMwdS+4SNw4rY9f07Xb2K99rjMwZVDgESKIzhsDB5GY465sCsiQ\n\tcSAZRxqE49RTBq2+EQsbrQpIc8XiffAB8qexh5/QPzCmR4kJgCGeHIXBtgRj+nIkCJPZvZtf\n\tKr2EAbc6tgg6DkAEHJb+1okosV09+0+TXywYvtEop/WUOWQ+zo+Y/OBd+8Ptgt1pDRyOBzL8\n\tRXa8ZqRf0Mwg75D+dKntZeJHzPRJyrlfQokngAAs4PaFt6UfS+ypMAF37T6CeDArQC41V3ko\n\tlPn1yMsVD0p+6i3DPvA/GPIksDC4owjnzVX9kM8Zc5Cx+XoAN0w5Eqo4t6qEVbuettxx55gq\n\t8K8FieAjgjMSxngo/HST8TpFeqI5nVeq0/lqtBRQKumuIqDg+Bkr4L1V/PSB6XgQcOdhtd36\n\tOe9X9dXB8YSNt7VjOcO7BTmFn/Z8r92mSAfHXpb07YJWJosQOQARAQABtDBLaWVyYW4gQmlu\n\tZ2hhbSA8a2llcmFuLmJpbmdoYW1AaWRlYXNvbmJvYXJkLmNvbT6JAkAEEwEKACoCGwMFCwkI\n\tBwIGFQgJCgsCBBYCAwECHgECF4ACGQEFAlnDk/gFCQeA/YsACgkQoR5GchCkYf3X5w/9EaZ7\n\tcnUcT6dxjxrcmmMnfFPoQA1iQXr/MXQJBjFWfxRUWYzjvUJb2D/FpA8FY7y+vksoJP7pWDL7\n\tQTbksdwzagUEk7CU45iLWL/CZ/knYhj1I/+5LSLFmvZ/5Gf5xn2ZCsmg7C0MdW/GbJ8IjWA8\n\t/LKJSEYH8tefoiG6+9xSNp1p0Gesu3vhje/GdGX4wDsfAxx1rIYDYVoX4bDM+uBUQh7sQox/\n\tR1bS0AaVJzPNcjeC14MS226mQRUaUPc9250aj44WmDfcg44/kMsoLFEmQo2II9aOlxUDJ+x1\n\txohGbh9mgBoVawMO3RMBihcEjo/8ytW6v7xSF+xP4Oc+HOn7qebAkxhSWcRxQVaQYw3S9iZz\n\t2iA09AXAkbvPKuMSXi4uau5daXStfBnmOfalG0j+9Y6hOFjz5j0XzaoF6Pln0jisDtWltYhP\n\tX9LjFVhhLkTzPZB/xOeWGmsG4gv2V2ExbU3uAmb7t1VSD9+IO3Km4FtnYOKBWlxwEd8qOFpS\n\tjEqMXURKOiJvnw3OXe9MqG19XdeENA1KyhK5rqjpwdvPGfSn2V+SlsdJA0DFsobUScD9qXQw\n\tOvhapHe3XboK2+Rd7L+g/9Ud7ZKLQHAsMBXOVJbufA1AT+IaOt0ugMcFkAR5UbBg5+dZUYJj\n\t1QbPQcGmM3wfvuaWV5+SlJ+WeKIb8ta5Ag0EVgT9ZgEQAM4o5G/kmruIQJ3K9SYzmPishRHV\n\tDcUcvoakyXSX2mIoccmo9BHtD9MxIt+QmxOpYFNFM7YofX4lG0ld8H7FqoNVLd/+a0yru5Cx\n\tadeZBe3qr1eLns10Q90LuMo7/6zJhCW2w+HE7xgmCHejAwuNe3+7yt4QmwlSGUqdxl8cgtS1\n\tPlEK93xXDsgsJj/bw1EfSVdAUqhx8UQ3aVFxNug5OpoX9FdWJLKROUrfNeBE16RLrNrq2ROc\n\tiSFETpVjyC/oZtzRFnwD9Or7EFMi76/xrWzk+/b15RJ9WrpXGMrttHUUcYZEOoiC2lEXMSAF\n\tSSSj4vHbKDJ0vKQdEFtdgB1roqzxdIOg4rlHz5qwOTynueiBpaZI3PHDudZSMR5Fk6QjFooE\n\tXTw3sSl/km/lvUFiv9CYyHOLdygWohvDuMkV/Jpdkfq8XwFSjOle+vT/4VqERnYFDIGBxaRx\n\tkoBLfNDiiuR3lD8tnJ4A1F88K6ojOUs+jndKsOaQpDZV6iNFv8IaNIklTPvPkZsmNDhJMRHH\n\tIu60S7BpzNeQeT4yyY4dX9lC2JL/LOEpw8DGf5BNOP1KgjCvyp1/KcFxDAo89IeqljaRsCdP\n\t7WCIECWYem6pLwaw6IAL7oX+tEqIMPph/G/jwZcdS6Hkyt/esHPuHNwX4guqTbVEuRqbDzDI\n\t2DJO5FbxABEBAAGJAiUEGAEKAA8CGwwFAlnDlGsFCQeA/gIACgkQoR5GchCkYf1yYRAAq+Yo\n\tnbf9DGdK1kTAm2RTFg+w9oOp2Xjqfhds2PAhFFvrHQg1XfQR/UF/SjeUmaOmLSczM0s6XMeO\n\tVcE77UFtJ/+hLo4PRFKm5X1Pcar6g5m4xGqa+Xfzi9tRkwC29KMCoQOag1BhHChgqYaUH3yo\n\tUzaPwT/fY75iVI+yD0ih/e6j8qYvP8pvGwMQfrmN9YB0zB39YzCSdaUaNrWGD3iCBxg6lwSO\n\tLKeRhxxfiXCIYEf3vwOsP3YMx2JkD5doseXmWBGW1U0T/oJF+DVfKB6mv5UfsTzpVhJRgee7\n\t4jkjqFq4qsUGxcvF2xtRkfHFpZDbRgRlVmiWkqDkT4qMA+4q1y/dWwshSKi/uwVZNycuLsz+\n\t+OD8xPNCsMTqeUkAKfbD8xW4LCay3r/dD2ckoxRxtMD9eOAyu5wYzo/ydIPTh1QEj9SYyvp8\n\tO0g6CpxEwyHUQtF5oh15O018z3ZLztFJKR3RD42VKVsrnNDKnoY0f4U0z7eJv2NeF8xHMuiU\n\tRCIzqxX1GVYaNkKTnb/Qja8hnYnkUzY1Lc+OtwiGmXTwYsPZjjAaDX35J/RSKAoy5wGo/YFA\n\tJxB1gWThL4kOTbsqqXj9GLcyOImkW0lJGGR3o/fV91Zh63S5TKnf2YGGGzxki+ADdxVQAm+Q\n\tsbsRB8KNNvVXBOVNwko86rQqF9drZuw=","Organization":"Ideas on Board","Message-ID":"<1f5b3610-6c20-1f2b-2667-22eff46a8cad@ideasonboard.com>","Date":"Thu, 4 Jul 2019 10:39:19 +0100","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101\n\tThunderbird/60.7.1","MIME-Version":"1.0","In-Reply-To":"<20190703211358.2362-1-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-GB","Content-Transfer-Encoding":"7bit","Subject":"Re: [libcamera-devel] [PATCH] utils: checkstyle.py: Add Doxygen\n\tformatter","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Thu, 04 Jul 2019 09:39:23 -0000"}}]