Patch Detail
Show a patch.
GET /api/1.1/patches/20909/?format=api
{ "id": 20909, "url": "https://patchwork.libcamera.org/api/1.1/patches/20909/?format=api", "web_url": "https://patchwork.libcamera.org/patch/20909/", "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": "<20240814084215.61857-3-stefan.klug@ideasonboard.com>", "date": "2024-08-14T08:41:03", "name": "[v1,2/2] Documentation: Add tuning guide from external source", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "e35e1f5f19839de1bc234d4f5ef124924ce31bdb", "submitter": { "id": 184, "url": "https://patchwork.libcamera.org/api/1.1/people/184/?format=api", "name": "Stefan Klug", "email": "stefan.klug@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/20909/mbox/", "series": [ { "id": 4518, "url": "https://patchwork.libcamera.org/api/1.1/series/4518/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4518", "date": "2024-08-14T08:41:01", "name": "Documentation: include tuning-guide via external repo", "version": 1, "mbox": "https://patchwork.libcamera.org/series/4518/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/20909/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/20909/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 53345BDB13\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 14 Aug 2024 08:42:33 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id E6C5D633C0;\n\tWed, 14 Aug 2024 10:42:32 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 750E6633BF\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 14 Aug 2024 10:42:28 +0200 (CEST)", "from ideasonboard.com (unknown\n\t[IPv6:2a00:6020:448c:6c00:8a6:aa2:ebee:5ae5])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id BBE059FF;\n\tWed, 14 Aug 2024 10:41: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=\"bzQ243th\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1723624890;\n\tbh=buW6W8OInYbXhZvVAy41lNfViDRXc0wjfgd3HqbKD58=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=bzQ243tholqvJEgekLHPHGZZEM0VYj538zrOAa5i4QOvvpZm1fJRUvmAro9XKq2Pi\n\tpc9SOpduQ96jwkvV8zReX6hwpHFl4XC1hmQt81S7dBvO7EPt118QScg+iVov0eWUSp\n\tmZYPIzy1LsvP2lSeBDiO1GlqHJM6R2+sGEZZ0eUw=", "From": "Stefan Klug <stefan.klug@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Stefan Klug <stefan.klug@ideasonboard.com>", "Subject": "[PATCH v1 2/2] Documentation: Add tuning guide from external source", "Date": "Wed, 14 Aug 2024 10:41:03 +0200", "Message-ID": "<20240814084215.61857-3-stefan.klug@ideasonboard.com>", "X-Mailer": "git-send-email 2.43.0", "In-Reply-To": "<20240814084215.61857-1-stefan.klug@ideasonboard.com>", "References": "<20240814084215.61857-1-stefan.klug@ideasonboard.com>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "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": "Add the external tuning guide as meson subproject. Symlink it into the\nDocumentation/guides directory, so that sphinx can pick it up.\n\nThis setup feels a bit cumbersome, therefore I try to explain the\nreasoning (and maybe someone comes up with a better solution):\n\nThe main reason is that we don't want to have large binary files (aka\nimages) in the main libcamera repository. Especially if they change a\nlot the repository size increases tremendously. In a meson based\nproject, meson subprojects are the way to go. This however has the\nfollowing side effects:\n\n- The subprojects needs to contain a meson.build (That's why\n libcamera-tuning-guide is also meson based)\n\n- We can't reference ../subproject/libcamera-tuning-guide/tuning.rst\n from within the main meson build, as that violates the meson sandbox\n\n- Referencing ../subproject/libcamera-tuning-guide/tuning.rst via a\n sphinx include directive doesn't work either as sphinx then tries to\n resolve images relative to the outer document.\n\n- Symlinking ../subprojects/libcameta-tuning-guide into\n Documentation/guides works wuite well, but fails as soon as\nlibcamera-tuning-guide contains an additional rst file (like index.rst)\nwhich is not referenced from the libcamera documentation.\n\nThe solution is to move the actual content into\n../subproject/libcamera-tuning-guide/content/ and to symlink that\ndirectory into Documentation/guides.\n\nSigned-off-by: Stefan Klug <stefan.klug@ideasonboard.com>\n---\n Documentation/conf.py | 4 ++--\n Documentation/guides/tuning | 1 +\n Documentation/index.rst | 1 +\n Documentation/meson.build | 2 ++\n subprojects/libcamera-tuning-guide.wrap | 7 +++++++\n 5 files changed, 13 insertions(+), 2 deletions(-)\n create mode 120000 Documentation/guides/tuning\n create mode 100644 subprojects/libcamera-tuning-guide.wrap", "diff": "diff --git a/Documentation/conf.py b/Documentation/conf.py\nindex 022e698efac4..7675efb6682a 100644\n--- a/Documentation/conf.py\n+++ b/Documentation/conf.py\n@@ -21,8 +21,8 @@\n # -- Project information -----------------------------------------------------\n \n project = 'libcamera'\n-copyright = '2018-2019, The libcamera documentation authors'\n-author = u'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Söderlund'\n+copyright = '2018-2024, The libcamera documentation authors'\n+author = u'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Söderlund, Stefan Klug'\n \n # Version information is provided by the build environment, through the\n # sphinx command line.\ndiff --git a/Documentation/guides/tuning b/Documentation/guides/tuning\nnew file mode 120000\nindex 000000000000..3e62b7b660d0\n--- /dev/null\n+++ b/Documentation/guides/tuning\n@@ -0,0 +1 @@\n+../../subprojects/libcamera-tuning-guide/content/\n\\ No newline at end of file\ndiff --git a/Documentation/index.rst b/Documentation/index.rst\nindex 5442ae75dde7..991dcf2b66fb 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -16,6 +16,7 @@\n \n Developer Guide <guides/introduction>\n Application Writer's Guide <guides/application-developer>\n+ Sensor Tuning Guide <guides/tuning/tuning>\n Pipeline Handler Writer's Guide <guides/pipeline-handler>\n IPA Writer's guide <guides/ipa>\n Tracing guide <guides/tracing>\ndiff --git a/Documentation/meson.build b/Documentation/meson.build\nindex 1ba40fdf67ac..58c656a54150 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -143,6 +143,8 @@ if sphinx.found()\n '../README.rst',\n ]\n \n+ subproject('libcamera-tuning-guide', required : true)\n+\n release = 'release=v' + libcamera_git_version\n \n custom_target('documentation',\ndiff --git a/subprojects/libcamera-tuning-guide.wrap b/subprojects/libcamera-tuning-guide.wrap\nnew file mode 100644\nindex 000000000000..d8e172471fa6\n--- /dev/null\n+++ b/subprojects/libcamera-tuning-guide.wrap\n@@ -0,0 +1,7 @@\n+# SPDX-License-Identifier: CC0-1.0\n+\n+[wrap-git]\n+directory = libcamera-tuning-guide\n+url = https://git.uk.ideasonboard.com/sklug/libcamera-tuning-guide.git\n+# tags/0.2.5\n+revision = head\n", "prefixes": [ "v1", "2/2" ] }