{"id":13491,"url":"https://patchwork.libcamera.org/api/patches/13491/?format=json","web_url":"https://patchwork.libcamera.org/patch/13491/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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":"<20210825161303.48955-2-jacopo@jmondi.org>","date":"2021-08-25T16:13:02","name":"[libcamera-devel,1/2] libcamera: camera configuration: Remove operator[] from doc","commit_ref":null,"pull_url":null,"state":"rfc","archived":false,"hash":"6ba43d6c887719f389d035f807a33769a975cda3","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/?format=json","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"delegate":{"id":15,"url":"https://patchwork.libcamera.org/api/users/15/?format=json","username":"jmondi","first_name":"Jacopo","last_name":"Mondi","email":"jacopo@jmondi.org"},"mbox":"https://patchwork.libcamera.org/patch/13491/mbox/","series":[{"id":2394,"url":"https://patchwork.libcamera.org/api/series/2394/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=2394","date":"2021-08-25T16:13:01","name":"lc-compliance: Test resoltions","version":1,"mbox":"https://patchwork.libcamera.org/series/2394/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/13491/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/13491/checks/","tags":{},"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 706BBBD87D\n\tfor ;\n\tWed, 25 Aug 2021 16:12:23 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 49227688C4;\n\tWed, 25 Aug 2021 18:12:23 +0200 (CEST)","from relay1-d.mail.gandi.net (relay1-d.mail.gandi.net\n\t[217.70.183.193])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 19B7F68893\n\tfor ;\n\tWed, 25 Aug 2021 18:12:21 +0200 (CEST)","(Authenticated sender: jacopo@jmondi.org)\n\tby relay1-d.mail.gandi.net (Postfix) with ESMTPSA id 82C84240007;\n\tWed, 25 Aug 2021 16:12:20 +0000 (UTC)"],"From":"Jacopo Mondi ","To":"libcamera-devel@lists.libcamera.org","Date":"Wed, 25 Aug 2021 18:13:02 +0200","Message-Id":"<20210825161303.48955-2-jacopo@jmondi.org>","X-Mailer":"git-send-email 2.32.0","In-Reply-To":"<20210825161303.48955-1-jacopo@jmondi.org>","References":"<20210825161303.48955-1-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH 1/2] libcamera: camera configuration:\n\tRemove operator[] from doc","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\" "},"content":"The documentation suggests to use CameraConfiguration::operator[] to\naccess the StreamConfiguration it contains, but as CameraConfiguration\ninstances are generated by the Camera class and are returned wrapped in\na unique_ptr<>. The usage of operator[] would require an awkward syntax such\nas (*config)[i].\n\nBetter to suggest the usage of the CameraConfiguration::at() function\ninstead to access the StreamConfigurations.\n\nSigned-off-by: Jacopo Mondi \n---\n src/libcamera/camera.cpp | 6 +++---\n 1 file changed, 3 insertions(+), 3 deletions(-)","diff":"diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp\nindex c20e05014fb9..c4d576b3985b 100644\n--- a/src/libcamera/camera.cpp\n+++ b/src/libcamera/camera.cpp\n@@ -114,9 +114,9 @@ LOG_DECLARE_CATEGORY(Camera)\n * The CameraConfiguration holds an ordered list of stream configurations. It\n * supports iterators and operates as a vector of StreamConfiguration instances.\n * The stream configurations are inserted by addConfiguration(), and the\n- * operator[](int) returns a reference to the StreamConfiguration based on its\n- * insertion index. Accessing a stream configuration with an invalid index\n- * results in undefined behaviour.\n+ * at(unsigned int) function returns a reference to the StreamConfiguration\n+ * based on its insertion index. Accessing a stream configuration with an\n+ * invalid index results in undefined behaviour.\n *\n * CameraConfiguration instances are retrieved from the camera with\n * Camera::generateConfiguration(). Applications may then inspect the\n","prefixes":["libcamera-devel","1/2"]}