diff --git a/doc/design/multiprocess.md b/doc/design/multiprocess.md index 11e81527ce1..16121dc373c 100644 --- a/doc/design/multiprocess.md +++ b/doc/design/multiprocess.md @@ -4,27 +4,6 @@ Guide to the design and architecture of the Bitcoin Core multiprocess feature _This document describes the design of the multiprocess feature. For usage information, see the top-level [multiprocess.md](../multiprocess.md) file._ -## Table of contents - -- [Introduction](#introduction) -- [Current Architecture](#current-architecture) -- [Proposed Architecture](#proposed-architecture) -- [Component Overview: Navigating the IPC Framework](#component-overview-navigating-the-ipc-framework) -- [Design Considerations](#design-considerations) - - [Selection of Cap’n Proto](#selection-of-capn-proto) - - [Hiding IPC](#hiding-ipc) - - [Interface Definition Maintenance](#interface-definition-maintenance) - - [Interface Stability](#interface-stability) -- [Security Considerations](#security-considerations) -- [Example Use Cases and Flows](#example-use-cases-and-flows) - - [Retrieving a Block Hash](#retrieving-a-block-hash) -- [Future Enhancements](#future-enhancements) -- [Conclusion](#conclusion) -- [Appendices](#appendices) - - [Glossary of Terms](#glossary-of-terms) - - [References](#references) -- [Acknowledgements](#acknowledgements) - ## Introduction The Bitcoin Core software has historically employed a monolithic architecture. The existing design has integrated functionality like P2P network operations, wallet management, and a GUI into a single executable. While effective, it has limitations in flexibility, security, and scalability. This project introduces changes that transition Bitcoin Core to a more modular architecture. It aims to enhance security, improve usability, and facilitate maintenance and development of the software in the long run. diff --git a/doc/developer-notes.md b/doc/developer-notes.md index ff3247ce13e..8a7bc8db40f 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -1,53 +1,5 @@ # Developer Notes - -**Table of Contents** - -- [Developer Notes](#developer-notes) - - [Coding Style (General)](#coding-style-general) - - [Coding Style (C++)](#coding-style-c) - - [Coding Style (Python)](#coding-style-python) - - [Coding Style (Doxygen-compatible comments)](#coding-style-doxygen-compatible-comments) - - [Generating Documentation](#generating-documentation) - - [Development tips and tricks](#development-tips-and-tricks) - - [Compiling for debugging](#compiling-for-debugging) - - [Show sources in debugging](#show-sources-in-debugging) - - [`debug.log`](#debuglog) - - [Signet, testnet, and regtest modes](#signet-testnet-and-regtest-modes) - - [DEBUG_LOCKORDER](#debug_lockorder) - - [DEBUG_LOCKCONTENTION](#debug_lockcontention) - - [Valgrind suppressions file](#valgrind-suppressions-file) - - [Compiling for test coverage](#compiling-for-test-coverage) - - [Performance profiling with perf](#performance-profiling-with-perf) - - [Sanitizers](#sanitizers) - - [Locking/mutex usage notes](#lockingmutex-usage-notes) - - [Threads](#threads) - - [Ignoring IDE/editor files](#ignoring-ideeditor-files) -- [Development guidelines](#development-guidelines) - - [General Bitcoin Core](#general-bitcoin-core) - - [Wallet](#wallet) - - [General C++](#general-c) - - [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) - - [Source code organization](#source-code-organization) - - [GUI](#gui) - - [Subtrees](#subtrees) - - [Upgrading LevelDB](#upgrading-leveldb) - - [File Descriptor Counts](#file-descriptor-counts) - - [Consensus Compatibility](#consensus-compatibility) - - [Scripted diffs](#scripted-diffs) - - [Suggestions and examples](#suggestions-and-examples) - - [Release notes](#release-notes) - - [RPC interface guidelines](#rpc-interface-guidelines) - - [Internal interface guidelines](#internal-interface-guidelines) - - - ## Coding Style (General) Various coding styles have been used during the history of the codebase, diff --git a/doc/productivity.md b/doc/productivity.md index e5268fdd1b8..d80ee90e0df 100644 --- a/doc/productivity.md +++ b/doc/productivity.md @@ -1,26 +1,5 @@ # Productivity Notes -## Table of Contents - -* [General](#general) - * [Cache compilations with `ccache`](#cache-compilations-with-ccache) - * [Disable features when generating the build system](#disable-features-when-generating-the-build-system) - * [Make use of your threads with `-j`](#make-use-of-your-threads-with--j) - * [Only build what you need](#only-build-what-you-need) - * [Compile on multiple machines](#compile-on-multiple-machines) - * [Multiple working directories with `git worktrees`](#multiple-working-directories-with-git-worktrees) - * [Interactive "dummy rebases" for fixups and execs with `git merge-base`](#interactive-dummy-rebases-for-fixups-and-execs-with-git-merge-base) -* [Writing code](#writing-code) - * [Format C/C++ diffs with `clang-format-diff.py`](#format-cc-diffs-with-clang-format-diffpy) - * [Format Python diffs with `yapf-diff.py`](#format-python-diffs-with-yapf-diffpy) -* [Rebasing/Merging code](#rebasingmerging-code) - * [More conflict context with `merge.conflictstyle diff3`](#more-conflict-context-with-mergeconflictstyle-diff3) -* [Reviewing code](#reviewing-code) - * [Reduce mental load with `git diff` options](#reduce-mental-load-with-git-diff-options) - * [Fetch commits directly](#fetch-commits-directly) - * [Reference PRs easily with `refspec`s](#reference-prs-easily-with-refspecs) - * [Diff the diffs with `git range-diff`](#diff-the-diffs-with-git-range-diff) - ## General ### Cache compilations with `ccache`