Differential D8568

rpc: Fix named arguments in documentation
ClosedPublic
Actions

Authored by Fabien on Dec 1 2020, 11:32.

Details

Reviewers

deadalnix

Group Reviewers

Restricted Project

Commits

rABCec1d2d93d8df: rpc: Fix named arguments in documentation

Summary

This fixes a bug found with #18531:

    Currently the named argument for generateblock is documented as
address/descriptor, but the server only accepts a named argument of
address. Fix it by changing the name to output for both the
documentation and the server code. Also, add tests to prove the server
understands the new name output.

    Unrelated to that, there have been a bunch of aliases in the server
code that are not present in the source code of the documentation. Fix
that by adding the alias to the source code of the documentation. Only
the first alias is displayed in the rendered documentation. Also, add
tests to prove the server actually understands all aliases.

Backport of core PR18607.

Depends on D8567.

Test Plan

ninja all check-all

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

Fabien created this revision.Dec 1 2020, 11:32

Herald added a reviewer: Restricted Project. · View Herald TranscriptDec 1 2020, 11:32

Fabien requested review of this revision.Dec 1 2020, 11:32

teamcity edited the summary of this revision. (Show Details)Dec 1 2020, 11:32

Harbormaster completed remote builds in B14259: Diff 26113.Dec 1 2020, 11:45

deadalnix requested changes to this revision.Dec 1 2020, 13:10

deadalnix added a subscriber: deadalnix.

deadalnix added inline comments.

src/rpc/mining.cpp
345 ↗	(On Diff #26113)	Relayout

This revision now requires changes to proceed.Dec 1 2020, 13:10

Fix layout

deadalnix accepted this revision.Dec 1 2020, 15:16

This revision is now accepted and ready to land.Dec 1 2020, 15:16

Harbormaster completed remote builds in B14263: Diff 26120.Dec 1 2020, 15:16

Build Bitcoin ABC Diffs / Diff Testing (build-clang) failed.

Tail of the build log:

[367/425] Running utility command for check-bitcoin-torcontrol_tests
[368/425] Running utility command for check-bitcoin-wallet_crypto_tests
[369/425] bitcoin: testing timedata_tests
[370/425] bitcoin: testing settings_tests
[371/425] bitcoin: testing streams_tests
[372/425] Running utility command for check-bitcoin-timedata_tests
[373/425] Running utility command for check-bitcoin-settings_tests
[374/425] Running utility command for check-bitcoin-streams_tests
[375/425] bitcoin: testing cuckoocache_tests
[376/425] bitcoin: testing undo_tests
[377/425] Running utility command for check-bitcoin-cuckoocache_tests
[378/425] Running utility command for check-bitcoin-undo_tests
[379/425] bitcoin: testing txvalidationcache_tests
[380/425] bitcoin: testing util_threadnames_tests
[381/425] Running utility command for check-bitcoin-txvalidationcache_tests
[382/425] Running utility command for check-bitcoin-util_threadnames_tests
[383/425] bitcoin: testing serialize_tests
[384/425] bitcoin: testing compilerbug_tests
[385/425] bitcoin: testing validation_chainstatemanager_tests
[386/425] Running utility command for check-bitcoin-serialize_tests
[387/425] Running utility command for check-bitcoin-compilerbug_tests
[388/425] bitcoin: testing validationinterface_tests
[389/425] Running utility command for check-bitcoin-validation_chainstatemanager_tests
[390/425] bitcoin: testing checkpoints_tests
[391/425] Running utility command for check-bitcoin-checkpoints_tests
[392/425] Running utility command for check-bitcoin-validationinterface_tests
[393/425] bitcoin: testing radix_tests
[394/425] Running utility command for check-bitcoin-radix_tests
[395/425] bitcoin: testing cashaddr_tests
[396/425] Running utility command for check-bitcoin-cashaddr_tests
[397/425] bitcoin: testing blockcheck_tests
[398/425] bitcoin: testing crypto_tests
[399/425] bitcoin: testing getarg_tests
[400/425] Running utility command for check-bitcoin-blockcheck_tests
[401/425] Running utility command for check-bitcoin-crypto_tests
[402/425] Running utility command for check-bitcoin-getarg_tests
[403/425] bitcoin: testing ref_tests
[404/425] Running utility command for check-bitcoin-ref_tests
[405/425] bitcoin: testing script_tests
[406/425] Running utility command for check-bitcoin-script_tests
[407/425] bitcoin: testing validation_tests
[408/425] bitcoin: testing monolith_opcodes_tests
[409/425] Running utility command for check-bitcoin-validation_tests
[410/425] Running utility command for check-bitcoin-monolith_opcodes_tests
[411/425] bitcoin: testing skiplist_tests
[412/425] Running utility command for check-bitcoin-skiplist_tests
[413/425] bitcoin: testing coinselector_tests
[414/425] Running utility command for check-bitcoin-coinselector_tests
[415/425] bitcoin: testing util_tests
[416/425] Running utility command for check-bitcoin-util_tests
[417/425] bitcoin: testing op_reversebytes_tests
[418/425] Running utility command for check-bitcoin-op_reversebytes_tests
[419/425] bitcoin: testing transaction_tests
[420/425] Running utility command for check-bitcoin-transaction_tests
[421/425] bitcoin: testing coins_tests
[422/425] Running utility command for check-bitcoin-coins_tests
[423/425] Running bitcoin test suite
PASSED: bitcoin test suite
ninja: build stopped: cannot make progress due to previous errors.
Build build-clang failed with exit code 1

This revision was landed with ongoing or failed builds.Dec 1 2020, 16:27

Closed by commit rABCec1d2d93d8df: rpc: Fix named arguments in documentation (authored by MarcoFalke <falke.marco@gmail.com>, committed by Fabien). · Explain Why

This revision was automatically updated to reflect the committed changes.

Fabien added a commit: rABCec1d2d93d8df: rpc: Fix named arguments in documentation.