Update DML version to 1.0.0 (#260)

intel · Mar 30, 2023 · 6086665 · 6086665
1 parent 7096c54
commit 6086665
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 39 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -8,9 +8,7 @@ if (UNIX AND "${SANITIZE_THREADS}" STREQUAL "ON")
 else ()
     cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
 endif ()
-project(Dml VERSION 0.1.9 LANGUAGES C CXX)
-
-set(PROJECT_SOVERSION 0)
+project(DML VERSION 1.0.0 LANGUAGES C CXX)
 
 if (CMAKE_C_COMPILER_ID STREQUAL "GNU")
     option(DML_RECORD_SWITCHES "Enables -frecord-gcc-switches flag" OFF)
@@ -77,7 +75,7 @@ message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
 
 # Install rules
 install(EXPORT ${PROJECT_NAME}Targets
-        NAMESPACE Dml::
+        NAMESPACE DML::
         DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})
 
 file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake

diff --git a/Doxyfile b/Doxyfile
@@ -42,7 +42,7 @@ PROJECT_NAME           = "Intel DML Library"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "v0.1.9-beta"
+PROJECT_NUMBER         = "v1.0.0"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -20,7 +20,7 @@
 project = 'Intel® DML'
 copyright = '2022, Intel'
 author = 'Intel'
-release = 'v0.1.9-beta'
+release = 'v1.0.0'
 
 # -- General configuration ---------------------------------------------------
 

diff --git a/doc/source/documentation/api_docs/high_level_api.rst b/doc/source/documentation/api_docs/high_level_api.rst
@@ -14,17 +14,8 @@ This document provides quick introduction into usage of High Level API
 for Intel® DML. It describes general usage concepts, main entities and
 detailed operation descriptions.
 
-For general introduction to Intel® DML, see `Introduction
-<../introduction_docs/introduction.html>`__.
+For general introduction to Intel® DML, see :ref:`introduction_reference_link`.
 
-Disclaimer
-===========
-
-
-The library exists in a prototype form and is being actively
-developed. This means that some of the things described here may change
-in the future. However, the library is released now with the expectation
-that it will be more useful than nothing to people who may use it.
 
 Header Files
 ************
@@ -320,8 +311,8 @@ No-op operation
 ---------------
 
 
-The No-op operation can be used in a batch operation to ensure that all 
-previous operations in the batch completed before the no-op. 
+The No-op operation can be used in a batch operation to ensure that all
+previous operations in the batch completed before the no-op.
 
 This could be useful for ensuring the order of non-independent operations.
 Like using the destination of a previous operation as the source of another.

diff --git a/doc/source/documentation/api_docs/low_level_api.rst b/doc/source/documentation/api_docs/low_level_api.rst
@@ -16,17 +16,8 @@ This document provides instructions on how to use the Intel® Data Mover Library
 It describes general usage concepts, main entities and
 detailed operation descriptions.
 
-For general introduction to Intel® DML, see `Introduction
-<../introduction_docs/introduction.html>`__.
+For general introduction to Intel® DML, see :ref:`introduction_reference_link`.
 
-Disclaimer
-===========
-
-
-The library exists in a prototype form and is being actively
-developed. This means that some of the things described here may change
-in the future. However, the library is released now with the expectation
-that it will be more useful than nothing to people who may use it.
 
 Header Files
 ************

diff --git a/doc/source/documentation/introduction_docs/introduction.rst b/doc/source/documentation/introduction_docs/introduction.rst
@@ -4,6 +4,8 @@
  .. * SPDX-License-Identifier: MIT
  .. ***************************************************************************/
 
+.. _introduction_reference_link:
+
 Introduction
 ############
 

diff --git a/sources/c_api/CMakeLists.txt b/sources/c_api/CMakeLists.txt
@@ -36,11 +36,11 @@ get_git_revision()
 
 set_property(
         SOURCE dml_get_library_version.cpp APPEND
-        PROPERTY COMPILE_DEFINITIONS DML_GIT_REVISION="${GIT_REV}")
+        PROPERTY COMPILE_DEFINITIONS DML_GIT_REVISION="${GIT_REV}"
+        PROPERTY COMPILE_DEFINITIONS DML_LIBRARY_VERSION="${CMAKE_PROJECT_VERSION}")
 
 set_target_properties(dml PROPERTIES
-        VERSION ${PROJECT_VERSION}
-        SOVERSION ${PROJECT_SOVERSION})
+        VERSION ${PROJECT_VERSION})
 
 install(TARGETS dml
         EXPORT ${PROJECT_NAME}Targets

diff --git a/sources/c_api/dml_get_library_version.cpp b/sources/c_api/dml_get_library_version.cpp
@@ -15,17 +15,14 @@
 /** Name of the library*/
 #define DML_LIBRARY_NAME "Intel(R) DML Software Library"
 
-/** Version of the library*/
-#define DML_LIBRARY_VERSION "Beta"
-
 /** Major version of the library*/
-#define DML_LIBRARY_MAJOR_VERSION 0u
+#define DML_LIBRARY_MAJOR_VERSION 1u
 
 /** Minor version of the library*/
-#define DML_LIBRARY_MINOR_VERSION 1u
+#define DML_LIBRARY_MINOR_VERSION 0u
 
 /** Minor version of the library*/
-#define DML_LIBRARY_PATCH 9u
+#define DML_LIBRARY_PATCH 0u
 
 /** Supported CPU ISA */
 #define DML_LIBRARY_MINIMAL_CPU_ISA "N/A"

diff --git a/sources/cpp_api/CMakeLists.txt b/sources/cpp_api/CMakeLists.txt
@@ -28,8 +28,7 @@ set_target_properties(dmlhl PROPERTIES
         CXX_STANDARD 17
         CXX_STANDARD_REQUIRED ON
         CXX_EXTENSIONS OFF
-        VERSION ${PROJECT_VERSION}
-        SOVERSION ${PROJECT_SOVERSION})
+        VERSION ${PROJECT_VERSION})
 
 install(TARGETS dmlhl
         EXPORT ${PROJECT_NAME}Targets