Patch Detail
Show a patch.
GET /api/patches/20044/?format=api
{ "id": 20044, "url": "https://patchwork.libcamera.org/api/patches/20044/?format=api", "web_url": "https://patchwork.libcamera.org/patch/20044/", "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": "<20240513124323.8933-1-laurent.pinchart@ideasonboard.com>", "date": "2024-05-13T12:43:23", "name": "Documentation: Add option to treat Doxygen warnings as errors", "commit_ref": "899087fe42d98a2847b1324f9224f731c7a8f91c", "pull_url": null, "state": "accepted", "archived": false, "hash": "8dd48f2ac8c4690f2e3e2c4dcd22c38a3dfe6128", "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/20044/mbox/", "series": [ { "id": 4307, "url": "https://patchwork.libcamera.org/api/series/4307/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4307", "date": "2024-05-13T12:43:23", "name": "Documentation: Add option to treat Doxygen warnings as errors", "version": 1, "mbox": "https://patchwork.libcamera.org/series/4307/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/20044/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/20044/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 364E8C3226\n\tfor <parsemail@patchwork.libcamera.org>;\n\tMon, 13 May 2024 12:43:34 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 4532A6347E;\n\tMon, 13 May 2024 14:43:33 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 5CD5161A64\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 13 May 2024 14:43:31 +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 C10EBCC8\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 13 May 2024 14:43:24 +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=\"OuQUmWjN\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1715604205;\n\tbh=wJrkQQBTfTy3U8NwTxPPp/AqEr8FbSWgyG8V1NzHIpQ=;\n\th=From:To:Subject:Date:From;\n\tb=OuQUmWjNHuaOYG28T6HQ/smRhZOJgDI9kBpxwJI2RsaBXikgwKi2sdeb9xTmhSU33\n\tL3EDlJVOxQNI4jaANJ7gYoyJ1AQWgnbRsOrhmD6gZH2wKSWo53O+EpXnk4VaoGzTYc\n\tc3UuKNLxe32pk5tsLL5WwaLxMnQWhjyfWV1ecKyc=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Subject": "[PATCH] Documentation: Add option to treat Doxygen warnings as\n\terrors", "Date": "Mon, 13 May 2024 15:43:23 +0300", "Message-ID": "<20240513124323.8933-1-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.43.2", "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": "A new Doxygen warning introduced in a recent commit went unnoticed, both\nin manual tests and in CI. Unlike C/C++ warnings that are treated as\nerrors, we don't fail the build with Doxygen warnings. This is due to\nthe fact that the libcamera documentation compiles cleanly only with quite\nrecent versions of Doxygen. Enabling the WARN_AS_ERROR Doxygen option\nunconditionally could bother many users.\n\nTo improve the situation, add a meson option to treat Doxygen warnings\nas errors. The option is disabled by default, preserving the current\nbehaviour, and will be enabled in CI builds.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n Documentation/Doxyfile.in | 1 +\n Documentation/meson.build | 1 +\n meson_options.txt | 5 +++++\n 3 files changed, 7 insertions(+)\n\n\nbase-commit: 3cb20bc2301c03d01a631eb637ab47031d2b91e6", "diff": "diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\nindex 2be8d47b8419..abafcf6c6c66 100644\n--- a/Documentation/Doxyfile.in\n+++ b/Documentation/Doxyfile.in\n@@ -20,6 +20,7 @@ TOC_INCLUDE_HEADINGS = 0\n CASE_SENSE_NAMES = YES\n \n QUIET = YES\n+WARN_AS_ERROR = @WARN_AS_ERROR@\n \n INPUT = \"@TOP_SRCDIR@/include/libcamera\" \\\n \"@TOP_SRCDIR@/src/ipa/ipu3\" \\\ndiff --git a/Documentation/meson.build b/Documentation/meson.build\nindex 3872e0a8f522..30d395234952 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -15,6 +15,7 @@ if doxygen.found() and dot.found()\n cdata.set('TOP_SRCDIR', meson.project_source_root())\n cdata.set('TOP_BUILDDIR', meson.project_build_root())\n cdata.set('OUTPUT_DIR', meson.current_build_dir())\n+ cdata.set('WARN_AS_ERROR', get_option('doc_werror') ? 'YES' : 'NO')\n \n doxygen_predefined = []\n foreach key : config_h.keys()\ndiff --git a/meson_options.txt b/meson_options.txt\nindex c61eb55584b5..7aa412491e91 100644\n--- a/meson_options.txt\n+++ b/meson_options.txt\n@@ -20,6 +20,11 @@ option('documentation',\n type : 'feature',\n description : 'Generate the project documentation')\n \n+option('doc_werror',\n+ type : 'boolean',\n+ value : false,\n+ description : 'Treat documentation warnings as errors')\n+\n option('gstreamer',\n type : 'feature',\n value : 'auto',\n", "prefixes": [] }