From af8fd0f1a9e6a9a7344f89e9260747f06b63c314 Mon Sep 17 00:00:00 2001 From: Marc Alff Date: Tue, 12 Sep 2023 16:47:24 +0200 Subject: [PATCH] format --- api/CMakeLists.txt | 3 ++- docs/building-with-stdlib.md | 7 ++++--- docs/dependencies.md | 5 +++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/api/CMakeLists.txt b/api/CMakeLists.txt index 2b90011caf..88f98591ca 100644 --- a/api/CMakeLists.txt +++ b/api/CMakeLists.txt @@ -79,7 +79,8 @@ elseif(WITH_STL STREQUAL "ON") target_compile_definitions(opentelemetry_api INTERFACE OPENTELEMETRY_STL_VERSION=2023) else() - message(FATAL_ERROR "WITH_STL must be ON, OFF, CXX11, CXX14, CXX17, CXX20 or CXX23") + message( + FATAL_ERROR "WITH_STL must be ON, OFF, CXX11, CXX14, CXX17, CXX20 or CXX23") endif() if(WITH_GSL) diff --git a/docs/building-with-stdlib.md b/docs/building-with-stdlib.md index b52b58ff90..d9c73073da 100644 --- a/docs/building-with-stdlib.md +++ b/docs/building-with-stdlib.md @@ -138,12 +138,13 @@ Visual Studio provides 1st class debug experience for the standard library. Supported build flavors: * `nostd` - OpenTelemetry backport of classes for C++11. Not using standard lib. -* `stdlib` - Standard Library. Native experience with - C++11/C++14/C++17/C++20/C++23 compiler. +* `stdlib` - Standard Library. + Native experience with C++11/C++14/C++17/C++20/C++23 compiler. Depending on the stdlib level in effect, C++ features are used from the standard library, completed with `nostd` replacement implementations. - C++17 and below works but with additional dependencies, e.g. either MS-GSL or Abseil for + C++17 and below works but with additional dependencies, + e.g. either MS-GSL or Abseil for `std::span` implementation (`gsl::span` or `absl::Span`). * `absl` - TODO: this should allow using Abseil C++ library only (no MS-GSL). diff --git a/docs/dependencies.md b/docs/dependencies.md index c8a2271ef5..d0dc09c54f 100644 --- a/docs/dependencies.md +++ b/docs/dependencies.md @@ -24,8 +24,9 @@ Both these dependencies are listed here: [SDK](/sdk): - Uses Standard C++ library for latest features (std::string_view, std::variant, std::span, std::shared_ptr, std::unique_ptr) with C++14/17/20 - compiler if cmake option `WITH_STL` is enabled or macro `OPENTELEMETRY_STL_VERSION` is - defined. License: `GNU General Public License` + compiler if cmake option `WITH_STL` is enabled + or macro `OPENTELEMETRY_STL_VERSION` is defined. + License: `GNU General Public License` - For C++11/14/17 compilers, fallback to gsl::span if [GSL C++ library](https://github.com/microsoft/GSL) is installed. License: `MIT License`