DML release v0.1.7-beta

Author: Smirnov1gor

CMakeLists.txt

@@ -14,7 +14,7 @@
 #
 
 cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
-project(Dml VERSION 0.1.6 LANGUAGES C CXX)
+project(Dml VERSION 0.1.7 LANGUAGES C CXX)
 
 set(PROJECT_SOVERSION 0)
 
@@ -27,7 +27,6 @@ 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)
 
@@ -67,7 +66,6 @@ endif()
 get_git_revision()
 
 add_subdirectory(sources)
-add_subdirectory(examples)
 
 # Install rules
 install(EXPORT ${PROJECT_NAME}Targets

Doxyfile

@@ -53,7 +53,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.6-beta"
+PROJECT_NUMBER         = "v0.1.7-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
@@ -73,7 +73,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = doc
+OUTPUT_DIRECTORY       = doc/build
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -831,14 +831,7 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = examples \
-                         README.md \
-                         CONTRIBUTING.md \
-                         SECURITY.md \
-                         include \
-                         doc/LOW_LEVEL_API_GUIDE.md \
-                         doc/HIGH_LEVEL_API_GUIDE.md \
-                         doc/DML_REFERENCE_MANUAL.md \
-                         doc/RELEASE_NOTES.md
+                         include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -960,12 +953,15 @@ EXCLUDE_SYMBOLS        = *_H__ \
                          DML_CORE_CHECK_* \
                          DML_BAD_* \
                          DML_PACKED_STRUCT_DECLARATION* \
+                         TEST_REGISTER* \
                          NULL \
                          DML_FUN \
                          OWN_API \
                          OWN_FUN \
                          OWN_API_INLINE \
-                         OWN_FUN_INLINE
+                         OWN_FUN_INLINE \
+                         DML_JOB_API_TEST_REGISTER \
+                         DML_UNIT_TEST_REGISTER
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
 # that contain example code fragments that are included (see the \include
@@ -1161,15 +1157,15 @@ IGNORE_PREFIX          =
 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
 # The default value is: YES.
 
-GENERATE_HTML          = YES
+GENERATE_HTML          = NO
 
 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
 # it.
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = html
+HTML_OUTPUT            = doxygen_html
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).
@@ -2024,15 +2020,15 @@ MAN_LINKS              = NO
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
-GENERATE_XML           = NO
+GENERATE_XML           = YES
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
 # it.
 # The default directory is: xml.
 # This tag requires that the tag GENERATE_XML is set to YES.
 
-XML_OUTPUT             = xml
+XML_OUTPUT             = doxygen_xml
 
 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
 # listings (including syntax highlighting and cross-referencing information) to

README.md

@@ -1,97 +1,35 @@
 Intel® Data Mover Library (Intel® DML) Beta
 =================================================
-[Get Started](#get-started) | [Documentation](#documentation) | [License](#license) | [GitHub repository](https://github.com/intel-innersource/libraries.performance.accelerators.dml.dml-library.git)
+[Get Started](#get-started) | [Documentation](#documentation) | [License](#license) | [GitHub repository](https://github.com/intel/DML)
 
 Intel® Data Mover Library (Intel® DML) is an open-source library to provide high-performance data manipulation on Intel CPUs. Intel® DML is intended for streaming data movement and transformation operations optimization that is applicable for effective storage, networking, persistent memory, and various data processing applications. 
 
 ## Get Started
 
-### Prerequisites
+To get started with Intel DML, follow instructions below:
 
-To build the library, make sure all system and build requirements are set up.
-See [Library Presetting](./doc/DML_REFERENCE_MANUAL.md#library-presetting) section for the list of all requirements.
+1. Make sure your system meets all [System Requirements](https://intel.github.io/DML/documentation/introduction_docs/system_requirements.html).
 
-### Build
+2. Follow instructions to build the library. See [Installation](https://intel.github.io/DML/documentation/get_started_docs/installation.html) for more details.
 
-To build the library, complete the following steps:
+## Documentation 
 
-1.  Make sure that all the tools from the Prerequisites section are available from your environment.
+### Online Documentation
 
-2.  Extract git sources using the following command:
+Documentation is delivered using GitHub Pages. See full Intel DML [online documentation](https://intel.github.io/DML/index.html).
 
-```shell
-git clone --recursive https://github.com/intel/DML.git
-```
-
-3.  Build the library and tests by executing the following list of commands from \<dml_library\>:
-
-#### Windows* OS 
-
-```shell
-mkdir build
-cd build
-cmake -DCMAKE_INSTALL_PREFIX=<install_dir> -G "NMake Makefiles" ..
-cmake --build . --target install
-```
-
-#### Linux* OS 
-
-```shell
-mkdir build
-cd build
-cmake -DCMAKE_INSTALL_PREFIX=<install_dir> ..
-cmake --build . --target install
-```
-
-Note: If you need to build a particular type of the library and tests (`DEBUG`|`RELEASE`), use the `CMAKE_BUILD_TYPE` flag as follows:
-
-```shell
-# Debug
-cmake -DCMAKE_BUILD_TYPE=Debug <path_to_cmake_folder>
-
-# Release
-cmake -DCMAKE_BUILD_TYPE=Release <path_to_cmake_folder>
+### Offline Documentation
 
-# Release with debug information
-cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo <path_to_cmake_folder>
-```
-
-Note: 
-- CMake generates the script for release build as default.
-
-- On Linux* OS, the default `<install_dir>` is `/usr/local/`.
-
-- The library builds by default with software path only. If you need to build the library with enabled hardware, use the DML_HW option as follows:
+**Note**: Before building Intel DML offline documentation, make sure you have all documentation generation tools properly installed and set up. See, [Documentation Build Prerequisites](https://intel.github.io/DML/documentation/get_started_docs/installation.html#documentation-build-prerequisites) for more details.
 
-```shell
-# Enable hardware path
-cmake -DCMAKE_BUILD_TYPE=Release -DDML_HW=ON <path_to_cmake_folder>
-```
-
-- To enable `-frecord-gcc-switches` flag, use the DML_RECORD_SWITCHES option as follows:
+To generate full offline documentation from sources, use the following commands:
 
 ```shell
-# Enable -frecord-gcc-switches
-cmake -DCMAKE_BUILD_TYPE=Release -DDML_RECORD_SWITCHES=ON <path_to_cmake_folder>
+cmd> cd <dml_library catalog path>/doc
+cmd> _get_docs.sh
 ```
 
-The resulting library is available in the `<install_dir>/lib` folder.
-
-## Documentation
-
-- [Intel DML Reference Manual](./doc/DML_REFERENCE_MANUAL.md)
-- [Security Policy](./SECURITY.md) 
-
-To generate full documentation from sources with Doxygen, use the following commands:
-
-```shell
-cmd> cd <dml_library catalog path>
-cmd> doxygen ./Doxyfile
-```
-
-To open the generated HTML Reference, open the `<dml_library>/doc/html/index.html` file.
-
-***Note:*** You can find the Doxygen processor at [Doxygen official site](http://www.doxygen.nl/).
+After generation process is completed, open the `<dml_library>/doc/build/html/index.html` file.
 
 ## How to Contribute