Page MenuHomePhabricator

rpc: Fail to return undocumented return values
ClosedPublic

Authored by PiRK on Dec 1 2022, 12:29.

Details

Reviewers
Fabien
Group Reviewers
Restricted Project
Commits
rABCf71cb0fc4ad5: rpc: Fail to return undocumented return values
Summary

Currently a few return values are undocumented. This is causing confusion at the least. See for example core#18476

Fix this by treating it as an internal bug to return undocumented return values.

This is a backport of core#20459
Depends on D12716

Test Plan

ninja all check-all

Diff Detail

Repository
rABC Bitcoin ABC
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

PiRK requested review of this revision.Dec 1 2022, 12:29

Tail of the build log:

[361/529] Building CXX object src/CMakeFiles/server.dir/rest.cpp.o
[362/529] Building CXX object src/CMakeFiles/server.dir/node/ui_interface.cpp.o
[363/529] Building CXX object src/test/CMakeFiles/testutil.dir/util/mining.cpp.o
[364/529] Building CXX object src/test/CMakeFiles/testutil.dir/util/str.cpp.o
[365/529] Building CXX object src/test/CMakeFiles/testutil.dir/util/net.cpp.o
[366/529] Building CXX object src/CMakeFiles/server.dir/rpc/misc.cpp.o
[367/529] Building CXX object src/wallet/CMakeFiles/wallet-tool.dir/wallettool.cpp.o
[368/529] Building CXX object src/test/CMakeFiles/testutil.dir/util/logging.cpp.o
[369/529] Building C object src/secp256k1/CMakeFiles/internal-bench.dir/src/bench_internal.c.o
[370/529] Linking C executable src/secp256k1/internal-bench
[371/529] Building CXX object src/CMakeFiles/server.dir/rpc/server.cpp.o
[372/529] Building CXX object src/CMakeFiles/server.dir/txdb.cpp.o
[373/529] Building CXX object src/CMakeFiles/server.dir/rpc/mining.cpp.o
[374/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/context.cpp.o
[375/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/coincontrol.cpp.o
[376/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/fees.cpp.o
[377/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/crypter.cpp.o
[378/529] Building CXX object src/test/CMakeFiles/testutil.dir/util/transaction_utils.cpp.o
[379/529] Building CXX object src/test/CMakeFiles/testutil.dir/util/blockfilter.cpp.o
[380/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/load.cpp.o
[381/529] Building CXX object src/test/CMakeFiles/testutil.dir/util/setup_common.cpp.o
FAILED: src/test/CMakeFiles/testutil.dir/util/setup_common.cpp.o 
/usr/bin/ccache /usr/bin/clang++ -DBOOST_AC_USE_STD_ATOMIC -DBOOST_ALL_NO_LIB -DBOOST_ATOMIC_DYN_LINK -DBOOST_FILESYSTEM_DYN_LINK -DBOOST_SP_USE_STD_ATOMIC -DBOOST_THREAD_DYN_LINK -DBUILD_BITCOIN_INTERNAL -DENABLE_AVX2 -DENABLE_SHANI -DENABLE_SSE41 -DHAVE_BUILD_INFO -DHAVE_CONFIG_H -DHAVE_CONSENSUS_LIB -DLEVELDB_ATOMIC_PRESENT -DLEVELDB_PLATFORM_POSIX -DOS_LINUX -I../../src/. -Isrc -I../../src/univalue/include -Isrc/crypto/.. -I../../src/secp256k1/include -I../../src/leveldb/include -isystem /usr/include/jemalloc -isystem /usr/include/miniupnpc -Werror -g -O2 -fPIC -fvisibility=hidden -fstack-protector-all -Wstack-protector -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=2 -Wall -Wextra -Wformat -Wgnu -Wvla -Wcast-align -Wunused-parameter -Wmissing-braces -Wthread-safety -Wrange-loop-analysis -Wredundant-decls -Wunreachable-code-loop-increment -Wsign-compare -Wconditional-uninitialized -Wdocumentation -Wformat-security -Wredundant-move -Woverloaded-virtual -Wshadow -Wshadow-field -Wno-unused-parameter -Wno-implicit-fallthrough -pthread -std=gnu++17 -MD -MT src/test/CMakeFiles/testutil.dir/util/setup_common.cpp.o -MF src/test/CMakeFiles/testutil.dir/util/setup_common.cpp.o.d -o src/test/CMakeFiles/testutil.dir/util/setup_common.cpp.o -c ../../src/test/util/setup_common.cpp
In file included from ../../src/test/util/setup_common.cpp:19:
../../src/./net_processing.h:65:20: error: parameter 'pindex' not found in the function declaration [-Werror,-Wdocumentation]
     * @param[in]  pindex   The block index
                   ^~~~~~
../../src/./net_processing.h:65:20: note: did you mean 'block_index'?
     * @param[in]  pindex   The block index
                   ^~~~~~
                   block_index
1 error generated.
[382/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/sqlite.cpp.o
[383/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/db.cpp.o
[384/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/walletdb.cpp.o
[385/529] Building CXX object src/test/CMakeFiles/testutil.dir/util/wallet.cpp.o
[386/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/bdb.cpp.o
[387/529] Building CXX object src/seeder/CMakeFiles/seeder-base.dir/bitcoin.cpp.o
[388/529] Building CXX object src/seeder/CMakeFiles/seeder-base.dir/db.cpp.o
[389/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/coinselection.cpp.o
[390/529] Building CXX object src/seeder/CMakeFiles/bitcoin-seeder.dir/main.cpp.o
[391/529] Building CXX object src/seeder/CMakeFiles/seeder-base.dir/dns.cpp.o
[392/529] Building CXX object src/CMakeFiles/bitcoin-tx.dir/bitcoin-tx.cpp.o
[393/529] Linking CXX executable src/bitcoin-tx
[394/529] Building CXX object src/CMakeFiles/server.dir/txmempool.cpp.o
[395/529] Building CXX object src/seeder/CMakeFiles/seeder-base.dir/options.cpp.o
[396/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/walletutil.cpp.o
[397/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/salvage.cpp.o
[398/529] Building CXX object src/CMakeFiles/server.dir/rpc/rawtransaction.cpp.o
[399/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/__/interfaces/wallet.cpp.o
[400/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/scriptpubkeyman.cpp.o
[401/529] Building CXX object src/CMakeFiles/server.dir/validation.cpp.o
[402/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/rpcdump.cpp.o
[403/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/wallet.cpp.o
[404/529] Building CXX object src/wallet/CMakeFiles/wallet.dir/rpcwallet.cpp.o
[405/529] Linking CXX static library src/wallet/libwallet.a
[406/529] Linking CXX static library src/wallet/libwallet-tool.a
[407/529] Linking CXX executable src/bitcoin-wallet
ninja: build stopped: cannot make progress due to previous errors.
Build build-clang failed with exit code 1

rebase after fixing doxygen in D12716

This revision is now accepted and ready to land.Dec 1 2022, 14:47