[{"id":16145,"web_url":"https://patchwork.libcamera.org/comment/16145/","msgid":"","date":"2021-04-07T14:32:25","subject":"Re: [libcamera-devel] [PATCH] libcamera: camera_data: Document\n\trequestSequence_","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Jacopo,\n\nThank you for the patch.\n\nOn Wed, Apr 07, 2021 at 04:10:41PM +0200, Jacopo Mondi wrote:\n> The CameraData::requestSequence_ field was not documented. Fix it.\n\nThe only thing worse than pushing to production on a Friday is pushing\nto production just before a week of holiday :-) Kieran said he would fix\nthis (and the other doxygen warnings introduced at the same time) when\ncoming back.\n\n> Also remove an empty line the class declaration as the field is not\n> special compared to the other existing ones.\n> \n> Fixes the doxygen warning\n> /include/libcamera/internal/pipeline_handler.h:51: warning: Member\n> requestSequence_ (variable) of class libcamera::CameraData is not\n> documented.\n> \n\nA Fixes: line could be nice.\n\n> Signed-off-by: Jacopo Mondi \n> \n> ---\n> Isn't it a bit fishy that the counter is never reset ?\n\nIt's on purpose, to uniquely identify requests across stop()/start()\nsequences.\n\n> ---\n> include/libcamera/internal/pipeline_handler.h | 1 -\n> src/libcamera/pipeline_handler.cpp | 8 ++++++++\n> 2 files changed, 8 insertions(+), 1 deletion(-)\n> \n> diff --git a/include/libcamera/internal/pipeline_handler.h b/include/libcamera/internal/pipeline_handler.h\n> index c6454db6b2c4..82fdc1fee9b9 100644\n> --- a/include/libcamera/internal/pipeline_handler.h\n> +++ b/include/libcamera/internal/pipeline_handler.h\n> @@ -47,7 +47,6 @@ public:\n> \tstd::list queuedRequests_;\n> \tControlInfoMap controlInfo_;\n> \tControlList properties_;\n> -\n> \tuint32_t requestSequence_;\n> \n> private:\n> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> index 433c05f60db0..7f4fa1b4ba89 100644\n> --- a/src/libcamera/pipeline_handler.cpp\n> +++ b/src/libcamera/pipeline_handler.cpp\n> @@ -97,6 +97,14 @@ LOG_DEFINE_CATEGORY(Pipeline)\n> * when creating the camera, and shall not be modified afterwards.\n> */\n> \n> +/**\n> + * \\var CameraData::requestSequence_\n> + * \\brief The request sequence counter\n> + *\n> + * The request sequence counter is increased when a new Request is queued to\n> + * the camera and monotonically increases during the whole library lifetime.\n\nIt's actually the lifetime of the camera.\n\nIt would be good to also document the purpose of this field.\n\n> + */\n> +\n> /**\n> * \\class PipelineHandler\n> * \\brief Create and manage cameras based on a set of media devices","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 8DBA6BD1F6\n\tfor ;\n\tWed, 7 Apr 2021 14:33:14 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 0C763687A2;\n\tWed, 7 Apr 2021 16:33:14 +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 5D90A687A1\n\tfor ;\n\tWed, 7 Apr 2021 16:33:12 +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 C0EC9580;\n\tWed, 7 Apr 2021 16:33:11 +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=\"sV/WSJrN\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1617805992;\n\tbh=rfjyXKOVCh7p+G/g+9f4dSxE/jVAeLVWWn4odCtKcDU=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=sV/WSJrNHXAGpde0+580iNKmLDIZgoAUnLL0rFRNSUph2c5PRFnDxNf2zV2SiaRtk\n\t/FYhYG5J8zMYnOA3J/PBL4TSSFLEKtKwwk7G/pbwk3l/ott01yasUXZ3oCtnUBxZ2s\n\t736hXL890VSO2siG2nLoUR8syom9sF5Se5AwX8Us=","Date":"Wed, 7 Apr 2021 17:32:25 +0300","From":"Laurent Pinchart ","To":"Jacopo Mondi ","Message-ID":"","References":"<20210407141041.31087-1-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20210407141041.31087-1-jacopo@jmondi.org>","Subject":"Re: [libcamera-devel] [PATCH] libcamera: camera_data: Document\n\trequestSequence_","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","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":16146,"web_url":"https://patchwork.libcamera.org/comment/16146/","msgid":"<20210407144230.lxgb5oyzcekifn5o@uno.localdomain>","date":"2021-04-07T14:42:30","subject":"Re: [libcamera-devel] [PATCH] libcamera: camera_data: Document\n\trequestSequence_","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Laurent\n\nOn Wed, Apr 07, 2021 at 05:32:25PM +0300, Laurent Pinchart wrote:\n\n> Hi Jacopo,\n>\n> Thank you for the patch.\n>\n> On Wed, Apr 07, 2021 at 04:10:41PM +0200, Jacopo Mondi wrote:\n> > The CameraData::requestSequence_ field was not documented. Fix it.\n>\n> The only thing worse than pushing to production on a Friday is pushing\n> to production just before a week of holiday :-) Kieran said he would fix\n> this (and the other doxygen warnings introduced at the same time) when\n> coming back.\n>\n> > Also remove an empty line the class declaration as the field is not\n> > special compared to the other existing ones.\n> >\n> > Fixes the doxygen warning\n> > /include/libcamera/internal/pipeline_handler.h:51: warning: Member\n> > requestSequence_ (variable) of class libcamera::CameraData is not\n> > documented.\n> >\n>\n> A Fixes: line could be nice.\n>\n> > Signed-off-by: Jacopo Mondi \n> >\n> > ---\n> > Isn't it a bit fishy that the counter is never reset ?\n>\n> It's on purpose, to uniquely identify requests across stop()/start()\n> sequences.\n>\n> > ---\n> > include/libcamera/internal/pipeline_handler.h | 1 -\n> > src/libcamera/pipeline_handler.cpp | 8 ++++++++\n> > 2 files changed, 8 insertions(+), 1 deletion(-)\n> >\n> > diff --git a/include/libcamera/internal/pipeline_handler.h b/include/libcamera/internal/pipeline_handler.h\n> > index c6454db6b2c4..82fdc1fee9b9 100644\n> > --- a/include/libcamera/internal/pipeline_handler.h\n> > +++ b/include/libcamera/internal/pipeline_handler.h\n> > @@ -47,7 +47,6 @@ public:\n> > \tstd::list queuedRequests_;\n> > \tControlInfoMap controlInfo_;\n> > \tControlList properties_;\n> > -\n> > \tuint32_t requestSequence_;\n> >\n> > private:\n> > diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> > index 433c05f60db0..7f4fa1b4ba89 100644\n> > --- a/src/libcamera/pipeline_handler.cpp\n> > +++ b/src/libcamera/pipeline_handler.cpp\n> > @@ -97,6 +97,14 @@ LOG_DEFINE_CATEGORY(Pipeline)\n> > * when creating the camera, and shall not be modified afterwards.\n> > */\n> >\n> > +/**\n> > + * \\var CameraData::requestSequence_\n> > + * \\brief The request sequence counter\n> > + *\n> > + * The request sequence counter is increased when a new Request is queued to\n> > + * the camera and monotonically increases during the whole library lifetime.\n>\n> It's actually the lifetime of the camera.\n>\n> It would be good to also document the purpose of this field.\n>\n\nI'm not 100% sure what does it serve to. Happy to have Kieran continue\non this if he's meant to fix the other warnings he introduced.\n\nThanks\n j\n\n> > + */\n> > +\n> > /**\n> > * \\class PipelineHandler\n> > * \\brief Create and manage cameras based on a set of media devices\n>\n> --\n> Regards,\n>\n> Laurent Pinchart","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 495DFBD224\n\tfor ;\n\tWed, 7 Apr 2021 14:41:56 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B3756687DB;\n\tWed, 7 Apr 2021 16:41:55 +0200 (CEST)","from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net\n\t[217.70.183.197])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id A978E687A1\n\tfor ;\n\tWed, 7 Apr 2021 16:41:53 +0200 (CEST)","from uno.localdomain (93-34-118-233.ip49.fastwebnet.it\n\t[93.34.118.233]) (Authenticated sender: jacopo@jmondi.org)\n\tby relay5-d.mail.gandi.net (Postfix) with ESMTPSA id 3E5561C0015;\n\tWed, 7 Apr 2021 14:41:52 +0000 (UTC)"],"X-Originating-IP":"93.34.118.233","Date":"Wed, 7 Apr 2021 16:42:30 +0200","From":"Jacopo Mondi ","To":"Laurent Pinchart ","Message-ID":"<20210407144230.lxgb5oyzcekifn5o@uno.localdomain>","References":"<20210407141041.31087-1-jacopo@jmondi.org>\n\t","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"","Subject":"Re: [libcamera-devel] [PATCH] libcamera: camera_data: Document\n\trequestSequence_","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","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":16147,"web_url":"https://patchwork.libcamera.org/comment/16147/","msgid":"","date":"2021-04-07T14:49:01","subject":"Re: [libcamera-devel] [PATCH] libcamera: camera_data: Document\n\trequestSequence_","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Jacopo,\n\nOn Wed, Apr 07, 2021 at 04:42:30PM +0200, Jacopo Mondi wrote:\n> On Wed, Apr 07, 2021 at 05:32:25PM +0300, Laurent Pinchart wrote:\n> > On Wed, Apr 07, 2021 at 04:10:41PM +0200, Jacopo Mondi wrote:\n> > > The CameraData::requestSequence_ field was not documented. Fix it.\n> >\n> > The only thing worse than pushing to production on a Friday is pushing\n> > to production just before a week of holiday :-) Kieran said he would fix\n> > this (and the other doxygen warnings introduced at the same time) when\n> > coming back.\n> >\n> > > Also remove an empty line the class declaration as the field is not\n> > > special compared to the other existing ones.\n> > >\n> > > Fixes the doxygen warning\n> > > /include/libcamera/internal/pipeline_handler.h:51: warning: Member\n> > > requestSequence_ (variable) of class libcamera::CameraData is not\n> > > documented.\n> > >\n> >\n> > A Fixes: line could be nice.\n> >\n> > > Signed-off-by: Jacopo Mondi \n> > >\n> > > ---\n> > > Isn't it a bit fishy that the counter is never reset ?\n> >\n> > It's on purpose, to uniquely identify requests across stop()/start()\n> > sequences.\n> >\n> > > ---\n> > > include/libcamera/internal/pipeline_handler.h | 1 -\n> > > src/libcamera/pipeline_handler.cpp | 8 ++++++++\n> > > 2 files changed, 8 insertions(+), 1 deletion(-)\n> > >\n> > > diff --git a/include/libcamera/internal/pipeline_handler.h b/include/libcamera/internal/pipeline_handler.h\n> > > index c6454db6b2c4..82fdc1fee9b9 100644\n> > > --- a/include/libcamera/internal/pipeline_handler.h\n> > > +++ b/include/libcamera/internal/pipeline_handler.h\n> > > @@ -47,7 +47,6 @@ public:\n> > > \tstd::list queuedRequests_;\n> > > \tControlInfoMap controlInfo_;\n> > > \tControlList properties_;\n> > > -\n> > > \tuint32_t requestSequence_;\n> > >\n> > > private:\n> > > diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\n> > > index 433c05f60db0..7f4fa1b4ba89 100644\n> > > --- a/src/libcamera/pipeline_handler.cpp\n> > > +++ b/src/libcamera/pipeline_handler.cpp\n> > > @@ -97,6 +97,14 @@ LOG_DEFINE_CATEGORY(Pipeline)\n> > > * when creating the camera, and shall not be modified afterwards.\n> > > */\n> > >\n> > > +/**\n> > > + * \\var CameraData::requestSequence_\n> > > + * \\brief The request sequence counter\n> > > + *\n> > > + * The request sequence counter is increased when a new Request is queued to\n> > > + * the camera and monotonically increases during the whole library lifetime.\n> >\n> > It's actually the lifetime of the camera.\n> >\n> > It would be good to also document the purpose of this field.\n> \n> I'm not 100% sure what does it serve to. Happy to have Kieran continue\n> on this if he's meant to fix the other warnings he introduced.\n\nHopefully he will know the purpose of the field he introduced :-)\nKieran, how about picking this patch up, and posting a v2 with the\ndocumentation expanded to explain what the purpose of the field is ?\n\n> > > + */\n> > > +\n> > > /**\n> > > * \\class PipelineHandler\n> > > * \\brief Create and manage cameras based on a set of media devices","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 4F604BD1F6\n\tfor ;\n\tWed, 7 Apr 2021 14:49:48 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B6EC0687DB;\n\tWed, 7 Apr 2021 16:49:47 +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 A2763687A1\n\tfor ;\n\tWed, 7 Apr 2021 16:49:46 +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 2443088F;\n\tWed, 7 Apr 2021 16:49:46 +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=\"Sr8KQ5YP\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1617806986;\n\tbh=dSzLPQfnFJXTOjTxE+IPFC8FKBgipOQm/6Tdd8NvWm8=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=Sr8KQ5YPcAlXyKkhLykqE3bo2N66JGAiSTQNYFxoLDcZOPcboL8UPsriELgi/UvWI\n\tTDcpm52zVWFVcSO60GH8eeBZMn0J8G0K4BtfFePjFLSto4cVnWczRpSIhTEXYyj8su\n\t+nv2V7JEF/eOMfqR5IaY37aHYgLwu1nHGLYrkyPU=","Date":"Wed, 7 Apr 2021 17:49:01 +0300","From":"Laurent Pinchart ","To":"Jacopo Mondi ","Message-ID":"","References":"<20210407141041.31087-1-jacopo@jmondi.org>\n\t\n\t<20210407144230.lxgb5oyzcekifn5o@uno.localdomain>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<20210407144230.lxgb5oyzcekifn5o@uno.localdomain>","Subject":"Re: [libcamera-devel] [PATCH] libcamera: camera_data: Document\n\trequestSequence_","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","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]