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/netaddress.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/netaddress.h')
| -rw-r--r-- | src/netaddress.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/netaddress.h b/src/netaddress.h index b0b1c5ca9e..a5b74eb35b 100644 --- a/src/netaddress.h +++ b/src/netaddress.h @@ -385,6 +385,12 @@ private: /** * Unserialize from a pre-ADDRv2/BIP155 format from an array. + * + * This function is only called from UnserializeV1Stream() and is a wrapper + * for SetLegacyIPv6(); however, we keep it for symmetry with + * SerializeV1Array() to have pairs of ser/unser functions and to make clear + * that if one is altered, a corresponding reverse modification should be + * applied to the other. */ void UnserializeV1Array(uint8_t (&arr)[V1_SERIALIZATION_SIZE]) { |