{"id":18789,"url":"https://patchwork.libcamera.org/api/patches/18789/?format=json","web_url":"https://patchwork.libcamera.org/patch/18789/","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":"<20230704234422.11863-2-laurent.pinchart@ideasonboard.com>","date":"2023-07-04T23:44:21","name":"[libcamera-devel,v2,1/2] Documentation: Add predefined macros from config.h to Doxyfile","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"1ef7db9fab82949904e6afdf5f3f07973b3f43cc","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/18789/mbox/","series":[{"id":3954,"url":"https://patchwork.libcamera.org/api/series/3954/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=3954","date":"2023-07-04T23:44:20","name":"libcamera: Add an application to verify IPA module signatures","version":2,"mbox":"https://patchwork.libcamera.org/series/3954/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/18789/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/18789/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 432FBC3240\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue,  4 Jul 2023 23:44:26 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id D1416628C4;\n\tWed,  5 Jul 2023 01:44: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 CDFCD61E38\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed,  5 Jul 2023 01:44:23 +0200 (CEST)","from pendragon.ideasonboard.com (85-160-42-71.reb.o2.cz\n\t[85.160.42.71])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 4DDB58CC\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed,  5 Jul 2023 01:43:39 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1688514265;\n\tbh=fgMMtJItJk7wKivuQz11EeEMMSVwlcKigD1pq2Ya4TM=;\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:\n\tFrom;\n\tb=uw2BZazmW64r5Fo2xUBSp5Ktfk8plQ3RivisE3KP9JJC2oLBltHo8wek+ELOWlp7p\n\tZ88vCZoKKhSGdaHBq0LZ8ZjautgJhYMe7xfuT9nzw2CzI60/o1/2E29QSvCabn5D2X\n\tBXzQ7toTRenr52Yc8Y0fgAIWw0H2n/zxoUFVQoFw/GYDcJk+mKEP8SgeoCCjqXkEfM\n\t7DMtZfqZd13JJ4cr+pe/OIjLm0ugxP99GPAYXWXgHQ0YPG8l3TLi02o4GwJpBuh3e/\n\tVH2cfT8dR3xV9IBFEaAO2tCc+G2GihAtfA0JVgP1NSouXVq+hrSn0my97Wh0ZqLirk\n\t4tV9qd+dzs0lA==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1688514219;\n\tbh=fgMMtJItJk7wKivuQz11EeEMMSVwlcKigD1pq2Ya4TM=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=MadnNZZ8v2PegTpdjOyoQbA3+Ysom9DAf31P5yd0D74QWbtudkNWaIgHrjzTM2zPq\n\t6XceNNs5KFwmIZPW1kpMWa+XHlZ0t0xI/0LwbOIp2XRcq3tpcsqhiolpzw2iGQje/J\n\tBzWr4GSuzs4i+tetBJRfAGITSy3SuE+YPpdo444w="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"MadnNZZ8\"; dkim-atps=neutral","To":"libcamera-devel@lists.libcamera.org","Date":"Wed,  5 Jul 2023 02:44:21 +0300","Message-Id":"<20230704234422.11863-2-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.39.3","In-Reply-To":"<20230704234422.11863-1-laurent.pinchart@ideasonboard.com>","References":"<20230704234422.11863-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v2 1/2] Documentation: Add predefined\n\tmacros from config.h to Doxyfile","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>","From":"Laurent Pinchart via libcamera-devel\n\t<libcamera-devel@lists.libcamera.org>","Reply-To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"libcamera creates a config.h file with predefined macros, and instructs\nthe compiler to include it implicitly with the -include argument.\nDoxygen has no support for implicit inclusion of headers, but has a\nPREDEFINED configuration option for its preprocessor that lists\npredefined macros. Populate it with the values from the config_h\nconfiguration data object that is used for generate the config.h file,\nto ensure that documentation matches the configuration options libcamera\nhas been built with.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\nReviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>\n---\nChanges since v1:\n\n- Correct indentation and line wrap in the generate Doxyfile\n---\n Documentation/Doxyfile.in | 3 ++-\n Documentation/meson.build | 7 +++++++\n 2 files changed, 9 insertions(+), 1 deletion(-)","diff":"diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\nindex 1447abdb7d8c..697a14d1dfe2 100644\n--- a/Documentation/Doxyfile.in\n+++ b/Documentation/Doxyfile.in\n@@ -80,6 +80,7 @@ INCLUDE_FILE_PATTERNS  = *.h\n \n PREDEFINED             = __DOXYGEN__ \\\n                          __cplusplus \\\n-                         __attribute__(x)=\n+                         __attribute__(x)= \\\n+\t\t\t @PREDEFINED@\n \n HAVE_DOT               = YES\ndiff --git a/Documentation/meson.build b/Documentation/meson.build\nindex 186461561f8d..d675f368cf79 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -16,6 +16,13 @@ if doxygen.found() and dot.found()\n     cdata.set('TOP_BUILDDIR', meson.project_build_root())\n     cdata.set('OUTPUT_DIR', meson.current_build_dir())\n \n+    doxygen_predefined = []\n+    foreach key : config_h.keys()\n+        doxygen_predefined += '@0@=@1@'.format(key, config_h.get(key))\n+    endforeach\n+\n+    cdata.set('PREDEFINED', ' \\\\\\n\\t\\t\\t '.join(doxygen_predefined))\n+\n     doxyfile = configure_file(input : 'Doxyfile.in',\n                               output : 'Doxyfile',\n                               configuration : cdata)\n","prefixes":["libcamera-devel","v2","1/2"]}