[{"id":35866,"web_url":"https://patchwork.libcamera.org/comment/35866/","msgid":"<175818047676.17312.8494289870944264783@localhost>","date":"2025-09-18T07:27:56","subject":"Re: [PATCH v3 10/10] Documentation: Rename api to public-api and\n\tdrop -html suffix","submitter":{"id":184,"url":"https://patchwork.libcamera.org/api/people/184/","name":"Stefan Klug","email":"stefan.klug@ideasonboard.com"},"content":"Hi Laurent,\n\nThank you for the patch.\n\nQuoting Laurent Pinchart (2025-09-17 22:17:41)\n> The public and internal Doxygen API documentation is compiled and\n> installed in api-html and internal-api-html directories respectively.\n> The '-html' suffix doesn't provide any value, and the asymmetry between\n> the names can be confusing. Rename the directories to public-api and\n> internal-api respectively.\n> \n> Signed-off-by: Laurent Pinchart \n\nLooks good to me.\nReviewed-by: Stefan Klug \n\nRegards,\nStefan\n\n> ---\n> Documentation/Doxyfile-internal.in | 4 ++--\n> Documentation/Doxyfile-public.in | 4 ++--\n> Documentation/conf.py.in | 8 ++++----\n> Documentation/index.rst | 4 ++--\n> .../{internal-api-html => internal-api}/index.rst | 0\n> Documentation/mainpage.dox | 4 ++--\n> Documentation/meson.build | 10 +++++-----\n> Documentation/{api-html => public-api}/index.rst | 0\n> 8 files changed, 17 insertions(+), 17 deletions(-)\n> rename Documentation/{internal-api-html => internal-api}/index.rst (100%)\n> rename Documentation/{api-html => public-api}/index.rst (100%)\n> \n> diff --git a/Documentation/Doxyfile-internal.in b/Documentation/Doxyfile-internal.in\n> index aeaa06e9d9d3..b64b6a6feef3 100644\n> --- a/Documentation/Doxyfile-internal.in\n> +++ b/Documentation/Doxyfile-internal.in\n> @@ -31,6 +31,6 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/span.h \\\n> @TOP_BUILDDIR@/include/libcamera/ipa/soft_ipa_interface.h \\\n> @TOP_BUILDDIR@/src/libcamera/proxy/\n> \n> -HTML_OUTPUT = internal-api-html\n> +HTML_OUTPUT = internal-api\n> \n> -GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml\n> +GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api/tagfile.xml\n> diff --git a/Documentation/Doxyfile-public.in b/Documentation/Doxyfile-public.in\n> index 917f24008579..9efb2b341ab4 100644\n> --- a/Documentation/Doxyfile-public.in\n> +++ b/Documentation/Doxyfile-public.in\n> @@ -16,8 +16,8 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/class.h \\\n> @TOP_SRCDIR@/src/libcamera/base/class.cpp \\\n> @TOP_SRCDIR@/src/libcamera/base/object.cpp\n> \n> -HTML_OUTPUT = api-html\n> +HTML_OUTPUT = public-api\n> \n> PREDEFINED += __DOXYGEN_PUBLIC__\n> \n> -GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/api-html/tagfile.xml\n> +GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/public-api/tagfile.xml\n> diff --git a/Documentation/conf.py.in b/Documentation/conf.py.in\n> index 349feda2a610..3054454b809c 100644\n> --- a/Documentation/conf.py.in\n> +++ b/Documentation/conf.py.in\n> @@ -74,12 +74,12 @@ pygments_style = None\n> \n> doxylink = {\n> 'doxy-pub': (\n> - '@TOP_BUILDDIR@/Documentation/api-html/tagfile.xml',\n> - 'api-html/',\n> + '@TOP_BUILDDIR@/Documentation/public-api/tagfile.xml',\n> + 'public-api/',\n> ),\n> 'doxy-int': (\n> - '@TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml',\n> - 'internal-api-html/',\n> + '@TOP_BUILDDIR@/Documentation/internal-api/tagfile.xml',\n> + 'internal-api/',\n> ),\n> }\n> \n> diff --git a/Documentation/index.rst b/Documentation/index.rst\n> index d55b5ff21464..7f762bbcc998 100644\n> --- a/Documentation/index.rst\n> +++ b/Documentation/index.rst\n> @@ -11,7 +11,7 @@\n> Application Writer's Guide \n> Python Bindings \n> Environment variables \n> - Public API \n> + Public API \n> \n> .. toctree::\n> :maxdepth: 1\n> @@ -26,7 +26,7 @@\n> SoftwareISP Benchmarking \n> Tracing guide \n> Design document: AE \n> - Internal API \n> + Internal API \n> \n> .. toctree::\n> :maxdepth: 1\n> diff --git a/Documentation/internal-api-html/index.rst b/Documentation/internal-api/index.rst\n> similarity index 100%\n> rename from Documentation/internal-api-html/index.rst\n> rename to Documentation/internal-api/index.rst\n> diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox\n> index fae99f28f1af..99e67e7ab13d 100644\n> --- a/Documentation/mainpage.dox\n> +++ b/Documentation/mainpage.dox\n> @@ -20,7 +20,7 @@ your platform the [pipeline handler writer's guide](../guides/pipeline-handler.h\n> and the [ipa module writer's guide](../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> +part of the API you can use [these pages](../public-api/index.html) instead.\n> \n> \\else\n> \n> @@ -31,7 +31,7 @@ gives an overview on how to achieve that.\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> +[reference pages](../internal-api/index.html) instead.\n> \n> \\endif\n> */\n> diff --git a/Documentation/meson.build b/Documentation/meson.build\n> index 54c32e249e45..a5d8c20c30f9 100644\n> --- a/Documentation/meson.build\n> +++ b/Documentation/meson.build\n> @@ -86,7 +86,7 @@ if doxygen.found() and dot.found()\n> doxyfile,\n> doxyfile_common,\n> ],\n> - output : 'api-html',\n> + output : 'public-api',\n> command : [doxygen, doxyfile],\n> install : true,\n> install_dir : doc_install_dir,\n> @@ -106,7 +106,7 @@ if doxygen.found() and dot.found()\n> doxygen_public_input,\n> doxygen_internal_input,\n> ],\n> - output : 'internal-api-html',\n> + output : 'internal-api',\n> command : [doxygen, doxyfile],\n> install : true,\n> install_dir : doc_install_dir,\n> @@ -150,7 +150,6 @@ if sphinx.found()\n> sphinx_conf_dir = fs.parent(sphinx_conf)\n> \n> docs_sources = [\n> - 'api-html/index.rst',\n> 'camera-sensor-model.rst',\n> 'code-of-conduct.rst',\n> 'coding-style.rst',\n> @@ -164,11 +163,12 @@ if sphinx.found()\n> 'guides/pipeline-handler.rst',\n> 'guides/tracing.rst',\n> 'index.rst',\n> - 'internal-api-html/index.rst',\n> + 'internal-api/index.rst',\n> 'introduction.rst',\n> 'lens_driver_requirements.rst',\n> 'libcamera_architecture.rst',\n> 'mali-c55.dot',\n> + 'public-api/index.rst',\n> 'python-bindings.rst',\n> 'sensor_driver_requirements.rst',\n> 'software-isp-benchmarking.rst',\n> @@ -193,7 +193,7 @@ if sphinx.found()\n> install_tag : 'doc')\n> \n> meson.add_install_script('install-doxygen.sh', doc_install_dir,\n> - 'api-html', 'internal-api-html')\n> + 'public-api', 'internal-api')\n> \n> custom_target('documentation-linkcheck',\n> command : [sphinx, '-W', '-b', 'linkcheck',\n> diff --git a/Documentation/api-html/index.rst b/Documentation/public-api/index.rst\n> similarity index 100%\n> rename from Documentation/api-html/index.rst\n> rename to Documentation/public-api/index.rst\n> -- \n> Regards,\n> \n> Laurent Pinchart\n>","headers":{"Return-Path":"","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 0AFE0BE173\n\tfor ;\n\tThu, 18 Sep 2025 07:28:06 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id CAD746936D;\n\tThu, 18 Sep 2025 09:28:04 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 91A0962C39\n\tfor ;\n\tThu, 18 Sep 2025 09:28:00 +0200 (CEST)","from ideasonboard.com (unknown\n\t[IPv6:2a00:6020:448c:6c00:ace3:d2c2:5eff:9cc5])\n\tby perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id 0809F6DF;\n\tThu, 18 Sep 2025 09:26:40 +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=\"JmigZpb0\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1758180401;\n\tbh=oZ2OdFnaZKwtzu4b1IJvuRLxj/e0X3KyjGwkGm4wZUE=;\n\th=In-Reply-To:References:Subject:From:To:Date:From;\n\tb=JmigZpb0njIFniNCGDUldU/sTpg5Tfs2aUjtaKweLJeWplJ3wZyFzMzT30ppmyGAK\n\tE/X77JcSI77rx5Htjmew3qjrPpIDFrgtrY1D5rY5j6LUe2+v37T+8MgpgZf+oPZpx2\n\tIqm7lKYP5CINpxm60LxCCaEEYTT138NcjIGUktA0=","Content-Type":"text/plain; charset=\"utf-8\"","MIME-Version":"1.0","Content-Transfer-Encoding":"quoted-printable","In-Reply-To":"<20250917201742.16406-11-laurent.pinchart@ideasonboard.com>","References":"<20250917201742.16406-1-laurent.pinchart@ideasonboard.com>\n\t<20250917201742.16406-11-laurent.pinchart@ideasonboard.com>","Subject":"Re: [PATCH v3 10/10] Documentation: Rename api to public-api and\n\tdrop -html suffix","From":"Stefan Klug ","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","Date":"Thu, 18 Sep 2025 09:27:56 +0200","Message-ID":"<175818047676.17312.8494289870944264783@localhost>","User-Agent":"alot/0.12.dev8+g2c003385c862.d20250602","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":35868,"web_url":"https://patchwork.libcamera.org/comment/35868/","msgid":"<23a95f06-f77b-4b92-b836-2d79ba482d18@ideasonboard.com>","date":"2025-09-18T07:34:16","subject":"Re: [PATCH v3 10/10] Documentation: Rename api to public-api and\n\tdrop -html suffix","submitter":{"id":216,"url":"https://patchwork.libcamera.org/api/people/216/","name":"Barnabás Pőcze","email":"barnabas.pocze@ideasonboard.com"},"content":"2025. 09. 17. 22:17 keltezéssel, Laurent Pinchart írta:\n> The public and internal Doxygen API documentation is compiled and\n> installed in api-html and internal-api-html directories respectively.\n> The '-html' suffix doesn't provide any value, and the asymmetry between\n> the names can be confusing. Rename the directories to public-api and\n> internal-api respectively.\n> \n> Signed-off-by: Laurent Pinchart \n> ---\n\nReviewed-by: Barnabás Pőcze \n\n\n> Documentation/Doxyfile-internal.in | 4 ++--\n> Documentation/Doxyfile-public.in | 4 ++--\n> Documentation/conf.py.in | 8 ++++----\n> Documentation/index.rst | 4 ++--\n> .../{internal-api-html => internal-api}/index.rst | 0\n> Documentation/mainpage.dox | 4 ++--\n> Documentation/meson.build | 10 +++++-----\n> Documentation/{api-html => public-api}/index.rst | 0\n> 8 files changed, 17 insertions(+), 17 deletions(-)\n> rename Documentation/{internal-api-html => internal-api}/index.rst (100%)\n> rename Documentation/{api-html => public-api}/index.rst (100%)\n> \n> diff --git a/Documentation/Doxyfile-internal.in b/Documentation/Doxyfile-internal.in\n> index aeaa06e9d9d3..b64b6a6feef3 100644\n> --- a/Documentation/Doxyfile-internal.in\n> +++ b/Documentation/Doxyfile-internal.in\n> @@ -31,6 +31,6 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/span.h \\\n> @TOP_BUILDDIR@/include/libcamera/ipa/soft_ipa_interface.h \\\n> @TOP_BUILDDIR@/src/libcamera/proxy/\n> \n> -HTML_OUTPUT = internal-api-html\n> +HTML_OUTPUT = internal-api\n> \n> -GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml\n> +GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api/tagfile.xml\n> diff --git a/Documentation/Doxyfile-public.in b/Documentation/Doxyfile-public.in\n> index 917f24008579..9efb2b341ab4 100644\n> --- a/Documentation/Doxyfile-public.in\n> +++ b/Documentation/Doxyfile-public.in\n> @@ -16,8 +16,8 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/class.h \\\n> @TOP_SRCDIR@/src/libcamera/base/class.cpp \\\n> @TOP_SRCDIR@/src/libcamera/base/object.cpp\n> \n> -HTML_OUTPUT = api-html\n> +HTML_OUTPUT = public-api\n> \n> PREDEFINED += __DOXYGEN_PUBLIC__\n> \n> -GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/api-html/tagfile.xml\n> +GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/public-api/tagfile.xml\n> diff --git a/Documentation/conf.py.in b/Documentation/conf.py.in\n> index 349feda2a610..3054454b809c 100644\n> --- a/Documentation/conf.py.in\n> +++ b/Documentation/conf.py.in\n> @@ -74,12 +74,12 @@ pygments_style = None\n> \n> doxylink = {\n> 'doxy-pub': (\n> - '@TOP_BUILDDIR@/Documentation/api-html/tagfile.xml',\n> - 'api-html/',\n> + '@TOP_BUILDDIR@/Documentation/public-api/tagfile.xml',\n> + 'public-api/',\n> ),\n> 'doxy-int': (\n> - '@TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml',\n> - 'internal-api-html/',\n> + '@TOP_BUILDDIR@/Documentation/internal-api/tagfile.xml',\n> + 'internal-api/',\n> ),\n> }\n> \n> diff --git a/Documentation/index.rst b/Documentation/index.rst\n> index d55b5ff21464..7f762bbcc998 100644\n> --- a/Documentation/index.rst\n> +++ b/Documentation/index.rst\n> @@ -11,7 +11,7 @@\n> Application Writer's Guide \n> Python Bindings \n> Environment variables \n> - Public API \n> + Public API \n> \n> .. toctree::\n> :maxdepth: 1\n> @@ -26,7 +26,7 @@\n> SoftwareISP Benchmarking \n> Tracing guide \n> Design document: AE \n> - Internal API \n> + Internal API \n> \n> .. toctree::\n> :maxdepth: 1\n> diff --git a/Documentation/internal-api-html/index.rst b/Documentation/internal-api/index.rst\n> similarity index 100%\n> rename from Documentation/internal-api-html/index.rst\n> rename to Documentation/internal-api/index.rst\n> diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox\n> index fae99f28f1af..99e67e7ab13d 100644\n> --- a/Documentation/mainpage.dox\n> +++ b/Documentation/mainpage.dox\n> @@ -20,7 +20,7 @@ your platform the [pipeline handler writer's guide](../guides/pipeline-handler.h\n> and the [ipa module writer's guide](../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> +part of the API you can use [these pages](../public-api/index.html) instead.\n> \n> \\else\n> \n> @@ -31,7 +31,7 @@ gives an overview on how to achieve that.\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> +[reference pages](../internal-api/index.html) instead.\n> \n> \\endif\n> */\n> diff --git a/Documentation/meson.build b/Documentation/meson.build\n> index 54c32e249e45..a5d8c20c30f9 100644\n> --- a/Documentation/meson.build\n> +++ b/Documentation/meson.build\n> @@ -86,7 +86,7 @@ if doxygen.found() and dot.found()\n> doxyfile,\n> doxyfile_common,\n> ],\n> - output : 'api-html',\n> + output : 'public-api',\n> command : [doxygen, doxyfile],\n> install : true,\n> install_dir : doc_install_dir,\n> @@ -106,7 +106,7 @@ if doxygen.found() and dot.found()\n> doxygen_public_input,\n> doxygen_internal_input,\n> ],\n> - output : 'internal-api-html',\n> + output : 'internal-api',\n> command : [doxygen, doxyfile],\n> install : true,\n> install_dir : doc_install_dir,\n> @@ -150,7 +150,6 @@ if sphinx.found()\n> sphinx_conf_dir = fs.parent(sphinx_conf)\n> \n> docs_sources = [\n> - 'api-html/index.rst',\n> 'camera-sensor-model.rst',\n> 'code-of-conduct.rst',\n> 'coding-style.rst',\n> @@ -164,11 +163,12 @@ if sphinx.found()\n> 'guides/pipeline-handler.rst',\n> 'guides/tracing.rst',\n> 'index.rst',\n> - 'internal-api-html/index.rst',\n> + 'internal-api/index.rst',\n> 'introduction.rst',\n> 'lens_driver_requirements.rst',\n> 'libcamera_architecture.rst',\n> 'mali-c55.dot',\n> + 'public-api/index.rst',\n> 'python-bindings.rst',\n> 'sensor_driver_requirements.rst',\n> 'software-isp-benchmarking.rst',\n> @@ -193,7 +193,7 @@ if sphinx.found()\n> install_tag : 'doc')\n> \n> meson.add_install_script('install-doxygen.sh', doc_install_dir,\n> - 'api-html', 'internal-api-html')\n> + 'public-api', 'internal-api')\n> \n> custom_target('documentation-linkcheck',\n> command : [sphinx, '-W', '-b', 'linkcheck',\n> diff --git a/Documentation/api-html/index.rst b/Documentation/public-api/index.rst\n> similarity index 100%\n> rename from Documentation/api-html/index.rst\n> rename to Documentation/public-api/index.rst","headers":{"Return-Path":"","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 E3C70C328C\n\tfor ;\n\tThu, 18 Sep 2025 07:34:21 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 52B406936F;\n\tThu, 18 Sep 2025 09:34:20 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id ADB2562C39\n\tfor ;\n\tThu, 18 Sep 2025 09:34:18 +0200 (CEST)","from [192.168.33.22] (185.221.142.115.nat.pool.zt.hu\n\t[185.221.142.115])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id E66206DF;\n\tThu, 18 Sep 2025 09:32:58 +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=\"vg2MLtX3\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1758180779;\n\tbh=TbT8tt/MpcNqKeJXkKH/jf+Jm1d2QH96F/aZynvaoFY=;\n\th=Date:Subject:To:References:From:In-Reply-To:From;\n\tb=vg2MLtX3nKToehb62rnQko/N2gPQ9kowKoPog3HuZEjW8Wg6svybgLq6n1G1i4+Hd\n\tJ6FrHNvwQZTtlswbUi7FBBP65Z2pj3lPQTUtOTzkjnayedbnKZNKR9rPAICGQsd/3r\n\tWj/OcMjdZCMwW+GJSJhnPNkzRpBSHVUE5/4lCcZ0=","Message-ID":"<23a95f06-f77b-4b92-b836-2d79ba482d18@ideasonboard.com>","Date":"Thu, 18 Sep 2025 09:34:16 +0200","MIME-Version":"1.0","User-Agent":"Mozilla Thunderbird","Subject":"Re: [PATCH v3 10/10] Documentation: Rename api to public-api and\n\tdrop -html suffix","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20250917201742.16406-1-laurent.pinchart@ideasonboard.com>\n\t<20250917201742.16406-11-laurent.pinchart@ideasonboard.com>","From":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","Content-Language":"en-US, hu-HU","In-Reply-To":"<20250917201742.16406-11-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=UTF-8; format=flowed","Content-Transfer-Encoding":"8bit","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]