diff --git a/doc/usage.rst b/doc/usage.rst index f9f818584a9a0..02884531d1d05 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -134,6 +134,44 @@ For ``build2`` newcomers or to get more details and use cases, you can read the ``build2`` `toolchain introduction `_. +Usage with meson +================ + +`Meson's wrapdb ` includes a ``fmt`` +package, which repackages fmt to be built by meson as a subproject. + +**Usage:** + +- Install the ``fmt`` subproject from the wrapdb by running + + meson wrap install fmt + + from the root of your project. + +- In your project's ``meson.build`` file, add an entry for the new subproject: + + fmt = subproject('fmt') + fmt_dep = fmt.get_variable('fmt_dep') + +- Include the new dependency object to link with fmt: + + my_build_target = executable('name', 'src/main.cc', dependencies: [fmt_dep]) + +**Options:** + +If desired, ``fmt`` may be built as a static library, or as a headers-only +library. + +For a static build, use the following subproject definition: + + fmt = subproject('fmt', default_options: 'default_library=static') + fmt_dep = fmt.get_variable('fmt_dep') + +For the headers-only version, use: + + fmt = subproject('fmt') + fmt_dep = fmt.get_variable('fmt_header_only_dep') + Building the Documentation ==========================