{"id":11990,"url":"https://patchwork.libcamera.org/api/patches/11990/?format=json","web_url":"https://patchwork.libcamera.org/patch/11990/","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":"<20210419131433.22920-9-jacopo@jmondi.org>","date":"2021-04-19T13:14:28","name":"[libcamera-devel,08/13] libcamera: buffer: Re-work setRequest() documentation","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"61f58d368a0e0bea61fc2bc738d648e40a71be28","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/11990/mbox/","series":[{"id":1948,"url":"https://patchwork.libcamera.org/api/series/1948/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=1948","date":"2021-04-19T13:14:20","name":"Support SensorTimestamp metadata","version":1,"mbox":"https://patchwork.libcamera.org/series/1948/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/11990/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/11990/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 0C721BD814\n\tfor ;\n\tMon, 19 Apr 2021 13:14:29 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B11B468831;\n\tMon, 19 Apr 2021 15:14:28 +0200 (CEST)","from relay11.mail.gandi.net (relay11.mail.gandi.net\n\t[217.70.178.231])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4932D6883F\n\tfor ;\n\tMon, 19 Apr 2021 15:14:22 +0200 (CEST)","from uno.lan (93-34-118-233.ip49.fastwebnet.it [93.34.118.233])\n\t(Authenticated sender: jacopo@jmondi.org)\n\tby relay11.mail.gandi.net (Postfix) with ESMTPSA id DFFA910001E;\n\tMon, 19 Apr 2021 13:14:21 +0000 (UTC)"],"From":"Jacopo Mondi ","To":"libcamera-devel@lists.libcamera.org","Date":"Mon, 19 Apr 2021 15:14:28 +0200","Message-Id":"<20210419131433.22920-9-jacopo@jmondi.org>","X-Mailer":"git-send-email 2.31.1","In-Reply-To":"<20210419131433.22920-1-jacopo@jmondi.org>","References":"<20210419131433.22920-1-jacopo@jmondi.org>","MIME-Version":"1.0","Subject":"[libcamera-devel] [PATCH 08/13] libcamera: buffer: Re-work\n\tsetRequest() 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","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"I got fooled by the documentation of setRequest() implying that the\nfunction is meant to be called by pipeline handlers only, which it is\nused in the Request class at Request::addBuffer() and Request::reuse()\ntime.\n\nExpand the documentation to report that.\n\nSigned-off-by: Jacopo Mondi \n---\n src/libcamera/buffer.cpp | 11 +++++++++--\n 1 file changed, 9 insertions(+), 2 deletions(-)","diff":"diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp\nindex 75b2693281a7..d8036ebec63e 100644\n--- a/src/libcamera/buffer.cpp\n+++ b/src/libcamera/buffer.cpp\n@@ -191,8 +191,15 @@ FrameBuffer::FrameBuffer(const std::vector &planes, unsigned int cookie)\n * \\brief Set the request this buffer belongs to\n * \\param[in] request Request to set\n *\n- * The intended callers of this method are pipeline handlers and only for\n- * buffers that are internal to the pipeline.\n+ * This method is also used to associate a buffer with the Request it belongs\n+ * to, so that it can be retrieved through FrameBuffer::request().\n+ *\n+ * This method is used by Request::addBuffer(), when an application facing\n+ * buffer is first added to the Request, and when the Request is reused with\n+ * Request::reuse().\n+ *\n+ * For buffers that are internal to the pipeline the intended callers of this\n+ * method are pipeline handlers.\n *\n * \\todo Shall be hidden from applications with a d-pointer design.\n */\n","prefixes":["libcamera-devel","08/13"]}