From 88534b92ebf8dde58594b3807b2dbb739c9dc3c2 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Tue, 23 Apr 2024 12:50:13 -0400 Subject: [PATCH] CONTRIBUTING.adoc: mention bt2c::makeSpan() Signed-off-by: Philippe Proulx Change-Id: I6b5340fd353cbd4ef40f9e75322588842f10a788 Reviewed-on: https://review.lttng.org/c/babeltrace/+/12455 Reviewed-by: Simon Marchi --- CONTRIBUTING.adoc | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 2e1e136e..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. @@ -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]. -- 2.34.1