[{"id":17906,"web_url":"https://patchwork.libcamera.org/comment/17906/","msgid":"<20210629032126.GI2624@pyrite.rasen.tech>","date":"2021-06-29T03:21:26","subject":"Re: [libcamera-devel] [PATCH] libcamera: Move uneeded comment from\n\tpipeline handler","submitter":{"id":17,"url":"https://patchwork.libcamera.org/api/people/17/","name":"Paul Elder","email":"paul.elder@ideasonboard.com"},"content":"Hi Jean-Michel,\n\nOn Mon, Jun 28, 2021 at 10:04:13PM +0200, Jean-Michel Hautbois wrote:\n> The comment is a implementation detail and does not belong to API\n> documentation. Move it inside the function.\n> \n> Signed-off-by: Jean-Michel Hautbois \n> ---\n> src/libcamera/pipeline_handler.cpp | 8 ++++----\n> 1 file changed, 4 insertions(+), 4 deletions(-)\n> \n> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> index f626eddd..39eed678 100644\n> --- a/src/libcamera/pipeline_handler.cpp\n> +++ b/src/libcamera/pipeline_handler.cpp\n> @@ -707,14 +707,14 @@ void PipelineHandlerFactory::registerType(PipelineHandlerFactory *factory)\n> \n> /**\n> * \\brief Retrieve the list of all pipeline handler factories\n> - *\n> - * The static factories map is defined inside the function to ensures it gets\n> - * initialized on first use, without any dependency on link order.\n> - *\n> * \\return the list of pipeline handler factories\n> */\n> std::vector &PipelineHandlerFactory::factories()\n> {\n> +\t/* The static factories map is defined inside the function to ensures\n\ns/ensures/ensure/\n\n(Not sure if you want to change it on a simple move patch, though)\n\nReviewed-by: Paul Elder \n\n> +\t * it gets initialized on first use, without any dependency on\n> +\t * link order.\n> +\t */\n> \tstatic std::vector factories;\n> \treturn factories;\n> }\n> -- \n> 2.30.2\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 B2819C3220\n\tfor ;\n\tTue, 29 Jun 2021 03:21:36 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 143BD684E8;\n\tTue, 29 Jun 2021 05:21:36 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 2E5036028B\n\tfor ;\n\tTue, 29 Jun 2021 05:21:34 +0200 (CEST)","from pyrite.rasen.tech (unknown\n\t[IPv6:2400:4051:61:600:2c71:1b79:d06d:5032])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id C0E964AD;\n\tTue, 29 Jun 2021 05:21:32 +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=\"fIDFKlqG\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1624936893;\n\tbh=OT6venHST6Fr/HVpFLU2iz4AgtgpWE9Shnm4k4an0bs=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=fIDFKlqGEdmsqXgxr6F9Z6jhcIssbG9WPAhf1ZPgrzggXhLcupBAjTp183F+ENcxc\n\tpo5M6PizLskO6XTUTJFuzw7XYdTxSGfqeSj3DxIUknD96JGP1s9gOqcQ9ycll7zhQF\n\tc+uImJ1Q8J8PaPwkmxFTuqgCrnhJ+Zx/Z+1N4MLQ=","Date":"Tue, 29 Jun 2021 12:21:26 +0900","From":"paul.elder@ideasonboard.com","To":"Jean-Michel Hautbois ","Message-ID":"<20210629032126.GI2624@pyrite.rasen.tech>","References":"<20210628200413.131701-1-jeanmichel.hautbois@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=us-ascii","Content-Disposition":"inline","In-Reply-To":"<20210628200413.131701-1-jeanmichel.hautbois@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH] libcamera: Move uneeded comment from\n\tpipeline handler","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","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":17910,"web_url":"https://patchwork.libcamera.org/comment/17910/","msgid":"<0c995f11-6b3a-0255-c948-1187516528c4@ideasonboard.com>","date":"2021-06-29T12:22:41","subject":"Re: [libcamera-devel] [PATCH] libcamera: Move uneeded comment from\n\tpipeline handler","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi JM,\n\nOn 28/06/2021 21:04, Jean-Michel Hautbois wrote:\n> The comment is a implementation detail and does not belong to API\n> documentation. Move it inside the function.\n> \n\nSounds reasonable indeed.\n\n> Signed-off-by: Jean-Michel Hautbois \n> ---\n> src/libcamera/pipeline_handler.cpp | 8 ++++----\n> 1 file changed, 4 insertions(+), 4 deletions(-)\n> \n> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> index f626eddd..39eed678 100644\n> --- a/src/libcamera/pipeline_handler.cpp\n> +++ b/src/libcamera/pipeline_handler.cpp\n> @@ -707,14 +707,14 @@ void PipelineHandlerFactory::registerType(PipelineHandlerFactory *factory)\n> \n> /**\n> * \\brief Retrieve the list of all pipeline handler factories\n> - *\n> - * The static factories map is defined inside the function to ensures it gets\n> - * initialized on first use, without any dependency on link order.\n> - *\n> * \\return the list of pipeline handler factories\n> */\n> std::vector &PipelineHandlerFactory::factories()\n> {\n> +\t/* The static factories map is defined inside the function to ensures\n\nThough a multiline comment should have /* on it's own\n\n /*\n * line 1.\n * line 2.\n */\n\nI'd say the s/ensures/ensure/ could be fixed up in this patch too, with\njust a comment in the commit message to say, it also fixes a grammatical\nerror in the comment.\n\n\nWith those:\n\nReviewed-by: Kieran Bingham \n\n\n> +\t * it gets initialized on first use, without any dependency on\n> +\t * link order.\n> +\t */\n> \tstatic std::vector factories;\n> \treturn factories;\n> }\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 627ABC3220\n\tfor ;\n\tTue, 29 Jun 2021 12:22:47 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A3A07684EA;\n\tTue, 29 Jun 2021 14:22:46 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B683C684CB\n\tfor ;\n\tTue, 29 Jun 2021 14:22:44 +0200 (CEST)","from [192.168.0.20]\n\t(cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 421F7E7;\n\tTue, 29 Jun 2021 14:22:44 +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=\"gR1HqrrP\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1624969364;\n\tbh=jV/bqKSoS8dTNi0bMVAP3Xc9uQyQDo3gRE9UW2fT+jQ=;\n\th=Subject:To:References:From:Date:In-Reply-To:From;\n\tb=gR1HqrrP+t7m+lyIned92DN/iZx+dE+LBIit8gjHqJU7uHnw10d9E9KNYM2FniPwg\n\tpabuuTaG0j6h8vCYOmF78XX4koKIgJLXEEkptmCU+Fmc0p/VFZFUktSA6zFhQGecib\n\tAkDU9f+gJ9Ue5CzXjfa5QK3JDQDUixZCzG1HkDtA=","To":"Jean-Michel Hautbois ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20210628200413.131701-1-jeanmichel.hautbois@ideasonboard.com>","From":"Kieran Bingham ","Message-ID":"<0c995f11-6b3a-0255-c948-1187516528c4@ideasonboard.com>","Date":"Tue, 29 Jun 2021 13:22:41 +0100","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101\n\tThunderbird/78.11.0","MIME-Version":"1.0","In-Reply-To":"<20210628200413.131701-1-jeanmichel.hautbois@ideasonboard.com>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-GB","Content-Transfer-Encoding":"7bit","Subject":"Re: [libcamera-devel] [PATCH] libcamera: Move uneeded comment from\n\tpipeline handler","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":17913,"web_url":"https://patchwork.libcamera.org/comment/17913/","msgid":"","date":"2021-06-29T13:24:54","subject":"Re: [libcamera-devel] [PATCH] libcamera: Move uneeded comment from\n\tpipeline handler","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Tue, Jun 29, 2021 at 01:22:41PM +0100, Kieran Bingham wrote:\n> Hi JM,\n> \n> On 28/06/2021 21:04, Jean-Michel Hautbois wrote:\n> > The comment is a implementation detail and does not belong to API\n> > documentation. Move it inside the function.\n> > \n> \n> Sounds reasonable indeed.\n> \n> > Signed-off-by: Jean-Michel Hautbois \n> > ---\n> > src/libcamera/pipeline_handler.cpp | 8 ++++----\n> > 1 file changed, 4 insertions(+), 4 deletions(-)\n> > \n> > diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> > index f626eddd..39eed678 100644\n> > --- a/src/libcamera/pipeline_handler.cpp\n> > +++ b/src/libcamera/pipeline_handler.cpp\n> > @@ -707,14 +707,14 @@ void PipelineHandlerFactory::registerType(PipelineHandlerFactory *factory)\n> > \n> > /**\n> > * \\brief Retrieve the list of all pipeline handler factories\n> > - *\n> > - * The static factories map is defined inside the function to ensures it gets\n> > - * initialized on first use, without any dependency on link order.\n> > - *\n> > * \\return the list of pipeline handler factories\n> > */\n> > std::vector &PipelineHandlerFactory::factories()\n> > {\n> > +\t/* The static factories map is defined inside the function to ensures\n> \n> Though a multiline comment should have /* on it's own\n> \n> /*\n> * line 1.\n> * line 2.\n> */\n> \n> I'd say the s/ensures/ensure/ could be fixed up in this patch too, with\n> just a comment in the commit message to say, it also fixes a grammatical\n> error in the comment.\n\nAnd the subject line should read\n\nlibcamera: pipeline_handler: Hide implementation detail comment from doxygen\n\nor something similar.\n\n> With those:\n> \n> Reviewed-by: Kieran Bingham \n> \n> > +\t * it gets initialized on first use, without any dependency on\n> > +\t * link order.\n> > +\t */\n> > \tstatic std::vector factories;\n> > \treturn factories;\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 52F9FC3220\n\tfor ;\n\tTue, 29 Jun 2021 13:24:59 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B10EC684EA;\n\tTue, 29 Jun 2021 15:24:58 +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 0D0CD684CB\n\tfor ;\n\tTue, 29 Jun 2021 15:24:58 +0200 (CEST)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 669354AD;\n\tTue, 29 Jun 2021 15:24:57 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"M5S0zPN3\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1624973097;\n\tbh=blFf/jeBRVM2zWtbq7B87LPUcF7vSJrCmYINFYKXiXU=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=M5S0zPN3h8gnXFXHArfc8oqGcAT2VPKuS02vwtJJQe6tvpAjPnH/pxX7T2uNqDK8+\n\t+OVzyy8OzQk6e1g0o14BcTHgD6NGDtXg70ETbzgKDiV4xvAkK9wweTIVNiYUxoYCqY\n\tdyXxleO2ji3t6ugaSBOgdRnSVTJnFI3Yx+R2aK3I=","Date":"Tue, 29 Jun 2021 16:24:54 +0300","From":"Laurent Pinchart ","To":"Kieran Bingham ","Message-ID":"","References":"<20210628200413.131701-1-jeanmichel.hautbois@ideasonboard.com>\n\t<0c995f11-6b3a-0255-c948-1187516528c4@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<0c995f11-6b3a-0255-c948-1187516528c4@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH] libcamera: Move uneeded comment from\n\tpipeline handler","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","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]