DML release v0.1.8-beta

intel · Feb 22, 2022 · 5a29563 · 5a29563
1 parent 2bbcac3
commit 5a29563
Show file tree

Hide file tree

Showing 171 changed files with 2,192 additions and 2,464 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,32 +1,19 @@
+# Copyright (C) 2021 Intel Corporation
 #
-# Copyright 2020-2021 Intel Corporation.
-#
-# This software and the related documents are Intel copyrighted materials,
-# and your use of them is governed by the express license under which they
-# were provided to you ("License"). Unless the License provides otherwise,
-# you may not use, modify, copy, publish, distribute, disclose or transmit
-# this software or the related documents without Intel's prior written
-# permission.
-#
-# This software and the related documents are provided as is, with no
-# express or implied warranties, other than those that are expressly
-# stated in the License.
-#
+# SPDX-License-Identifier: MIT
 
 cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
-project(Dml VERSION 0.1.7 LANGUAGES C CXX)
+project(Dml VERSION 0.1.8 LANGUAGES C CXX)
 
 set(PROJECT_SOVERSION 0)
 
-option(DML_HW "Build hardware path or not" OFF)
-option(DML_SUPPRESS_WARNINGS "Suppress all compiler warnings" OFF)
-
 if (CMAKE_C_COMPILER_ID STREQUAL "GNU")
     option(DML_RECORD_SWITCHES "Enables -frecord-gcc-switches flag" OFF)
 else()
     set(DML_RECORD_SWITCHES OFF CACHE BOOL "Disable recording of switches for non-gnu compiler" FORCE)
 endif()
 
+# TODO: Remove all options below
 option(LOG_HW_INIT "Enables HW initialization log" OFF)
 option(EFFICIENT_WAIT "Enables usage of umonitor/umwait" OFF)
 
