[{"id":2948,"web_url":"https://patchwork.libcamera.org/comment/2948/","msgid":"<7c4e2486-7aad-d3ea-f09a-5b64a4e5accd@ideasonboard.com>","date":"2019-10-23T14:02:16","subject":"Re: [libcamera-devel] [PATCH 2/4] Documentation: coding-style:\n\tDocument order of includes","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/10/2019 14:52, Laurent Pinchart wrote:\n> We follow the Google C++ Style Guide rule on include ordering with a few\n> tweaks. Document our rule explicitly.\n> \n\nHappy to see this documented for clarity.\n\n> Signed-off-by: Laurent Pinchart \n\nOnly white-space comments below.\n\nReviewed-by: Kieran Bingham \n\n> ---\n> Documentation/coding-style.rst | 23 +++++++++++++++++++++++\n> 1 file changed, 23 insertions(+)\n> \n> diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst\n> index ced3155169a6..c53248234c34 100644\n> --- a/Documentation/coding-style.rst\n> +++ b/Documentation/coding-style.rst\n> @@ -61,6 +61,29 @@ document:\n> Code Style for indentation, braces, spacing, etc\n> * Header guards are formatted as '__LIBCAMERA_FILE_NAME_H__'\n> \n\nSingle separating line here,\n\n> +Order of Includes\n> +~~~~~~~~~~~~~~~~~\n> +\n> +Headers shall be included at the beginning of .c, .cpp and .h files, right\n> +after the file description comment block and, for .h files, the header guard\n> +macro. For .cpp files, if the file implements an API declared in a header file,\n> +that header file shall be included first in order to ensure it is\n> +self-contained.\n> +\n> +The headers shall be grouped and ordered as follows.\n> +\n> + # The header declaring the API being implemented (if any)\n> + # The C and C++ system and standard library headers\n> + # Other libraries' headers, with one group per library\n> + # Other project's headers\n> +\n> +Groups of headers shall be separated by a single blank line. Headers within\n> +each group shall be sorted alphabetically.\n> +\n> +System and library headers shall be included with angle brackets. Project\n> +headers shall be included with angle brackets for the libcamera public API\n> +headers, and with double quotes for other libcamera headers.\n> +\n> \n\nBut double here, just like the previous patch, so the adding an extra at\nthe bottom is consistent between the two making it look intentional -\nbut /both/ patches have a single separating line at the top or the entry?\n\n\n> C++ Specific Rules\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 4A0FC6138B\n\tfor ;\n\tWed, 23 Oct 2019 16:02:20 +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 9919471F;\n\tWed, 23 Oct 2019 16:02:19 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1571839339;\n\tbh=xA8pl3Ugvh2Lb24lxBIzUTNz3osWiGO5pbFF/1pERX0=;\n\th=Reply-To:Subject:To:References:From:Date:In-Reply-To:From;\n\tb=X4pla6seJmBauXQ/SvxCzU5ee/AvjNfGsMtvN2A/ZFoBc5VWdm7srO8yHtSvn+EtT\n\tPAjlG04mU+Ac0n8K33fylmuUGh0EmRbOAtHPtfguC/8ba5fhdJpibTud9CoDOoMv5T\n\tJwKkC8cNYPQ4HOCZE3yr5nFlFDpxr9ktP9/HFLPM=","Reply-To":"kieran.bingham@ideasonboard.com","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20191023135258.32256-1-laurent.pinchart@ideasonboard.com>\n\t<20191023135258.32256-2-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\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":"<7c4e2486-7aad-d3ea-f09a-5b64a4e5accd@ideasonboard.com>","Date":"Wed, 23 Oct 2019 15:02:16 +0100","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101\n\tThunderbird/60.8.0","MIME-Version":"1.0","In-Reply-To":"<20191023135258.32256-2-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-GB","Content-Transfer-Encoding":"7bit","Subject":"Re: [libcamera-devel] [PATCH 2/4] Documentation: coding-style:\n\tDocument order of includes","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","X-List-Received-Date":"Wed, 23 Oct 2019 14:02:20 -0000"}},{"id":2950,"web_url":"https://patchwork.libcamera.org/comment/2950/","msgid":"<20191023140627.GD4763@pendragon.ideasonboard.com>","date":"2019-10-23T14:06:27","subject":"Re: [libcamera-devel] [PATCH 2/4] Documentation: coding-style:\n\tDocument order of includes","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Kieran,\n\nOn Wed, Oct 23, 2019 at 03:02:16PM +0100, Kieran Bingham wrote:\n> Hi Laurent,\n> \n> On 23/10/2019 14:52, Laurent Pinchart wrote:\n> > We follow the Google C++ Style Guide rule on include ordering with a few\n> > tweaks. Document our rule explicitly.\n> > \n> \n> Happy to see this documented for clarity.\n> \n> > Signed-off-by: Laurent Pinchart \n> \n> Only white-space comments below.\n> \n> Reviewed-by: Kieran Bingham \n> \n> > ---\n> > Documentation/coding-style.rst | 23 +++++++++++++++++++++++\n> > 1 file changed, 23 insertions(+)\n> > \n> > diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst\n> > index ced3155169a6..c53248234c34 100644\n> > --- a/Documentation/coding-style.rst\n> > +++ b/Documentation/coding-style.rst\n> > @@ -61,6 +61,29 @@ document:\n> > Code Style for indentation, braces, spacing, etc\n> > * Header guards are formatted as '__LIBCAMERA_FILE_NAME_H__'\n> > \n> \n> Single separating line here,\n> \n> > +Order of Includes\n> > +~~~~~~~~~~~~~~~~~\n> > +\n> > +Headers shall be included at the beginning of .c, .cpp and .h files, right\n> > +after the file description comment block and, for .h files, the header guard\n> > +macro. For .cpp files, if the file implements an API declared in a header file,\n> > +that header file shall be included first in order to ensure it is\n> > +self-contained.\n> > +\n> > +The headers shall be grouped and ordered as follows.\n> > +\n> > + # The header declaring the API being implemented (if any)\n> > + # The C and C++ system and standard library headers\n> > + # Other libraries' headers, with one group per library\n> > + # Other project's headers\n> > +\n> > +Groups of headers shall be separated by a single blank line. Headers within\n> > +each group shall be sorted alphabetically.\n> > +\n> > +System and library headers shall be included with angle brackets. Project\n> > +headers shall be included with angle brackets for the libcamera public API\n> > +headers, and with double quotes for other libcamera headers.\n> > +\n> \n> But double here, just like the previous patch, so the adding an extra at\n> the bottom is consistent between the two making it look intentional -\n> but /both/ patches have a single separating line at the top or the entry?\n\nThere's a single line before the ~~~ headers, but a double line before\nthe --- headers. That's to stay consistent with the current style of the\nfile, I don't really have a preference.\n\n> > C++ Specific Rules\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 33A146138B\n\tfor ;\n\tWed, 23 Oct 2019 16:06:34 +0200 (CEST)","from pendragon.ideasonboard.com (143.121.2.93.rev.sfr.net\n\t[93.2.121.143])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 7086271F;\n\tWed, 23 Oct 2019 16:06:33 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1571839593;\n\tbh=pbbIa5LiFbFV1elGOXEJuThs4yqCtMaIa6O9NANtqy0=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=pFrTy4YYY5dnnxrO4AHPGa5EXtLy0NxCNoyYc1q22BcLyl+PqJMkXC+2AsU61pjUz\n\tbgRN17CA6p35ZSPxQf7VRHcW+KoVIMSLzL5LImobfPP8vbW5yo+1x6z6uVgbN9Swik\n\tzBm1ICQn4JcbQSxfn8NCZ9gZP89E2SYSQiiXL9m8=","Date":"Wed, 23 Oct 2019 17:06:27 +0300","From":"Laurent Pinchart ","To":"Kieran Bingham ","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20191023140627.GD4763@pendragon.ideasonboard.com>","References":"<20191023135258.32256-1-laurent.pinchart@ideasonboard.com>\n\t<20191023135258.32256-2-laurent.pinchart@ideasonboard.com>\n\t<7c4e2486-7aad-d3ea-f09a-5b64a4e5accd@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<7c4e2486-7aad-d3ea-f09a-5b64a4e5accd@ideasonboard.com>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH 2/4] Documentation: coding-style:\n\tDocument order of includes","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","X-List-Received-Date":"Wed, 23 Oct 2019 14:06:34 -0000"}}]