Patch Detail
Show a patch.
GET /api/patches/20728/?format=api
{ "id": 20728, "url": "https://patchwork.libcamera.org/api/patches/20728/?format=api", "web_url": "https://patchwork.libcamera.org/patch/20728/", "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": "<20240731135201.2866145-5-dan.scally@ideasonboard.com>", "date": "2024-07-31T13:52:01", "name": "[v4,4/4] libcamera: Documentation: Improve doxygen main page", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "2b5bebc11f2c87af06f74276f7f9ae66daec22e9", "submitter": { "id": 156, "url": "https://patchwork.libcamera.org/api/people/156/?format=api", "name": "Dan Scally", "email": "dan.scally@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/20728/mbox/", "series": [ { "id": 4469, "url": "https://patchwork.libcamera.org/api/series/4469/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4469", "date": "2024-07-31T13:51:57", "name": "Improve libcamera documentation", "version": 4, "mbox": "https://patchwork.libcamera.org/series/4469/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/20728/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/20728/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 0E24DC323E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 31 Jul 2024 13:52:28 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 615A36337A;\n\tWed, 31 Jul 2024 15:52:24 +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 0AD2963375\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 31 Jul 2024 15:52:18 +0200 (CEST)", "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 1A4DE146B;\n\tWed, 31 Jul 2024 15:51:30 +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=\"Ab/w/7jG\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1722433890;\n\tbh=olobQnrmW3vdalENulTeo4BugyqYUFZogJ6sqUARGzc=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=Ab/w/7jGbU3Tob8/oUdXdlgFT2sGVQzpAij21xl3FHrHfnVFaZTiGTc8euW0XVJzR\n\t6GTTGC8oSr6047pVuDLNExBozkmM+fX0XY2wpBp7hxEzHSbL674FyC4/4zq79NrVpP\n\tSq6A4C6SjBzjn3uR0clflXseGsnVZqmAfOWwLHVQ=", "From": "Daniel Scally <dan.scally@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Daniel Scally <dan.scally@ideasonboard.com>,\n\tJacopo Mondi <jacopo.mondi@ideasonboard.com>,\n\tKieran Bingham <kieran.bingham@ideasonboard.com>", "Subject": "[PATCH v4 4/4] libcamera: Documentation: Improve doxygen main page", "Date": "Wed, 31 Jul 2024 14:52:01 +0100", "Message-Id": "<20240731135201.2866145-5-dan.scally@ideasonboard.com>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20240731135201.2866145-1-dan.scally@ideasonboard.com>", "References": "<20240731135201.2866145-1-dan.scally@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 \"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---\nChanges in v4:\n\n\t- None\n\nChanges in v3:\n\n\t- renamed file to mainpage.dox\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-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 9d4cf9d9..6a40eb46 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\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 00000000..d5a57653\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": [ "v4", "4/4" ] }