{"id":2710,"url":"https://patchwork.libcamera.org/api/patches/2710/?format=json","web_url":"https://patchwork.libcamera.org/patch/2710/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20200120125544.12562-3-kieran.bingham@ideasonboard.com>","date":"2020-01-20T12:55:43","name":"[libcamera-devel,2/3] Documentation: Add linkcheck target","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"7e976250c7be6c649dd497a6e2593aec569ed9c4","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/?format=json","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/2710/mbox/","series":[{"id":643,"url":"https://patchwork.libcamera.org/api/series/643/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=643","date":"2020-01-20T12:55:41","name":"CI: Initial gitlab ci builder","version":1,"mbox":"https://patchwork.libcamera.org/series/643/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/2710/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/2710/checks/","tags":{},"headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 2A0CE60804\n\tfor ;\n\tMon, 20 Jan 2020 13:55:49 +0100 (CET)","from localhost.localdomain\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id A9B4F1534;\n\tMon, 20 Jan 2020 13:55:48 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1579524948;\n\tbh=qSfWAoJm1M3l/VHbJR5pTx95asXBASoKqEhZCnNodC8=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=R2uBsfiZ8LPR9qHSOdg8thtrlkYDKmjySCe6QPNw63P8CQAUTzyuB9sZ7YFikvIte\n\tpDlCIL3u0efhiYeFl6VTvoLS5UKwx5gBElIfE4fpd6GrFqpcu+P6vSH0Ip4HXoHZWT\n\tmcdZ7dRJshxVgvaJ4TgAKy2cMiPYB8HT+PeHsMpc=","From":"Kieran Bingham ","To":"LibCamera Devel ","Date":"Mon, 20 Jan 2020 12:55:43 +0000","Message-Id":"<20200120125544.12562-3-kieran.bingham@ideasonboard.com>","X-Mailer":"git-send-email 2.20.1","In-Reply-To":"<20200120125544.12562-1-kieran.bingham@ideasonboard.com>","References":"<20200120125544.12562-1-kieran.bingham@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH 2/3] Documentation: Add linkcheck target","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","X-List-Received-Date":"Mon, 20 Jan 2020 12:55:49 -0000"},"content":"Sphinx provides a run-target to verify external links specified in the\ndocumentation. This requires an active connection to be able to validate\nthe links.\n\nAdd a meson target to integrate the linkcheck facility into our build\nand test system.\n\nSigned-off-by: Kieran Bingham \n\n--\n\nThis can be utilised by automated checks to make sure we don't reference\nany stale links.\n\nThis produces output such as the following:\n\nlibcamera/build$ ninja Documentation/linkcheck\n[1/1] Generating documentation-linkcheck with a custom command.\nRunning Sphinx v1.8.5\nmaking output directory...\nbuilding [mo]: targets for 0 po files that are out of date\nbuilding [linkcheck]: targets for 5 source files that are out of date\nupdating environment: 5 added, 0 changed, 0 removed\nreading sources... [ 20%] api-html/index\nreading sources... [ 40%] coding-style\nreading sources... [ 60%] contributing\nreading sources... [ 80%] docs\nreading sources... [100%] index\n\nlooking for now-outdated files... none found\npickling environment... done\nchecking consistency... done\npreparing documents... done\nwriting output... [ 20%] api-html/index\n\nwriting output... [ 40%] coding-style\n\n(line 20) ok https://www.kernel.org/doc/html/latest/process/coding-style.html\n(line 178) ok https://chromium.googlesource.com/chromium/src/+/master/styleguide/c++/c++.md#object-ownership-and-calling-conventions\n(line 39) ok https://google.github.io/styleguide/cppguide.html\nwriting output... [ 60%] contributing\n\n(line 29) ok https://linuxtv.org/\n(line 12) ok https://lists.libcamera.org/listinfo/libcamera-devel\n(line 42) ok http://www.doxygen.nl\n(line 29) ok https://git.linuxtv.org/libcamera.git/\n(line 42) redirect http://www.sphinx-doc.org - with Found to http://www.sphinx-doc.org/en/master/\n(line 62) ok https://developercertificate.org/\n(line 21) redirect https://webchat.freenode.net/?channels=%23libcamera&uio=d4 - with Found to https://webchat.freenode.net/#%23libcamera\nwriting output... [ 80%] docs\n\nwriting output... [100%] index\n\nbuild succeeded.\n\nLook for any errors in the above output or in Documentation/linkcheck/output.txt\n---\n Documentation/meson.build | 6 ++++++\n 1 file changed, 6 insertions(+)","diff":"diff --git a/Documentation/meson.build b/Documentation/meson.build\nindex 9136506f5d9c..c4e9892470de 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -62,4 +62,10 @@ if sphinx.found()\n build_by_default : true,\n install : true,\n install_dir : doc_install_dir)\n+\n+ custom_target('documentation-linkcheck',\n+ command: [sphinx, '-W', '-b', 'linkcheck', meson.current_source_dir(), '@OUTPUT@'],\n+ build_always_stale: true,\n+ input: docs_sources,\n+ output: 'linkcheck')\n endif\n","prefixes":["libcamera-devel","2/3"]}