|
1 | 1 | # Developer Notes
|
2 | 2 |
|
3 |
| -<!-- markdown-toc start --> |
4 |
| -**Table of Contents** |
5 |
| - |
6 |
| -- [Developer Notes](#developer-notes) |
7 |
| - - [Coding Style (General)](#coding-style-general) |
8 |
| - - [Coding Style (C++)](#coding-style-c) |
9 |
| - - [Coding Style (Python)](#coding-style-python) |
10 |
| - - [Coding Style (Doxygen-compatible comments)](#coding-style-doxygen-compatible-comments) |
11 |
| - - [Generating Documentation](#generating-documentation) |
12 |
| - - [Development tips and tricks](#development-tips-and-tricks) |
13 |
| - - [Compiling for debugging](#compiling-for-debugging) |
14 |
| - - [Show sources in debugging](#show-sources-in-debugging) |
15 |
| - - [`debug.log`](#debuglog) |
16 |
| - - [Signet, testnet, and regtest modes](#signet-testnet-and-regtest-modes) |
17 |
| - - [DEBUG_LOCKORDER](#debug_lockorder) |
18 |
| - - [DEBUG_LOCKCONTENTION](#debug_lockcontention) |
19 |
| - - [Valgrind suppressions file](#valgrind-suppressions-file) |
20 |
| - - [Compiling for test coverage](#compiling-for-test-coverage) |
21 |
| - - [Performance profiling with perf](#performance-profiling-with-perf) |
22 |
| - - [Sanitizers](#sanitizers) |
23 |
| - - [Locking/mutex usage notes](#lockingmutex-usage-notes) |
24 |
| - - [Threads](#threads) |
25 |
| - - [Ignoring IDE/editor files](#ignoring-ideeditor-files) |
26 |
| -- [Development guidelines](#development-guidelines) |
27 |
| - - [General Bitcoin Core](#general-bitcoin-core) |
28 |
| - - [Wallet](#wallet) |
29 |
| - - [General C++](#general-c) |
30 |
| - - [C++ data structures](#c-data-structures) |
31 |
| - - [Strings and formatting](#strings-and-formatting) |
32 |
| - - [Shadowing](#shadowing) |
33 |
| - - [Lifetimebound](#lifetimebound) |
34 |
| - - [Threads and synchronization](#threads-and-synchronization) |
35 |
| - - [Scripts](#scripts) |
36 |
| - - [Shebang](#shebang) |
37 |
| - - [Source code organization](#source-code-organization) |
38 |
| - - [GUI](#gui) |
39 |
| - - [Subtrees](#subtrees) |
40 |
| - - [Upgrading LevelDB](#upgrading-leveldb) |
41 |
| - - [File Descriptor Counts](#file-descriptor-counts) |
42 |
| - - [Consensus Compatibility](#consensus-compatibility) |
43 |
| - - [Scripted diffs](#scripted-diffs) |
44 |
| - - [Suggestions and examples](#suggestions-and-examples) |
45 |
| - - [Release notes](#release-notes) |
46 |
| - - [RPC interface guidelines](#rpc-interface-guidelines) |
47 |
| - - [Internal interface guidelines](#internal-interface-guidelines) |
48 |
| - |
49 |
| -<!-- markdown-toc end --> |
50 |
| - |
51 | 3 | ## Coding Style (General)
|
52 | 4 |
|
53 | 5 | Various coding styles have been used during the history of the codebase,
|
|
0 commit comments