Patch Detail
Show a patch.
GET /api/1.1/patches/19376/?format=api
{ "id": 19376, "url": "https://patchwork.libcamera.org/api/1.1/patches/19376/?format=api", "web_url": "https://patchwork.libcamera.org/patch/19376/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/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": "<20240105164104.78398-6-dan.scally@ideasonboard.com>", "date": "2024-01-05T16:41:04", "name": "[libcamera-devel,v2,5/5] libcamera: Documentation: Improve doxygen main page", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "ec7a54f937fe4f1aead6ab492cb87060602a4f7c", "submitter": { "id": 156, "url": "https://patchwork.libcamera.org/api/1.1/people/156/?format=api", "name": "Dan Scally", "email": "dan.scally@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/19376/mbox/", "series": [ { "id": 4134, "url": "https://patchwork.libcamera.org/api/1.1/series/4134/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4134", "date": "2024-01-05T16:40:59", "name": "Improve libcamera documentation", "version": 2, "mbox": "https://patchwork.libcamera.org/series/4134/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/19376/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/19376/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 9F4F5C32BD\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 5 Jan 2024 16:41:30 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 0FF3462B5C;\n\tFri, 5 Jan 2024 17:41:30 +0100 (CET)", "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 B116F62B59\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 5 Jan 2024 17:41:23 +0100 (CET)", "from mail.ideasonboard.com\n\t(cpc141996-chfd3-2-0-cust928.12-3.cable.virginm.net [86.13.91.161])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 0DEEAD49;\n\tFri, 5 Jan 2024 17:40:22 +0100 (CET)" ], "DKIM-Signature": [ "v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1704472890;\n\tbh=vrwtTEGOTvWeWKk3iu+pHOPambWPQe0oO3irmpMVPSQ=;\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=RkgJXN6J2OUt1vVuorkO6F2Qnq9njYY+5hm66oeHei5vDGSkabKxfGsO7biLvQL83\n\tYMmRoV/Uxm6ZX2i5yFfV/2apsiDgCszZtAxmryYTk2ZnHJoBWp+LcFzer1kYJB6Mcp\n\tB5krSkJwdtEujc7a+Bv+aU0Fs7zmnftQ8uGu04+4m8ukDymEPPXIxp9AD7kHCh6aD8\n\tvWDXO1UNFpLkPb/WMLyQc+8tDr2PXGRIPJntEQotUUvYU+P+xCHasQ48oZWWxmYC79\n\t6H0F7HTDgKWwZ4DmsNUrxxZoJSfYdp7oKA/zNANE7pOdrzS8zDNTcVVWOnM5Xv2FcS\n\tKbKNUmzVuBP2g==", "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1704472822;\n\tbh=vrwtTEGOTvWeWKk3iu+pHOPambWPQe0oO3irmpMVPSQ=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=hxAzKvusBttzmwFSyZKqOoqNg/dCf2vqBlVLGm9ivit4sc+GmGz4LxtiusfkusXvU\n\tAbwWyJ3ngNfhxvM6f+KIgUoeZgnrkHTAoAPeWEBWGij+hN0kp3YmpDCg47tn90rk33\n\tCwk3JiVQh5NxXjvDSL9aHHmrCMl5AZ6/dgUWAga8=" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"hxAzKvus\"; dkim-atps=neutral", "To": "libcamera-devel@lists.libcamera.org", "Date": "Fri, 5 Jan 2024 16:41:04 +0000", "Message-Id": "<20240105164104.78398-6-dan.scally@ideasonboard.com>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20240105164104.78398-1-dan.scally@ideasonboard.com>", "References": "<20240105164104.78398-1-dan.scally@ideasonboard.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH v2 5/5] libcamera: Documentation: Improve\n\tdoxygen main page", "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": "Daniel Scally via libcamera-devel <libcamera-devel@lists.libcamera.org>", "Reply-To": "Daniel Scally <dan.scally@ideasonboard.com>", "Errors-To": "libcamera-devel-bounces@lists.libcamera.org", "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>" }, "content": "The \"Main Page\" of the doxygen generated API reference is currently\ntotally empty. Expand it with some introductory text along with links\nto the developer's guide, application developer's guide and the\npipeline and IPA module writer's guides.\n\nProvide an easy link to switch between the reduced public reference\npages and the more complete internal ones.\n\nSigned-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n---\nChanges in v2:\n\n\t- Changed the first paragraph to be more about what the documentation is\n\tthan isn't (Jacopo)\n\t- Pushed the links to the guides into the \\if internal block so that\n\tonly the relevant one is presented.\n\n Documentation/Doxyfile.in | 1 +\n Documentation/libcamera.dox | 33 +++++++++++++++++++++++++++++++++\n Documentation/meson.build | 2 ++\n 3 files changed, 36 insertions(+)\n create mode 100644 Documentation/libcamera.dox", "diff": "diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\nindex a271c7bc..625d1e90 100644\n--- a/Documentation/Doxyfile.in\n+++ b/Documentation/Doxyfile.in\n@@ -53,6 +53,7 @@ EXCLUDE_SYMBOLS = libcamera::BoundMethodArgs \\\n \n EXCLUDE_SYMLINKS = YES\n \n+ENABLED_SECTIONS = @ENABLED_SECTIONS@\n HIDE_UNDOC_CLASSES = @HIDE_UNDOC_CLASSES@\n HIDE_UNDOC_MEMBERS = @HIDE_UNDOC_MEMBERS@\n HTML_OUTPUT = @HTML_OUTPUT@\ndiff --git a/Documentation/libcamera.dox b/Documentation/libcamera.dox\nnew file mode 100644\nindex 00000000..d5a57653\n--- /dev/null\n+++ b/Documentation/libcamera.dox\n@@ -0,0 +1,33 @@\n+/**\n+\\mainpage libcamera API reference\n+\n+Welcome to the API reference for <a href=\"https://libcamera.org/\">libcamera</a>,\n+a complex camera support library for Linux, Android and ChromeOS. These pages\n+are automatically generated from the libcamera source code and describe the API\n+in detail - if this is your first interaction with libcamera then you may find\n+it useful to visit the [developer's guide](../html/guides/introduction.html) in\n+the first instance, which can provide a more generic introduction to the\n+library's concepts.\n+\n+\\if internal\n+\n+As a follow-on to the developer's guide, to assist you in adding support for\n+your platform the [pipeline handler writer's guide](../html/guides/pipeline-handler.html)\n+and the [ipa module writer's guide](../html/guides/ipa.html) should be helpful.\n+\n+The full libcamera API is documented here. If you wish to see only the public\n+part of the API you can use [these pages](../api-html/index.html) instead.\n+\n+\\else\n+\n+As a follow-on to the developer's guide, to assist you in using libcamera within\n+your project the [application developer's guide](../html/guides/application-developer.html)\n+gives an overview on how to achieve that.\n+\n+Only the public part of the libcamera API is documented here; if you are a\n+developer seeking to add support for your hardware to the library or make other\n+improvements, you should switch to the internal API\n+[reference pages](../internal-api-html/index.html) instead.\n+\n+\\endif\n+*/\ndiff --git a/Documentation/meson.build b/Documentation/meson.build\nindex afaad751..ab8168bb 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -62,6 +62,7 @@ if doxygen.found() and dot.found()\n \n cdata_public = configuration_data()\n cdata_public.merge_from(cdata)\n+ cdata_public.set('ENABLED_SECTIONS', '')\n cdata_public.set('HIDE_UNDOC_CLASSES', 'YES')\n cdata_public.set('HIDE_UNDOC_MEMBERS', 'YES')\n cdata_public.set('HTML_OUTPUT', 'api-html')\n@@ -89,6 +90,7 @@ if doxygen.found() and dot.found()\n \n cdata_internal = configuration_data()\n cdata_internal.merge_from(cdata)\n+ cdata_internal.set('ENABLED_SECTIONS', 'internal')\n cdata_internal.set('HIDE_UNDOC_CLASSES', 'NO')\n cdata_internal.set('HIDE_UNDOC_MEMBERS', 'NO')\n cdata_internal.set('HTML_OUTPUT', 'internal-api-html')\n", "prefixes": [ "libcamera-devel", "v2", "5/5" ] }