{"id":12044,"url":"https://patchwork.libcamera.org/api/1.1/patches/12044/?format=json","web_url":"https://patchwork.libcamera.org/patch/12044/","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":"<20210421160319.42251-12-jacopo@jmondi.org>","date":"2021-04-21T16:03:14","name":"[libcamera-devel,v3,11/16] 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":{"id":15,"url":"https://patchwork.libcamera.org/api/1.1/users/15/?format=json","username":"jmondi","first_name":"Jacopo","last_name":"Mondi","email":"jacopo@jmondi.org"},"mbox":"https://patchwork.libcamera.org/patch/12044/mbox/","series":[{"id":1957,"url":"https://patchwork.libcamera.org/api/1.1/series/1957/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=1957","date":"2021-04-21T16:03:03","name":"Support SensorTimestamp metadata","version":3,"mbox":"https://patchwork.libcamera.org/series/1957/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/12044/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/12044/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 79C42BDB17\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 21 Apr 2021 16:03:00 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 44B4A6886B;\n\tWed, 21 Apr 2021 18:03:00 +0200 (CEST)","from relay10.mail.gandi.net (relay10.mail.gandi.net\n\t[217.70.178.230])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B321668840\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 21 Apr 2021 18:02:50 +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 relay10.mail.gandi.net (Postfix) with ESMTPSA id 2A76B240003;\n\tWed, 21 Apr 2021 16:02:49 +0000 (UTC)"],"From":"Jacopo Mondi <jacopo@jmondi.org>","To":"libcamera-devel@lists.libcamera.org","Date":"Wed, 21 Apr 2021 18:03:14 +0200","Message-Id":"<20210421160319.42251-12-jacopo@jmondi.org>","X-Mailer":"git-send-email 2.31.1","In-Reply-To":"<20210421160319.42251-1-jacopo@jmondi.org>","References":"<20210421160319.42251-1-jacopo@jmondi.org>","MIME-Version":"1.0","Subject":"[libcamera-devel] [PATCH v3 11/16] libcamera: buffer: Re-work\n\tsetRequest() documentation","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>","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":"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\nFixes: 125be3436ae0 (\"libcamera: FrameBuffer: Add a setRequest() interface\")\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\nSigned-off-by: Jacopo Mondi <jacopo@jmondi.org>\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 75b2693281a7..5baccfa99f10 100644\n--- a/src/libcamera/buffer.cpp\n+++ b/src/libcamera/buffer.cpp\n@@ -191,8 +191,9 @@ FrameBuffer::FrameBuffer(const std::vector<Plane> &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","v3","11/16"]}