Patch Detail
Show a patch.
GET /api/patches/20787/?format=api
{ "id": 20787, "url": "https://patchwork.libcamera.org/api/patches/20787/?format=api", "web_url": "https://patchwork.libcamera.org/patch/20787/", "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": "<20240805143654.20870-2-laurent.pinchart@ideasonboard.com>", "date": "2024-08-05T14:36:37", "name": "[v5,01/18] libcamera: Drop path prefix from Doxygen file directive", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "4d3728917247ad55554ccebb7f9bbab02a03b545", "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/20787/mbox/", "series": [ { "id": 4488, "url": "https://patchwork.libcamera.org/api/series/4488/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4488", "date": "2024-08-05T14:36:36", "name": "Split libcamera documentation in public and internal APIs", "version": 5, "mbox": "https://patchwork.libcamera.org/series/4488/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/20787/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/20787/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 9C775C323E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tMon, 5 Aug 2024 14:37:25 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 0434B63381;\n\tMon, 5 Aug 2024 16:37:25 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 6F9AC63369\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 5 Aug 2024 16:37:19 +0200 (CEST)", "from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi\n\t[81.175.209.231])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 5A2EB581\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 5 Aug 2024 16:36:27 +0200 (CEST)" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"CMLtXdAG\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1722868587;\n\tbh=KMMIZCVjewT6AJyLgj1xUaFlWMm5lb2EMRfjtTBB5sM=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=CMLtXdAGQRcwOlD0ore+wwmL+PYqQUQkQrYiIAo0HMpDsKoCGmprQbZfihS60IW2Y\n\tS8k+FjvuzHwlhtYS8oWaIOMGH5O91+JLAEQ6nXF12t4rNGkODBMT/B1f7HVMYw0Byf\n\tHtkWqjzuI6W3U5o+yFijbDX5wITAP51Wbqj9oOFQ=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Subject": "[PATCH v5 01/18] libcamera: Drop path prefix from Doxygen file\n\tdirective", "Date": "Mon, 5 Aug 2024 17:36:37 +0300", "Message-ID": "<20240805143654.20870-2-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.44.2", "In-Reply-To": "<20240805143654.20870-1-laurent.pinchart@ideasonboard.com>", "References": "<20240805143654.20870-1-laurent.pinchart@ideasonboard.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "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>", "Errors-To": "libcamera-devel-bounces@lists.libcamera.org", "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>" }, "content": "The Doxygen directive only requires qualifying header file names with a\npath to differentiate between multiple header files with the same name.\nMost file directives that refer to unambiguous files do not have a\nlibcamera/ and/or internal/ path prefix, but a few do, most likely due\nto copy&paste. Drop the prefix in those few files for consistency.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n src/libcamera/converter.cpp | 2 +-\n src/libcamera/converter/converter_v4l2_m2m.cpp | 2 +-\n src/libcamera/fence.cpp | 2 +-\n src/libcamera/mapped_framebuffer.cpp | 2 +-\n src/libcamera/orientation.cpp | 2 +-\n src/libcamera/yaml_parser.cpp | 2 +-\n 6 files changed, 6 insertions(+), 6 deletions(-)", "diff": "diff --git a/src/libcamera/converter.cpp b/src/libcamera/converter.cpp\nindex 2ab461332677..8237998f044b 100644\n--- a/src/libcamera/converter.cpp\n+++ b/src/libcamera/converter.cpp\n@@ -14,7 +14,7 @@\n #include \"libcamera/internal/media_device.h\"\n \n /**\n- * \\file internal/converter.h\n+ * \\file converter.h\n * \\brief Abstract converter\n */\n \ndiff --git a/src/libcamera/converter/converter_v4l2_m2m.cpp b/src/libcamera/converter/converter_v4l2_m2m.cpp\nindex 2e77872e1710..006ba9f7f665 100644\n--- a/src/libcamera/converter/converter_v4l2_m2m.cpp\n+++ b/src/libcamera/converter/converter_v4l2_m2m.cpp\n@@ -23,7 +23,7 @@\n #include \"libcamera/internal/v4l2_videodevice.h\"\n \n /**\n- * \\file internal/converter/converter_v4l2_m2m.h\n+ * \\file converter/converter_v4l2_m2m.h\n * \\brief V4L2 M2M based converter\n */\n \ndiff --git a/src/libcamera/fence.cpp b/src/libcamera/fence.cpp\nindex 634c74f8e13e..73299b402702 100644\n--- a/src/libcamera/fence.cpp\n+++ b/src/libcamera/fence.cpp\n@@ -11,7 +11,7 @@ namespace libcamera {\n \n /**\n *\n- * \\file libcamera/fence.h\n+ * \\file fence.h\n * \\brief Definition of the Fence class\n */\n \ndiff --git a/src/libcamera/mapped_framebuffer.cpp b/src/libcamera/mapped_framebuffer.cpp\nindex b3104e0504d4..ad82e1f6e49c 100644\n--- a/src/libcamera/mapped_framebuffer.cpp\n+++ b/src/libcamera/mapped_framebuffer.cpp\n@@ -16,7 +16,7 @@\n #include <libcamera/base/log.h>\n \n /**\n- * \\file libcamera/internal/mapped_framebuffer.h\n+ * \\file mapped_framebuffer.h\n * \\brief Frame buffer memory mapping support\n */\n \ndiff --git a/src/libcamera/orientation.cpp b/src/libcamera/orientation.cpp\nindex 47fd6a32502b..fd191197fb8c 100644\n--- a/src/libcamera/orientation.cpp\n+++ b/src/libcamera/orientation.cpp\n@@ -11,7 +11,7 @@\n #include <string>\n \n /**\n- * \\file libcamera/orientation.h\n+ * \\file orientation.h\n * \\brief Image orientation definition\n */\n \ndiff --git a/src/libcamera/yaml_parser.cpp b/src/libcamera/yaml_parser.cpp\nindex 025006bcdcdd..8b6a403898be 100644\n--- a/src/libcamera/yaml_parser.cpp\n+++ b/src/libcamera/yaml_parser.cpp\n@@ -18,7 +18,7 @@\n #include <yaml.h>\n \n /**\n- * \\file libcamera/internal/yaml_parser.h\n+ * \\file yaml_parser.h\n * \\brief A YAML parser helper\n */\n \n", "prefixes": [ "v5", "01/18" ] }