@@ -55,17 +42,13 @@ add_compile_options(
 add_compile_definitions(${DML_SECURITY_DEFINITIONS})
 
 message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
-
-# TODO: Remove when option is removed
-if (DML_HW)
-    message(STATUS "HW path: ON")
-    message(STATUS "Hardware initialization logging: ${LOG_HW_INIT}")
-endif()
+message(STATUS "Hardware initialization logging: ${LOG_HW_INIT}")
 
 # TODO: Remove
 get_git_revision()
 
 add_subdirectory(sources)
+add_subdirectory(examples)
 
 # Install rules
 install(EXPORT ${PROJECT_NAME}Targets

diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1,14 +1,3 @@
+# Copyright (C) 2021 Intel Corporation
 #
-# Copyright 2020-2021 Intel Corporation.
-#
-# This software and the related documents are Intel copyrighted materials,
-# and your use of them is governed by the express license under which they
-# were provided to you ("License"). Unless the License provides otherwise,
-# you may not use, modify, copy, publish, distribute, disclose or transmit
-# this software or the related documents without Intel's prior written
-# permission.
-#
-# This software and the related documents are provided as is, with no
-# express or implied warranties, other than those that are expressly
-# stated in the License.
-#
+# SPDX-License-Identifier: MIT
diff --git a/Doxyfile b/Doxyfile
@@ -1,17 +1,6 @@
+# Copyright (C) 2021 Intel Corporation
 #
-# Copyright 2020-2021 Intel Corporation.
-#
-# This software and the related documents are Intel copyrighted materials,
-# and your use of them is governed by the express license under which they
-# were provided to you ("License"). Unless the License provides otherwise,
-# you may not use, modify, copy, publish, distribute, disclose or transmit
-# this software or the related documents without Intel's prior written
-# permission.
-#
-# This software and the related documents are provided as is, with no
-# express or implied warranties, other than those that are expressly
-# stated in the License.
-#
+# SPDX-License-Identifier: MIT
 
 # Doxyfile 1.8.17
 
@@ -53,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.7-beta"
+PROJECT_NUMBER         = "v0.1.8-beta"
 
 # 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/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright(c) 2021 Intel Corporation
+Copyright (C) 2021 Intel Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/cmake/CompileOptions.cmake b/cmake/CompileOptions.cmake
@@ -1,17 +1,6 @@
+# Copyright (C) 2021 Intel Corporation
 #
-# Copyright 2018-2021 Intel Corporation.
-#
-# This software and the related documents are Intel copyrighted materials,
-# and your use of them is governed by the express license under which they
-# were provided to you ("License"). Unless the License provides otherwise,
-# you may not use, modify, copy, publish, distribute, disclose or transmit
-# this software or the related documents without Intel's prior written
-# permission.
-#
-# This software and the related documents are provided as is, with no
-# express or implied warranties, other than those that are expressly
-# stated in the License.
-#
+# SPDX-License-Identifier: MIT
 
 function(modify_standard_language_flag)
     # Declaring function parameters

diff --git a/cmake/gnu.cmake b/cmake/gnu.cmake
@@ -1,17 +1,6 @@
+# Copyright (C) 2021 Intel Corporation
 #
-# Copyright 2021 Intel Corporation.
-#
-# This software and the related documents are Intel copyrighted materials,
-# and your use of them is governed by the express license under which they
-# were provided to you ("License"). Unless the License provides otherwise,
-# you may not use, modify, copy, publish, distribute, disclose or transmit
-# this software or the related documents without Intel's prior written
-# permission.
-#
-# This software and the related documents are provided as is, with no
-# express or implied warranties, other than those that are expressly
-# stated in the License.
-#
+# SPDX-License-Identifier: MIT
 
 list(APPEND DML_SECURITY_OPTIONS
     -fPIC

diff --git a/cmake/msvc.cmake b/cmake/msvc.cmake
@@ -1,17 +1,6 @@
+# Copyright (C) 2021 Intel Corporation
 #
-# Copyright 2021 Intel Corporation.
-#
-# This software and the related documents are Intel copyrighted materials,
-# and your use of them is governed by the express license under which they
-# were provided to you ("License"). Unless the License provides otherwise,
-# you may not use, modify, copy, publish, distribute, disclose or transmit
-# this software or the related documents without Intel's prior written
-# permission.
-#
-# This software and the related documents are provided as is, with no
-# express or implied warranties, other than those that are expressly
-# stated in the License.
-#
+# SPDX-License-Identifier: MIT
 
 list(APPEND DML_SECURITY_OPTIONS
     /GS

diff --git a/cmake/utils.cmake b/cmake/utils.cmake
@@ -1,17 +1,6 @@
+# Copyright (C) 2021 Intel Corporation
 #
-# Copyright 2018-2021 Intel Corporation.
-#
-# This software and the related documents are Intel copyrighted materials,
-# and your use of them is governed by the express license under which they
-# were provided to you ("License"). Unless the License provides otherwise,
-# you may not use, modify, copy, publish, distribute, disclose or transmit
-# this software or the related documents without Intel's prior written
-# permission.
-#
-# This software and the related documents are provided as is, with no
-# express or implied warranties, other than those that are expressly
-# stated in the License.
-#
+# SPDX-License-Identifier: MIT
 
 macro(get_git_revision)
     # Find git revision

diff --git a/doc/_get_docs.sh b/doc/_get_docs.sh
@@ -1,18 +1,8 @@
 #!/bin/bash
 # ==========================================================================
-#  Copyright 2020-2021 Intel Corporation.
-# 
-#  This software and the related documents are Intel copyrighted materials,
-#  and your use of them is governed by the express license under which they
-#  were provided to you ("License"). Unless the License provides otherwise,
-#  you may not use, modify, copy, publish, distribute, disclose or transmit
-#  this software or the related documents without Intel's prior written
-#  permission.
-# 
-#  This software and the related documents are provided as is, with no
-#  express or implied warranties, other than those that are expressly
-#  stated in the License.
-# 
+# Copyright (C) 2021 Intel Corporation
+#
+# SPDX-License-Identifier: MIT
 # ==========================================================================
 
 set -ex

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1,7 @@
+# Copyright (C) 2021 Intel Corporation
+#
+# SPDX-License-Identifier: MIT
+
+breathe==4.31.0
+Sphinx==4.3.2
+sphinx-book-theme==0.2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -1,17 +1,7 @@
 # ==========================================================================
-#  Copyright 2020-2021 Intel Corporation.
-#
-#  This software and the related documents are Intel copyrighted materials,
-#  and your use of them is governed by the express license under which they
-#  were provided to you ("License"). Unless the License provides otherwise,
-#  you may not use, modify, copy, publish, distribute, disclose or transmit
-#  this software or the related documents without Intel's prior written
-#  permission.
-#
-#  This software and the related documents are provided as is, with no
-#  express or implied warranties, other than those that are expressly
-#  stated in the License.
+# Copyright (C) 2021 Intel Corporation
 #
+# SPDX-License-Identifier: MIT
 # ==========================================================================
 
 # -- Path setup --------------------------------------------------------------
@@ -30,12 +20,11 @@
 project = 'Intel® DML'
 copyright = '2022, Intel'
 author = 'Intel'
-release = 'v0.1.7-beta'
+release = 'v0.1.8-beta'
 
 # -- General configuration ---------------------------------------------------
 
 extensions = [
-    'sphinx_rtd_theme',
     'breathe'
 ]
 templates_path = ['_templates']
@@ -62,10 +51,16 @@
 
 # -- Options for HTML output -------------------------------------------------
 
-import sphinx_rtd_theme
+html_theme = "sphinx_book_theme"
 
-html_theme = 'sphinx_rtd_theme'
-# html_theme = 'sphinx_book_theme'
+html_theme_options = {
+    'repository_url': 'https://github.com/intel/DML',
+    'path_to_docs': 'doc/source',
+    'use_issues_button': True,
+    'use_edit_page_button': True,
+    'repository_branch': 'develop',
+    'extra_footer': '<p align="right"><a href="https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html">Cookies</a></p>'
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/doc/source/documentation/api_docs/high_level_api.rst b/doc/source/documentation/api_docs/high_level_api.rst
@@ -1,17 +1,7 @@
  .. ***************************************************************************
- .. * Copyright 2020-2021 Intel Corporation.
- .. *
- .. * This software and the related documents are Intel copyrighted materials,
- .. * and your use of them is governed by the express license under which they
- .. * were provided to you ("License"). Unless the License provides otherwise,
- .. * you may not use, modify, copy, publish, distribute, disclose or transmit
- .. * this software or the related documents without Intel's prior written
- .. * permission.
- .. *
- .. * This software and the related documents are provided as is, with no
- .. * express or implied warranties, other than those that are expressly
- .. * stated in the License.
+ .. * Copyright (C) 2021 Intel Corporation
  .. *
+ .. * SPDX-License-Identifier: MIT
  .. ***************************************************************************/
 
 High-level C++ API

diff --git a/doc/source/documentation/api_docs/low_level_api.rst b/doc/source/documentation/api_docs/low_level_api.rst
@@ -1,17 +1,7 @@
  .. ***************************************************************************
- .. * Copyright 2020-2021 Intel Corporation.
- .. *
- .. * This software and the related documents are Intel copyrighted materials,
- .. * and your use of them is governed by the express license under which they
- .. * were provided to you ("License"). Unless the License provides otherwise,
- .. * you may not use, modify, copy, publish, distribute, disclose or transmit
- .. * this software or the related documents without Intel's prior written
- .. * permission.
- .. *
- .. * This software and the related documents are provided as is, with no
- .. * express or implied warranties, other than those that are expressly
- .. * stated in the License.
+ .. * Copyright (C) 2021 Intel Corporation
  .. *
+ .. * SPDX-License-Identifier: MIT
  .. ***************************************************************************/
 
 Low-level C API
@@ -22,8 +12,8 @@ Introduction
 ************
 
 
-This document provides instructions on how to use the Intel® Data Mover
-Library. It describes general usage concepts, main entities and
+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
@@ -116,7 +106,7 @@ where:
 -  ``path`` - has type ``dml_path_t`` and supports the following values:
 
    -  ``DML_PATH_HW`` – all hardware-supported features are executed
-      by Intel® DSA
+      by Intel® Data Streaming Accelerator
    -  ``DML_PATH_SW`` – all supported features are executed by the
       software path of the library
    -  ``DML_PATH_AUTO`` – the library automatically dispatches execution

diff --git a/doc/source/documentation/general_docs/notices.rst b/doc/source/documentation/general_docs/notices.rst
@@ -1,17 +1,7 @@
  .. ***************************************************************************
- .. * Copyright 2020-2021 Intel Corporation.
- .. *
- .. * This software and the related documents are Intel copyrighted materials,
- .. * and your use of them is governed by the express license under which they
- .. * were provided to you ("License"). Unless the License provides otherwise,
- .. * you may not use, modify, copy, publish, distribute, disclose or transmit
- .. * this software or the related documents without Intel's prior written
- .. * permission.
- .. *
- .. * This software and the related documents are provided as is, with no
- .. * express or implied warranties, other than those that are expressly
- .. * stated in the License.
+ .. * Copyright (C) 2021 Intel Corporation
  .. *
+ .. * SPDX-License-Identifier: MIT
  .. ***************************************************************************/
 
 No license (express or implied, by estoppel or otherwise) to any

diff --git a/doc/source/documentation/get_started_docs/code_samples_and_examples.rst b/doc/source/documentation/get_started_docs/code_samples_and_examples.rst
@@ -1,17 +1,7 @@
  .. ***************************************************************************
- .. * Copyright 2020-2021 Intel Corporation.
- .. *
- .. * This software and the related documents are Intel copyrighted materials,
- .. * and your use of them is governed by the express license under which they
- .. * were provided to you ("License"). Unless the License provides otherwise,
- .. * you may not use, modify, copy, publish, distribute, disclose or transmit
- .. * this software or the related documents without Intel's prior written
- .. * permission.
- .. *
- .. * This software and the related documents are provided as is, with no
- .. * express or implied warranties, other than those that are expressly
- .. * stated in the License.
+ .. * Copyright (C) 2021 Intel Corporation
  .. *
+ .. * SPDX-License-Identifier: MIT
  .. ***************************************************************************/
 
 Code Samples and examples