89ff142b99
If a project is using the facade-header yaml-cpp/yaml.h it might get `misc-include-cleaner` warnings from the `clangd` language server and `clang-tidy` that this header is not providing directly the symbols used. The annotation with IWYU pragmas fixes that and tells the tools that it should consider all the includes as if they directly provided the symbol Documentation clangd and clang-tidy https://clang.llvm.org/extra/clang-tidy/checks/misc/include-cleaner.html points to https://clangd.llvm.org/design/include-cleaner#iwyu-pragmas This has been first implemented and docuemnted in the include-what-you-use project https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md#iwyu-pragma-begin_exportsend_exports Signed-off-by: Henner Zeller <h.zeller@acm.org>
yaml-cpp 
yaml-cpp is a YAML parser and emitter in C++ matching the YAML 1.2 spec.
Usage
See Tutorial and How to Emit YAML for reference. For the old API (until 0.5.0), see How To Parse A Document.
Any Problems?
If you find a bug, post an issue! If you have questions about how to use yaml-cpp, please post it on http://stackoverflow.com and tag it yaml-cpp.
How to Build
yaml-cpp uses CMake to support cross-platform building. Install CMake (Resources -> Download) before proceeding. The basic steps to build are:
Note: If you don't use the provided installer for your platform, make sure that you add CMake's bin folder to your path.
1. Navigate into the source directory, create build folder and run CMake:
mkdir build
cd build
cmake [-G generator] [-DYAML_BUILD_SHARED_LIBS=on|OFF] ..
-
The
generatoroption is the build system you'd like to use. Runcmakewithout arguments to see a full list of available generators.- On Windows, you might use "Visual Studio 12 2013" (VS 2013 32-bits), or "Visual Studio 14 2015 Win64" (VS 2015 64-bits).
- On OS X, you might use "Xcode".
- On a UNIX-like system, omit the option (for a Makefile).
-
yaml-cppbuilds a static library by default, you may want to build a shared library by specifying-DYAML_BUILD_SHARED_LIBS=ON. -
Debug mode of the GNU standard C++ library can be used when both
yaml-cppand client code is compiled with the_GLIBCXX_DEBUGflag (e.g. by calling CMake with-D CMAKE_CXX_FLAGS_DEBUG='-g -D_GLIBCXX_DEBUG'option).Note that for
yaml-cppunit tests to run successfully, the GoogleTest library also must be built with this flag, i.e. the system one cannot be used (the YAML_USE_SYSTEM_GTEST CMake option must be OFF, which is the default). -
For more options on customizing the build, see the CMakeLists.txt file.
2. Build it!
- The command you'll need to run depends on the generator you chose earlier.
Note: To clean up, just remove the build directory.
How to Integrate it within your project using CMake
You can use for example FetchContent :
include(FetchContent)
FetchContent_Declare(
yaml-cpp
GIT_REPOSITORY https://github.com/jbeder/yaml-cpp.git
GIT_TAG <tag_name> # Can be a tag (yaml-cpp-x.x.x), a commit hash, or a branch name (master)
)
FetchContent_MakeAvailable(yaml-cpp)
target_link_libraries(YOUR_LIBRARY PUBLIC yaml-cpp::yaml-cpp) # The library or executable that require yaml-cpp library
Recent Releases
yaml-cpp 0.8.0 released!
yaml-cpp 0.3.0 is still available if you want the old API.
The old API will stop receiving bugfixes in 2026. The 0.3.x versions provide the old API, and 0.5.x and above all provide the new API.
API Documentation
The autogenerated API reference is hosted on CodeDocs
Third Party Integrations
The following projects are not officially supported: