[{"id":35268,"web_url":"https://patchwork.libcamera.org/comment/35268/","msgid":"","date":"2025-08-04T08:22:51","subject":"Re: [PATCH 0/2] Documentation/linkcheck fixes","submitter":{"id":216,"url":"https://patchwork.libcamera.org/api/people/216/","name":"Barnabás Pőcze","email":"barnabas.pocze@ideasonboard.com"},"content":"Hi\n\n2025. 07. 25. 19:21 keltezéssel, Kieran Bingham írta:\n> The doxygen build contains a tool to verify links are still valid.\n> \n> Running this tool presently reports several issues fixed by this series.\n> \n> You can run it too with:\n> \n> ninja -C build/gcc/ Documentation/linkcheck\n> \n> And I've started an update to the CI to introduce including this -\n> however we can't merge that yet - because one of the documents is harder\n> to fix than the others.\n> \n> Documentation/guides/tracing.rst references\n> https://lttng.org/docs/#doc-tracing-your-own-user-application and\n> https://lttng.org/docs/#doc-viewing-and-analyzing-your-traces-bt which\n> seem to be valid URL anchors in a web browser but the tooling reports\n> them as invalid. I suspect they may be generated after page load with\n> javascript or such that the tooling does not comprehend.\n\nThe cause appears to be that it redirects to https://lttng.org/docs/v2.13/\nusing javascript. Otherwise I think it would work.\n\nRegards,\nBarnabás Pőcze\n\n\n> \n> Anyway, perhaps the fixes to pipeline handler and application guides are\n> still worth merging first.\n> \n> \n> Kieran Bingham (2):\n> Documentation: pipeline-handler: Fix broken links\n> Documentation: application: Update mediactl URL\n> \n> Documentation/guides/application-developer.rst | 2 +-\n> Documentation/guides/pipeline-handler.rst | 12 ++++++------\n> 2 files changed, 7 insertions(+), 7 deletions(-)\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 6BB9FBDCC1\n\tfor ;\n\tMon, 4 Aug 2025 08:23:00 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 5323F69217;\n\tMon, 4 Aug 2025 10:22:59 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 0718B61468\n\tfor ;\n\tMon, 4 Aug 2025 10:22:57 +0200 (CEST)","from [192.168.33.13] (185.182.215.213.nat.pool.zt.hu\n\t[185.182.215.213])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 94DEF289;\n\tMon, 4 Aug 2025 10:22:08 +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=\"iJA934w9\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1754295730;\n\tbh=ioveWHaVRho4stm14R64u4UMlSGOY3U6prP54ZB87P0=;\n\th=Date:Subject:To:References:From:In-Reply-To:From;\n\tb=iJA934w9cH7+lAdZoK0TDR/M4pAa80/sJgsJqrDAoSHNz34ApRKjdwSXGt1VVr2eC\n\tl1aWG2gDGizVQ1Ko/h8GeQCFcKtq/SX7Fz7wKO72H79uduBinmomGYVqne6iLe6Gin\n\to6oRePwwVOPoK9RazKAuMZ9PFq2IyGtlqs3psnrA=","Message-ID":"","Date":"Mon, 4 Aug 2025 10:22:51 +0200","MIME-Version":"1.0","User-Agent":"Mozilla Thunderbird","Subject":"Re: [PATCH 0/2] Documentation/linkcheck fixes","To":"Kieran Bingham ,\n\tlibcamera devel ","References":"<20250725172130.2218836-1-kieran.bingham@ideasonboard.com>","From":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","Content-Language":"en-US, hu-HU","In-Reply-To":"<20250725172130.2218836-1-kieran.bingham@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\" "}},{"id":35269,"web_url":"https://patchwork.libcamera.org/comment/35269/","msgid":"<199f933f-ca94-46d8-9c72-a9f5fbee020f@ideasonboard.com>","date":"2025-08-04T08:56:33","subject":"Re: [PATCH 0/2] Documentation/linkcheck fixes","submitter":{"id":216,"url":"https://patchwork.libcamera.org/api/people/216/","name":"Barnabás Pőcze","email":"barnabas.pocze@ideasonboard.com"},"content":"2025. 08. 04. 10:22 keltezéssel, Barnabás Pőcze írta:\n> Hi\n> \n> 2025. 07. 25. 19:21 keltezéssel, Kieran Bingham írta:\n>> The doxygen build contains a tool to verify links are still valid.\n>>\n>> Running this tool presently reports several issues fixed by this series.\n>>\n>> You can run it too with:\n>>\n>>    ninja -C build/gcc/ Documentation/linkcheck\n>>\n>> And I've started an update to the CI to introduce including this -\n>> however we can't merge that yet - because one of the documents is harder\n>> to fix than the others.\n>>\n>> Documentation/guides/tracing.rst references\n>> https://lttng.org/docs/#doc-tracing-your-own-user-application and\n>> https://lttng.org/docs/#doc-viewing-and-analyzing-your-traces-bt which\n>> seem to be valid URL anchors in a web browser but the tooling reports\n>> them as invalid. I suspect they may be generated after page load with\n>> javascript or such that the tooling does not comprehend.\n> \n> The cause appears to be that it redirects to https://lttng.org/docs/v2.13/\n> using javascript. Otherwise I think it would work.\n\nOr one could set\n\n linkcheck_anchors_ignore_for_url = (\n 'https://lttng.org/docs/',\n )\n\nin the sphinx configuration and then they pass the check.\n\n\n> \n> Regards,\n> Barnabás Pőcze\n> \n> \n>>\n>> Anyway, perhaps the fixes to pipeline handler and application guides are\n>> still worth merging first.\n>>\n>>\n>> Kieran Bingham (2):\n>>    Documentation: pipeline-handler: Fix broken links\n>>    Documentation: application: Update mediactl URL\n>>\n>>   Documentation/guides/application-developer.rst |  2 +-\n>>   Documentation/guides/pipeline-handler.rst      | 12 ++++++------\n>>   2 files changed, 7 insertions(+), 7 deletions(-)\n>>\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 53DBFBE086\n\tfor ;\n\tMon, 4 Aug 2025 08:56:40 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 6AA6B69217;\n\tMon, 4 Aug 2025 10:56:39 +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 96E1661468\n\tfor ;\n\tMon, 4 Aug 2025 10:56:37 +0200 (CEST)","from [192.168.33.13] (185.182.215.213.nat.pool.zt.hu\n\t[185.182.215.213])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 8A241C6D;\n\tMon, 4 Aug 2025 10:55:50 +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=\"surlV+ne\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1754297750;\n\tbh=ZJs1p79nPqyGiKiljnLymww+wumhe9PGEglLOdnG7zM=;\n\th=Date:Subject:From:To:References:In-Reply-To:From;\n\tb=surlV+neApNtVyAD4izZZ1YSMcnYKDUDgkauvg386ru3GyX9WpT5W9d+7nN1ZmEnR\n\t2sU5Y2X50Aq1Q/pWoyuZfJj1UFkZoghx0z9agbMbriTtECrVUR9k34wc047cNPIqrQ\n\tp2n6QHmE+eZcxdYJ9o/m2FlSakwhehvnKXs2UCSE=","Message-ID":"<199f933f-ca94-46d8-9c72-a9f5fbee020f@ideasonboard.com>","Date":"Mon, 4 Aug 2025 10:56:33 +0200","MIME-Version":"1.0","User-Agent":"Mozilla Thunderbird","Subject":"Re: [PATCH 0/2] Documentation/linkcheck fixes","From":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","To":"Kieran Bingham ,\n\tlibcamera devel ","References":"<20250725172130.2218836-1-kieran.bingham@ideasonboard.com>\n\t","Content-Language":"en-US, hu-HU","In-Reply-To":"","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\" "}},{"id":35277,"web_url":"https://patchwork.libcamera.org/comment/35277/","msgid":"<20250804215149.GK30355@pendragon.ideasonboard.com>","date":"2025-08-04T21:51:49","subject":"Re: [PATCH 0/2] Documentation/linkcheck fixes","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Mon, Aug 04, 2025 at 10:56:33AM +0200, Barnabás Pőcze wrote:\n> 2025. 08. 04. 10:22 keltezéssel, Barnabás Pőcze írta:\n> > 2025. 07. 25. 19:21 keltezéssel, Kieran Bingham írta:\n> >> The doxygen build contains a tool to verify links are still valid.\n> >>\n> >> Running this tool presently reports several issues fixed by this series.\n> >>\n> >> You can run it too with:\n> >>\n> >>    ninja -C build/gcc/ Documentation/linkcheck\n> >>\n> >> And I've started an update to the CI to introduce including this -\n> >> however we can't merge that yet - because one of the documents is harder\n> >> to fix than the others.\n> >>\n> >> Documentation/guides/tracing.rst references\n> >> https://lttng.org/docs/#doc-tracing-your-own-user-application and\n> >> https://lttng.org/docs/#doc-viewing-and-analyzing-your-traces-bt which\n> >> seem to be valid URL anchors in a web browser but the tooling reports\n> >> them as invalid. I suspect they may be generated after page load with\n> >> javascript or such that the tooling does not comprehend.\n> > \n> > The cause appears to be that it redirects to https://lttng.org/docs/v2.13/\n> > using javascript. Otherwise I think it would work.\n\nDamn javascript. Everybody should use lynx, that would solve many of our\nissues :-)\n\n> Or one could set\n> \n> linkcheck_anchors_ignore_for_url = (\n> 'https://lttng.org/docs/',\n> )\n\nThat defeats the point of link checks a little bit, but if that's the\nbest we can do... I wonder if it's worth contacting lttng to ask them to\nuse an HTTP redirection.\n\n> in the sphinx configuration and then they pass the check.\n> \n> >> Anyway, perhaps the fixes to pipeline handler and application guides are\n> >> still worth merging first.\n> >>\n> >>\n> >> Kieran Bingham (2):\n> >>    Documentation: pipeline-handler: Fix broken links\n> >>    Documentation: application: Update mediactl URL\n> >>\n> >>   Documentation/guides/application-developer.rst |  2 +-\n> >>   Documentation/guides/pipeline-handler.rst      | 12 ++++++------\n> >>   2 files changed, 7 insertions(+), 7 deletions(-)","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 A5535BE086\n\tfor ;\n\tMon, 4 Aug 2025 21:52:05 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id D0BB369217;\n\tMon, 4 Aug 2025 23:52:04 +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 632056920D\n\tfor ;\n\tMon, 4 Aug 2025 23:52:03 +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 UTF8SMTPSA id C7C669CE;\n\tMon, 4 Aug 2025 23:51:15 +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=\"Xj5H2OSi\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1754344275;\n\tbh=9K6zUcXJ0XRFElmX807G7TZAgWHBiCfC7OJNuV78w04=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=Xj5H2OSi9f9ihIj+bmQgavtOMvQzy+BwFh9CmMhqlWp48I7IIQzITZhNCxi7Qkgtr\n\tOmppVGXbBIVkrsNM02u+vHUSDb4GIcxaKAG7rt/HQ7ekl3O3N6cQhcg16b1lqCCZnk\n\tB0Hbhr1gZ+dYGSxoHyN8KeJ6MFOY3Z/aajXzjSS4=","Date":"Tue, 5 Aug 2025 00:51:49 +0300","From":"Laurent Pinchart ","To":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","Cc":"Kieran Bingham ,\n\tlibcamera devel ","Subject":"Re: [PATCH 0/2] Documentation/linkcheck fixes","Message-ID":"<20250804215149.GK30355@pendragon.ideasonboard.com>","References":"<20250725172130.2218836-1-kieran.bingham@ideasonboard.com>\n\t\n\t<199f933f-ca94-46d8-9c72-a9f5fbee020f@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<199f933f-ca94-46d8-9c72-a9f5fbee020f@ideasonboard.com>","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":35278,"web_url":"https://patchwork.libcamera.org/comment/35278/","msgid":"<20250804223326.GL30355@pendragon.ideasonboard.com>","date":"2025-08-04T22:33:26","subject":"Re: [PATCH 0/2] Documentation/linkcheck fixes","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Tue, Aug 05, 2025 at 12:51:49AM +0300, Laurent Pinchart wrote:\n> On Mon, Aug 04, 2025 at 10:56:33AM +0200, Barnabás Pőcze wrote:\n> > 2025. 08. 04. 10:22 keltezéssel, Barnabás Pőcze írta:\n> > > 2025. 07. 25. 19:21 keltezéssel, Kieran Bingham írta:\n> > >> The doxygen build contains a tool to verify links are still valid.\n> > >>\n> > >> Running this tool presently reports several issues fixed by this series.\n> > >>\n> > >> You can run it too with:\n> > >>\n> > >>    ninja -C build/gcc/ Documentation/linkcheck\n> > >>\n> > >> And I've started an update to the CI to introduce including this -\n> > >> however we can't merge that yet - because one of the documents is harder\n> > >> to fix than the others.\n> > >>\n> > >> Documentation/guides/tracing.rst references\n> > >> https://lttng.org/docs/#doc-tracing-your-own-user-application and\n> > >> https://lttng.org/docs/#doc-viewing-and-analyzing-your-traces-bt which\n> > >> seem to be valid URL anchors in a web browser but the tooling reports\n> > >> them as invalid. I suspect they may be generated after page load with\n> > >> javascript or such that the tooling does not comprehend.\n> > > \n> > > The cause appears to be that it redirects to https://lttng.org/docs/v2.13/\n> > > using javascript. Otherwise I think it would work.\n> \n> Damn javascript. Everybody should use lynx, that would solve many of our\n> issues :-)\n> \n> > Or one could set\n> > \n> > linkcheck_anchors_ignore_for_url = (\n> > 'https://lttng.org/docs/',\n> > )\n> \n> That defeats the point of link checks a little bit, but if that's the\n> best we can do... I wonder if it's worth contacting lttng to ask them to\n> use an HTTP redirection.\n\nApparently we have another issue: the relative links generated by\ndoxylink are not handled nicely by linkcheck. The linkcheck builder\ntries to resolve all relative files path based on the path to the Sphinx\nsource document, while they should be relative to the generated html\ndocuments. One option could be to pass a custom conf.py to set different\nrelative paths when using linkcheck.\n\n> > in the sphinx configuration and then they pass the check.\n> > \n> > >> Anyway, perhaps the fixes to pipeline handler and application guides are\n> > >> still worth merging first.\n> > >>\n> > >>\n> > >> Kieran Bingham (2):\n> > >>    Documentation: pipeline-handler: Fix broken links\n> > >>    Documentation: application: Update mediactl URL\n> > >>\n> > >>   Documentation/guides/application-developer.rst |  2 +-\n> > >>   Documentation/guides/pipeline-handler.rst      | 12 ++++++------\n> > >>   2 files changed, 7 insertions(+), 7 deletions(-)","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 060CDBDCC1\n\tfor ;\n\tMon, 4 Aug 2025 22:33:43 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 60154691D5;\n\tTue, 5 Aug 2025 00:33:42 +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 04F6F691D5\n\tfor ;\n\tTue, 5 Aug 2025 00:33:40 +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 UTF8SMTPSA id 7D8F67F5;\n\tTue, 5 Aug 2025 00:32:52 +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=\"u77091Wl\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1754346772;\n\tbh=Q9F6WId+H/vNYuEaSln8n8AMEJTufHFD1jZXTwXKSQo=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=u77091WlJicE+4miSJROaP+c4egHLX4M6H4jBa78y7ujD423lJGXQMz8CHhGQaPEU\n\tOzpNXU1TnR0qjayrPSCGTBPUBdTaV1SemScvkHhfbvgTQP4w3ZgHHnxKEtE9jdOJpN\n\tUB6my4b3V5ZdDa9uvBHjEeXymiVh1uzgKP+Mrpz4=","Date":"Tue, 5 Aug 2025 01:33:26 +0300","From":"Laurent Pinchart ","To":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","Cc":"Kieran Bingham ,\n\tlibcamera devel ","Subject":"Re: [PATCH 0/2] Documentation/linkcheck fixes","Message-ID":"<20250804223326.GL30355@pendragon.ideasonboard.com>","References":"<20250725172130.2218836-1-kieran.bingham@ideasonboard.com>\n\t\n\t<199f933f-ca94-46d8-9c72-a9f5fbee020f@ideasonboard.com>\n\t<20250804215149.GK30355@pendragon.ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20250804215149.GK30355@pendragon.ideasonboard.com>","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\" "}}]