diff options
| author | W. J. van der Laan <laanwj@protonmail.com> | 2021-11-17 15:43:16 +0100 |
|---|---|---|
| committer | W. J. van der Laan <laanwj@protonmail.com> | 2021-11-17 17:06:55 +0100 |
| commit | 2ef186a1400c1c7f498549dd97c227819456245e (patch) | |
| tree | d5297111d3c5716d0d171ee9140cd38fbc3a0c4e /src/span.h | |
| parent | d94dc69ee454144f4db12d163b15717cc6cad383 (diff) | |
| parent | 33c6a208a9e2512a174c99c224a933a59f091bc2 (diff) | |
Merge bitcoin/bitcoin#22881: doc: provide context for CNetAddr::UnserializeV1Array() and span.h with lifetimebound
33c6a208a9e2512a174c99c224a933a59f091bc2 span, doc: provide span.h context and explain lifetimebound definition (Jon Atack)
d14395bc5db55331115fa3c1e71741d1de7f092f net, doc: provide context for UnserializeV1Array() (Jon Atack)
Pull request description:
Add contextual documentation for developers and future readers of the code regarding
- CNetAddr::UnserializeV1Array (see #22140)
- Span and why it defines Clang lifetimebound locally rather than using the one in attributes.h
ACKs for top commit:
laanwj:
Documentation review ACK 33c6a208a9e2512a174c99c224a933a59f091bc2
Tree-SHA512: cb8e6a6c23b36c9ef7499257e97c5378ec895bb9122b79b63b572d9721a1ae6ce6c0be7ad61bdf976c255527ae750fc9ff4b3e03c07c6c797d14dbc82ea9fb3a
Diffstat (limited to 'src/span.h')
| -rw-r--r-- | src/span.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/span.h b/src/span.h index 168162e309..1e347846d8 100644 --- a/src/span.h +++ b/src/span.h @@ -30,7 +30,11 @@ /** A Span is an object that can refer to a contiguous sequence of objects. * - * It implements a subset of C++20's std::span. + * This file implements a subset of C++20's std::span. It can be considered + * temporary compatibility code until C++20 and is designed to be a + * self-contained abstraction without depending on other project files. For this + * reason, Clang lifetimebound is defined here instead of including + * <attributes.h>, which also defines it. * * Things to be aware of when writing code that deals with Spans: * @@ -60,7 +64,7 @@ * types that expose a data() and size() member function), functions that * accept a Span as input parameter can be called with any compatible * range-like object. For example, this works: -* + * * void Foo(Span<const int> arg); * * Foo(std::vector<int>{1, 2, 3}); // Works |