Rename dpCtl to dpctl in all comments, license headers, and docs. (#342)

IntelPython · Mar 31, 2021 · 7b20dc8 · 7b20dc8
1 parent 82ea16d
commit 7b20dc8
Show file tree

Hide file tree

Showing 122 changed files with 163 additions and 163 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,7 +9,7 @@ We use [clang-format](https://clang.llvm.org/docs/ClangFormat.html) code formatt
 Install: `conda install clang-tools`
 
 - Revision: `10.0.1`
-- See the default configuration used by dpCtl in `.clang-format`.
+- See the default configuration used by dpctl in `.clang-format`.
 
 Run before each commit: `clang-format -style=file -i dpctl-capi/include/*.h dpctl-capi/include/Support/*.h dpctl-capi/source/*.cpp dpctl-capi/tests/*.cpp dpctl-capi/helper/include/*.h dpctl-capi/helper/source/*.cpp`
 
@@ -30,7 +30,7 @@ purpose of the file. The standard header looks like this:
 ```
 //===----- dpctl_sycl_event_interface.h - C API for sycl::event  -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //
@@ -69,7 +69,7 @@ Few things to note about this format:
 Every Python and Cython file should only include the following license header:
 
 ```
-#                      Data Parallel Control (dpCtl)
+#                      Data Parallel Control (dpctl)
 #
 # Copyright 2020-2021 Intel Corporation
 #

diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ conda install dpctl
 
 Build and Install with setuptools
 =================================
-dpCtl relies on DPC++ runtime. With Intel oneAPI installed you should activate it.
+dpctl relies on DPC++ runtime. With Intel oneAPI installed you should activate it.
 `setup.py` requires environment variable `ONEAPI_ROOT` and following packages
 installed:
 - `cython`
@@ -67,11 +67,11 @@ python setup.py develop
 
 Install Wheel Package from Pypi
 ==================================
-1. Install dpCtl
+1. Install dpctl
 ```cmd
 python -m pip install --index-url https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple dpctl
 ```
-Note: dpCtl wheel package is placed on Pypi, but some of its dependencies (like Intel numpy) are in Anaconda Cloud.
+Note: dpctl wheel package is placed on Pypi, but some of its dependencies (like Intel numpy) are in Anaconda Cloud.
 That is why install command requires additional intel Pypi channel from Anaconda Cloud.
 
 2. Set path to Performance Libraries in case of using venv or system Python:
@@ -84,9 +84,9 @@ On Windows:
 set PATH=<path_to_your_env>\bin;<path_to_your_env>\Library\bin;%PATH%
 ```
 
-Using dpCtl
+Using dpctl
 ===========
-dpCtl relies on DPC++ runtime. With Intel oneAPI installed you could activate it.
+dpctl relies on DPC++ runtime. With Intel oneAPI installed you could activate it.
 
 On Windows:
 ```cmd
@@ -97,7 +97,7 @@ On Linux:
 source ${ONEAPI_ROOT}/compiler/latest/env/vars.sh
 ```
 
-When dpCtl is installed via conda package
+When dpctl is installed via conda package
 then it uses DPC++ runtime from `dpcpp_cpp_rt` package
 and it is not necessary to activate oneAPI DPC++ compiler environment.
 
@@ -113,7 +113,7 @@ for script in `ls examples/python/`; do echo "executing ${script}"; python examp
 ```
 
 Examples of building Cython extensions with DPC++ compiler, that interoperate
-with dpCtl can be found in folder `cython`.
+with dpctl can be found in folder `cython`.
 
 Each example in `cython` folder can be built using
 `CC=clang CXX=dpcpp python setup.py build_ext --inplace`.

diff --git a/conda-recipe/meta.yaml b/conda-recipe/meta.yaml
@@ -34,7 +34,7 @@ test:
     - pytest
     - pytest-cov
 about:
-    home: https://github.com/IntelPython/dpCtl.git
+    home: https://github.com/IntelPython/dpctl.git
     license: Apache-2.0
     license_file: LICENSE
     summary: 'A lightweight Python wrapper for a subset of OpenCL and SYCL API.'

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.18 FATAL_ERROR)
-project("Data-parallel Control (dpCtl)")
+project("Data-parallel Control (dpctl)")
 # Add the cmake folder so the FindSphinx module is found
 set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
 
@@ -9,7 +9,7 @@ find_package (Git)
 
 set(DOC_OUTPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/generated_docs)
 if( DPCTL_DOCGEN_PREFIX )
-    message(STATUS "Generating dpCtl documents in " ${DPCTL_DOCGEN_PREFIX})
+    message(STATUS "Generating dpctl documents in " ${DPCTL_DOCGEN_PREFIX})
     set(DOC_OUTPUT_DIR ${DPCTL_DOCGEN_PREFIX})
 endif()
 
@@ -74,7 +74,7 @@ add_custom_command(
     COMMAND
         ${SPHINX_EXECUTABLE} -b html
         # Tell Breathe where to find the Doxygen output
-        -Dbreathe_projects.dpCtl-CAPI=${DOXYGEN_OUTPUT_DIR}/xml
+        -Dbreathe_projects.dpctl-CAPI=${DOXYGEN_OUTPUT_DIR}/xml
         ${SPHINX_SOURCE} ${SPHINX_OUTPUT_DIR}
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
     DEPENDS

diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "Data-parallel Control (dpCtl)"
+PROJECT_NAME           = "Data-parallel Control (dpctl)"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version

diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,7 @@
 What?
 =====
 
-Generator scripts for dpCtl API documentation. To run these scripts, follow
+Generator scripts for dpctl API documentation. To run these scripts, follow
 the following steps:
 ```bash
 cd dpctl/docs
@@ -16,7 +16,7 @@ documents in the current source directory in a sub-directory called
 `generated_docs`.
 
 The `make Sphinx` command will generate standalone Doxygen documentation and
-a consolidated Sphinx documentation for both dpCtl Python and C APIs.
+a consolidated Sphinx documentation for both dpctl Python and C APIs.
 
 Prerequisite
 ============

diff --git a/docs/conf.in b/docs/conf.in
@@ -38,7 +38,7 @@ extensions = [
 ]
 
 # Breathe Configuration
-breathe_default_project = "dpCtl-CAPI"
+breathe_default_project = "dpctl-CAPI"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -58,8 +58,8 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 exhale_args = {
     # These arguments are required
     "containmentFolder": "./api",
-    "rootFileName": "dpCtl-CAPI_root.rst",
-    "rootFileTitle": "dpCtl C API",
+    "rootFileName": "dpctl-CAPI_root.rst",
+    "rootFileTitle": "dpctl C API",
     "doxygenStripFromPath": "..",
     "createTreeView": True,
     "exhaleExecutesDoxygen": True,

diff --git a/docs/dpCtl.dptensor_api.rst b/docs/dpCtl.dptensor_api.rst
@@ -1,7 +1,7 @@
 .. _dpCtl.dptensor_api:
 
 #########################
-dpCtl dptensor Python API
+dpctl dptensor Python API
 #########################
 
 .. automodule:: dpctl.dptensor

diff --git a/docs/dpCtl.program_api.rst b/docs/dpCtl.program_api.rst
@@ -1,7 +1,7 @@
 .. _dpCtl.program_api:
 
 ########################
-dpCtl Program Python API
+dpctl Program Python API
 ########################
 
 .. automodule:: dpctl.program

diff --git a/docs/dpCtl_api.rst b/docs/dpCtl_api.rst
@@ -1,7 +1,7 @@
 .. _dpCtl_api:
 
 ################
-dpCtl Python API
+dpctl Python API
 ################
 
 .. automodule:: dpctl

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Data-parallel Control (dpCtl)'s documentation!
+Welcome to Data-parallel Control (dpctl)'s documentation!
 =========================================================
 
 .. toctree::

diff --git a/dpctl-capi/CMakeLists.txt b/dpctl-capi/CMakeLists.txt
@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.10 FATAL_ERROR)
-project("dpCtl C API - A C wrapper for a subset of SYCL")
+project("dpctl C API - A C wrapper for a subset of SYCL")
 
 # Option to turn on support for creating Level Zero interoperability programs
 # from a SPIR-V binary file.
@@ -152,7 +152,7 @@ if(DPCTL_GENERATE_COVERAGE)
     endif()
 endif()
 
-# Add sub-directory to build the dpCtl C API test cases
+# Add sub-directory to build the dpctl C API test cases
 if(DPCTL_BUILD_CAPI_TESTS)
     add_subdirectory(tests)
 endif()
diff --git a/dpctl-capi/cmake/modules/FindDPCPP.cmake b/dpctl-capi/cmake/modules/FindDPCPP.cmake
@@ -1,4 +1,4 @@
-#                       Data Parallel Control (dpCtl)
+#                       Data Parallel Control (dpctl)
 #
 # Copyright 2020-2021 Intel Corporation
 #

diff --git a/dpctl-capi/cmake/modules/FindLcov.cmake b/dpctl-capi/cmake/modules/FindLcov.cmake
@@ -1,4 +1,4 @@
-#                       Data Parallel Control (dpCtl)
+#                       Data Parallel Control (dpctl)
 #
 # Copyright 2020-2021 Intel Corporation
 #

diff --git a/dpctl-capi/cmake/modules/FindLevelZero.cmake b/dpctl-capi/cmake/modules/FindLevelZero.cmake
@@ -1,4 +1,4 @@
-#                       Data Parallel Control (dpCtl)
+#                       Data Parallel Control (dpctl)
 #
 # Copyright 2020-2021 Intel Corporation
 #

diff --git a/dpctl-capi/helper/include/dpctl_async_error_handler.h b/dpctl-capi/helper/include/dpctl_async_error_handler.h
@@ -1,6 +1,6 @@
 //===-- dpctl_async_error_handler.h - An async error handler     -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //

diff --git a/dpctl-capi/helper/include/dpctl_dynamic_lib_helper.h b/dpctl-capi/helper/include/dpctl_dynamic_lib_helper.h
@@ -1,6 +1,6 @@
 //===--- dpctl_dynamic_lib_helper.h - Dynamic library helper     -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //

diff --git a/dpctl-capi/helper/include/dpctl_utils_helper.h b/dpctl-capi/helper/include/dpctl_utils_helper.h
@@ -1,6 +1,6 @@
 //===-- dpctl_utils.h - Enum to string helper functions          -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //
@@ -19,7 +19,7 @@
 //===----------------------------------------------------------------------===//
 ///
 /// \file
-/// This file defines common helper functions used in other places in dpCtl.
+/// This file defines common helper functions used in other places in dpctl.
 //===----------------------------------------------------------------------===//
 
 #pragma once

diff --git a/dpctl-capi/helper/include/dpctl_vector_macros.h b/dpctl-capi/helper/include/dpctl_vector_macros.h
@@ -1,6 +1,6 @@
 //=== dpctl_vector_macros.h - Macros to help build function sig.    -*-C++-*- //
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //

diff --git a/dpctl-capi/helper/source/dpctl_async_error_handler.cpp b/dpctl-capi/helper/source/dpctl_async_error_handler.cpp
@@ -1,6 +1,6 @@
 //===-- dpctl_async_error_handler.h - An async error handler     -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //

diff --git a/dpctl-capi/helper/source/dpctl_utils_helper.cpp b/dpctl-capi/helper/source/dpctl_utils_helper.cpp
@@ -1,6 +1,6 @@
 //===- dpctl_utils_helper.cpp - Implementation of enum to string helpers   ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //

diff --git a/dpctl-capi/include/Config/dpctl_config.h.in b/dpctl-capi/include/Config/dpctl_config.h.in
@@ -1,6 +1,6 @@
-//===--------- dpctl_config.h - Configured options for dpCtl C API         ===//
+//===--------- dpctl_config.h - Configured options for dpctl C API         ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //
@@ -19,14 +19,14 @@
 //===----------------------------------------------------------------------===//
 ///
 /// \file
-/// This file exports a set of dpCtl C API configurations.
+/// This file exports a set of dpctl C API configurations.
 ///
 //===----------------------------------------------------------------------===//
 
 #pragma once
 
-/* Defined when dpCtl was built with level zero program creation enabled. */
+/* Defined when dpctl was built with level zero program creation enabled. */
 #cmakedefine DPCTL_ENABLE_LO_PROGRAM_CREATION @DPCTL_ENABLE_LO_PROGRAM_CREATION@
 
-/* The DPCPP version used to build dpCtl */
+/* The DPCPP version used to build dpctl */
 #define DPCTL_DPCPP_VERSION "@DPCPP_VERSION@"
diff --git a/dpctl-capi/include/Support/CBindingWrapping.h b/dpctl-capi/include/Support/CBindingWrapping.h
@@ -1,6 +1,6 @@
 //===- CBindingWrapping.h - Wrappers for casting C pointers      -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //
@@ -19,7 +19,7 @@
 //===----------------------------------------------------------------------===//
 ///
 /// \file
-/// This file declares the wrapping macros for the dpCtl C interface.
+/// This file declares the wrapping macros for the dpctl C interface.
 ///
 //===----------------------------------------------------------------------===//
 

diff --git a/dpctl-capi/include/Support/DllExport.h b/dpctl-capi/include/Support/DllExport.h
@@ -1,6 +1,6 @@
 //===---------  DllExport.h - Decalres dllexport for Windows     -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //

diff --git a/dpctl-capi/include/Support/ExternC.h b/dpctl-capi/include/Support/ExternC.h
@@ -1,6 +1,6 @@
 //===----------- ExternC.h - Defines an extern C helper macro    -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //

diff --git a/dpctl-capi/include/Support/MemOwnershipAttrs.h b/dpctl-capi/include/Support/MemOwnershipAttrs.h
@@ -1,6 +1,6 @@
 //===- MemOwnershipAttrs.h - Defines memory ownership attributes -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //
@@ -22,7 +22,7 @@
 /// This file defines a group of macros that serve as attributes indicating the
 /// type of ownership of a pointer. The macros are modeled after similar
 /// attributes defines in Integer Set Library (isl) and serve the purpose of
-/// helping a programmer understand the semantics of a dpCtl function.
+/// helping a programmer understand the semantics of a dpctl function.
 ///
 //===----------------------------------------------------------------------===//
 

diff --git a/dpctl-capi/include/dpctl_data_types.h b/dpctl-capi/include/dpctl_data_types.h
@@ -1,6 +1,6 @@
 //===-------------- dpctl_data_types.h - Defines integer types   -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //

diff --git a/dpctl-capi/include/dpctl_error_handler_type.h b/dpctl-capi/include/dpctl_error_handler_type.h
@@ -1,6 +1,6 @@
 //===--- dpctl_error_handler_types.h - Error handler callbacks   -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //

diff --git a/dpctl-capi/include/dpctl_sycl_context_interface.h b/dpctl-capi/include/dpctl_sycl_context_interface.h
@@ -1,6 +1,6 @@
 //===-- dpctl_sycl_context_interface.h - C API for sycl::context -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //

diff --git a/dpctl-capi/include/dpctl_sycl_device_interface.h b/dpctl-capi/include/dpctl_sycl_device_interface.h
@@ -1,6 +1,6 @@
 //===----- dpctl_sycl_device_interface.h - C API for sycl::device -*-C++-*- ==//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //