[{"id":26480,"web_url":"https://patchwork.libcamera.org/comment/26480/","msgid":"<20230226131724.egwsqzsrz4lncad4@uno.localdomain>","date":"2023-02-26T13:17:24","subject":"Re: [libcamera-devel] [PATCH v2] Implementation was spelled\n\tincorrectly in the pipeline-handler documentation","submitter":{"id":143,"url":"https://patchwork.libcamera.org/api/people/143/","name":"Jacopo Mondi","email":"jacopo.mondi@ideasonboard.com"},"content":"Hello Advait\n\n thanks for the patch\n\nOn Sat, Feb 25, 2023 at 07:10:45PM +0530, Advait Dhamorikar via libcamera-devel wrote:\n> Signed-off-by: Advait Dhamorikar \n\nA few notes about the submission process\n- The commit subject should ideally be shorter than 80 columns and\n should report what component is modified. As an example\n\n documentation: guides: pipeline-handler: Fix spelling error\n\n- We usually require a little commit message even for simple patches\n In this case something like:\n\n Fix wrong spelling of \"impelementation\" in the pipeline handler\n development guide.\n\nlibcamera provides git hooks in utils/hooks that help you catch these\nerrors early. You can install them by copying them in your\n.git/hooks/ directory.\n\n> ---\n> Documentation/guides/pipeline-handler.rst | 2 +-\n> 1 file changed, 1 insertion(+), 1 deletion(-)\n>\n> diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\n> index e1930fdf..4d38fa23 100644\n> --- a/Documentation/guides/pipeline-handler.rst\n> +++ b/Documentation/guides/pipeline-handler.rst\n> @@ -1409,7 +1409,7 @@ function to the V4L2 device buffer signal.\n> video_->bufferReady.connect(this, &VividCameraData::bufferReady);\n>\n> Create the matching ``VividCameraData::bufferReady`` function after your\n> -VividCameradata::init() impelementation.\n> +VividCameradata::init() implementation.\n\nThe patch itself looks correct.\n\n>\n> The ``bufferReady`` function obtains the request from the buffer using the\n> ``request`` function, and notifies the ``Camera`` that the buffer and\n> --\n> 2.34.1\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 1FAB1BE080\n\tfor ;\n\tSun, 26 Feb 2023 13:17:40 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 6EFA862672;\n\tSun, 26 Feb 2023 14:17:39 +0100 (CET)","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 D08236263C\n\tfor ;\n\tSun, 26 Feb 2023 14:17:37 +0100 (CET)","from ideasonboard.com (host-87-16-53-160.retail.telecomitalia.it\n\t[87.16.53.160])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 927C96DB;\n\tSun, 26 Feb 2023 14:17:34 +0100 (CET)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1677417459;\n\tbh=5Z6fvOa/JOaoKqzKR3we8yHJiVHrZkYR4dx6z1xP9m8=;\n\th=Date:To:References:In-Reply-To:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc:\n\tFrom;\n\tb=1MU9zlz+d/NFj0d1Dcsia+oFDtOJH7bDbIf9HzjrxABVUBmgbn+tJFCgdDxQ7MBiT\n\tJPXH7JSCYROZUBRRvWJ0HeRyVuqCw2BSy6N986SmnwSq4WUAJ6PcfqfW6PQXm3ko4a\n\tjSckV/dOaVvOGnfzE/EIRmR9U/vDW6lxUdvOtHbvSU9ZApuronD8u6f0iRR+B44YIt\n\tTNydaGrCcxwbSjKZKYG34q8HrdYrG1dK3barQ1bDx5IDf0wEyYz21XKLTbqjT9SxZf\n\tbAUEWo1Dx8SCC+Bf+BgATRePy84XWdp4xRjBCBMs6510zankgNonuhm2g4Rj+4qKIg\n\t3LrwEwu2pvOsw==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1677417457;\n\tbh=5Z6fvOa/JOaoKqzKR3we8yHJiVHrZkYR4dx6z1xP9m8=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=r3sehCQmrYWL47aMeYHPcUs5wtu4nRkkabMcB9LzoloR+nMkuK/nYHCw7B9Ep+bkN\n\tsX5cUxsIZLkaoY7PcQzX+PPUS262KJMWVDlJydZEFMs8UhW/1ECWhK4j5oMXz0MkBk\n\tPbUabWcL87IMetKPM2F/BoHNjHGngRg3EPnMu+hk="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"r3sehCQm\"; dkim-atps=neutral","Date":"Sun, 26 Feb 2023 14:17:24 +0100","To":"Advait Dhamorikar ","Message-ID":"<20230226131724.egwsqzsrz4lncad4@uno.localdomain>","References":"<20230225134045.5350-1-advaitdhamorikar@gmail.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20230225134045.5350-1-advaitdhamorikar@gmail.com>","Subject":"Re: [libcamera-devel] [PATCH v2] Implementation was spelled\n\tincorrectly in the pipeline-handler documentation","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","From":"Jacopo Mondi via libcamera-devel ","Reply-To":"Jacopo Mondi ","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":26481,"web_url":"https://patchwork.libcamera.org/comment/26481/","msgid":"","date":"2023-02-26T15:27:40","subject":"Re: [libcamera-devel] [PATCH v2] Implementation was spelled\n\tincorrectly in the pipeline-handler documentation","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Sun, Feb 26, 2023 at 02:17:24PM +0100, Jacopo Mondi via libcamera-devel wrote:\n> Hello Advait\n> \n> thanks for the patch\n> \n> On Sat, Feb 25, 2023 at 07:10:45PM +0530, Advait Dhamorikar via libcamera-devel wrote:\n> > Signed-off-by: Advait Dhamorikar \n> \n> A few notes about the submission process\n> - The commit subject should ideally be shorter than 80 columns and\n> should report what component is modified. As an example\n> \n> documentation: guides: pipeline-handler: Fix spelling error\n> \n> - We usually require a little commit message even for simple patches\n> In this case something like:\n> \n> Fix wrong spelling of \"impelementation\" in the pipeline handler\n> development guide.\n> \n> libcamera provides git hooks in utils/hooks that help you catch these\n> errors early. You can install them by copying them in your\n> .git/hooks/ directory.\n\nNote that there are both pre-commit and post-commit hooks, only one of\nthem is necessary. I recommend the post-commit hook, as it catches\nissues in the git commit message that the pre-commit hook doesn't catch.\n\n> > ---\n> > Documentation/guides/pipeline-handler.rst | 2 +-\n> > 1 file changed, 1 insertion(+), 1 deletion(-)\n> >\n> > diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\n> > index e1930fdf..4d38fa23 100644\n> > --- a/Documentation/guides/pipeline-handler.rst\n> > +++ b/Documentation/guides/pipeline-handler.rst\n> > @@ -1409,7 +1409,7 @@ function to the V4L2 device buffer signal.\n> > video_->bufferReady.connect(this, &VividCameraData::bufferReady);\n> >\n> > Create the matching ``VividCameraData::bufferReady`` function after your\n> > -VividCameradata::init() impelementation.\n> > +VividCameradata::init() implementation.\n> \n> The patch itself looks correct.\n> \n> >\n> > The ``bufferReady`` function obtains the request from the buffer using the\n> > ``request`` function, and notifies the ``Camera`` that the buffer and","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 32DF3BE08A\n\tfor ;\n\tSun, 26 Feb 2023 15:27:43 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 85D0D62672;\n\tSun, 26 Feb 2023 16:27:42 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 1CBCD6263C\n\tfor ;\n\tSun, 26 Feb 2023 16:27:41 +0100 (CET)","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 6EF796DB;\n\tSun, 26 Feb 2023 16:27:40 +0100 (CET)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1677425262;\n\tbh=l6qf2UMTn8VpInt/t9wTjldoC62ZTU9jI0aABnd754c=;\n\th=Date:To:References:In-Reply-To:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc:\n\tFrom;\n\tb=iN5SvG7E9TXEnuYM8UYxJTa/HxMvCBO0lo6vQ2dwS3qmDY5a/R+MVV25P5WKHbseh\n\tNoWJBtl2J0o5ibfS63k6Lx0UdOoKpk7HaoaH1DBckQp7W9CIgyDdxipENv6fsL0i4E\n\tQKD3XZe2YOTHuKsl2neFuF7ThfrqpeY5p6FFFdY8cx4wJEL4BROIYEviFKAWbbl9pY\n\tdhAc20SaGZdADL0tIe+rLDRa73MqpUV7LkYQv+m86g5TLSmlS1mGyXTR+Frzqrc/L3\n\tw9V/vVj080r2gFL0h4c28RsjuBQ6GJievOGRkYfe1k+iuuIlm3gzyqLXNjkPcGe3DY\n\tB+0W1tHVnawcw==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1677425260;\n\tbh=l6qf2UMTn8VpInt/t9wTjldoC62ZTU9jI0aABnd754c=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=BXiw1qqggF94MudmdNHd8ZUVf3pQtJYbjveK0SEau0wCWx5ts6bszwfaZuu3S23KV\n\tJP88koyhPdmdfiBkwRrgxP3PZIsZOvTz4ZNGs5ShafNSD4ekFeb2sKyKsLD6aF8YsJ\n\tVfw8twbKuvUz4nYrCckzyiJL0Gk7yQHoByagnVxI="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"BXiw1qqg\"; dkim-atps=neutral","Date":"Sun, 26 Feb 2023 17:27:40 +0200","To":"Jacopo Mondi ","Message-ID":"","References":"<20230225134045.5350-1-advaitdhamorikar@gmail.com>\n\t<20230226131724.egwsqzsrz4lncad4@uno.localdomain>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20230226131724.egwsqzsrz4lncad4@uno.localdomain>","Subject":"Re: [libcamera-devel] [PATCH v2] Implementation was spelled\n\tincorrectly in the pipeline-handler documentation","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","From":"Laurent Pinchart via libcamera-devel\n\t","Reply-To":"Laurent Pinchart ","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]