Files
rtems/cpukit/sapi/src/version.c
Chris Johns a1c3d4ba8e version: Add the release label interfaces
- Mark the VC key interfaces as deprecated in doxygen

Updates #5037
2024-10-30 22:40:15 +00:00

107 lines
3.1 KiB
C

/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplClassic
*
* @brief This source file contains the implementation of rtems_version(),
* rtems_version_control_key(), rtems_version_major(), rtems_version_minor(),
* and rtems_version_revision().
*
* The version strings are created from the various pieces of version
* information. The main version number is part of the build system
* and is stamped into <rtems/score/cpuopts.h>. The revision label is
* determined by the build system and is a string. It can be used and
* so set when deploying the sources or the release label can be
* formed using the version control tool when the code is not released
* and being built with a version controlled repository.
*/
/*
* Copyright (C) 2017, 2024.
* Chris Johns <chrisj@rtems.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <rtems/version.h>
#include <rtems/score/cpuopts.h>
#include "version-vc-key.h"
const char *rtems_version( void )
{
#ifdef RTEMS_VERSION_CONTROL_KEY
return RTEMS_VERSION "." RTEMS_VERSION_CONTROL_KEY;
#else
return RTEMS_VERSION;
#endif
}
int rtems_version_major( void )
{
return __RTEMS_MAJOR__;
}
int rtems_version_minor( void )
{
return __RTEMS_MINOR__;
}
int rtems_version_revision( void )
{
return __RTEMS_REVISION__;
}
const char *rtems_version_control_key( void )
{
#ifdef RTEMS_VERSION_CONTROL_KEY
return RTEMS_VERSION_CONTROL_KEY;
#else
return "";
#endif
}
const char *rtems_version_release_label( void )
{
/*
* RTEMS 5 and 6 only provide the VC key. The VC key header will be
* moved to `version-release-label.h` after RTEMS 6
*/
#ifdef RTEMS_VERSION_CONTROL_KEY
return RTEMS_VERSION_CONTROL_KEY;
#else
return "";
#endif
}
bool rtems_version_release_label_is_valid( void )
{
const char* release_label = rtems_version_release_label( );
return release_label[ 0 ] != '\0';
}