Patch Detail
Show a patch.
GET /api/patches/10102/?format=api
{ "id": 10102, "url": "https://patchwork.libcamera.org/api/patches/10102/?format=api", "web_url": "https://patchwork.libcamera.org/patch/10102/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20201020000310.3008-3-laurent.pinchart@ideasonboard.com>", "date": "2020-10-20T00:03:07", "name": "[libcamera-devel,2/5] ipa: Skip doxygen parsing for pipeline-specific IPA headers", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "40d56756dbab1daea042eba39933acb41808fc82", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/10102/mbox/", "series": [ { "id": 1385, "url": "https://patchwork.libcamera.org/api/series/1385/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=1385", "date": "2020-10-20T00:03:05", "name": "libcamera: Miscellaneous documentation fixes", "version": 1, "mbox": "https://patchwork.libcamera.org/series/1385/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/10102/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/10102/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 3D510BDB20\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Oct 2020 00:04:09 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 17E5D613B9;\n\tTue, 20 Oct 2020 02:04:08 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id E67A060CE6\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Oct 2020 02:04:05 +0200 (CEST)", "from pendragon.lan (62-78-145-57.bb.dnainternet.fi [62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 8B4E552\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Oct 2020 02:04:05 +0200 (CEST)" ], "Authentication-Results": "lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"CbWIzqq5\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1603152245;\n\tbh=jbKwQifX6VEF/mQftap82PE6c+gUo2g4JVfeSx8vhWk=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=CbWIzqq5KJZ1N8++9ZxvEyzBnLm2q6AiLcFzXciIrLKSL8ynCAjPszMOQbobBABiM\n\tYm8Znk/e4/0b0FhY1EMvpj2wSby6dPP8fcVPAooBBc/z7fc+UcVVIGGNBLJUM0k8ao\n\tjs+HVErLXQQunVgFeuDBve+zzyFqxFbDfisBd/v8=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Date": "Tue, 20 Oct 2020 03:03:07 +0300", "Message-Id": "<20201020000310.3008-3-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.27.0", "In-Reply-To": "<20201020000310.3008-1-laurent.pinchart@ideasonboard.com>", "References": "<20201020000310.3008-1-laurent.pinchart@ideasonboard.com>", "MIME-Version": "1.0", "Subject": "[libcamera-devel] [PATCH 2/5] ipa: Skip doxygen parsing for\n\tpipeline-specific IPA headers", "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": "The pipeline-specific IPA headers are not part of the libcamera API,\nthey should thus be skipped when generating documentation. doxygen\ndoesn't complain currently due to the fact that types defined in those\nheaders are part of undocumented namespaces. In preparation for\ndocumenting the libcamera namespace, make sure the headers don't get\nparsed by doxygen.\n\nOnly vimc.h needs a header guard, as rkisp1.h uses the global namespace\nand raspberrypi.h uses the undocumented libcamera::RPi namespace,\nneither of which cause issues. Still, for consistency, add header guards\nto all headers.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n include/libcamera/ipa/raspberrypi.h | 4 ++++\n include/libcamera/ipa/rkisp1.h | 4 ++++\n include/libcamera/ipa/vimc.h | 4 ++++\n 3 files changed, 12 insertions(+)", "diff": "diff --git a/include/libcamera/ipa/raspberrypi.h b/include/libcamera/ipa/raspberrypi.h\nindex b3041591ff7c..b23baf2f1330 100644\n--- a/include/libcamera/ipa/raspberrypi.h\n+++ b/include/libcamera/ipa/raspberrypi.h\n@@ -10,6 +10,8 @@\n #include <libcamera/control_ids.h>\n #include <libcamera/controls.h>\n \n+#ifndef __DOXYGEN__\n+\n namespace libcamera {\n \n namespace RPi {\n@@ -66,4 +68,6 @@ static const ControlInfoMap Controls = {\n \n } /* namespace libcamera */\n \n+#endif /* __DOXYGEN__ */\n+\n #endif /* __LIBCAMERA_IPA_INTERFACE_RASPBERRYPI_H__ */\ndiff --git a/include/libcamera/ipa/rkisp1.h b/include/libcamera/ipa/rkisp1.h\nindex 4fe0482b8de5..bb824f292032 100644\n--- a/include/libcamera/ipa/rkisp1.h\n+++ b/include/libcamera/ipa/rkisp1.h\n@@ -7,6 +7,8 @@\n #ifndef __LIBCAMERA_IPA_INTERFACE_RKISP1_H__\n #define __LIBCAMERA_IPA_INTERFACE_RKISP1_H__\n \n+#ifndef __DOXYGEN__\n+\n enum RkISP1Operations {\n \tRKISP1_IPA_ACTION_V4L2_SET = 1,\n \tRKISP1_IPA_ACTION_PARAM_FILLED = 2,\n@@ -15,4 +17,6 @@ enum RkISP1Operations {\n \tRKISP1_IPA_EVENT_QUEUE_REQUEST = 5,\n };\n \n+#endif /* __DOXYGEN__ */\n+\n #endif /* __LIBCAMERA_IPA_INTERFACE_RKISP1_H__ */\ndiff --git a/include/libcamera/ipa/vimc.h b/include/libcamera/ipa/vimc.h\nindex 22d97992f80f..27a4a61df889 100644\n--- a/include/libcamera/ipa/vimc.h\n+++ b/include/libcamera/ipa/vimc.h\n@@ -8,6 +8,8 @@\n #ifndef __LIBCAMERA_IPA_VIMC_H__\n #define __LIBCAMERA_IPA_VIMC_H__\n \n+#ifndef __DOXYGEN__\n+\n namespace libcamera {\n \n #define VIMC_IPA_FIFO_PATH \"/tmp/libcamera_ipa_vimc_fifo\"\n@@ -21,4 +23,6 @@ enum IPAOperationCode {\n \n } /* namespace libcamera */\n \n+#endif /* __DOXYGEN__ */\n+\n #endif /* __LIBCAMERA_IPA_VIMC_H__ */\n", "prefixes": [ "libcamera-devel", "2/5" ] }