Skip to content

Commit

Permalink
Rename dpctl capi (#666)
Browse files Browse the repository at this point in the history
* Rename dpctl-capi to libsyclinterface.

* Update CONTRIBUTING.md to use new name for dpctl-capi.

* Update folder name in cpp_style_checks workflow.

* Update Changelog.

* Change to libsyclinterface in docs.
  • Loading branch information
Diptorup Deb authored Nov 10, 2021
1 parent 309aa1f commit 5c3fed5
Show file tree
Hide file tree
Showing 88 changed files with 23 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cpp_style_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ jobs:
uses: jidicula/clang-format-action@v3.1.0
with:
clang-format-version: '11'
check-path: 'dpctl-capi'
check-path: 'libsyclinterface'
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Next Release] TBD

### Changed
- dpctl-capi is now renamed to `libsyclinterface` (#666).

## [0.11.0] - 11/01/2021

### Added
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ Run before each commit:

```bash
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
libsyclinterface/include/*.h \
libsyclinterface/include/Support/*.h \
libsyclinterface/source/*.cpp \
libsyclinterface/tests/*.cpp \
libsyclinterface/helper/include/*.h \
libsyclinterface/helper/source/*.cpp
```

> **_NOTE:_** A much simpler option is to use `pre-commit` and the
Expand Down
2 changes: 1 addition & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
docs
generated_docs
docfiles/dpctl-capi
docfiles/libsyclinterface
api
build
conf.py
Expand Down
4 changes: 2 additions & 2 deletions docs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ function(_setup_doxygen)
if(DPCTL_ENABLE_DOXYGEN_HTML)
set(GENERATE_HTML "YES")
endif()
set(DOXYGEN_INPUT_DIR ../dpctl-capi/include)
set(DOXYGEN_INPUT_DIR ../libsyclinterface/include)
set(DOXYGEN_OUTPUT_DIR ${DOC_OUTPUT_DIR}/doxygen)
set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml)
set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
Expand Down Expand Up @@ -61,7 +61,7 @@ function(_setup_doxygen)
endfunction()

function(_setup_doxyrest)
set(DOXYREST_OUTPUT_DIR_NAME docfiles/dpctl-capi)
set(DOXYREST_OUTPUT_DIR_NAME docfiles/libsyclinterface)
set(DOXYREST_OUTPUT_DIR
${CMAKE_CURRENT_SOURCE_DIR}/${DOXYREST_OUTPUT_DIR_NAME}
PARENT_SCOPE
Expand Down
10 changes: 5 additions & 5 deletions docs/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -917,11 +917,11 @@ RECURSIVE = YES
# Note that relative paths are relative to the directory from which doxygen is
# run.

EXCLUDE = ../dpctl-capi/include/Support
EXCLUDE += ../dpctl-capi/include/Config
EXCLUDE += ../dpctl-capi/include/dpctl_vector.h
EXCLUDE += ../dpctl-capi/include/dpctl_data_types.h
EXCLUDE += ../dpctl-capi/include/dpctl_utils.h
EXCLUDE = ../libsyclinterface/include/Support
EXCLUDE += ../libsyclinterface/include/Config
EXCLUDE += ../libsyclinterface/include/dpctl_vector.h
EXCLUDE += ../libsyclinterface/include/dpctl_data_types.h
EXCLUDE += ../libsyclinterface/include/dpctl_utils.h

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
Expand Down
2 changes: 1 addition & 1 deletion docs/doxyrest-config.lua.in
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ EXTRA_PAGE_LIST = {}
--! is not set (otherwise, the title of intro file will be used).
--!

INDEX_TITLE = "dpctl C API"
INDEX_TITLE = "libsyclinterface"

--!
--! File with project introduction (reStructuredText). When non-nil, this file
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions scripts/build_backend.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def build_backend(
if os.path.exists(INSTALL_PREFIX):
shutil.rmtree(INSTALL_PREFIX)

backends = os.path.join(dpctl_dir, "dpctl-capi")
backends = os.path.join(dpctl_dir, "libsyclinterface")

ENABLE_LO_PROGRAM_CREATION = "ON" if l0_support else "OFF"

Expand Down Expand Up @@ -213,7 +213,7 @@ def build_backend(
shutil.rmtree(include_dir)

shutil.copytree(
os.path.join(dpctl_dir, "dpctl-capi", "include"), include_dir
os.path.join(dpctl_dir, "libsyclinterface", "include"), include_dir
)


Expand Down

0 comments on commit 5c3fed5

Please sign in to comment.