Merge pull request #4 from eth-cscs/misc-cleanup

Clean up a few minor typos and other details

Author: msimberg

CMakeLists.txt

@@ -6,15 +6,17 @@
 # Please, refer to the LICENSE file in the root directory.
 # SPDX-License-Identifier: BSD-3-Clause
 
+# General project setup
 cmake_minimum_required(VERSION 3.22)
 
 project(whip VERSION 0.1.0 LANGUAGES CXX)
 
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${PROJECT_SOURCE_DIR}/cmake")
 
-set(WHIP_BACKEND "CUDA" CACHE STRING "${description}")
+set(whip_backend_description "Backend to use (CUDA or HIP)")
+set(WHIP_BACKEND "CUDA" CACHE STRING "${whip_backend_description}")
 set_property(CACHE WHIP_BACKEND PROPERTY TYPE STRING)
-set_property(CACHE WHIP_BACKEND PROPERTY HELPSTRING "The backend to use...")
+set_property(CACHE WHIP_BACKEND PROPERTY HELPSTRING "${whip_backend_description}")
 set(whip_valid_backends CUDA HIP)
 set_property(CACHE WHIP_BACKEND PROPERTY STRINGS "${whip_valid_backends}")
 
@@ -46,6 +48,7 @@ elseif(WHIP_BACKEND STREQUAL "HIP")
   target_link_libraries(whip INTERFACE hip::host)
 endif()
 
+# Generate whip header
 set(whip_types_section "// Types")
 whip_add_type(whip_types_section device_prop DeviceProp_t CUDA_OVERRIDE cudaDeviceProp)
 whip_add_type(whip_types_section dim3 dim3 CUDA_OVERRIDE dim3 HIP_OVERRIDE dim3)
@@ -106,6 +109,7 @@ whip_add_function(whip_functions_section stream_get_flags "stream_t stream;unsig
 whip_add_function(whip_functions_section stream_ready "stream_t stream" StreamQuery QUERY)
 whip_add_function(whip_functions_section stream_synchronize "stream_t stream" StreamSynchronize)
 
+# Install whip
 write_basic_package_version_file("${PROJECT_BINARY_DIR}/whip-config-version.cmake" VERSION ${PROJECT_VERSION} COMPATIBILITY AnyNewerVersion)
 configure_file("${PROJECT_SOURCE_DIR}/cmake/whip.hpp.in" "${PROJECT_BINARY_DIR}/include/whip.hpp")
 

README.md

@@ -24,25 +24,25 @@ that:
 whip lightly wraps CUDA and HIP functions. Function wrappers:
 
 - Are C++ lambdas to easily allow passing templated functions (like
-  `cuda/hipMemcpy`) into higher order functions.
+  `cudaMemcpy/hipMemcpy`) into higher order functions.
 - Check the return codes from wrapped functions and throw a `whip::exception` on
   failure.
 
 Wrapped types, errors, and functions have the same names as in CUDA and HIP,
 with the `cuda/hip` prefix removed and the name changed to `snake_case`. For
-example `cuda/hipMemcpy` is wrapped by a `whip::error_t whip::memcpy(auto* dst,
-const auto*, std::size_t size_bytes, whip::memcpy_kind)` function. All
+example `cudaMemcpy/hipMemcpy` is wrapped by a `whip::error_t whip::memcpy(auto*
+dst, const auto*, std::size_t size_bytes, whip::memcpy_kind)` function. All
 functionality is available in the `whip` namespace.
 
 There are two main exceptions to the above rules:
 
-- The functions `cuda/hipEventQuery` and `cuda/hipStreamQuery` are expected to
-  fail under normal circumstances. The wrappers in whip (respectively
-  `whip::event_ready` and `whip::stream_ready`) return instead a bool indicating
-  readiness.
-  The wrappers throw an exception in all other cases.
-- `cuda/hipGetLastError` is called `whip::check_last_error` instead of
-  `whip::get_last_error` because it throws on failure as other wrappers do.
+- The functions `cudaEventQuery/hipEventQuery` and
+  `cudaStreamQuery/hipStreamQuery` are expected to fail under normal
+  circumstances. The wrappers in whip (respectively `whip::event_ready` and
+  `whip::stream_ready`) return instead a bool indicating readiness.  The
+  wrappers throw an exception in all other cases.
+- `cudaGetLastError/hipGetLastError` is called `whip::check_last_error` instead
+  of `whip::get_last_error` because it throws on failure as other wrappers do.
 
 # Usage
 

cmake/whip-config.cmake

@@ -19,5 +19,5 @@ set(WHIP_BACKEND @WHIP_BACKEND@)
 if(WHIP_BACKEND STREQUAL "CUDA")
   find_dependency(CUDAToolkit)
 elseif(WHIP_BACKEND STREQUAL "HIP")
-  find_package(hip)
+  find_dependency(hip)
 endif()

cmake/whip_helpers.cmake

@@ -59,7 +59,7 @@ function(whip_add_function var wrapper params wrapped)
   string(REPLACE ";" ", " wrapper_definition_params "${params}")
   set(wrapper_definition "${wrapper}(${wrapper_definition_params})")
 
-  # Transform parameter list into somethig usable in the call to the wrapped
+  # Transform parameter list into something usable in the call to the wrapped
   # function: replace semicolons with commas and keep only the variable names
   set(wrapped_call_args)
   foreach(param ${params})