Merge pull request #1724 from Mirobit/devclean

Devdoc clean up
This commit is contained in:
Will Binns 2017-08-06 07:33:05 -06:00 committed by GitHub
commit 7d32f8407f
6 changed files with 10 additions and 18 deletions

View file

@ -223,7 +223,7 @@ check-for-missing-rpc-summaries:
## Make sure the Quick Reference section has a summary for each RPC we
## have documented
$S for f in _includes/devdoc/bitcoin-core/rpcs/rpcs/*.md ;\
do grep -q "\[$$( grep '^##### ' $$f | sed 's/^##### *\([a-zA-Z]*\).*/\1/')\]\[" _includes/devdoc/bitcoin-core/rpcs/quick-ref.md \
do grep -q "\[$$( grep '^##### ' $$f | sed 's/^##### *\([a-zA-Z]*\).*/\1/')\]\[" _includes/devdoc/bitcoin-core/rpcs/quick-reference.md \
|| echo 'missing summary for '$$f', you need to add the summary to _includes/devdoc/bitcoin-core/rpcs/quick-ref.md and run make manual-updates' \
; done | eval $(ERROR_ON_OUTPUT)

View file

@ -2,7 +2,7 @@
This file is licensed under the MIT License (MIT) available on
http://opensource.org/licenses/MIT.
{% endcomment %}
{% assign filename="_includes/devdoc/bitcoin-core/rpcs/quick-ref.md" %}
{% assign filename="_includes/devdoc/bitcoin-core/rpcs/quick-reference.md" %}
#### Quick Reference {#rpc-quick-reference}
{% include helpers/subhead-links.md %}

View file

@ -21,7 +21,7 @@ The `getbalance` RPC {{summary_getBalance}}
- n: "Account"
t: "string"
p: "Optional<br>(0 or 1)"
d: "The name of an account to get the balance for. An empty string (\"\") is the default account. The string `*` will get the balance for all accounts (this is the default behavior)"
d: "*Deprecated: will be removed in a later version of Bitcoin Core*<br><br>The name of an account to get the balance for. An empty string (\"\") is the default account. The string `*` will get the balance for all accounts (this is the default behavior)"
{% enditemplate %}

View file

@ -119,10 +119,6 @@ someone else, that second transaction would not be displayed in our
list of UTXOs.
{% highlight bash %}
## Bitcoin Core 0.10.1 and earlier
> bitcoin-cli -regtest setgenerate true 1
## Later versions of Bitcoin Core
> bitcoin-cli -regtest generate 1
> unset NEW_ADDRESS
@ -349,10 +345,6 @@ would usually then broadcast it to other peers, but we're not currently
connected to other peers because we started in regtest mode.
{% highlight bash %}
## Bitcoin Core 0.10.1 and earlier
> bitcoin-cli -regtest setgenerate true 1
## Later versions of Bitcoin Core
> bitcoin-cli -regtest generate 1
> unset UTXO_TXID UTXO_VOUT NEW_ADDRESS RAW_TX SIGNED_RAW_TX

View file

@ -362,7 +362,7 @@ provide incomplete information.
Bitcoin Core includes code that detects a hard fork by looking at block
chain proof of work. If a non-upgraded node receives block chain headers
demonstrating at least six blocks more proof of work than the best chain
it considers valid, the node reports an error in the `getinfo` RPC
it considers valid, the node reports a warning in the `getnetworkinfo` RPC
results and runs the `-alertnotify` command if set. This warns the
operator that the non-upgraded node can't switch to what is likely the
best block chain.
@ -370,12 +370,12 @@ best block chain.
Full nodes can also check block and transaction version numbers. If the
block or transaction version numbers seen in several recent blocks are
higher than the version numbers the node uses, it can assume it doesn't
use the current consensus rules. Bitcoin Core 0.10.0
reports this situation through the `getinfo` RPC and
`-alertnotify` command if set.
use the current consensus rules. Bitcoin Core reports this situation
through the `getnetworkinfo` RPC and `-alertnotify` command if set.
In either case, block and transaction data should not be relied upon if it comes from a node
that apparently isn't using the current consensus rules.
In either case, block and transaction data should not be relied upon
if it comes from a node that apparently isn't using the current
consensus rules.
SPV clients which connect to full nodes can detect a likely hard fork by
connecting to several full nodes and ensuring that they're all on the

View file

@ -54,7 +54,7 @@ end_of_page: |
{% include devdoc/bitcoin-core/rpcs/intro.md %}
{% include devdoc/bitcoin-core/rpcs/quick-ref.md %}
{% include devdoc/bitcoin-core/rpcs/quick-reference.md %}
#### RPCs
<!-- no subhead-links here -->