Update documentation

_sources/building_and_running_tests.rst

@@ -23,9 +23,9 @@ following:
 
   git clone https://github.com/Reference-LAPACK/lapack.git 
   cd lapack; mkdir -p build; cd build 
-  cmake -DCMAKE_INSTALL_PREFIX=~/lapack -DCBLAS=True -DLAPACK=True -DLAPACKE=True -DBUILD_INDEX64=True -DBUILD_SHARED_LIBS=True .. 
+  cmake -DCMAKE_INSTALL_PREFIX=~/lapack -DCBLAS=True -DLAPACK=True -DLAPACKE=True -DBUILD_INDEX64=True -DBUILD_SHARED_LIBS=True ..
   cmake --build . -j --target install 
-  cmake -DCMAKE_INSTALL_PREFIX=~/lapack -DCBLAS=True -DLAPACK=True -DLAPACKE=True -DBUILD_INDEX64=False -DBUILD_SHARED_LIBS=True .. 
+  cmake -DCMAKE_INSTALL_PREFIX=~/lapack -DCBLAS=True -DLAPACK=True -DLAPACKE=True -DBUILD_INDEX64=False -DBUILD_SHARED_LIBS=True ..
   cmake --build . -j --target install
 
 and then used in oneMKL by setting ``-REF_BLAS_ROOT=/path/to/lapack/install``

_sources/building_the_project_with_dpcpp.rst

@@ -386,11 +386,11 @@ disabled:
   cmake $ONEMKL_DIR \
       -DCMAKE_CXX_COMPILER=clang++ \ 
       -DCMAKE_C_COMPILER=clang \
-      -DENABLE_MKLCPU_BACKEND=False \ 
+      -DENABLE_MKLCPU_BACKEND=False \
       -DENABLE_MKLGPU_BACKEND=False \
-      -DENABLE_ROCFFT_BACKEND=True  \ 
+      -DENABLE_ROCFFT_BACKEND=True  \
       -DENABLE_ROCBLAS_BACKEND=True \
-      -DENABLE_ROCSOLVER_BACKEND=True \ 
+      -DENABLE_ROCSOLVER_BACKEND=True \
       -DHIP_TARGETS=gfx90a \
       -DBUILD_FUNCTIONAL_TESTS=False
 

_sources/create_new_backend.rst

@@ -157,13 +157,13 @@ To integrate the new third-party library to a oneMKL header-based part, followin
             { domain::blas,
               { { device::x86cpu,
                   {
-        #ifdef ENABLE_MKLCPU_BACKEND
+        #ifdef ONEMKL_ENABLE_MKLCPU_BACKEND
                       LIB_NAME("blas_mklcpu")
         #endif
                    } },
      +          { device::newdevice,
      +            {
-     +  #ifdef ENABLE_NEWLIB_BACKEND
+     +  #ifdef ONEMKL_ENABLE_NEWLIB_BACKEND
      +                 LIB_NAME("blas_newlib")
      +  #endif
      +             } },
@@ -427,8 +427,8 @@ Update the following files to enable the new third-party library for unit tests:
 
   .. code-block:: diff
     
-        #cmakedefine ENABLE_MKLCPU_BACKEND
-     +  #cmakedefine ENABLE_NEWLIB_BACKEND
+        #cmakedefine ONEMKL_ENABLE_MKLCPU_BACKEND
+     +  #cmakedefine ONEMKL_ENABLE_NEWLIB_BACKEND
 
 * ``tests/unit_tests/CMakeLists.txt``: add instructions about how to link tests with the new backend library
 
@@ -464,14 +464,14 @@ Update the following files to enable the new third-party library for unit tests:
 
   .. code-block:: diff
     
-        #ifdef ENABLE_MKLGPU_BACKEND
+        #ifdef ONEMKL_ENABLE_MKLGPU_BACKEND
             #define TEST_RUN_INTELGPU(q, func, args) \
                 func<oneapi::mkl::backend::mklgpu> args
         #else
             #define TEST_RUN_INTELGPU(q, func, args)
         #endif
      +    
-     +  #ifdef ENABLE_NEWLIB_BACKEND
+     +  #ifdef ONEMKL_ENABLE_NEWLIB_BACKEND
      +     #define TEST_RUN_NEWDEVICE(q, func, args) \
      +         func<oneapi::mkl::backend::newbackend> args
      +  #else
@@ -495,7 +495,7 @@ Update the following files to enable the new third-party library for unit tests:
                 }
             }
      +           
-     +  #ifdef ENABLE_NEWLIB_BACKEND
+     +  #ifdef ONEMKL_ENABLE_NEWLIB_BACKEND
      +      devices.push_back(sycl::device(sycl::host_selector()));
      +  #endif
 

