{"id":19094,"url":"https://patchwork.libcamera.org/api/patches/19094/?format=json","web_url":"https://patchwork.libcamera.org/patch/19094/","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":"<20230928185537.20178-2-andrey.konovalov@linaro.org>","date":"2023-09-28T18:55:33","name":"[libcamera-devel,v3,1/5] libcamera: converter: a few fixes to ConverterFactoryBase documentation","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"6f69d85a8752f359c38bbc711855ae10744ab178","submitter":{"id":25,"url":"https://patchwork.libcamera.org/api/people/25/?format=json","name":"Andrey Konovalov","email":"andrey.konovalov@linaro.org"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/19094/mbox/","series":[{"id":4043,"url":"https://patchwork.libcamera.org/api/series/4043/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4043","date":"2023-09-28T18:55:32","name":"libcamera: converter: generalize Converter to remove MediaDevice dependency","version":3,"mbox":"https://patchwork.libcamera.org/series/4043/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/19094/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/19094/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 0F02DC0F2A\n\tfor ;\n\tThu, 28 Sep 2023 18:56:42 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id BFFF162965;\n\tThu, 28 Sep 2023 20:56:41 +0200 (CEST)","from mail-wr1-x42e.google.com (mail-wr1-x42e.google.com\n\t[IPv6:2a00:1450:4864:20::42e])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4862761DE3\n\tfor ;\n\tThu, 28 Sep 2023 20:56:40 +0200 (CEST)","by mail-wr1-x42e.google.com with SMTP id\n\tffacd0b85a97d-3231dff4343so6242757f8f.0\n\tfor ;\n\tThu, 28 Sep 2023 11:56:40 -0700 (PDT)","from Lat-5310.. ([87.116.164.210]) by smtp.gmail.com with ESMTPSA\n\tid\n\tu1-20020adfed41000000b003247d3e5d99sm890842wro.55.2023.09.28.11.56.39\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tThu, 28 Sep 2023 11:56:39 -0700 (PDT)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1695927401;\n\tbh=JBU65R7c//9e4z7g5JrHGKqa8T0iaHXFk0mO+RreV7A=;\n\th=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc:\n\tFrom;\n\tb=jEKdFsqf3bwwtvDyKAR+DgqLfyx+R1KK1dFPsmIkycikc0zWP/YLTt/iMIy4m/vEU\n\t5RkNydljFLlS/35X8M1GEGbHBgF+Z/XQ9Ickzm12/TIm16UQCn9IGTcG2/DnB6Nv5x\n\t7Dhxgbi21bSJwRmt2taRBPlbxQk6Ao+2G4JNai/BL+2Xv7uGL1ra6QGlxPRQiDsbGw\n\tl9UofUM02sec4B1DTlqwK+J98EFw9sd1QhBevEGit4Co2Y43BnG+AOOG2MwbrVWpmZ\n\tLWoho8xDISmgV7l6IrLmDzDeGpvH8zmbCZlfp0+cH1U9Ab2sLvt6xn6d8fjLKF84yD\n\t5zNYCL36io5kQ==","v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=linaro.org; s=google; t=1695927400; x=1696532200;\n\tdarn=lists.libcamera.org; \n\th=content-transfer-encoding:mime-version:references:in-reply-to\n\t:message-id:date:subject:cc:to:from:from:to:cc:subject:date\n\t:message-id:reply-to;\n\tbh=ypxvKBx6mrteqp8A4cjPERuJutJlBXx0XrDjTtsVzPY=;\n\tb=ul4OkIr42jnyq4hCWGfQ3kLoxKP4qS7sKClj5yfQQhESPDoe6608O7Znk5pqVF8DI1\n\t18xw0v8GKhAJzFPH44hlPoQtz2sHgZM/gMqA4DtkJjxMeBXTBBvGKyQnjuRpOVOdUdc1\n\t1b1MZGTYSdVH3cSncr5gruTuy8yQ4jxese1PaGYnQUlPwh8oGfe72S9XctCpzhGkGbX7\n\tsunGwpy8SwE0RqL8fPY19CpgenhU37NFS0jsTs8pjl5cKVP/ITKd7RPVUWFXlW/bg0Vi\n\te4mYSS9+9skyIuIk0XpPXYOVK12rhXrMDfkqn/T2v15d1FrSyTywweXMCgUE0KcT9RTT\n\tvLrw=="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (2048-bit key; \n\tunprotected) header.d=linaro.org\n\theader.i=@linaro.org header.b=\"ul4OkIr4\"; \n\tdkim-atps=neutral","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20230601; t=1695927400; x=1696532200;\n\th=content-transfer-encoding:mime-version:references:in-reply-to\n\t:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n\t:subject:date:message-id:reply-to;\n\tbh=ypxvKBx6mrteqp8A4cjPERuJutJlBXx0XrDjTtsVzPY=;\n\tb=LzHQgS3e5IPPlpbjkmWXoOi+RnyTF2wEeTXTyZTzoqFT9PtSnar/RNSsGMr4lCGfPC\n\theD6wmiAPfONTg1Bj4zjCWbcbKdQ/N0xtHWvmtkL2hT64u7kWhQfLrBoIqGDtmdwrMiJ\n\tF1PZ39y6rkvdEHQ7Kb6PRjMKESl/jWD4V6CPllu3zP4NqbN5V+hk/w0Z0/jMTwwU8WlU\n\toI+TqzWQofgkr16unk7OwR+SbVZ7JQppa5T2V6Ew9TOmrVXvuggYo3HQly7sUUiHERLm\n\tJ2ua6PM8NxCCExc5NiF8sO7Ue7xpWzDSQx+0PZCgiyTKz5NxsD5uP9LDMeceDxW8PGeR\n\tDrBA==","X-Gm-Message-State":"AOJu0YzMhunRKA+vSLDxB1KQWjbAmdil7N1d/YmwV/LCMUSohvGqnpGR\n\tT+BqyGHWu/aTqk4Lhnq+lJOcEz4xCaxzG/5nm6c=","X-Google-Smtp-Source":"AGHT+IFR4xGaH2DlR0ZodomGberS7Pl8FnRVon25Mbl+UFSWACLfCFVA5r2H8xcvTk2piNAxu/N98w==","X-Received":"by 2002:a5d:4052:0:b0:31f:eb45:462e with SMTP id\n\tw18-20020a5d4052000000b0031feb45462emr1897064wrp.28.1695927399933; \n\tThu, 28 Sep 2023 11:56:39 -0700 (PDT)","To":"libcamera-devel@lists.libcamera.org","Date":"Thu, 28 Sep 2023 21:55:33 +0300","Message-Id":"<20230928185537.20178-2-andrey.konovalov@linaro.org>","X-Mailer":"git-send-email 2.34.1","In-Reply-To":"<20230928185537.20178-1-andrey.konovalov@linaro.org>","References":"<20230928185537.20178-1-andrey.konovalov@linaro.org>","MIME-Version":"1.0","Content-Transfer-Encoding":"7bit","Subject":"[libcamera-devel] [PATCH v3 1/5] libcamera: converter: a few fixes\n\tto ConverterFactoryBase 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","From":"Andrey Konovalov via libcamera-devel\n\t","Reply-To":"Andrey Konovalov ","Cc":"jacopo.mondi@ideasonboard.com, bryan.odonoghue@linaro.org,\n\tsrinivas.kandagatla@linaro.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"The description of ConverterFactoryBase::registerType() referred to\na converter factory as \"converter class\" and \"converter\". Fix that.\n\nAlso make the descriptions of ConverterFactoryBase::compatibles() and\nConverterFactoryBase::create() a bit more specific.\n\nSigned-off-by: Andrey Konovalov \n---\n src/libcamera/converter.cpp | 18 +++++++++++-------\n 1 file changed, 11 insertions(+), 7 deletions(-)","diff":"diff --git a/src/libcamera/converter.cpp b/src/libcamera/converter.cpp\nindex fa0f1ec8..15701363 100644\n--- a/src/libcamera/converter.cpp\n+++ b/src/libcamera/converter.cpp\n@@ -199,16 +199,19 @@ ConverterFactoryBase::ConverterFactoryBase(const std::string name, std::initiali\n \n /**\n * \\fn ConverterFactoryBase::compatibles()\n- * \\return The names compatibles\n+ * \\return The list of compatible name aliases of the converter\n */\n \n /**\n- * \\brief Create an instance of the converter corresponding to a named factory\n- * \\param[in] media Name of the factory\n+ * \\brief Create an instance of the converter corresponding to the media device\n+ * \\param[in] media The media device to create the converter for\n *\n * \\return A unique pointer to a new instance of the converter subclass\n- * corresponding to the named factory or one of its alias. Otherwise a null\n- * pointer if no such factory exists\n+ * corresponding to the media device. The converter is created by matching\n+ * the factory name or any of its compatible aliases with the media device\n+ * driver name.\n+ * If the media device driver name doesn't match anything a null pointer is\n+ * returned.\n */\n std::unique_ptr ConverterFactoryBase::create(MediaDevice *media)\n {\n@@ -236,10 +239,11 @@ std::unique_ptr ConverterFactoryBase::create(MediaDevice *media)\n }\n \n /**\n- * \\brief Add a converter class to the registry\n+ * \\brief Add a converter factory to the registry\n * \\param[in] factory Factory to use to construct the converter class\n *\n- * The caller is responsible to guarantee the uniqueness of the converter name.\n+ * The caller is responsible to guarantee the uniqueness of the converter\n+ * factory name.\n */\n void ConverterFactoryBase::registerType(ConverterFactoryBase *factory)\n {\n","prefixes":["libcamera-devel","v3","1/5"]}