[{"id":26545,"web_url":"https://patchwork.libcamera.org/comment/26545/","msgid":"<167784358114.93391.888417910899744923@Monstersaurus>","date":"2023-03-03T11:39:41","subject":"Re: [libcamera-devel] [PATCH v3] documentation: guides:\n\tpipeline-handler: Fix spelling error","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hello Advait,\n\nThanks for contibuting to libcamera. Even these little patches help fix\nour documentation, and help to learn the processes!\n\nQuoting Advait Dhamorikar via libcamera-devel (2023-03-02 19:48:14)\n> Please fix spelling of \"impelementation\" in the pipeline handler development guide.\n> \n\nThe change log should state what the patch does. Not be a request.\n\nPlease do read : https://cbea.ms/git-commit/ in full. It's a great\nguide.\n\nYour $SUBJECT line is perfect, for the message itself, try to explain\nthe issue, and then what or /why/ this commit does to fix it. Of course\nit's not always appropriate so it seems overkill on a single spelling\npatch - but it's a helpful to get into the flow and practise this for\nthe bigger patches too on a simple patch like this.\n\nIn this instance, something like:\n\n\"\"\"\nThe pipeline handler writers guide incorrectly references the\nVividCameradata::init() impelementation with a spelling error.\n\nFix it by correcting the typo.\n\"\"\"\n\n> ---\n\nNow you've got this bit right. The '---' lets you add free-form comments\nand discussion to the patch, which can include a message as you have\nbelow:\n\n> This is my first time using git send-email, thanks for the help with your replies,\n> The communications and logistics documentation was quite useful for me. I'm interested in the the GSoC project that integrates libcamera into applications and am currently studying how I can interface it with libcamera.\n> Do let me know if i've sent the patch correctly and also if you've any advice regarding the interfacing, that would be great too!\n> \n> Signed-off-by: Advait Dhamorikar \n\nHowever, it's important that the Signed-off-by: tag goes 'above' the\nfirst occurrance of '---'\n\n> ---\n\nAnd there shouldn't be a second '---'.\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\nFor the fix:\n\n\nReviewed-by: Kieran Bingham \n\nPlease add this above your Signed-off-by: tag for a followup version.\n\n--\nKieran\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 E2805BE080\n\tfor ;\n\tFri, 3 Mar 2023 11:39:46 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 29EEE626AC;\n\tFri, 3 Mar 2023 12:39:46 +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 7E7D162660\n\tfor ;\n\tFri, 3 Mar 2023 12:39:44 +0100 (CET)","from pendragon.ideasonboard.com\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 ED8AB735;\n\tFri, 3 Mar 2023 12:39:43 +0100 (CET)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1677843586;\n\tbh=NBhmZL2bMCp8l8U7xqxf5oSpLc39tD9jDCPXI29nNKE=;\n\th=In-Reply-To:References:To:Date:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=ic28S3YVMN4LBYiyoP9gd/kabunU8wMHYuQ8rVE+LEgQ8Io/hnqQzGmhw6r4OceGT\n\tyupGFqE0jS/paJc8fV4i0RJdhXy3X+ZYU3VOBhEfAm48S5xUwLd92JwVZa0VgUyGrL\n\tOuhExOrGdyzXTtJbzjnadSQY0WVFbd5tJv5NdA5jq20JIEd5GAvKCrqptvI3fHQlpy\n\tvrFd6QIh263xoUG4osCHlSwwpqpPZv3eYT0uOPCfwA6m3dsWVISI7TdlNyEYQbWk3c\n\t5Kt+2FRDFGi8WUTD5p/W+zYA2q+l9783Hcf7RsnKo6vtJUm9zURGFeSLnqbLmeeueq\n\tb1UBLfKWNutBQ==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1677843584;\n\tbh=NBhmZL2bMCp8l8U7xqxf5oSpLc39tD9jDCPXI29nNKE=;\n\th=In-Reply-To:References:Subject:From:To:Date:From;\n\tb=Uqg3dpvYm5gjRujYJ83KfgTBj6kM/+wxy5neRCmDCCyzc/Kd4Djs7KkZ/5wk8Hxif\n\t0UgtGehFAOpZU57Xt+IHLPViLB8P5ubEbKrZLeX3UrefVl6EaSumIdsIIB4D2wDs1o\n\tL0rjfXPB7VFuBBQwzzqDbKZW8wUTp6iGNVZAS9QI="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"Uqg3dpvY\"; dkim-atps=neutral","Content-Type":"text/plain; charset=\"utf-8\"","MIME-Version":"1.0","Content-Transfer-Encoding":"quoted-printable","In-Reply-To":"<20230302194814.6152-1-advaitdhamorikar@gmail.com>","References":"<20230302194814.6152-1-advaitdhamorikar@gmail.com>","To":"Advait Dhamorikar ,\n\tlibcamera-devel@lists.libcamera.org","Date":"Fri, 03 Mar 2023 11:39:41 +0000","Message-ID":"<167784358114.93391.888417910899744923@Monstersaurus>","User-Agent":"alot/0.10","Subject":"Re: [libcamera-devel] [PATCH v3] documentation: guides:\n\tpipeline-handler: Fix spelling error","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":"Kieran Bingham via libcamera-devel\n\t","Reply-To":"Kieran Bingham ","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]