[{"id":4192,"web_url":"https://patchwork.libcamera.org/comment/4192/","msgid":"<986c45bb-59fa-02fa-49b0-870908009d61@ideasonboard.com>","date":"2020-03-23T11:35:39","subject":"Re: [libcamera-devel] [PATCH 1/2] utils: checkstyle: Add formatter\n\tto sort #include statements","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Laurent,\n\nOn 22/03/2020 12:02, Laurent Pinchart wrote:\n\nHa, I love this :-)\n\nOne less thing to worry about in reviews!\n\n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> ---\n>  utils/checkstyle.py | 33 +++++++++++++++++++++++++++++++++\n>  1 file changed, 33 insertions(+)\n> \n> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> index 0827a1e6ba0f..5fd63f047781 100755\n> --- a/utils/checkstyle.py\n> +++ b/utils/checkstyle.py\n> @@ -481,6 +481,39 @@ class DoxygenFormatter(Formatter):\n>          return '\\n'.join(lines)\n>  \n>  \n> +class IncludeOrderFormatter(Formatter):\n> +    patterns = ('*.cpp', '*.h')\n> +\n> +    include_regex = re.compile('^#include [\"<]([^\">]*)[\">]')\n> +\n> +    @classmethod\n> +    def format(cls, filename, data):\n> +        lines = []\n> +        includes = []\n> +\n> +        for line in data.split('\\n'):\n> +            match = IncludeOrderFormatter.include_regex.match(line)\n> +            if match:\n> +                includes.append((line, match.group(1)))\n> +                continue\n> +\n\nMaybe it's just me, but this seems somehow quite hard to interpret and I\nfound it difficult to work out /how/ the code is parsing the blocks.\n\nI'm not yet sure what, but a comment describing what happens somewhere\nwould be useful for the future me...\n\n(It didn't help that I missed the continue on my first read, so I didn't\nrealise the code below was only executed for non #include lines).\n\nMaybe a top level comment saying:\n # Parse blocks of #include statements, and output them as a sorted list\n # when we reach a non #include statement.\n\n\nPerhaps that's verging towards commenting what the code does rather than\nwhy, but now that I 'know' that information, it's easier to parse the\npaths of the code to determine the 'how'...\n\n\n> +            if len(includes):\n> +                includes.sort(key=lambda i: i[1])\n> +                for include in includes:\n> +                    lines.append(include[0])\n> +                includes = []\n> +\n> +            lines.append(line)\n> +\n> +        if len(includes):\n> +            includes.sort(key=lambda i: i[1])\n> +            for include in includes:\n> +                lines.append(include[0])\n> +            includes = []\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":"<kieran.bingham@ideasonboard.com>","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 1281860413\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 23 Mar 2020 12:35:43 +0100 (CET)","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 03A72308;\n\tMon, 23 Mar 2020 12:35:41 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1584963342;\n\tbh=YTZ5NjaAJi0xR8tB00d6I6OCDnWgzJtboqjmx2EO9uc=;\n\th=Reply-To:Subject:To:References:From:Date:In-Reply-To:From;\n\tb=ISxQJ/MEehBZVTsgLD7hHAq6rMsEp/aEb3OXT89yL83ML5lsRu74oAeTC2qilKLtr\n\tgFMq0IiJE2bwVujvRvSY2Cbn+w2s2L23VQE/mcsfHQGIIbHdcZEgl7U3IYxL0n6XwP\n\tR5oHzt3U2HJgt35+6H3tAtJm0M5nNOYNgh791aPU=","Reply-To":"kieran.bingham@ideasonboard.com","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>,\n\tlibcamera-devel@lists.libcamera.org","References":"<20200322120225.31356-1-laurent.pinchart@ideasonboard.com>","From":"Kieran Bingham <kieran.bingham@ideasonboard.com>","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\tZ2hhbSA8a2llcmFuLmJpbmdoYW1AaWRlYXNvbmJvYXJkLmNvbT6JAlcEEwEKAEECGwMFCwkI\n\tBwIGFQgJCgsCBBYCAwECHgECF4ACGQEWIQSQLdeYP70o/eNy1HqhHkZyEKRh/QUCXWTtygUJ\n\tCyJXZAAKCRChHkZyEKRh/f8dEACTDsbLN2nioNZMwyLuQRUAFcXNolDX48xcUXsWS2QjxaPm\n\tVsJx8Uy8aYkS85mdPBh0C83OovQR/OVbr8AxhGvYqBs3nQvbWuTl/+4od7DfK2VZOoKBAu5S\n\tQK2FYuUcikDqYcFWJ8DQnubxfE8dvzojHEkXw0sA4igINHDDFX3HJGZtLio+WpEFQtCbfTAG\n\tYZslasz1YZRbwEdSsmO3/kqy5eMnczlm8a21A3fKUo3g8oAZEFM+f4DUNzqIltg31OAB/kZS\n\tenKZQ/SWC8PmLg/ZXBrReYakxXtkP6w3FwMlzOlhGxqhIRNiAJfXJBaRhuUWzPOpEDE9q5YJ\n\tBmqQL2WJm1VSNNVxbXJHpaWMH1sA2R00vmvRrPXGwyIO0IPYeUYQa3gsy6k+En/aMQJd27dp\n\taScf9am9PFICPY5T4ppneeJLif2lyLojo0mcHOV+uyrds9XkLpp14GfTkeKPdPMrLLTsHRfH\n\tfA4I4OBpRrEPiGIZB/0im98MkGY/Mu6qxeZmYLCcgD6qz4idOvfgVOrNh+aA8HzIVR+RMW8H\n\tQGBN9f0E3kfwxuhl3omo6V7lDw8XOdmuWZNC9zPq1UfryVHANYbLGz9KJ4Aw6M+OgBC2JpkD\n\thXMdHUkC+d20dwXrwHTlrJi1YNp6rBc+xald3wsUPOZ5z8moTHUX/uPA/qhGsbkCDQRWBP1m\n\tARAAzijkb+Sau4hAncr1JjOY+KyFEdUNxRy+hqTJdJfaYihxyaj0Ee0P0zEi35CbE6lgU0Uz\n\ttih9fiUbSV3wfsWqg1Ut3/5rTKu7kLFp15kF7eqvV4uezXRD3Qu4yjv/rMmEJbbD4cTvGCYI\n\td6MDC417f7vK3hCbCVIZSp3GXxyC1LU+UQr3fFcOyCwmP9vDUR9JV0BSqHHxRDdpUXE26Dk6\n\tmhf0V1YkspE5St814ETXpEus2urZE5yJIUROlWPIL+hm3NEWfAP06vsQUyLvr/GtbOT79vXl\n\tEn1aulcYyu20dRRxhkQ6iILaURcxIAVJJKPi8dsoMnS8pB0QW12AHWuirPF0g6DiuUfPmrA5\n\tPKe56IGlpkjc8cO51lIxHkWTpCMWigRdPDexKX+Sb+W9QWK/0JjIc4t3KBaiG8O4yRX8ml2R\n\t+rxfAVKM6V769P/hWoRGdgUMgYHFpHGSgEt80OKK5HeUPy2cngDUXzwrqiM5Sz6Od0qw5pCk\n\tNlXqI0W/who0iSVM+8+RmyY0OEkxEcci7rRLsGnM15B5PjLJjh1f2ULYkv8s4SnDwMZ/kE04\n\t/UqCMK/KnX8pwXEMCjz0h6qWNpGwJ0/tYIgQJZh6bqkvBrDogAvuhf60Sogw+mH8b+PBlx1L\n\toeTK396wc+4c3BfiC6pNtUS5GpsPMMjYMk7kVvEAEQEAAYkCPAQYAQoAJgIbDBYhBJAt15g/\n\tvSj943LUeqEeRnIQpGH9BQJdizzIBQkLSKZiAAoJEKEeRnIQpGH9eYgQAJpjaWNgqNOnMTmD\n\tMJggbwjIotypzIXfhHNCeTkG7+qCDlSaBPclcPGYrTwCt0YWPU2TgGgJrVhYT20ierN8LUvj\n\t6qOPTd+Uk7NFzL65qkh80ZKNBFddx1AabQpSVQKbdcLb8OFs85kuSvFdgqZwgxA1vl4TFhNz\n\tPZ79NAmXLackAx3sOVFhk4WQaKRshCB7cSl+RIng5S/ThOBlwNlcKG7j7W2MC06BlTbdEkUp\n\tECzuuRBv8wX4OQl+hbWbB/VKIx5HKlLu1eypen/5lNVzSqMMIYkkZcjV2SWQyUGxSwq0O/sx\n\tS0A8/atCHUXOboUsn54qdxrVDaK+6jIAuo8JiRWctP16KjzUM7MO0/+4zllM8EY57rXrj48j\n\tsbEYX0YQnzaj+jO6kJtoZsIaYR7rMMq9aUAjyiaEZpmP1qF/2sYenDx0Fg2BSlLvLvXM0vU8\n\tpQk3kgDu7kb/7PRYrZvBsr21EIQoIjXbZxDz/o7z95frkP71EaICttZ6k9q5oxxA5WC6sTXc\n\tMW8zs8avFNuA9VpXt0YupJd2ijtZy2mpZNG02fFVXhIn4G807G7+9mhuC4XG5rKlBBUXTvPU\n\tAfYnB4JBDLmLzBFavQfvonSfbitgXwCG3vS+9HEwAjU30Bar1PEOmIbiAoMzuKeRm2LVpmq4\n\tWZw01QYHU/GUV/zHJSFk","Organization":"Ideas on Board","Message-ID":"<986c45bb-59fa-02fa-49b0-870908009d61@ideasonboard.com>","Date":"Mon, 23 Mar 2020 11:35:39 +0000","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101\n\tThunderbird/60.9.1","MIME-Version":"1.0","In-Reply-To":"<20200322120225.31356-1-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-GB","Content-Transfer-Encoding":"8bit","Subject":"Re: [libcamera-devel] [PATCH 1/2] utils: checkstyle: Add formatter\n\tto sort #include statements","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","X-List-Received-Date":"Mon, 23 Mar 2020 11:35:43 -0000"}},{"id":4193,"web_url":"https://patchwork.libcamera.org/comment/4193/","msgid":"<20200323114142.GB12103@pendragon.ideasonboard.com>","date":"2020-03-23T11:41:42","subject":"Re: [libcamera-devel] [PATCH 1/2] utils: checkstyle: Add formatter\n\tto sort #include statements","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Kieran,\n\nOn Mon, Mar 23, 2020 at 11:35:39AM +0000, Kieran Bingham wrote:\n> On 22/03/2020 12:02, Laurent Pinchart wrote:\n> \n> Ha, I love this :-)\n> \n> One less thing to worry about in reviews!\n> \n> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> > ---\n> >  utils/checkstyle.py | 33 +++++++++++++++++++++++++++++++++\n> >  1 file changed, 33 insertions(+)\n> > \n> > diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> > index 0827a1e6ba0f..5fd63f047781 100755\n> > --- a/utils/checkstyle.py\n> > +++ b/utils/checkstyle.py\n> > @@ -481,6 +481,39 @@ class DoxygenFormatter(Formatter):\n> >          return '\\n'.join(lines)\n> >  \n> >  \n> > +class IncludeOrderFormatter(Formatter):\n> > +    patterns = ('*.cpp', '*.h')\n> > +\n> > +    include_regex = re.compile('^#include [\"<]([^\">]*)[\">]')\n> > +\n> > +    @classmethod\n> > +    def format(cls, filename, data):\n> > +        lines = []\n> > +        includes = []\n> > +\n> > +        for line in data.split('\\n'):\n> > +            match = IncludeOrderFormatter.include_regex.match(line)\n> > +            if match:\n> > +                includes.append((line, match.group(1)))\n> > +                continue\n> > +\n> \n> Maybe it's just me, but this seems somehow quite hard to interpret and I\n> found it difficult to work out /how/ the code is parsing the blocks.\n> \n> I'm not yet sure what, but a comment describing what happens somewhere\n> would be useful for the future me...\n> \n> (It didn't help that I missed the continue on my first read, so I didn't\n> realise the code below was only executed for non #include lines).\n> \n> Maybe a top level comment saying:\n>  # Parse blocks of #include statements, and output them as a sorted list\n>  # when we reach a non #include statement.\n> \n> \n> Perhaps that's verging towards commenting what the code does rather than\n> why, but now that I 'know' that information, it's easier to parse the\n> paths of the code to determine the 'how'...\n\ndiff --git a/utils/checkstyle.py b/utils/checkstyle.py\nindex 5fd63f047781..b594a19aed5b 100755\n--- a/utils/checkstyle.py\n+++ b/utils/checkstyle.py\n@@ -491,12 +491,18 @@ class IncludeOrderFormatter(Formatter):\n         lines = []\n         includes = []\n\n+        # Parse blocks of #include statements, and output them as a sorted list\n+        # when we reach a non #include statement.\n         for line in data.split('\\n'):\n             match = IncludeOrderFormatter.include_regex.match(line)\n             if match:\n+                # If the current line is an #include statement, add it to the\n+                # includes group and continue to the next line.\n                 includes.append((line, match.group(1)))\n                 continue\n\n+            # The current line is not an #include statement, output the sorted\n+            # stashed includes first, and then the current line.\n             if len(includes):\n                 includes.sort(key=lambda i: i[1])\n                 for include in includes:\n@@ -505,6 +511,8 @@ class IncludeOrderFormatter(Formatter):\n\n             lines.append(line)\n\n+        # In the unlikely case the file ends with an #include statement, make\n+        # sure we output the stashed includes.\n         if len(includes):\n             includes.sort(key=lambda i: i[1])\n             for include in includes:\n\nDoes this look good to you ? If so, your Rb tag will be appreciated (for\nthe result of squashing the original patch with this change) :-)\n\n> > +            if len(includes):\n> > +                includes.sort(key=lambda i: i[1])\n> > +                for include in includes:\n> > +                    lines.append(include[0])\n> > +                includes = []\n> > +\n> > +            lines.append(line)\n> > +\n> > +        if len(includes):\n> > +            includes.sort(key=lambda i: i[1])\n> > +            for include in includes:\n> > +                lines.append(include[0])\n> > +            includes = []\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":"<laurent.pinchart@ideasonboard.com>","Received":["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 F2B5160413\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 23 Mar 2020 12:41:51 +0100 (CET)","from pendragon.ideasonboard.com (81-175-216-236.bb.dnainternet.fi\n\t[81.175.216.236])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 3854B308;\n\tMon, 23 Mar 2020 12:41:51 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1584963711;\n\tbh=Fc5mW2+ftykmEUPw6UJSZhSoYqZqHaRB14vUZLHjuTg=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=IdDiqm4wbg8c5KgxUuXBynenBVjcP+HnKHIHOIwac2YMOcXa8ynvrAR78i5CnM+Ea\n\taTa6Xo7I/q4APWhjIOTtAFIr78PAmQfI0uUQXoCIzKLzOqNrTsnOJK7yFr27uc5N1w\n\tB7LAy3/reRSJZ9klwHlovbL7eWW3CIc4k32ERcv0=","Date":"Mon, 23 Mar 2020 13:41:42 +0200","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Kieran Bingham <kieran.bingham@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20200323114142.GB12103@pendragon.ideasonboard.com>","References":"<20200322120225.31356-1-laurent.pinchart@ideasonboard.com>\n\t<986c45bb-59fa-02fa-49b0-870908009d61@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<986c45bb-59fa-02fa-49b0-870908009d61@ideasonboard.com>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH 1/2] utils: checkstyle: Add formatter\n\tto sort #include statements","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","X-List-Received-Date":"Mon, 23 Mar 2020 11:41:52 -0000"}},{"id":4194,"web_url":"https://patchwork.libcamera.org/comment/4194/","msgid":"<8bb74666-1b29-304f-abd6-fdabddb8292b@ideasonboard.com>","date":"2020-03-23T11:46:31","subject":"Re: [libcamera-devel] [PATCH 1/2] utils: checkstyle: Add formatter\n\tto sort #include statements","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Laurent,\n\nOn 23/03/2020 11:41, Laurent Pinchart wrote:\n> Hi Kieran,\n> \n> On Mon, Mar 23, 2020 at 11:35:39AM +0000, Kieran Bingham wrote:\n>> On 22/03/2020 12:02, Laurent Pinchart wrote:\n>>\n>> Ha, I love this :-)\n>>\n>> One less thing to worry about in reviews!\n>>\n>>> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n>>> ---\n>>>  utils/checkstyle.py | 33 +++++++++++++++++++++++++++++++++\n>>>  1 file changed, 33 insertions(+)\n>>>\n>>> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n>>> index 0827a1e6ba0f..5fd63f047781 100755\n>>> --- a/utils/checkstyle.py\n>>> +++ b/utils/checkstyle.py\n>>> @@ -481,6 +481,39 @@ class DoxygenFormatter(Formatter):\n>>>          return '\\n'.join(lines)\n>>>  \n>>>  \n>>> +class IncludeOrderFormatter(Formatter):\n>>> +    patterns = ('*.cpp', '*.h')\n>>> +\n>>> +    include_regex = re.compile('^#include [\"<]([^\">]*)[\">]')\n>>> +\n>>> +    @classmethod\n>>> +    def format(cls, filename, data):\n>>> +        lines = []\n>>> +        includes = []\n>>> +\n>>> +        for line in data.split('\\n'):\n>>> +            match = IncludeOrderFormatter.include_regex.match(line)\n>>> +            if match:\n>>> +                includes.append((line, match.group(1)))\n>>> +                continue\n>>> +\n>>\n>> Maybe it's just me, but this seems somehow quite hard to interpret and I\n>> found it difficult to work out /how/ the code is parsing the blocks.\n>>\n>> I'm not yet sure what, but a comment describing what happens somewhere\n>> would be useful for the future me...\n>>\n>> (It didn't help that I missed the continue on my first read, so I didn't\n>> realise the code below was only executed for non #include lines).\n>>\n>> Maybe a top level comment saying:\n>>  # Parse blocks of #include statements, and output them as a sorted list\n>>  # when we reach a non #include statement.\n>>\n>>\n>> Perhaps that's verging towards commenting what the code does rather than\n>> why, but now that I 'know' that information, it's easier to parse the\n>> paths of the code to determine the 'how'...\n> \n> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> index 5fd63f047781..b594a19aed5b 100755\n> --- a/utils/checkstyle.py\n> +++ b/utils/checkstyle.py\n> @@ -491,12 +491,18 @@ class IncludeOrderFormatter(Formatter):\n>          lines = []\n>          includes = []\n> \n> +        # Parse blocks of #include statements, and output them as a sorted list\n> +        # when we reach a non #include statement.\n>          for line in data.split('\\n'):\n>              match = IncludeOrderFormatter.include_regex.match(line)\n>              if match:\n> +                # If the current line is an #include statement, add it to the\n> +                # includes group and continue to the next line.\n>                  includes.append((line, match.group(1)))\n>                  continue\n> \n> +            # The current line is not an #include statement, output the sorted\n> +            # stashed includes first, and then the current line.\n>              if len(includes):\n>                  includes.sort(key=lambda i: i[1])\n>                  for include in includes:\n> @@ -505,6 +511,8 @@ class IncludeOrderFormatter(Formatter):\n> \n>              lines.append(line)\n> \n> +        # In the unlikely case the file ends with an #include statement, make\n> +        # sure we output the stashed includes.\n>          if len(includes):\n>              includes.sort(key=lambda i: i[1])\n>              for include in includes:\n> \n> Does this look good to you ? If so, your Rb tag will be appreciated (for\n> the result of squashing the original patch with this change) :-)\n\nHaha - more than I was expecting -  but that's helpful in this case I\nthink :-)\n\nReviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>\n\n> \n>>> +            if len(includes):\n>>> +                includes.sort(key=lambda i: i[1])\n>>> +                for include in includes:\n>>> +                    lines.append(include[0])\n>>> +                includes = []\n>>> +\n>>> +            lines.append(line)\n>>> +\n>>> +        if len(includes):\n>>> +            includes.sort(key=lambda i: i[1])\n>>> +            for include in includes:\n>>> +                lines.append(include[0])\n>>> +            includes = []\n>>> +\n>>> +        return '\\n'.join(lines)\n>>> +\n>>> +\n>>>  class StripTrailingSpaceFormatter(Formatter):\n>>>      patterns = ('*.c', '*.cpp', '*.h', '*.py', 'meson.build')\n>>>  \n>>>\n>","headers":{"Return-Path":"<kieran.bingham@ideasonboard.com>","Received":["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 D079960413\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 23 Mar 2020 12:46:34 +0100 (CET)","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 3E443308;\n\tMon, 23 Mar 2020 12:46:34 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1584963994;\n\tbh=NhBg790H6oKP5IN5hoJ2yO1vVAdifmQfN5E0yVhp2Zg=;\n\th=Reply-To:Subject:To:Cc:References:From:Date:In-Reply-To:From;\n\tb=SkwitQcH10C3uLn36NVylLpPWPhbcSm1AGP5NjZ6KThCnpYUlPdGpgjJry9WlIZ6e\n\tN2cziotCIkisZ6pPLdez+L/nx9SrWhYt5cEYG0p6DVizWAcnv4YYKoKcaAOdMTe7j+\n\tzfx5eVbah4CCo+NzMjH20LhSciU/DJxf043OJVuY=","Reply-To":"kieran.bingham@ideasonboard.com","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org","References":"<20200322120225.31356-1-laurent.pinchart@ideasonboard.com>\n\t<986c45bb-59fa-02fa-49b0-870908009d61@ideasonboard.com>\n\t<20200323114142.GB12103@pendragon.ideasonboard.com>","From":"Kieran Bingham <kieran.bingham@ideasonboard.com>","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\tZ2hhbSA8a2llcmFuLmJpbmdoYW1AaWRlYXNvbmJvYXJkLmNvbT6JAlcEEwEKAEECGwMFCwkI\n\tBwIGFQgJCgsCBBYCAwECHgECF4ACGQEWIQSQLdeYP70o/eNy1HqhHkZyEKRh/QUCXWTtygUJ\n\tCyJXZAAKCRChHkZyEKRh/f8dEACTDsbLN2nioNZMwyLuQRUAFcXNolDX48xcUXsWS2QjxaPm\n\tVsJx8Uy8aYkS85mdPBh0C83OovQR/OVbr8AxhGvYqBs3nQvbWuTl/+4od7DfK2VZOoKBAu5S\n\tQK2FYuUcikDqYcFWJ8DQnubxfE8dvzojHEkXw0sA4igINHDDFX3HJGZtLio+WpEFQtCbfTAG\n\tYZslasz1YZRbwEdSsmO3/kqy5eMnczlm8a21A3fKUo3g8oAZEFM+f4DUNzqIltg31OAB/kZS\n\tenKZQ/SWC8PmLg/ZXBrReYakxXtkP6w3FwMlzOlhGxqhIRNiAJfXJBaRhuUWzPOpEDE9q5YJ\n\tBmqQL2WJm1VSNNVxbXJHpaWMH1sA2R00vmvRrPXGwyIO0IPYeUYQa3gsy6k+En/aMQJd27dp\n\taScf9am9PFICPY5T4ppneeJLif2lyLojo0mcHOV+uyrds9XkLpp14GfTkeKPdPMrLLTsHRfH\n\tfA4I4OBpRrEPiGIZB/0im98MkGY/Mu6qxeZmYLCcgD6qz4idOvfgVOrNh+aA8HzIVR+RMW8H\n\tQGBN9f0E3kfwxuhl3omo6V7lDw8XOdmuWZNC9zPq1UfryVHANYbLGz9KJ4Aw6M+OgBC2JpkD\n\thXMdHUkC+d20dwXrwHTlrJi1YNp6rBc+xald3wsUPOZ5z8moTHUX/uPA/qhGsbkCDQRWBP1m\n\tARAAzijkb+Sau4hAncr1JjOY+KyFEdUNxRy+hqTJdJfaYihxyaj0Ee0P0zEi35CbE6lgU0Uz\n\ttih9fiUbSV3wfsWqg1Ut3/5rTKu7kLFp15kF7eqvV4uezXRD3Qu4yjv/rMmEJbbD4cTvGCYI\n\td6MDC417f7vK3hCbCVIZSp3GXxyC1LU+UQr3fFcOyCwmP9vDUR9JV0BSqHHxRDdpUXE26Dk6\n\tmhf0V1YkspE5St814ETXpEus2urZE5yJIUROlWPIL+hm3NEWfAP06vsQUyLvr/GtbOT79vXl\n\tEn1aulcYyu20dRRxhkQ6iILaURcxIAVJJKPi8dsoMnS8pB0QW12AHWuirPF0g6DiuUfPmrA5\n\tPKe56IGlpkjc8cO51lIxHkWTpCMWigRdPDexKX+Sb+W9QWK/0JjIc4t3KBaiG8O4yRX8ml2R\n\t+rxfAVKM6V769P/hWoRGdgUMgYHFpHGSgEt80OKK5HeUPy2cngDUXzwrqiM5Sz6Od0qw5pCk\n\tNlXqI0W/who0iSVM+8+RmyY0OEkxEcci7rRLsGnM15B5PjLJjh1f2ULYkv8s4SnDwMZ/kE04\n\t/UqCMK/KnX8pwXEMCjz0h6qWNpGwJ0/tYIgQJZh6bqkvBrDogAvuhf60Sogw+mH8b+PBlx1L\n\toeTK396wc+4c3BfiC6pNtUS5GpsPMMjYMk7kVvEAEQEAAYkCPAQYAQoAJgIbDBYhBJAt15g/\n\tvSj943LUeqEeRnIQpGH9BQJdizzIBQkLSKZiAAoJEKEeRnIQpGH9eYgQAJpjaWNgqNOnMTmD\n\tMJggbwjIotypzIXfhHNCeTkG7+qCDlSaBPclcPGYrTwCt0YWPU2TgGgJrVhYT20ierN8LUvj\n\t6qOPTd+Uk7NFzL65qkh80ZKNBFddx1AabQpSVQKbdcLb8OFs85kuSvFdgqZwgxA1vl4TFhNz\n\tPZ79NAmXLackAx3sOVFhk4WQaKRshCB7cSl+RIng5S/ThOBlwNlcKG7j7W2MC06BlTbdEkUp\n\tECzuuRBv8wX4OQl+hbWbB/VKIx5HKlLu1eypen/5lNVzSqMMIYkkZcjV2SWQyUGxSwq0O/sx\n\tS0A8/atCHUXOboUsn54qdxrVDaK+6jIAuo8JiRWctP16KjzUM7MO0/+4zllM8EY57rXrj48j\n\tsbEYX0YQnzaj+jO6kJtoZsIaYR7rMMq9aUAjyiaEZpmP1qF/2sYenDx0Fg2BSlLvLvXM0vU8\n\tpQk3kgDu7kb/7PRYrZvBsr21EIQoIjXbZxDz/o7z95frkP71EaICttZ6k9q5oxxA5WC6sTXc\n\tMW8zs8avFNuA9VpXt0YupJd2ijtZy2mpZNG02fFVXhIn4G807G7+9mhuC4XG5rKlBBUXTvPU\n\tAfYnB4JBDLmLzBFavQfvonSfbitgXwCG3vS+9HEwAjU30Bar1PEOmIbiAoMzuKeRm2LVpmq4\n\tWZw01QYHU/GUV/zHJSFk","Organization":"Ideas on Board","Message-ID":"<8bb74666-1b29-304f-abd6-fdabddb8292b@ideasonboard.com>","Date":"Mon, 23 Mar 2020 11:46:31 +0000","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101\n\tThunderbird/60.9.1","MIME-Version":"1.0","In-Reply-To":"<20200323114142.GB12103@pendragon.ideasonboard.com>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-GB","Content-Transfer-Encoding":"7bit","Subject":"Re: [libcamera-devel] [PATCH 1/2] utils: checkstyle: Add formatter\n\tto sort #include statements","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","X-List-Received-Date":"Mon, 23 Mar 2020 11:46:35 -0000"}}]