From patchwork Fri Jul 25 17:51:04 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 23972 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id B9B18BDCC1 for ; Fri, 25 Jul 2025 17:51:14 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id EC5E56910A; Fri, 25 Jul 2025 19:51:13 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="T9v1gLC7"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 03349690A6 for ; Fri, 25 Jul 2025 19:51:12 +0200 (CEST) Received: from Monstersaurus.lan (cpc89244-aztw30-2-0-cust6594.18-1.cable.virginm.net [86.31.185.195]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id D850DC66; Fri, 25 Jul 2025 19:50:32 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1753465833; bh=Qjk/TDfx8BqgLOiLkQfXHMEtxzKtNvrwATxY4wwiO68=; h=From:To:Cc:Subject:Date:From; b=T9v1gLC77hei1M9BAZDe2XRkBTIhs8+q2Y6TyG9DsUywYS9/M5VC3IMydXiwr5kmp d7UQ4RkQzCf814zyMllrVJxz+K4aNLJgJeVTJfEdPWI9ygP5vb4kPlELUxB2Emn3vc hDBbAAIizIfH1six/KArfkywHFRAB0HGxwA76yGQ= From: Kieran Bingham To: libcamera devel Cc: Kieran Bingham Subject: [RFC PATCH] documentation: Split documentation build task Date: Fri, 25 Jul 2025 18:51:04 +0100 Message-ID: <20250725175107.2301710-1-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.49.0 MIME-Version: 1.0 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: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Update the CI to split out the documentation task and include a link-check call. Signed-off-by: Kieran Bingham --- I can't currently get a clean run on the link-check so ... this isn't mergeable yet - but posting for RFC already so that in the event we could clean up the linkcheck we could include it to prevent link regressions creeping in. I do also like the idea of splitting out the doxygen build anyway so that documentation failures aren't shown simply in a GCC 12 build... .gitlab-ci/build-documentation.sh | 28 ++++++++++++++++++++++++++++ gitlab-ci.yml | 20 ++++++++++++++++++-- 2 files changed, 46 insertions(+), 2 deletions(-) create mode 100755 .gitlab-ci/build-documentation.sh diff --git a/.gitlab-ci/build-documentation.sh b/.gitlab-ci/build-documentation.sh new file mode 100755 index 000000000000..33484bd48c0a --- /dev/null +++ b/.gitlab-ci/build-documentation.sh @@ -0,0 +1,28 @@ +#!/bin/bash + +# SPDX-License-Identifier: GPL-2.0-or-later +# SPDX-FileCopyrightText: © 2025 Kieran Bingham +# +# Build libcamera Documentation only and perform a link check + +set -e + +source "$(dirname "$0")/lib.sh" +source "$(dirname "$0")/build-libcamera-common.sh" + +libcamera_documentation() { + echo "Building libcamera documentation" + + meson compile -C build documentation +} + +libcamera_documentation_linkcheck() { + echo "Documentation link-check" + + meson compile -C build documentation-linkcheck +} + +run libcamera_install_pkgs collapsed +run libcamera_setup collapsed +run libcamera_documentation +run libcamera_documentation_linkcheck diff --git a/gitlab-ci.yml b/gitlab-ci.yml index ceb0fd215b89..777456529ac3 100644 --- a/gitlab-ci.yml +++ b/gitlab-ci.yml @@ -170,7 +170,6 @@ build-full:debian:12: variables: MESON_OPTIONS: >- ${MESON_ALL_OPTIONS} - -D doc_werror=true parallel: matrix: - ARCH: amd64 @@ -312,9 +311,26 @@ build-package:cros: dotenv: env # ------------------------------------------------------------------------------ -# Lint stage - Run checkstyle.py and check merge suitability +# Lint stage - Run checkstyle.py and check merge suitability and validate Docs # ------------------------------------------------------------------------------ +documentation: + extends: + - .fdo.distribution-image@debian + - .libcamera-ci.scripts + - .libcamera-ci.debian:12 + stage: lint + needs: + - job: container-debian:12 + artifacts: false + script: + - $CI_PROJECT_DIR/.gitlab-ci/build-documentation.sh + variables: + BUILD_TYPE: release + MESON_OPTIONS: >- + ${MESON_ALL_OPTIONS} + -D doc_werror=true + lint: extends: - .fdo.distribution-image@debian