foster/bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-03-05 14:06:27 -05:00
Code Issues Activity

Prefer Python for scripts in developer notes

Browse source 
along with a few miscellaneous touch-ups.
This commit is contained in:
Jon Atack 2022-05-06 18:15:57 +02:00
parent 370120ec2f
commit fc4cb857cc
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/developer-notes.md
View file

@ -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. 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 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 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 - 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 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 Scripts
-------------------------- --------------------------
Write scripts in Python rather than bash, when possible.
### Shebang ### Shebang
- Use `#!/usr/bin/env bash` instead of obsolete `#!/bin/bash`. - 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 - 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. should come last.
Example: Example: