Patch Detail
Show a patch.
GET /api/patches/19343/?format=api
{ "id": 19343, "url": "https://patchwork.libcamera.org/api/patches/19343/?format=api", "web_url": "https://patchwork.libcamera.org/patch/19343/", "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": "<20231222170449.794915-1-dan.scally@ideasonboard.com>", "date": "2023-12-22T17:04:49", "name": "[libcamera-devel] libcamera: Documentation: Improve doxygen main page", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "497b23867cc0fab604670676ceaf83234e07a20c", "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/19343/mbox/", "series": [ { "id": 4126, "url": "https://patchwork.libcamera.org/api/series/4126/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4126", "date": "2023-12-22T17:04:49", "name": "[libcamera-devel] libcamera: Documentation: Improve doxygen main page", "version": 1, "mbox": "https://patchwork.libcamera.org/series/4126/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/19343/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/19343/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 999FEC3237\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 22 Dec 2023 17:05:08 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id E35C562B41;\n\tFri, 22 Dec 2023 18:05:07 +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 8488D61D8F\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 22 Dec 2023 18:05:06 +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 B2DCC22A;\n\tFri, 22 Dec 2023 18:04:14 +0100 (CET)" ], "DKIM-Signature": [ "v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1703264707;\n\tbh=b1rd4RvkMAFDUsc24zhOkyghunipsOieGGRrHDJOzQk=;\n\th=To:Date:Subject:List-Id:List-Unsubscribe:List-Archive:List-Post:\n\tList-Help:List-Subscribe:From:Reply-To:From;\n\tb=4gT3piYepQWSVppFySHXC4T2N5Mrk+o6edYTlCir0W0ZYQB7oDAORtiq3d3k4GDnj\n\tK5Ecn3gCkNI7m0yo2qWpU+xRLCYG0DeZpQThbnIfNMSROQPTCBQlC6tCxu918YcQCp\n\ttaBxwzg1FmxlOqwXlBcIgoNiw4yi0C71hLgNKsjxgo6sSGXpNHLSZccHn03CepTKAz\n\tan4Rhccz9XYu900Lght9KQsPbEJWO2xSAbUtGLD2g7jwNQWToq0G3cGF9tWcSZYhZa\n\t7+bu+L3ZbHnlkyDYz706yEpLNQJqUDBAEGXc6TXkPlmZY+Y9Ve9KujnLpAyROcKYTc\n\tk4ElUe2yu/Bvg==", "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1703264654;\n\tbh=b1rd4RvkMAFDUsc24zhOkyghunipsOieGGRrHDJOzQk=;\n\th=From:To:Cc:Subject:Date:From;\n\tb=lDAZ6zL2Ewt2HKN7AiqGZMGZ8mSfKs8RABPZw97uBG0YnaJhhZbmDwc0xoJOfX48P\n\tU3KQ/84c1nuVf4NGomQEYvlPynFtyGTaKcLH5jRBN6Nho4B300k+REsZVMeVFmLmGI\n\tjWFGs2c9Pw2vrWIXi59RJcpZHINAdloRDIwr/w4U=" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"lDAZ6zL2\"; dkim-atps=neutral", "To": "libcamera-devel@lists.libcamera.org", "Date": "Fri, 22 Dec 2023 17:04:49 +0000", "Message-Id": "<20231222170449.794915-1-dan.scally@ideasonboard.com>", "X-Mailer": "git-send-email 2.34.1", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH] libcamera: Documentation: Improve doxygen\n\tmain 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---\nThis patch depends on \"[PATCH 2/2] libcamera: Documentation: Split public/private documentation\"\n\n Documentation/Doxyfile.in | 6 ++++--\n Documentation/libcamera.dox | 33 +++++++++++++++++++++++++++++++++\n 2 files changed, 37 insertions(+), 2 deletions(-)\n create mode 100644 Documentation/libcamera.dox", "diff": "diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\nindex 6689ace1..1c6412ed 100644\n--- a/Documentation/Doxyfile.in\n+++ b/Documentation/Doxyfile.in\n@@ -21,7 +21,8 @@ CASE_SENSE_NAMES = YES\n \n QUIET = YES\n \n-INPUT = \"@TOP_SRCDIR@/include/libcamera\" \\\n+INPUT = \"@TOP_SRCDIR@/Documentation\" \\\n+ \"@TOP_SRCDIR@/include/libcamera\" \\\n \"@TOP_SRCDIR@/src/ipa/ipu3\" \\\n \"@TOP_SRCDIR@/src/ipa/libipa\" \\\n \"@TOP_SRCDIR@/src/libcamera\" \\\n@@ -30,7 +31,8 @@ INPUT = \"@TOP_SRCDIR@/include/libcamera\" \\\n \n FILE_PATTERNS = *.c \\\n *.cpp \\\n- *.h\n+ *.h \\\n+ *.dox\n \n RECURSIVE = YES\n \ndiff --git a/Documentation/libcamera.dox b/Documentation/libcamera.dox\nnew file mode 100644\nindex 00000000..c3101739\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 do\n+not explain how to use libcamera to consume data from camera sensors in your\n+application, nor how to add support to the library for your hardware. There is\n+documentation available to detail how to achieve those things in detail, which\n+may be a better first contact with libcamera as a developer. As a starting\n+point we recommend the [developer's guide](../html/guides/introduction.html).\n+\n+As a follow-on to the developer's guide, if you wish add support for a new\n+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+Alternatively if you are an application developer seeking to use libcamera within\n+your work the [application developer's guide](../html/guides/application-developer.html)\n+gives an overview on how to achieve that.\n+\n+\\if internal\n+\n+If you are an application developer seeking to use libcamera with your program\n+then you may find it useful to use the [reduced version](../api-html/index.html)\n+of the API reference pages instead, which excludes library objects if they are\n+intended for internal use only.\n+\n+\\else\n+\n+If you are a developer seeking to add support for your hardware to the library\n+or make other improvements, you should switch to the more complete internal API\n+[reference pages](../internal-api-html/index.html) instead\n+\n+\\endif\n+*/\n", "prefixes": [ "libcamera-devel" ] }