diff --git a/Documentation/conf.py b/Documentation/conf.py index 970edf3d7298..3ac61a208145 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -23,11 +23,8 @@ project = 'libcamera' copyright = '2018-2019, The libcamera documentation authors' author = u'Kieran Bingham, Jacopo Mondi, Laurent Pinchart, Niklas Söderlund' -# The short X.Y version -version = '' -# The full version, including alpha/beta/rc tags -release = '0.1' - +# Version information is provided by the build environment, through the +# configuration_data (cdata) in Documentation/meson.build # -- General configuration --------------------------------------------------- diff --git a/Documentation/meson.build b/Documentation/meson.build index 629e853120cb..91539b2afd66 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -1,4 +1,4 @@ -doc_install_dir = join_paths(get_option('datadir'), 'doc', 'libcamera-@0@'.format(api_version)) +doc_install_dir = join_paths(get_option('datadir'), 'doc', 'libcamera-@0@'.format(meson.project_version())) # # Doxygen diff --git a/include/libcamera/meson.build b/include/libcamera/meson.build index 15484724df01..c925af7b3f96 100644 --- a/include/libcamera/meson.build +++ b/include/libcamera/meson.build @@ -12,6 +12,7 @@ libcamera_api = files([ 'signal.h', 'stream.h', 'timer.h', + 'version.h', ]) gen_header = files('gen-header.sh') diff --git a/include/libcamera/version.h b/include/libcamera/version.h new file mode 100644 index 000000000000..3075cfb7a6e3 --- /dev/null +++ b/include/libcamera/version.h @@ -0,0 +1,24 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2019, Google Inc. + * + * version.h - Library version information + */ +#ifndef __LIBCAMERA_VERSION_H__ +#define __LIBCAMERA_VERSION_H__ + +#include + +namespace libcamera { + +class LibcameraVersion +{ +public: + std::string toString() const; +}; + +extern const LibcameraVersion version; + +} /* namespace libcamera */ + +#endif /* __LIBCAMERA_VERSION_H__ */ diff --git a/meson.build b/meson.build index a3b0bc820072..c34763162d7d 100644 --- a/meson.build +++ b/meson.build @@ -1,6 +1,8 @@ project('libcamera', 'c', 'cpp', meson_version : '>= 0.40', - version : '0.1', + version : run_command('utils/version-gen', + '@0@'.format(meson.source_root()), + check : true).stdout().strip(), default_options : [ 'werror=true', 'warning_level=2', @@ -8,10 +10,10 @@ project('libcamera', 'c', 'cpp', ], license : 'LGPL 2.1+') -# TODO: Extract this from project.version. -# Ideally the version at Documentation/conf.py should be -# generated from this too. -api_version = '0.1' +vcs = vcs_tag(command: ['utils/version-gen', '.'], + input: 'version.h.in', + output: 'version.h', + fallback: 'v0.0') cc = meson.get_compiler('c') config_h = configuration_data() diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp index cf881ce2e641..09be4b03af45 100644 --- a/src/libcamera/camera_manager.cpp +++ b/src/libcamera/camera_manager.cpp @@ -9,6 +9,7 @@ #include #include +#include #include "device_enumerator.h" #include "event_dispatcher_poll.h" @@ -79,6 +80,8 @@ int CameraManager::start() if (enumerator_) return -EBUSY; + LOG(Camera, Info) << "libcamera version : " << version.toString(); + enumerator_ = DeviceEnumerator::create(); if (!enumerator_ || enumerator_->enumerate()) return -ENODEV; diff --git a/src/libcamera/meson.build b/src/libcamera/meson.build index 45bd9d1793aa..0110f1906bc3 100644 --- a/src/libcamera/meson.build +++ b/src/libcamera/meson.build @@ -28,6 +28,7 @@ libcamera_sources = files([ 'v4l2_device.cpp', 'v4l2_subdevice.cpp', 'v4l2_videodevice.cpp', + 'version.cpp', ]) libcamera_headers = files([ diff --git a/src/libcamera/version.cpp b/src/libcamera/version.cpp new file mode 100644 index 000000000000..d46985c88da5 --- /dev/null +++ b/src/libcamera/version.cpp @@ -0,0 +1,35 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2019, Google Inc. + * + * version.cpp - Version information + */ + +#include + +#include "log.h" + +/* The version header is automatically generated at the base of the project. */ +#include "../../version.h" + +namespace libcamera { + +LOG_DEFINE_CATEGORY(Version) + +/** + * \class LibcameraVersion + * + * Reports library version information + */ + +/** + * \brief Return the library version as a string + */ +std::string LibcameraVersion::toString() const +{ + return LIBCAMERA_VERSION; +} + +const LibcameraVersion version; + +} /* namespace libcamera */ diff --git a/utils/version-gen b/utils/version-gen new file mode 100755 index 000000000000..481616b45c70 --- /dev/null +++ b/utils/version-gen @@ -0,0 +1,37 @@ +#!/bin/sh + +# SPDX-License-Identifier: GPL-2.0-or-later +# Generate a version string using git describe + +if [ -n "$1" ] +then + cd "$1" 2>/dev/null || exit 1 +fi + +# Get a short description from the tree. +version=$(git describe --abbrev=4 --match "v[0-9]*" 2>/dev/null) + +if [ -z "$version" ] +then + # Handle an un-tagged repository + sha=$(git describe --abbrev=4 --always 2>/dev/null) + commits=$(git log --oneline | wc -l 2>/dev/null) + version=v0.0.$commits.$sha +fi + +# Prevent changed timestamps causing -dirty labels +git update-index --refresh > /dev/null 2>&1 +dirty=$(git diff-index --name-only HEAD 2>/dev/null) || dirty= + +# Strip the 'g' +version=$(echo "$version" | sed -e 's/-g/-/g') + +# Fix the '-' (the patch count) to a '.' as a version increment. +version=$(echo "$version" | sed -e 's/-/./g') + +if [ -n "$dirty" ] +then + version=$version-dirty +fi + +echo "$version" diff --git a/version.h.in b/version.h.in new file mode 100644 index 000000000000..ad9134682df6 --- /dev/null +++ b/version.h.in @@ -0,0 +1,14 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2019, Google Inc. + * + * version.h - VCS TAG generated file. + * + * This file is auto-generated. Do not modify. + */ +#ifndef __LIBCAMERA_VERSION_TAG_H__ +#define __LIBCAMERA_VERSION_TAG_H__ + +#define LIBCAMERA_VERSION "@VCS_TAG@" + +#endif // __LIBCAMERA_VERSION_TAG_H__