From patchwork Mon Jan 20 12:55:43 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 2710 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 2A0CE60804 for ; Mon, 20 Jan 2020 13:55:49 +0100 (CET) Received: from localhost.localdomain (cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id A9B4F1534; Mon, 20 Jan 2020 13:55:48 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1579524948; bh=qSfWAoJm1M3l/VHbJR5pTx95asXBASoKqEhZCnNodC8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=R2uBsfiZ8LPR9qHSOdg8thtrlkYDKmjySCe6QPNw63P8CQAUTzyuB9sZ7YFikvIte pDlCIL3u0efhiYeFl6VTvoLS5UKwx5gBElIfE4fpd6GrFqpcu+P6vSH0Ip4HXoHZWT mcdZ7dRJshxVgvaJ4TgAKy2cMiPYB8HT+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 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: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 20 Jan 2020 12:55:49 -0000 Sphinx provides a run-target to verify external links specified in the documentation. This requires an active connection to be able to validate the links. Add a meson target to integrate the linkcheck facility into our build and test system. Signed-off-by: Kieran Bingham Reviewed-by: Laurent Pinchart --- This can be utilised by automated checks to make sure we don't reference any stale links. This produces output such as the following: libcamera/build$ ninja Documentation/linkcheck [1/1] Generating documentation-linkcheck with a custom command. Running Sphinx v1.8.5 making output directory... building [mo]: targets for 0 po files that are out of date building [linkcheck]: targets for 5 source files that are out of date updating environment: 5 added, 0 changed, 0 removed reading sources... [ 20%] api-html/index reading sources... [ 40%] coding-style reading sources... [ 60%] contributing reading sources... [ 80%] docs reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 20%] api-html/index writing output... [ 40%] coding-style (line 20) ok https://www.kernel.org/doc/html/latest/process/coding-style.html (line 178) ok https://chromium.googlesource.com/chromium/src/+/master/styleguide/c++/c++.md#object-ownership-and-calling-conventions (line 39) ok https://google.github.io/styleguide/cppguide.html writing output... [ 60%] contributing (line 29) ok https://linuxtv.org/ (line 12) ok https://lists.libcamera.org/listinfo/libcamera-devel (line 42) ok http://www.doxygen.nl (line 29) ok https://git.linuxtv.org/libcamera.git/ (line 42) redirect http://www.sphinx-doc.org - with Found to http://www.sphinx-doc.org/en/master/ (line 62) ok https://developercertificate.org/ (line 21) redirect https://webchat.freenode.net/?channels=%23libcamera&uio=d4 - with Found to https://webchat.freenode.net/#%23libcamera writing output... [ 80%] docs writing output... [100%] index build succeeded. Look for any errors in the above output or in Documentation/linkcheck/output.txt --- Documentation/meson.build | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/meson.build b/Documentation/meson.build index 9136506f5d9c..c4e9892470de 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -62,4 +62,10 @@ if sphinx.found() build_by_default : true, install : true, install_dir : doc_install_dir) + + custom_target('documentation-linkcheck', + command: [sphinx, '-W', '-b', 'linkcheck', meson.current_source_dir(), '@OUTPUT@'], + build_always_stale: true, + input: docs_sources, + output: 'linkcheck') endif