X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=CONTRIBUTING.adoc;h=72434e89346dc4ef7dcd15e306ae095898a87794;hp=37105c6c696af503273b5068d8d77051ea290ede;hb=HEAD;hpb=8ae5c2b21dc7f792be1a6b10fc245d82ba501e21 diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 37105c6c..171fcb14 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -1728,6 +1728,11 @@ When possible, prefer using this over the C{nbsp}logging API. One important benefit is that this API uses {fmt} to format the logging message instead of `vsnprintf()`. +`make-span.hpp`:: + The function template `bt2c::makeSpan()` which is an alternative to + https://en.cppreference.com/w/cpp/language/class_template_argument_deduction[CTAD] + (a {cpp}17 feature). + `prio-heap.hpp`:: The `bt2c::PrioHeap` class template: an efficient heap data structure. @@ -1777,7 +1782,7 @@ Also provides conversion to `bt2c::Uuid`. Everything under the `bt2s` namespace has its equivalent under the `std` namespace, but in {cpp} versions we don't yet have access to, namely: -`make_unique.hpp`:: +`make-unique.hpp`:: `bt2s::make_unique()`, a drop-in replacement of `std::make_unique()` ({cpp}14). @@ -1814,6 +1819,11 @@ the `bt2s` namespace, instead of using this directly. + IMPORTANT: Use the symbols of `src/cpp-common/bt2s/span.hpp`, under the `bt2s` namespace, instead of using this directly. ++ +TIP: `src/cpp-common/bt2c/make-span.hpp` offers `bt2c::makeSpan()` which +is an alternative to +https://en.cppreference.com/w/cpp/language/class_template_argument_deduction[CTAD] +(a {cpp}17 feature). `string-view-lite`:: https://github.com/martinmoene/string-view-lite[string_view lite].