From c0bf70d89a96f4cedc516dd526e46e4c624c08ae Mon Sep 17 00:00:00 2001 From: "Mads R. B. Kristensen" Date: Mon, 4 Nov 2024 16:38:59 +0100 Subject: [PATCH] doc --- README.md | 1 - cpp/doxygen/main_page.md | 6 ++---- cpp/include/kvikio/shim/utils.hpp | 9 ++++----- 3 files changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e0e26ac560..50e4328fbd 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,6 @@ KvikIO (pronounced "kuh-VICK-eye-oh", see [here](https://ordnet.dk/ddo_en/dict?q bindings to [cuFile](https://docs.nvidia.com/gpudirect-storage/api-reference-guide/index.html), which enables [GPUDirect Storage (GDS)](https://developer.nvidia.com/blog/gpudirect-storage/). KvikIO also works efficiently when GDS isn't available and can read/write both host and device data seamlessly. -The C++ library is header-only making it easy to include in [existing projects](https://github.com/rapidsai/kvikio/blob/HEAD/cpp/examples/downstream/). ### Features diff --git a/cpp/doxygen/main_page.md b/cpp/doxygen/main_page.md index 21a33b1d45..497fb3e13e 100644 --- a/cpp/doxygen/main_page.md +++ b/cpp/doxygen/main_page.md @@ -5,7 +5,7 @@ bindings to [cuFile](https://docs.nvidia.com/gpudirect-storage/api-reference-gui which enables [GPUDirect Storage (GDS)](https://developer.nvidia.com/blog/gpudirect-storage/). KvikIO also works efficiently when GDS isn't available and can read/write both host and device data seamlessly. -KvikIO C++ is a header-only library that is part of the [RAPIDS](https://rapids.ai/) suite of open-source software libraries for GPU-accelerated data science. +KvikIO C++ is part of the [RAPIDS](https://rapids.ai/) suite of open-source software libraries for GPU-accelerated data science. --- **Notice** this is the documentation for the C++ library. For the Python documentation, see under [kvikio](https://docs.rapids.ai/api/kvikio/nightly/). @@ -23,9 +23,7 @@ KvikIO C++ is a header-only library that is part of the [RAPIDS](https://rapids. ## Installation -KvikIO is a header-only library and as such doesn't need installation. -However, for convenience we release Conda packages that makes it easy -to include KvikIO in your CMake projects. +For convenience we release Conda packages that makes it easy to include KvikIO in your CMake projects. ### Conda/Mamba diff --git a/cpp/include/kvikio/shim/utils.hpp b/cpp/include/kvikio/shim/utils.hpp index f805ed8ee3..17a38c62ac 100644 --- a/cpp/include/kvikio/shim/utils.hpp +++ b/cpp/include/kvikio/shim/utils.hpp @@ -24,11 +24,10 @@ namespace kvikio { // Macros used for defining symbol visibility. -// Since KvikIO is header-only, we rely on the linker to disambiguate inline functions -// and static methods that have (or return) static references. To do this, the relevant -// function/method must have `__attribute__((visibility("default")))`. If not, then if -// KvikIO is used in two different DSOs, the function will appear twice, and there will -// be two static objects. +// Since KvikIO declare global default values in headers, we rely on the linker to disambiguate +// inline and static methods that have (or return) static references. To do this, the relevant +// function/method must have `__attribute__((visibility("default")))`. If not, then if KvikIO is +// used in two different DSOs, the function will appear twice, and there will be two static objects. // See and . #if (defined(__GNUC__) || defined(__clang__)) && !defined(__MINGW32__) && !defined(__MINGW64__) #define KVIKIO_EXPORT __attribute__((visibility("default")))