Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: various developer notes updates #25092

Merged
merged 5 commits into from
May 16, 2022
Merged

doc: various developer notes updates #25092

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
370120e
Remove obsolete BDB ENABLE_WALLET section in developer notes
jonatack May 6, 2022
fc4cb85
Prefer Python for scripts in developer notes
jonatack May 6, 2022
5fca70f
Link in developer notes style to internal interface exception
jonatack May 6, 2022
e66b321
Add C++ functions and methods section to developer notes
jonatack May 9, 2022
6542842
Add clang lifetimebound section to developer notes
jonatack May 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add clang lifetimebound section to developer notes
  • Loading branch information
@jonatack
jonatack committed May 10, 2022
commit 654284209f30fd309c326a527cda1d2d7385cee8
11 changes: 11 additions & 0 deletions doc/developer-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Developer Notes
- [C++ data structures](#c-data-structures)
- [Strings and formatting](#strings-and-formatting)
- [Shadowing](#shadowing)
- [Lifetimebound](#lifetimebound)
- [Threads and synchronization](#threads-and-synchronization)
- [Scripts](#scripts)
- [Shebang](#shebang)
Expand Down Expand Up @@ -885,6 +886,16 @@ please name variables so that their names do not shadow variables defined in the
When using nested cycles, do not name the inner cycle variable the same as in
the outer cycle, etc.

Lifetimebound
--------------

The [Clang `lifetimebound`
attribute](https://clang.llvm.org/docs/AttributeReference.html#lifetimebound)
can be used to tell the compiler that a lifetime is bound to an object and
potentially see a compile-time warning if the object has a shorter lifetime from
the invalid use of a temporary. You can use the attribute by adding a `LIFETIMEBOUND`
annotation defined in `src/attributes.h`; please grep the codebase for examples.

Threads and synchronization
----------------------------

Expand Down