From patchwork Thu Oct 13 09:59:55 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 17591 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 D42A2C327C for ; Thu, 13 Oct 2022 10:00:05 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id D28B262DB0; Thu, 13 Oct 2022 12:00:03 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1665655204; bh=KHAS4uiEgbbCNfCaSS+BQR7DU43JPBYhGoiWP2rPWH8=; h=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To: From; b=plm3s36MTstHRBAK32wqk/D+Q0OsJhyO3AINT63Ep2Pt/w/PrQsQivpf3WdL8ESqb 1RNspn6ZH5qeXtxZ6cB3vvzmApAIoYH21Y9Xz2ZYUhgx/Vf10FRdiJeimpPufKYYya mSPQ6wYTL2GEi3clnwCl94AbPaIyFS6efHr+sD2jTstcxnlsfIASjjW44yhiDzokjL As8nrWK5upbEKsio0wPmyoBsHaPPG+KOfb41NY8aBubskGxYRKAXt9uIAvmCmD9vRT /CCyciV13l0jsAHGj/Xia8kqA5ThVpw69oDyEM4Lm6eFhBrJV4VzJ3PCCRSDyzKCEA kbmlFgUM5FxTA== Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 62C0462D6B for ; Thu, 13 Oct 2022 12:00:02 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="XlOJynWw"; dkim-atps=neutral Received: from Monstersaurus.ksquared.org.uk.beta.tailscale.net (cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 74F2BBB8; Thu, 13 Oct 2022 12:00:01 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1665655201; bh=KHAS4uiEgbbCNfCaSS+BQR7DU43JPBYhGoiWP2rPWH8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=XlOJynWwcha+/SKCDZ/0CkwggUsivUTvxDrRxEegJM/A5YCt/G2bpt1CV3Vh5mwBq FUnq5iQ9XkrHxHpur/RwSmUzxmk9YUhRIOBMSQSdzsnEv42K8M0dypvNg0h0TLVRTx JK6RL2a9z13lkpt7Wsl84qByxagWBDqNyrWd2NXI= To: libcamera devel Date: Thu, 13 Oct 2022 10:59:55 +0100 Message-Id: <20221013095957.1642901-2-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221013095957.1642901-1-kieran.bingham@ideasonboard.com> References: <20221013095957.1642901-1-kieran.bingham@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v4 1/3] meson: Shared Object version handling 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-Patchwork-Original-From: Kieran Bingham via libcamera-devel From: Kieran Bingham Reply-To: Kieran Bingham Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The libcamera project is not yet ready to declare ABI nor API stability, but it will benefit the community to be able to provide more regular release cycles to determine 'versioned' points of history. Ideally, these releases will be made at any ABI breakage, but can be made at arbitary time based points along the way. To support releases which may not be ABI stable, declare the soversion of both the libcamera and libcamera-base library to be dependant upon both the major minor and patch component of the project version. As part of this, introduce a new 'Versions' summary section to highlight the different version components that may become apparent within any given build. Reviewed-by: Jacopo Mondi Reviewed-by: Laurent Pinchart Signed-off-by: Kieran Bingham --- v4: - Use EXCLUDE_SYMLINKS - Reduce redundant information from Versions summary - -nvm appended when the sources do not match the project version. - Fixed the update of the libcamera source version from the project version in event of mismatch v3: - fix typo - Use libcamera_version directly for SONAME. - Fix ordering of EXCLUDE_PATTERNS - Use meson.project_version() in the event the git versions are incorrect. - No need to present libcamera_version anymore - Guaranteed to be the same as 'project_version' Documentation/Doxyfile.in | 2 ++ meson.build | 32 ++++++++++++++++++++++++++++++++ src/libcamera/base/meson.build | 1 + src/libcamera/meson.build | 1 + 4 files changed, 36 insertions(+) diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in index 88dfcddaebf6..e4f0cd426d39 100644 --- a/Documentation/Doxyfile.in +++ b/Documentation/Doxyfile.in @@ -66,6 +66,8 @@ EXCLUDE_SYMBOLS = libcamera::BoundMethodArgs \ *::details \ std::* +EXCLUDE_SYMLINKS = YES + HTML_OUTPUT = api-html GENERATE_LATEX = NO diff --git a/meson.build b/meson.build index 2c6173b4f97e..9b0966cb04c9 100644 --- a/meson.build +++ b/meson.build @@ -26,6 +26,38 @@ endif libcamera_version = libcamera_git_version.split('+')[0] +# A shallow clone, or a clone without a reachable tag equivalent to the +# meson.project_version() could leave the project in a mis-described state. +# Produce a warning in this event, and fix to a best effort. +if libcamera_version != meson.project_version() + warning('The sources disagree about the version: ' + + libcamera_version + ' != ' + meson.project_version()) + + summary({'libcamera git version' : libcamera_git_version, + 'Source version match' : false, + }, + bool_yn : true, section : 'Versions') + + libcamera_git_version = libcamera_git_version.replace(libcamera_version, + meson.project_version()) + libcamera_version = meson.project_version() + + # Append a marker to show we have modified this version string + libcamera_git_version += '-nvm' +endif + +# Until we make ABI compatible releases, the full libcamera version is used as +# the soname. No ABI/API compatibility is guaranteed between releases. (x.x.x) +# +# When automatic ABI based detection is used to increment the version, this +# will bump the minor number. (x.x) +# +# When we declare a stable ABI/API we will provide a 1.0 release and the +# soversion at that point will be the 'major' release value. (x) +libcamera_soversion = libcamera_version + +summary({ 'Sources': libcamera_git_version, }, section : 'Versions') + # This script generates the .tarball-version file on a 'meson dist' command. meson.add_dist_script('utils/run-dist.sh') diff --git a/src/libcamera/base/meson.build b/src/libcamera/base/meson.build index 7a75914ab2a8..7a7fd7e4ca87 100644 --- a/src/libcamera/base/meson.build +++ b/src/libcamera/base/meson.build @@ -51,6 +51,7 @@ libcamera_base_args = [ '-DLIBCAMERA_BASE_PRIVATE' ] libcamera_base_lib = shared_library('libcamera-base', [libcamera_base_sources, libcamera_base_headers], version : libcamera_version, + soversion : libcamera_soversion, name_prefix : '', install : true, cpp_args : libcamera_base_args, diff --git a/src/libcamera/meson.build b/src/libcamera/meson.build index 7fcbb2ddc9e7..5f39d2e2c60a 100644 --- a/src/libcamera/meson.build +++ b/src/libcamera/meson.build @@ -161,6 +161,7 @@ libcamera_deps = [ libcamera = shared_library('libcamera', libcamera_sources, version : libcamera_version, + soversion : libcamera_soversion, name_prefix : '', install : true, include_directories : includes,