Patch Detail
Show a patch.
GET /api/1.1/patches/20826/?format=api
{ "id": 20826, "url": "https://patchwork.libcamera.org/api/1.1/patches/20826/?format=api", "web_url": "https://patchwork.libcamera.org/patch/20826/", "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": "<20240807154410.9552-5-laurent.pinchart@ideasonboard.com>", "date": "2024-08-07T15:44:09", "name": "[v6,4/5] Documentation: Improve doxygen main page", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "d13f95d68c734abb6bedf8b99b3f0b9e29136eb7", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/1.1/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/20826/mbox/", "series": [ { "id": 4497, "url": "https://patchwork.libcamera.org/api/1.1/series/4497/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4497", "date": "2024-08-07T15:44:05", "name": "Split libcamera documentation in public and internal APIs", "version": 6, "mbox": "https://patchwork.libcamera.org/series/4497/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/20826/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/20826/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 DE01FC323E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 7 Aug 2024 15:44:43 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 7D7A9633BF;\n\tWed, 7 Aug 2024 17:44:43 +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 0D35A633B9\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 7 Aug 2024 17:44:39 +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 0A9926AF;\n\tWed, 7 Aug 2024 17:43:45 +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=\"sc/N/sRy\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1723045426;\n\tbh=JdX1wf465nKXe4Y64c6ARzhJaj1/TZdocqXuGhVqcEY=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=sc/N/sRygTl3LZOmXTRNHhb3Bfh+QzXmefvc96kjeAuMq4zoxYUmZHsI+FwdbFoq8\n\tua7kXhdKma49FrxPrUelbF2u54C7avGwrvxNAZMDtLgk898EQ1pSuaFIlON6Kp2Bfy\n\tBoT5t5tPNWlQ6oOG2MMJ4MkGInZljFPo8Aq1+iuI=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Daniel Scally <dan.scally@ideasonboard.com>", "Subject": "[PATCH v6 4/5] Documentation: Improve doxygen main page", "Date": "Wed, 7 Aug 2024 18:44:09 +0300", "Message-ID": "<20240807154410.9552-5-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.44.2", "In-Reply-To": "<20240807154410.9552-1-laurent.pinchart@ideasonboard.com>", "References": "<20240807154410.9552-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": "From: Daniel Scally <dan.scally@ideasonboard.com>\n\nThe \"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\nReviewed-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>\nReviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>\nSigned-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n---\n Documentation/Doxyfile-internal.in | 1 +\n Documentation/mainpage.dox | 33 ++++++++++++++++++++++++++++++\n 2 files changed, 34 insertions(+)\n create mode 100644 Documentation/mainpage.dox", "diff": "diff --git a/Documentation/Doxyfile-internal.in b/Documentation/Doxyfile-internal.in\nindex 5e0310091416..e56321c3f8f6 100644\n--- a/Documentation/Doxyfile-internal.in\n+++ b/Documentation/Doxyfile-internal.in\n@@ -3,6 +3,7 @@\n @INCLUDE_PATH = @TOP_BUILDDIR@/Documentation\n @INCLUDE = Doxyfile-common\n \n+ENABLED_SECTIONS = internal\n HIDE_UNDOC_CLASSES = NO\n HIDE_UNDOC_MEMBERS = NO\n HTML_OUTPUT = internal-api-html\ndiff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox\nnew file mode 100644\nindex 000000000000..d5a57653ca93\n--- /dev/null\n+++ b/Documentation/mainpage.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+*/\n", "prefixes": [ "v6", "4/5" ] }