misc: Rename CMake project from byte-span to ByteSpan

Author: range3

BUILDING.md

@@ -65,18 +65,18 @@ cmake --install build --config Release
 This project exports a CMake package to be used with the [`find_package`][3]
 command of CMake:
 
-* Package name: `byte-span`
-* Target name: `byte-span::byte-span`
+* Package name: `ByteSpan`
+* Target name: `ByteSpan::ByteSpan`
 
 Example usage:
 
 ```cmake
-find_package(byte-span REQUIRED)
+find_package(ByteSpan REQUIRED)
 # Declare the imported target as a build requirement using PRIVATE, where
 # project_target is a target created in the consuming project
 target_link_libraries(
     project_target PRIVATE
-    byte-span::byte-span
+    ByteSpan::ByteSpan
 )
 ```
 

CMakeLists.txt

@@ -3,10 +3,10 @@ cmake_minimum_required(VERSION 3.14)
 include(cmake/prelude.cmake)
 
 project(
-    byte-span
+    ByteSpan
     VERSION 0.1.0
     DESCRIPTION "Lightweight view class for efficient handling of byte data"
-    HOMEPAGE_URL "https://github.com/range3/byte-span"
+    HOMEPAGE_URL "https://github.com/range3/ByteSpan"
     LANGUAGES CXX
 )
 
@@ -15,21 +15,21 @@ include(cmake/variables.cmake)
 
 # ---- Declare library ----
 
-add_library(byte-span_byte-span INTERFACE)
-add_library(byte-span::byte-span ALIAS byte-span_byte-span)
+add_library(ByteSpan_ByteSpan INTERFACE)
+add_library(ByteSpan::ByteSpan ALIAS ByteSpan_ByteSpan)
 
 set_property(
-    TARGET byte-span_byte-span PROPERTY
-    EXPORT_NAME byte-span
+    TARGET ByteSpan_ByteSpan PROPERTY
+    EXPORT_NAME ByteSpan
 )
 
 target_include_directories(
-    byte-span_byte-span ${warning_guard}
+    ByteSpan_ByteSpan ${warning_guard}
     INTERFACE
     "\$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>"
 )
 
-target_compile_features(byte-span_byte-span INTERFACE cxx_std_20)
+target_compile_features(ByteSpan_ByteSpan INTERFACE cxx_std_20)
 
 # ---- Install rules ----
 
@@ -39,12 +39,12 @@ endif()
 
 # ---- Developer mode ----
 
-if(NOT byte-span_DEVELOPER_MODE)
+if(NOT ByteSpan_DEVELOPER_MODE)
   return()
 elseif(NOT PROJECT_IS_TOP_LEVEL)
   message(
       AUTHOR_WARNING
-      "Developer mode is intended for developers of byte-span"
+      "Developer mode is intended for developers of ByteSpan"
   )
 endif()
 

CMakePresets.json

@@ -10,7 +10,7 @@
       "name": "dev-mode",
       "hidden": true,
       "cacheVariables": {
-        "byte-span_DEVELOPER_MODE": "ON",
+        "ByteSpan_DEVELOPER_MODE": "ON",
         "VCPKG_MANIFEST_FEATURES": "test"
       }
     },

HACKING.md

@@ -9,7 +9,7 @@ guide.
 ## Developer mode
 
 Build system targets that are only useful for developers of this project are
-hidden if the `byte-span_DEVELOPER_MODE` option is disabled. Enabling this
+hidden if the `ByteSpan_DEVELOPER_MODE` option is disabled. Enabling this
 option makes tests and other developer targets and options available. Not
 enabling this option means that you are a consumer of this project and thus you
 have no need for these targets and options.
@@ -23,7 +23,7 @@ the project. As a developer, you are recommended to always have the [latest
 CMake version][2] installed to make use of the latest Quality-of-Life
 additions.
 
-You have a few options to pass `byte-span_DEVELOPER_MODE` to the configure
+You have a few options to pass `ByteSpan_DEVELOPER_MODE` to the configure
 command, but this project prefers to use presets.
 
 As a developer, you should create a `CMakeUserPresets.json` file at the root of

cmake/install-config.cmake

@@ -2,5 +2,5 @@ include(CMakeFindDependencyMacro)
 find_dependency(fmt)
 
 if(fmt_FOUND)
-  include("${CMAKE_CURRENT_LIST_DIR}/byte-spanTargets.cmake")
+  include("${CMAKE_CURRENT_LIST_DIR}/ByteSpanTargets.cmake")
 endif()

cmake/install-rules.cmake

@@ -1,6 +1,6 @@
 if(PROJECT_IS_TOP_LEVEL)
   set(
-      CMAKE_INSTALL_INCLUDEDIR "include/byte-span-${PROJECT_VERSION}"
+      CMAKE_INSTALL_INCLUDEDIR "include/ByteSpan-${PROJECT_VERSION}"
       CACHE STRING ""
   )
   set_property(CACHE CMAKE_INSTALL_INCLUDEDIR PROPERTY TYPE PATH)
@@ -13,17 +13,17 @@ include(CMakePackageConfigHelpers)
 include(GNUInstallDirs)
 
 # find_package(<package>) call for consumers to find this project