create_new_backend.html

@@ -654,13 +654,13 @@ <h2> Contents </h2>
 <span class="w"> </span>      { domain::blas,
 <span class="w"> </span>        { { device::x86cpu,
 <span class="w"> </span>            {
-<span class="w"> </span>  #ifdef ENABLE_MKLCPU_BACKEND
+<span class="w"> </span>  #ifdef ONEMKL_ENABLE_MKLCPU_BACKEND
 <span class="w"> </span>                LIB_NAME(&quot;blas_mklcpu&quot;)
 <span class="w"> </span>  #endif
 <span class="w"> </span>             } },
 <span class="gi">+          { device::newdevice,</span>
 <span class="gi">+            {</span>
-<span class="gi">+  #ifdef ENABLE_NEWLIB_BACKEND</span>
+<span class="gi">+  #ifdef ONEMKL_ENABLE_NEWLIB_BACKEND</span>
 <span class="gi">+                 LIB_NAME(&quot;blas_newlib&quot;)</span>
 <span class="gi">+  #endif</span>
 <span class="gi">+             } },</span>
@@ -885,8 +885,8 @@ <h2> Contents </h2>
 <ul>
 <li><p><code class="docutils literal notranslate"><span class="pre">src/config.hpp.in</span></code>: add a cmake option for the new third-party library so this macro can be propagated to unit tests</p>
 <p><strong>Example</strong>: add <code class="docutils literal notranslate"><span class="pre">ENABLE_NEWLIB_BACKEND</span></code></p>
-<div class="highlight-diff notranslate"><div class="highlight"><pre><span></span><span class="w"> </span>  #cmakedefine ENABLE_MKLCPU_BACKEND
-<span class="gi">+  #cmakedefine ENABLE_NEWLIB_BACKEND</span>
+<div class="highlight-diff notranslate"><div class="highlight"><pre><span></span><span class="w"> </span>  #cmakedefine ONEMKL_ENABLE_MKLCPU_BACKEND
+<span class="gi">+  #cmakedefine ONEMKL_ENABLE_NEWLIB_BACKEND</span>
 </pre></div>
 </div>
 </li>
@@ -918,14 +918,14 @@ <h2> Contents </h2>
 </li>
 <li><p><code class="docutils literal notranslate"><span class="pre">tests/unit_tests/include/test_helper.hpp</span></code>: add the helper function for the compile-time dispatching interface with the new backend, and specify the device for which it should be called</p>
 <p><strong>Example</strong>: add the helper function for the <code class="docutils literal notranslate"><span class="pre">newlib</span></code> compile-time dispatching interface with <code class="docutils literal notranslate"><span class="pre">newdevice</span></code> if it is the Host</p>
-<div class="highlight-diff notranslate"><div class="highlight"><pre><span></span><span class="w"> </span>  #ifdef ENABLE_MKLGPU_BACKEND
+<div class="highlight-diff notranslate"><div class="highlight"><pre><span></span><span class="w"> </span>  #ifdef ONEMKL_ENABLE_MKLGPU_BACKEND
 <span class="w"> </span>      #define TEST_RUN_INTELGPU(q, func, args) \
 <span class="w"> </span>          func&lt;oneapi::mkl::backend::mklgpu&gt; args
 <span class="w"> </span>  #else
 <span class="w"> </span>      #define TEST_RUN_INTELGPU(q, func, args)
 <span class="w"> </span>  #endif
 <span class="gi">+</span>
-<span class="gi">+  #ifdef ENABLE_NEWLIB_BACKEND</span>
+<span class="gi">+  #ifdef ONEMKL_ENABLE_NEWLIB_BACKEND</span>
 <span class="gi">+     #define TEST_RUN_NEWDEVICE(q, func, args) \</span>
 <span class="gi">+         func&lt;oneapi::mkl::backend::newbackend&gt; args</span>
 <span class="gi">+  #else</span>
@@ -945,7 +945,7 @@ <h2> Contents </h2>
 <div class="highlight-diff notranslate"><div class="highlight"><pre><span></span><span class="w"> </span>          }
 <span class="w"> </span>      }
 <span class="gi">+</span>
-<span class="gi">+  #ifdef ENABLE_NEWLIB_BACKEND</span>
+<span class="gi">+  #ifdef ONEMKL_ENABLE_NEWLIB_BACKEND</span>
 <span class="gi">+      devices.push_back(sycl::device(sycl::host_selector()));</span>
 <span class="gi">+  #endif</span>
 </pre></div>