Cover Letter Detail
Show a cover letter.
GET /api/1.1/covers/20786/?format=api
{ "id": 20786, "url": "https://patchwork.libcamera.org/api/1.1/covers/20786/?format=api", "web_url": "https://patchwork.libcamera.org/cover/20786/", "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": "<20240805143654.20870-1-laurent.pinchart@ideasonboard.com>", "date": "2024-08-05T14:36:36", "name": "[v5,00/18] Split libcamera documentation in public and internal APIs", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/1.1/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "mbox": "https://patchwork.libcamera.org/cover/20786/mbox/", "series": [ { "id": 4488, "url": "https://patchwork.libcamera.org/api/1.1/series/4488/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4488", "date": "2024-08-05T14:36:36", "name": "Split libcamera documentation in public and internal APIs", "version": 5, "mbox": "https://patchwork.libcamera.org/series/4488/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/covers/20786/comments/", "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 14FE7C323E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tMon, 5 Aug 2024 14:37:20 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 9590863382;\n\tMon, 5 Aug 2024 16:37:18 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4FE0E63369\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 5 Aug 2024 16:37:17 +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 8280C581\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 5 Aug 2024 16:36:25 +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=\"kNkbz2qZ\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1722868585;\n\tbh=7ntJU9jBzI/xWGduJ2G+wQ+1enfSc+nxrDT3Ikt+xNM=;\n\th=From:To:Subject:Date:From;\n\tb=kNkbz2qZrXsbYw/fmKzib6+n+n2rbZH+3ESSO9qGA0v83hid/+NNlULEEN8lMHCd1\n\t+tg9fjQ4TItC7/FchiTwJZjbR1YEGNYRkj37MyJJ3oFGOl/4udpSKP3TbsWMJu5+Ju\n\tK2xGDtDz/8Ox7lMrmekc1OL99feMiGqjClIgDMQ0=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Subject": "[PATCH v5 00/18] Split libcamera documentation in public and\n\tinternal APIs", "Date": "Mon, 5 Aug 2024 17:36:36 +0300", "Message-ID": "<20240805143654.20870-1-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.44.2", "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": "Hello,\n\nThis series aims to improve the libcamera API documentation a little by adding\nsome content to the landing page and splitting it to two separate outputs for\nthe library's users and developers. The \"public\" run, intended for users, is a\nmuch abridged version that only documents those objects intended to be used by\napplication developers.\n\nThe split is achieved by collecting file paths for public sources in meson and\npassing them to a generated Doxyfile-public, which is used for the \"public\" run\nof Doxygen. A second Doxyfile-internal retains the current behaviour for the\ninternal API run.\n\nCompared to v4, I've tried to address some small issues I wasn't fully\nsatisfied with. This has resulted in a further 14 patches. This seems to\nhappen sometimes when I touch code, I apologize about it. On the upside,\nthe additional patches are small, and should therefore be easy to\nreview.\n\nPatches 06/18 and 16/18, originally from Dan, have been significantly\nmodified. As a consequence, I've dropped the Reviewed-by tags. I haven't\ntouched Dan's patches 14/18 and 17/18, they are identifical to v4.\n\nDaniel Scally (4):\n libcamera: Split public and internal source arrays\n Documentation: Add Thread support page\n Documentation: Split public/private documentation\n Documentation: Improve doxygen main page\n\nLaurent Pinchart (14):\n libcamera: Drop path prefix from Doxygen file directive\n libcamera: Make all internal headers visible to Doxygen\n libcamera: Unify Doxygen file directive prefix for formats.h\n libcamera: Mark internal parts of public classes with \\internal\n libcamera: Hide *::Private classes with __DOXYGEN_PUBLIC__\n libcamera: Add version.h to public headers\n libcamera: Drop libcamera_generated_ipa_headers from sources\n libcamera: Move IPA headers to the libcamera_private dependency\n libcamera: Consolidate all IPA headers in libcamera_ipa_headers\n libcamera: Add missing headers to libcamera_internal_headers\n libcamera: Consolidate tracepoint header in libcamera_internal_headers\n libcamera: Don't add libcamera_public_headers to\n libcamera_public_sources\n Documentation: Split doxygen_input in public and internal inputs\n libcamera: camera: Hide Camera::create() from the public API\n\n .../{Doxyfile.in => Doxyfile-common.in} | 23 +---\n Documentation/Doxyfile-internal.in | 31 +++++\n Documentation/Doxyfile-public.in | 20 +++\n Documentation/gen-doxyfile.py | 46 +++++++\n Documentation/guides/pipeline-handler.rst | 5 +-\n Documentation/mainpage.dox | 33 +++++\n Documentation/meson.build | 91 +++++++++++--\n Documentation/thread.dox | 122 +++++++++++++++++\n include/libcamera/internal/meson.build | 18 ++-\n include/libcamera/ipa/meson.build | 8 +-\n include/libcamera/meson.build | 9 +-\n src/ipa/ipu3/meson.build | 3 +-\n src/ipa/rkisp1/meson.build | 3 +-\n src/ipa/rpi/vc4/meson.build | 3 +-\n src/ipa/simple/meson.build | 3 +-\n src/ipa/vimc/meson.build | 3 +-\n src/libcamera/base/meson.build | 25 ++--\n src/libcamera/base/thread.cpp | 123 ------------------\n src/libcamera/camera.cpp | 9 ++\n src/libcamera/camera_manager.cpp | 3 +\n src/libcamera/converter.cpp | 2 +-\n .../converter/converter_v4l2_m2m.cpp | 2 +-\n src/libcamera/converter/meson.build | 2 +-\n src/libcamera/fence.cpp | 2 +-\n src/libcamera/formats.cpp | 2 +-\n src/libcamera/framebuffer.cpp | 7 +-\n src/libcamera/mapped_framebuffer.cpp | 2 +-\n src/libcamera/meson.build | 56 ++++----\n src/libcamera/orientation.cpp | 2 +-\n src/libcamera/pipeline/imx8-isi/meson.build | 2 +-\n src/libcamera/pipeline/ipu3/meson.build | 2 +-\n src/libcamera/pipeline/mali-c55/meson.build | 2 +-\n src/libcamera/pipeline/rkisp1/meson.build | 2 +-\n src/libcamera/pipeline/rpi/common/meson.build | 2 +-\n src/libcamera/pipeline/rpi/vc4/meson.build | 2 +-\n src/libcamera/pipeline/simple/meson.build | 2 +-\n src/libcamera/pipeline/uvcvideo/meson.build | 2 +-\n src/libcamera/pipeline/vimc/meson.build | 2 +-\n src/libcamera/proxy/meson.build | 2 +-\n src/libcamera/proxy/worker/meson.build | 3 +-\n src/libcamera/request.cpp | 8 ++\n src/libcamera/sensor/meson.build | 2 +-\n src/libcamera/software_isp/meson.build | 2 +-\n src/libcamera/yaml_parser.cpp | 2 +-\n test/ipa/meson.build | 2 +-\n test/ipa/rkisp1/meson.build | 2 +-\n 46 files changed, 454 insertions(+), 245 deletions(-)\n rename Documentation/{Doxyfile.in => Doxyfile-common.in} (63%)\n create mode 100644 Documentation/Doxyfile-internal.in\n create mode 100644 Documentation/Doxyfile-public.in\n create mode 100755 Documentation/gen-doxyfile.py\n create mode 100644 Documentation/mainpage.dox\n create mode 100644 Documentation/thread.dox\n\n\nbase-commit: 19bbca3c0b376ba0183f5db53472c8c46cd402b5" }