Skip to content

Commit

Permalink
docs: small celanup of "Build options" chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
mpusz committed Jul 16, 2024
1 parent b870b85 commit 827b0f5
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/getting_started/installation_and_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,6 @@ tools.build:compiler_executables={"c": "gcc-12", "cpp": "g++-12"}

[conan build all support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0


[`user.mp-units.build:skip_la`](#user-skip-la){ #user-skip-la }

: [:octicons-tag-24: 2.2.0][conan skip la support] · :octicons-milestone-24: `True`/`False` (Default: `True`)
Expand All @@ -321,7 +320,6 @@ tools.build:compiler_executables={"c": "gcc-12", "cpp": "g++-12"}

[conan skip la support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0


[`user.mp-units.analyze:clang-tidy`](#user.mp-units.analyze-clang-tidy){ #user.mp-units.analyze-clang-tidy }

: [:octicons-tag-24: 2.2.0][conan clang-tidy support] · :octicons-milestone-24: `True`/`False` (Default: `False`)
Expand All @@ -334,18 +332,19 @@ tools.build:compiler_executables={"c": "gcc-12", "cpp": "g++-12"}

[`MP_UNITS_BUILD_AS_SYSTEM_HEADERS`](#MP_UNITS_BUILD_AS_SYSTEM_HEADERS){ #MP_UNITS_BUILD_AS_SYSTEM_HEADERS }

: [:octicons-tag-24: 2.2.0][as system headers support] · :octicons-milestone-24: `ON`/`OFF` (Default: `OFF`)
: [:octicons-tag-24: 2.2.0][cmake as system headers support] · :octicons-milestone-24: `ON`/`OFF` (Default: `OFF`)

Exports library as system headers.

[as system headers support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
[cmake as system headers support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0

[`MP_UNITS_BUILD_CXX_MODULES`](#MP_UNITS_BUILD_CXX_MODULES){ #MP_UNITS_BUILD_CXX_MODULES }

: [:octicons-tag-24: 2.2.0][build_cxx_modules support] · :octicons-milestone-24: `ON`/`OFF` (Default: `OFF`)
: [:octicons-tag-24: 2.2.0][cmake build cxx modules support] · :octicons-milestone-24: `ON`/`OFF` (Default: `OFF`)

Adds C++ modules to the list of default targets.

[cmake build cxx modules support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0

[`MP_UNITS_BUILD_IMPORT_STD`](#MP_UNITS_BUILD_IMPORT_STD){ #MP_UNITS_BUILD_IMPORT_STD }

Expand All @@ -357,13 +356,13 @@ tools.build:compiler_executables={"c": "gcc-12", "cpp": "g++-12"}

[`MP_UNITS_API_STD_FORMAT`](#MP_UNITS_API_STD_FORMAT){ #MP_UNITS_API_STD_FORMAT }

: [:octicons-tag-24: 2.2.0][use fmtlib support] · :octicons-milestone-24: `ON`/`OFF` (Default: automatically determined)
: [:octicons-tag-24: 2.2.0][cmake std::format support] · :octicons-milestone-24: `ON`/`OFF` (Default: automatically determined)

Enables the usage of [`std::format`](https://en.cppreference.com/w/cpp/utility/format/format)
and associated facilities for text formatting. If it is not supported, then
the [{fmt}](https://github.com/fmtlib/fmt) library is used instead.

[use fmtlib support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
[cmake std::format support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0

[`MP_UNITS_API_STRING_VIEW_RET`](#MP_UNITS_API_STRING_VIEW_RET){ #MP_UNITS_API_STRING_VIEW_RET }

Expand Down

0 comments on commit 827b0f5

Please sign in to comment.