{"id":11624,"url":"https://patchwork.libcamera.org/api/1.1/patches/11624/?format=json","web_url":"https://patchwork.libcamera.org/patch/11624/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20210318141124.12014-1-m.cichy@pengutronix.de>","date":"2021-03-18T14:11:24","name":"[libcamera-devel] libcamera: request: Fix documentation of controls() method","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"53fe798d5679d19becbc947b7f90d1263e51a9b3","submitter":{"id":80,"url":"https://patchwork.libcamera.org/api/1.1/people/80/?format=json","name":"Marian Cichy","email":"m.cichy@pengutronix.de"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/11624/mbox/","series":[{"id":1803,"url":"https://patchwork.libcamera.org/api/1.1/series/1803/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=1803","date":"2021-03-18T14:11:24","name":"[libcamera-devel] libcamera: request: Fix documentation of controls() method","version":1,"mbox":"https://patchwork.libcamera.org/series/1803/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/11624/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/11624/checks/","tags":{},"headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 2C9D1C32E1\n\tfor <parsemail@patchwork.libcamera.org>;\n\tThu, 18 Mar 2021 14:11:42 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id AA46F602E3;\n\tThu, 18 Mar 2021 15:11:41 +0100 (CET)","from metis.ext.pengutronix.de (metis.ext.pengutronix.de\n\t[IPv6:2001:67c:670:201:290:27ff:fe1d:cc33])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4B982602DB\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu, 18 Mar 2021 15:11:40 +0100 (CET)","from dude02.hi.pengutronix.de ([2001:67c:670:100:1d::28])\n\tby metis.ext.pengutronix.de with esmtps\n\t(TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92)\n\t(envelope-from <mci@pengutronix.de>)\n\tid 1lMtND-0001t4-M2; Thu, 18 Mar 2021 15:11:39 +0100","from mci by dude02.hi.pengutronix.de with local (Exim 4.92)\n\t(envelope-from <mci@pengutronix.de>)\n\tid 1lMtND-000394-Dd; Thu, 18 Mar 2021 15:11:39 +0100"],"From":"Marian Cichy <m.cichy@pengutronix.de>","To":"libcamera-devel@lists.libcamera.org","Date":"Thu, 18 Mar 2021 15:11:24 +0100","Message-Id":"<20210318141124.12014-1-m.cichy@pengutronix.de>","X-Mailer":"git-send-email 2.29.2","MIME-Version":"1.0","X-SA-Exim-Connect-IP":"2001:67c:670:100:1d::28","X-SA-Exim-Mail-From":"mci@pengutronix.de","X-SA-Exim-Scanned":"No (on metis.ext.pengutronix.de);\n\tSAEximRunCond expanded to false","X-PTX-Original-Recipient":"libcamera-devel@lists.libcamera.org","Subject":"[libcamera-devel] [PATCH] libcamera: request: Fix documentation of\n\tcontrols() method","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Cc":"graphics@pengutronix.de, Marian Cichy <m.cichy@pengutronix.de>","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"The documentation of the controls() method refers to the methods\nControlList::operator[]() and ControlList::update(), which do not exist.\n\nInstead refer to ControlList::get() and ControlList::set() to achieve a\nsimilar documentation.\n\nSigned-off-by: Marian Cichy <m.cichy@pengutronix.de>\n---\n src/libcamera/request.cpp | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)","diff":"diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp\nindex 24c3694d..fe521ae2 100644\n--- a/src/libcamera/request.cpp\n+++ b/src/libcamera/request.cpp\n@@ -138,8 +138,8 @@ void Request::reuse(ReuseFlag flags)\n  *\n  * Requests store a list of controls to be applied to all frames captured for\n  * the request. They are created with an empty list of controls that can be\n- * accessed through this method and updated with ControlList::operator[]() or\n- * ControlList::update().\n+ * accessed through this method. Control values can be retrieved using\n+ * Control::get() and updated using Control::set().\n  *\n  * Only controls supported by the camera to which this request will be\n  * submitted shall be included in the controls list. Attempting to add an\n","prefixes":["libcamera-devel"]}