{"id":12181,"url":"https://patchwork.libcamera.org/api/1.1/patches/12181/?format=json","web_url":"https://patchwork.libcamera.org/patch/12181/","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":"<20210503104152.34048-13-jacopo@jmondi.org>","date":"2021-05-03T10:41:47","name":"[libcamera-devel,v5,12/17] libcamera: buffer: Re-work setRequest() documentation","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"e89ef39a9963e39e0a9559bee960fd6865546e82","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/1.1/people/3/?format=json","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/12181/mbox/","series":[{"id":1994,"url":"https://patchwork.libcamera.org/api/1.1/series/1994/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=1994","date":"2021-05-03T10:41:35","name":"Support SensorTimestamp metadata","version":5,"mbox":"https://patchwork.libcamera.org/series/1994/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/12181/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/12181/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 3DC12BDE79\n\tfor ;\n\tMon, 3 May 2021 10:41:22 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 0443368921;\n\tMon, 3 May 2021 12:41:22 +0200 (CEST)","from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net\n\t[217.70.183.199])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4738668923\n\tfor ;\n\tMon, 3 May 2021 12:41:16 +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 relay9-d.mail.gandi.net (Postfix) with ESMTPSA id 15727FF805\n\tfor ;\n\tMon, 3 May 2021 10:41:15 +0000 (UTC)"],"X-Originating-IP":"93.34.118.233","From":"Jacopo Mondi ","To":"libcamera-devel@lists.libcamera.org","Date":"Mon, 3 May 2021 12:41:47 +0200","Message-Id":"<20210503104152.34048-13-jacopo@jmondi.org>","X-Mailer":"git-send-email 2.31.1","In-Reply-To":"<20210503104152.34048-1-jacopo@jmondi.org>","References":"<20210503104152.34048-1-jacopo@jmondi.org>","MIME-Version":"1.0","Subject":"[libcamera-devel] [PATCH v5 12/17] 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=\"utf-8\"","Content-Transfer-Encoding":"base64","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\nRework the documentation to report that.\n\nReviewed-by: Niklas Söderlund \nReviewed-by: Laurent Pinchart \nSigned-off-by: Jacopo Mondi \n---\n src/libcamera/buffer.cpp | 5 +++--\n 1 file changed, 3 insertions(+), 2 deletions(-)","diff":"diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp\nindex 7635226b9045..ca999429dce5 100644\n--- a/src/libcamera/buffer.cpp\n+++ b/src/libcamera/buffer.cpp\n@@ -191,8 +191,9 @@ 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+ * For buffers added to requests by applications, this method is called by\n+ * Request::addBuffer() or Request::reuse(). For buffers internal to pipeline\n+ * handlers, it is called by the pipeline handlers themselves.\n *\n * \\todo Shall be hidden from applications with a d-pointer design.\n */\n","prefixes":["libcamera-devel","v5","12/17"]}