]> git.proxmox.com Git - ceph.git/blobdiff - ceph/src/boost/libs/leaf/README.md
update ceph source to reef 18.1.2
[ceph.git] / ceph / src / boost / libs / leaf / README.md
index 0a97339585063a2b92b8fd9494a427aacbc06766..a8241876ee3395525504924582b1bf8af776044e 100644 (file)
@@ -1,22 +1,31 @@
-Boost LEAF is a lightweight error handling library for C++11.
+# LEAF
 
-Official documentation: https://boostorg.github.io/leaf/
+> A lightweight error handling library for C++11.
 
-Features:
+## Documentation
 
-* Small single-header format, **no dependencies**.
-* Designed for maximum efficiency ("happy" path and "sad" path).
-* No dynamic memory allocations, even with heavy payloads.
-* O(1) transport of arbitrary error types (independent of call stack depth).
+https://boostorg.github.io/leaf/
+
+## Features
+
+* Portable single-header format, no dependencies.
+* Tiny code size when configured for embedded development.
+* No dynamic memory allocations, even with very large payloads.
+* Deterministic unbiased efficiency on the "happy" path and the "sad" path.
+* Error objects are handled in constant time, independent of call stack depth.
 * Can be used with or without exception handling.
-* Support for multi-thread programming.
 
-Support is available via:
+## Support
 
 * [cpplang on Slack](https://Cpplang.slack.com) (use the `#boost` channel)
 * [Boost Users Mailing List](https://lists.boost.org/mailman/listinfo.cgi/boost-users)
 * [Boost Developers Mailing List](https://lists.boost.org/mailman/listinfo.cgi/boost)
 
-Copyright (c) 2018-2020 Emil Dotchevski and Reverge Studios, Inc.
+## Distribution
+
+Besides GitHub, there are two other distribution channels:
+
+* LEAF is included in official [Boost](https://www.boost.org/) releases, starting with Boost 1.75.
+* For maximum portability, the library is also available in single-header format: simply download [leaf.hpp](https://boostorg.github.io/leaf/leaf.hpp) (direct download link).
 
-Distributed under the [Boost Software License, Version 1.0](http://www.boost.org/LICENSE_1_0.txt).
+Copyright 2018-2022 Emil Dotchevski and Reverge Studios, Inc. Distributed under the http://www.boost.org/LICENSE_1_0.txt[Boost Software License, Version 1.0].