Skip to content

Commit e3c5327

Browse files
committed
adoc: fix links after doc split
We must now use the xref style references, to link between independent *.adoc files: https://docs.asciidoctor.org/asciidoc/latest/macros/inter-document-xref/
1 parent f4e4aa4 commit e3c5327

28 files changed

+45
-45
lines changed

06_p2p.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Further down in `ThreadDNSAddressSeed()` we see such a magic number:
9797
unsigned int nMaxIPs = 256; // Limits number of IPs learned from a DNS seed
9898
----
9999

100-
If after 60 seconds we have not made any connections, then `ThreadOpenConnections` will deserialize the hardcoded seeds and https://github.com/bitcoin/bitcoin/blob/v23.0/src/net.cpp#L1960-L1987[add^] them to <<Addrman,addrman>> as candidates for connection.
100+
If after 60 seconds we have not made any connections, then `ThreadOpenConnections` will deserialize the hardcoded seeds and https://github.com/bitcoin/bitcoin/blob/v23.0/src/net.cpp#L1960-L1987[add^] them to xref:addrman.adoc#[addrman] as candidates for connection.
101101
////
102102
103103
include::message-relay.adoc[]

addition-removal-mempool.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
:page-title: Additional and removal of transactions
1+
:page-title: Addition and removal of transactions
22
:page-nav_order: 30
33
:page-parent: Mempool
44
:mermaid-puppeteer-config: ./puppeteer-config.json
55
include::links-onepage.adoc[]
66
== Addition to the mempool
77

88
Transactions are added to the mempool via `addUnchecked()` as part of the `AcceptToMemoryPool()` flow.
9-
See <<{transaction-validation}transaction_validation>> for more information on how this flow is entered.
9+
See xref:transaction-validation.adoc[Transaction validation] for more information on how this flow is entered.
1010

1111
WARNING: The function name `addUnchecked` specifically refers to the fact that no checks are being performed, so this must not be called until policy checks have passed.
1212

@@ -41,7 +41,7 @@ Transactions are removed from the mempool for a number of reasons:
4141

4242
. A new block has been connected `removeForBlock()`
4343
. A re-org is taking place `removeForReorg()`
44-
. The transaction has <<{mempool-lifecycle}default_mempool_expire,expired>> `Expire()`
44+
. The transaction has xref:mempool-lifecycle.adoc#default_mempool_expire[expired] `Expire()`
4545
. The transaction is being replaced by a higher-fee version `MemPoolAccept::Finalize()`
4646
. The mempool must be trimmed back down below its maximum size `TrimToSize()`
4747

addrman.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ include::links-onepage.adoc[]
55
=== Addrman
66

77
Addrman is the in-memory database of peers and consists of the new and tried tables.
8-
These tables are stored in `peers.dat` and serve as cache for network information that the node gathered from previous connections, so that if it is rebooted it can quickly reestablish connections with its former peer network and avoid performing <<{bootstrapping}bootstrapping, the seeding process>> again.
8+
These tables are stored in `peers.dat` and serve as cache for network information that the node gathered from previous connections, so that if it is rebooted it can quickly re-establish connections with its former peer network and avoid performing xref:bootstrapping.adoc[bootstrapping] again.
99

1010
Addrman is setup using `LoadAddrman` from _src/addrdb.cpp_, passing in the `NetGroupManager`, our global program `args` and a pointer to the (to be initialized) `Addrman`.
1111
`args` are used to determine whether consistency checks should run and to pass on the `datadir` value in order to attempt deserialization on any addrman database (`peers.dat`) that is found.
@@ -102,7 +102,7 @@ TIP: The nonces generated by the randomizer are used to detect us making new con
102102
Connman is started via `node.connman->Start()` in _init.cpp_.
103103
This begins by calling `init()` which binds to any ports selected, before starting up an I2P session if the I2P proxy is found.
104104
Next it schedules sending `GETADDR` to any seednodes provided (via `-seednodes`) using the `ThreadOpenConnections()` loop, and then continues by loading anchor connections from _anchors.dat_.
105-
Following this the various <<{threads}net_threads,net threads>> are started up.
105+
Following this the various xref:threads.adoc#net_threads[net threads] are started up.
106106

107107
As connman has a pointer to the node's addrman it can directly fetch new addresses to serve via `CConnman:GetAddresses()`.
108108
If new addresses are requested from a remote P2P node (via `GETADDR`), then it will use a https://github.com/bitcoin/bitcoin/blob/v23.0/src/net.h#L1129-L1154[cached^] addr response to respond with.

block-relay.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Because `-blocksonly` is a global startup option, it therefore applies to all co
2929
block-relay-only connections are a specific type of connection which is used by Bitcoin Core full nodes to only participate in block relay.
3030

