This project provides the version source library as an xPack dependency and includes a header with the µOS++ version information.
The project is hosted on GitHub as micro-os-plus/version-xpack.
This page is addressed to developers who plan to include this source library into their own projects.
For maintainer info, please see the README-MAINTAINER file.
As a source library xPack, the easiest way to add it to a project is via xpm, but it can also be used as any Git project, for example as a submodule.
A recent xpm, which is a portable Node.js command line application.
For details please follow the instructions in the xPack install page.
This package is available from npmjs.com as
@micro-os-plus/version
from the npmjs.com
registry:
cd my-project
xpm init # Unless a package.json is already present
xpm install @micro-os-plus/version@latest
ls -l xpacks/micro-os-plus-version
If, for any reason, xpm is not available, the next recommended
solution is to link it as a Git submodule below an xpacks
folder.
cd my-project
git init # Unless already a Git project
mkdir -p xpacks
git submodule add https://github.com/micro-os-plus/version-xpack.git \
xpacks/micro-os-plus-version
Apart from the unused master
branch, there are two active branches:
xpack
, with the latest stable version (default)xpack-develop
, with the current development version
All development is done in the xpack-develop
branch, and contributions via
Pull Requests should be directed to this branch.
When new releases are published, the xpack-develop
branch is merged
into xpack
.
This source xPack provides a header with the µOS++ version information and the root node for the xPack configuration tree.
The version source library is fully functional.
The project is written in C, and it is expected to be used in C and C++ projects.
The source code was compiled with GCC 11, clang 12, clang 13 and arm-none-eabi-gcc 11, riscv-none-elf-gcc 12, and should be warning free.
To ease the integration of this package into user projects, there are already made CMake and meson configuration files (see below).
For other build systems, consider the following details:
The following folders should be passed to the compiler during the build:
include
The header files to be included in user projects are:
#include <micro-os-plus/version.h>
The source files to be added to the build are:
- none
- none
-std=c++20
or higher for C++ sources-std=c11
for C sources
- none
- none
- none
To integrate the version source library into a CMake application, add this folder to the build:
add_subdirectory("xpacks/micro-os-plus-version")`
The result is an interface library that can be added as an application dependency with:
target_link_libraries(your-target PRIVATE
micro-os-plus::version
)
To integrate the version source library into a meson application, add this folder to the build:
subdir('xpacks/micro-os-plus-version')
The result is a dependency object that can be added to an application with:
exe = executable(
your-target,
link_with: [
# Nothing, not static.
],
dependencies: [
micro_os_plus_version_dependency,
]
)
An example showing how to use the version is available in tests/src/sample-test.cpp.
- none
TODO - add content from template when implemented
According to semver rules:
Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API.
The incompatible changes, in reverse chronological order, are:
- v7.x: the current version
The original content is released under the MIT License, with all rights reserved to Liviu Ionescu.