-set(package byte-span)
+set(package ByteSpan)
 
 install(
     DIRECTORY include/
     DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
-    COMPONENT byte-span_Development
+    COMPONENT ByteSpan_Development
 )
 
 install(
-    TARGETS byte-span_byte-span
-    EXPORT byte-spanTargets
+    TARGETS ByteSpan_ByteSpan
+    EXPORT ByteSpanTargets
     INCLUDES DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
 )
 
@@ -35,30 +35,30 @@ write_basic_package_version_file(
 
 # Allow package maintainers to freely override the path for the configs
 set(
-    byte-span_INSTALL_CMAKEDIR "${CMAKE_INSTALL_DATADIR}/${package}"
+    ByteSpan_INSTALL_CMAKEDIR "${CMAKE_INSTALL_DATADIR}/${package}"
     CACHE STRING "CMake package config location relative to the install prefix"
 )
-set_property(CACHE byte-span_INSTALL_CMAKEDIR PROPERTY TYPE PATH)
-mark_as_advanced(byte-span_INSTALL_CMAKEDIR)
+set_property(CACHE ByteSpan_INSTALL_CMAKEDIR PROPERTY TYPE PATH)
+mark_as_advanced(ByteSpan_INSTALL_CMAKEDIR)
 
 install(
     FILES cmake/install-config.cmake
-    DESTINATION "${byte-span_INSTALL_CMAKEDIR}"
+    DESTINATION "${ByteSpan_INSTALL_CMAKEDIR}"
     RENAME "${package}Config.cmake"
-    COMPONENT byte-span_Development
+    COMPONENT ByteSpan_Development
 )
 
 install(
     FILES "${PROJECT_BINARY_DIR}/${package}ConfigVersion.cmake"
-    DESTINATION "${byte-span_INSTALL_CMAKEDIR}"
-    COMPONENT byte-span_Development
+    DESTINATION "${ByteSpan_INSTALL_CMAKEDIR}"
+    COMPONENT ByteSpan_Development
 )
 
 install(
-    EXPORT byte-spanTargets
-    NAMESPACE byte-span::
-    DESTINATION "${byte-span_INSTALL_CMAKEDIR}"
-    COMPONENT byte-span_Development
+    EXPORT ByteSpanTargets
+    NAMESPACE ByteSpan::
+    DESTINATION "${ByteSpan_INSTALL_CMAKEDIR}"
+    COMPONENT ByteSpan_Development
 )
 
 if(PROJECT_IS_TOP_LEVEL)

cmake/variables.cmake

@@ -1,11 +1,11 @@
 # ---- Developer mode ----
 
 # Developer mode enables targets and code paths in the CMake scripts that are
-# only relevant for the developer(s) of byte-span
+# only relevant for the developer(s) of ByteSpan
 # Targets necessary to build the project must be provided unconditionally, so
 # consumers can trivially build and package the project
 if(PROJECT_IS_TOP_LEVEL)
-  option(byte-span_DEVELOPER_MODE "Enable developer mode" OFF)
+  option(ByteSpan_DEVELOPER_MODE "Enable developer mode" OFF)
 endif()
 
 # ---- Warning guard ----
@@ -17,12 +17,12 @@ endif()
 set(warning_guard "")
 if(NOT PROJECT_IS_TOP_LEVEL)
   option(
-      byte-span_INCLUDES_WITH_SYSTEM
-      "Use SYSTEM modifier for byte-span's includes, disabling warnings"
+      ByteSpan_INCLUDES_WITH_SYSTEM
+      "Use SYSTEM modifier for ByteSpan's includes, disabling warnings"
       ON
   )
-  mark_as_advanced(byte-span_INCLUDES_WITH_SYSTEM)
-  if(byte-span_INCLUDES_WITH_SYSTEM)
+  mark_as_advanced(ByteSpan_INCLUDES_WITH_SYSTEM)
+  if(ByteSpan_INCLUDES_WITH_SYSTEM)
     set(warning_guard SYSTEM)
   endif()
 endif()

test/CMakeLists.txt

@@ -1,14 +1,14 @@
 cmake_minimum_required(VERSION 3.14)
 
-project(byte-spanTests LANGUAGES CXX)
+project(ByteSpanTests LANGUAGES CXX)
 
 include(../cmake/project-is-top-level.cmake)
 include(../cmake/folders.cmake)
 
 # ---- Dependencies ----
 
 if(PROJECT_IS_TOP_LEVEL)
-  find_package(byte-span REQUIRED)
+  find_package(ByteSpan REQUIRED)
   enable_testing()
 endif()
 
@@ -19,15 +19,15 @@ include(Catch)
 file(GLOB_RECURSE TEST_SOURCES CONFIGURE_DEPENDS
      "${CMAKE_CURRENT_SOURCE_DIR}/source/*_test.cpp")
 
-add_executable(byte-span_test ${TEST_SOURCES})
+add_executable(ByteSpan_test ${TEST_SOURCES})
 target_link_libraries(
-    byte-span_test PRIVATE
-    byte-span::byte-span
+    ByteSpan_test PRIVATE
+    ByteSpan::ByteSpan
     Catch2::Catch2WithMain
 )
-target_compile_features(byte-span_test PRIVATE cxx_std_20)
+target_compile_features(ByteSpan_test PRIVATE cxx_std_20)
 
-catch_discover_tests(byte-span_test)
+catch_discover_tests(ByteSpan_test)
 
 # ---- End-of-file commands ----