Use Ninja generator on both Linux and Windows

Ninja parallalizes the build and hence works faster to build the project,
it also does not have the bug that make has cause it to unconditionally
recompile and relink extension libraries saving significant iterative
development time.

Author: oleksandr-pavlyk

.github/workflows/generate-coverage.yaml

@@ -32,9 +32,9 @@ jobs:
           sudo apt-get install intel-oneapi-compiler-dpcpp-cpp
           sudo apt-get install intel-oneapi-tbb
 
-      - name: Install CMake
+      - name: Install CMake and Ninja
         run: |
-          sudo apt-get install cmake
+          sudo apt-get install cmake ninja-build
 
       - name: Setup Python
         uses: actions/setup-python@v2
@@ -87,8 +87,10 @@ jobs:
           source /opt/intel/oneapi/setvars.sh
           export _SAVED_PATH=${PATH}
           export PATH=$(dirname $(dirname $(which icx)))/bin-llvm:${PATH}
-          python setup.py develop -- -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_GENERATE_COVERAGE=ON -DDPCTL_BUILD_CAPI_TESTS=ON -DDPCTL_COVERAGE_REPORT_OUTPUT_DIR=$(pwd)
-          make -C $(find _skbuild -name tests) lcov-genhtml
+          python setup.py develop -- -G "Ninja" -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_GENERATE_COVERAGE=ON -DDPCTL_BUILD_CAPI_TESTS=ON -DDPCTL_COVERAGE_REPORT_OUTPUT_DIR=$(pwd)
+          pushd $(find _skbuild -name tests)
+          cmake --build . --target lcov-genhtml || exit 1
+          popd
           export PATH=${_SAVED_PATH}
           unset _SAVED_PATH
           python -c "import dpctl; print(dpctl.__version__); dpctl.lsplatform()" || exit 1

.github/workflows/generate-docs.yml

@@ -35,10 +35,10 @@ jobs:
         if: ${{ !github.event.pull_request || github.event.action != 'closed' }}
         run: |
           sudo apt-get install doxygen
-      - name: Install CMake
+      - name: Install CMake and Ninja
         if: ${{ !github.event.pull_request || github.event.action != 'closed' }}
         run: |
-          sudo apt-get install cmake
+          sudo apt-get install cmake ninja-build
       - name: Setup Python
         if: ${{ !github.event.pull_request || github.event.action != 'closed' }}
         uses: actions/setup-python@v2
@@ -64,7 +64,7 @@ jobs:
           wget https://github.com/vovkos/doxyrest/releases/download/doxyrest-2.1.2/doxyrest-2.1.2-linux-amd64.tar.xz
           tar xf doxyrest-2.1.2-linux-amd64.tar.xz
           python setup.py develop --                       \
-              -G "Unix Makefiles"                          \
+              -G "Ninja"                                   \
               -DCMAKE_BUILD_TYPE=Debug                     \
               -DCMAKE_C_COMPILER:PATH=icx                  \
               -DCMAKE_CXX_COMPILER:PATH=icpx               \

.github/workflows/os-llvm-sycl-build.yml

@@ -68,7 +68,7 @@ jobs:
       - name: Install system components
         shell: bash -l {0}
         run: |
-          sudo apt-get install cmake libtinfo5
+          sudo apt-get install cmake ninja-build libtinfo5
 
       - name: Setup Python
         uses: actions/setup-python@v2
@@ -97,6 +97,6 @@ jobs:
           export OCL_ICD_FILENAMES=libintelocl.so:libintelocl_emu.so
           clang++ --version
           sycl-ls
-          python setup.py develop -- -G "Unix Makefiles" -DCMAKE_C_COMPILER:PATH=clang -DCMAKE_CXX_COMPILER:PATH=clang++ -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_DPCPP_HOME_DIR=$(dirname $(dirname $(which clang))) -DDPCTL_DPCPP_FROM_ONEAPI=OFF
+          python setup.py develop -- -G Ninja -DCMAKE_C_COMPILER:PATH=clang -DCMAKE_CXX_COMPILER:PATH=clang++ -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_DPCPP_HOME_DIR=$(dirname $(dirname $(which clang))) -DDPCTL_DPCPP_FROM_ONEAPI=OFF
           python -c "import dpctl; dpctl.lsplatform()" || exit 1
           SYCL_ENABLE_HOST_DEVICE=1 python -m pytest -v dpctl/tests

