diff options
| author | Jon Atack <jon@atack.com> | 2022-05-06 18:15:57 +0200 |
|---|---|---|
| committer | Jon Atack <jon@atack.com> | 2022-05-09 16:13:38 +0200 |
| commit | fc4cb857ccfa622e76f0f8e7aa164ca4d8bd599a (patch) | |
| tree | 8b751021246a053f18eca46240a7e9586470f70f /doc/developer-notes.md | |
| parent | 370120ec2ff4b5e7d5cd6678a7be7cfe651be509 (diff) | |
| download | bitcoin-fc4cb857ccfa622e76f0f8e7aa164ca4d8bd599a.tar.xz | |
Prefer Python for scripts in developer notes
along with a few miscellaneous touch-ups.
Diffstat (limited to 'doc/developer-notes.md')
| -rw-r--r-- | doc/developer-notes.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index b1bb7dc887..00fa0825a8 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -859,12 +859,12 @@ from using a different variable with the same name), please name variables so that their names do not shadow variables defined in the source code. When using nested cycles, do not name the inner cycle variable the same as in -the upper cycle, etc. +the outer cycle, etc. Threads and synchronization ---------------------------- -- Prefer `Mutex` type to `RecursiveMutex` one +- Prefer `Mutex` type to `RecursiveMutex` one. - Consistently use [Clang Thread Safety Analysis](https://clang.llvm.org/docs/ThreadSafetyAnalysis.html) annotations to get compile-time warnings about potential race conditions in code. Combine annotations in function declarations with @@ -943,6 +943,8 @@ TRY_LOCK(cs_vNodes, lockNodes); Scripts -------------------------- +Write scripts in Python rather than bash, when possible. + ### Shebang - Use `#!/usr/bin/env bash` instead of obsolete `#!/bin/bash`. @@ -1386,7 +1388,7 @@ communication: ``` - For consistency and friendliness to code generation tools, interface method - input and inout parameters should be ordered first and output parameters + input and in-out parameters should be ordered first and output parameters should come last. Example: |