3131
As currently implemented block-relay-only connections (introduced in https://github.com/bitcoin/bitcoin/pull/15759[PR#15759^]), disables both transaction and address relay.
32-
Bitcoin Core nodes per default settings make two *outbound* block-relay-only connections in addition to 8 regular outbound connections (also see <<{p2p-attacks}eclipse_attacks>> for more use cases of these connections).
32+
Bitcoin Core nodes per default settings make two *outbound* block-relay-only connections in addition to 8 regular outbound connections (also see xref:p2p-attacks.adoc#eclipse_attacks[eclipse attacks] for more use cases of these connections).
3333

3434

3535
[id=blocksonly-vs-block-relay-only]

calculating-balance.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ PR https://github.com/bitcoin/bitcoin/pull/19602[19602^] enables migration of le
9393
Although legacy wallets are now effectively end of life it's still relevant to have documentation for legacy wallets.
9494
****
9595

96-
See the section on how wallets determine whether transactions belong to them using the <<{transaction-identification}ismine-enum,IsMine>> enum for more in-depth information.
96+
See the section on how wallets determine whether transactions belong to them using the xref:transaction-identification.adoc#ismine-enum[enum] for more in-depth information.
9797

9898
=== Conflict tracking
9999

coin-selection.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::links-onepage.adoc[]
66
=== Coin selection
77

88
See https://bitcoinops.org/en/topics/coin-selection/[Bitcoin Optech^] for more information on coin selection.
9-
There is a section digging deeper into the coin selection code found <<{constructing-transactions}coin-selection,below>>.
9+
There is a section digging deeper into the coin selection code found xref:constructing-transactions.adoc#coin-selection[below].
1010
To select inputs to a transaction our primary considerations are privacy and fees.
1111

1212
The below sections form an overview of creating a transaction via `CreateTransactionInternal()`.
@@ -47,7 +47,7 @@ If this is still unsuccessful it increases the number of ancestors and descendan
4747
==== `AttemptSelection()`
4848

4949
This function is orchestrating the <<GroupOutputs,Output group>> creation, and then the <<selectCoins,coin selection>>.
50-
Currently, this is always based on the <<{constructing-transactions}coin-selection,waste metric>>.
50+
Currently, this is always based on the xref:constructing-transactions.adoc#coin-selection[waste metric].
5151

5252
It is using 3 algorithms and then selecting the "best" of the three (based on the waste metric):
5353

consensus-and-validation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ WARNING: If all nodes do not compute consensus values identically (including edg
1515

1616
For more information on how the bitcoin networks' decentralized consensus mechanism works see the Mastering Bitcoin section on https://github.com/bitcoinbook/bitcoinbook/tree/develop/ch10.asciidoc#decentralized-consensus[decentralized consensus^].
1717

18-
TIP: In Bitcoin Core there are an extra level of validation checks applied to incoming transactions in addition to consensus checks called "policy" which have a slightly different purpose, see <<{consensus-v-policy}consensus_vs_policy>> for more information on the differences between the two.
18+
TIP: In Bitcoin Core there are an extra level of validation checks applied to incoming transactions in addition to consensus checks called "policy" which have a slightly different purpose, see xref:consensus-v-policy.adoc#consensus_vs_policy[consensus vs policy] for more information on the differences between the two.
1919

2020
Consensus::
2121
A collection of functions and variables which **must** be computed identically to all https://bitnodes.io/nodes/[other^] nodes on the network in order to remain in consensus and therefore on the main chain.

consensus-bugs.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Do you think this approach -- first altering policy, followed later by consensus
109109
Are there circumstances where it might not make sense?
110110
====
111111

112-
Having OpenSSL as a consensus-critical dependency to the project was ultimately fixed in https://github.com/bitcoin/bitcoin/pull/6954[PR#6954^] which switched to using the in-house libsecp256k1 library (as a <<{subtrees}subtrees,subtree>>) for signature verification.
112+
Having OpenSSL as a consensus-critical dependency to the project was ultimately fixed in https://github.com/bitcoin/bitcoin/pull/6954[PR#6954^] which switched to using the in-house libsecp256k1 library (as a xref:subtrees.adoc#subtrees[subtree]) for signature verification.
113113

114114
[[database_consensus]]
115115
=== Database consensus
@@ -188,7 +188,7 @@ If they do, then the changes will end up being either a soft or hard fork, depen
188188

189189
WARNING: As <<Database consensus,described>>, certain Bitcoin Core components, such as the block database can also unwittingly introduce forking behaviour, even though they do not directly modify consensus rules.
190190

191-
Some of the components which are known to alter consensus behaviour, and should therefore be approached with caution, are listed in the section <<{locating-consensus-code}consensus-components,consensus components>>.
191+
Some of the components which are known to alter consensus behaviour, and should therefore be approached with caution, are listed in the section xref:locating-consensus-code.adoc#consensus-components[consensus components].
192192

193193
Changes are not made to consensus values or computations without extreme levels of review and necessity.
194194
In contrast, changes such as refactoring can be (and are) made to areas of consensus code, when we can be sure that they will not alter consensus validation.

consensus-exercises.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Contextual checks require some knowledge of the current "state", e.g. ChainState
1414

1515
Context-free checks only require the information required in the transaction itself.
1616

17-
For more info, see <<{transaction-validation}glozow-tx-mempool-validation,glozow's notes>> on transaction "Validation and Submission to the Mempool".
17+
For more info, see xref:transaction-validation.adoc#glozow-tx-mempool-validation[glozow's notes] on transaction "Validation and Submission to the Mempool".
1818
====
1919

2020
What are some examples of each?::

consensus-specification.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ include::links-onepage.adoc[]
55
== Bitcoin core consensus specification
66

77
A common question is where the bitcoin protocol is documented, i.e. specified.
8-
However bitcoin does not have a formal specification, even though many ideas have some specification (in <<{bips}bips>>) to aid re-implementation.
8+
However bitcoin does not have a formal specification, even though many ideas have some specification (in xref:bips.adoc[BIPS]) to aid re-implementation.
99

1010
IMPORTANT: The requirements to be compliant with "the bitcoin spec" are to be bug-for-bug compatible with the Bitcoin Core implementation.
1111

0 commit comments

Comments
 (0)