conda-recipe/build.sh

@@ -6,7 +6,7 @@
 export LDFLAGS="$LDFLAGS -Wl,-rpath,$PREFIX/lib"
 
 ${PYTHON} setup.py clean --all
-export CMAKE_GENERATOR="Unix Makefiles"
+export CMAKE_GENERATOR="Ninja"
 SKBUILD_ARGS="-- -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_DPCPP_HOME_DIR=${BUILD_PREFIX}"
 echo "${PYTHON} setup.py install ${SKBUILD_ARGS}"
 

conda-recipe/meta.yaml

@@ -20,8 +20,7 @@ requirements:
         - cython
         - cmake  >=3.21
         - python
-        - make                     # [unix]
-        - ninja                    # [win]
+        - ninja
         - scikit-build
         - numpy 1.19
         - wheel

docs/docfiles/user_guides/QuickStart.rst

@@ -143,7 +143,7 @@ installed:
     - ``numpy``
     - ``cmake``
     - ``scikit-build``
-    - ``ninja`` (only on Windows)
+    - ``ninja``
     - ``gtest`` (optional to run C API tests)
     - ``gmock`` (optional to run C API tests)
     - ``pytest`` (optional to run Python API tests)
@@ -152,15 +152,15 @@ Once the prerequisites are installed, building using ``scikit-build`` involves t
 
 .. code-block:: bash
 
-    python setup.py install -- -G Unix\ Makefiles -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON
+    python setup.py install -- -G Ninja -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON
 
 , and to develop:
 
 .. code-block:: bash
 
-    python setup.py develop -G Unix\ Makefiles -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON
+    python setup.py develop -G Ninja -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON
 
-On Windows, use ``icx`` for both C and CXX compilers, and use :code:`-G Ninja` for cmake generator.
+On Windows, use ``icx`` for both C and CXX compilers.
 
 Developing on Linux can also be done using driver script:
 
@@ -180,7 +180,7 @@ Following steps in `Build and install with scikit-build`_ use command line optio
 
 .. code-block:: bash
 
-    python setup.py develop -- -G Unix\ Makefiles -DCMAKE_C_COMPILER:PATH=clang -DCMAKE_CXX_COMPILER:PATH=clang++ -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ONE -DDPCTL_DPCPP_HOME_DIR=${DPCPP_ROOT}/llvm/build -DDPCTL_DPCPP_FROM_ONEAPI=OFF
+    python setup.py develop -- -G Ninja -DCMAKE_C_COMPILER:PATH=clang -DCMAKE_CXX_COMPILER:PATH=clang++ -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ONE -DDPCTL_DPCPP_HOME_DIR=${DPCPP_ROOT}/llvm/build -DDPCTL_DPCPP_FROM_ONEAPI=OFF
 
 Alterantively, the driver script can be used
 

scripts/gen_coverage.py

@@ -48,7 +48,7 @@ def run(
         "develop",
         "--",
         "-G",
-        "Unix Makefiles",
+        "Ninja",
         "-DCMAKE_BUILD_TYPE=Debug",
         "-DCMAKE_C_COMPILER:PATH=" + c_compiler,
         "-DCMAKE_CXX_COMPILER:PATH=" + cxx_compiler,

scripts/gen_docs.py

@@ -48,7 +48,7 @@ def run(
         "develop",
         "--",
         "-G",
-        "Unix Makefiles",
+        "Ninja",
         "-DCMAKE_BUILD_TYPE=Debug",
         "-DCMAKE_C_COMPILER:PATH=" + c_compiler,
         "-DCMAKE_CXX_COMPILER:PATH=" + cxx_compiler,