Preserve a format of RPC command definitions #14008

pull kostyantyn wants to merge 1 commits into bitcoin:master from kostyantyn:preserve_format_of_rpc_command_definitions changing 9 files +18 −2

kostyantyn commented at 12:33 PM on August 20, 2018: contributor

Currently, RPC commands are formatted in a way that it's easy to read and that test/lint/check-rpc-mappings.py can parse it.

To void breaking test/lint/check-rpc-mappings.py script by running clang-format, RPC command definitions should be disabled for clang-format.

in src/coins.h:289 in f378b8960a outdated

 284 | @@ -285,8 +285,8 @@ class CCoinsViewCache : public CCoinsViewBacked
 285 |       * Note that lightweight clients may not know anything besides the hash of previous transactions,
 286 |       * so may not be able to calculate this.
 287 |       *
 288 | -     * @param[in] tx	transaction for which we are checking input total
 289 | -     * @return	Sum of value of all inputs (scriptSigs)
 290 | +     * @param[in] tx    transaction for which we are checking input total
 291 | +     * @return  Sum of value of all inputs (scriptSigs)

kostyantyn commented at 12:34 PM on August 20, 2018:

for reviewers: I replaced tabs with spaces because if this block is moved, the test/lint/lint-whitespace.sh will fail.

fanquake added the label RPC/REST/ZMQ on Aug 20, 2018

Preserve a format of RPC command definitions

Currently RPC commands are formatted in a way that it's easy to read
and that test/lint/check-rpc-mappings.py can parse it.

To void breaking test/lint/check-rpc-mappings.py script by running
clang-format, RPC command definitions should be disabled for clang-format.

d9d79576f4

kostyantyn force-pushed on Aug 20, 2018
DrahtBot commented at 6:17 PM on August 20, 2018: member
Note to reviewers: This pull request conflicts with the following ones:
- #14121 (Index for BIP 157 block filters by jimpo)
- #13932 (Additional utility RPCs for PSBT by achow101)
- #13152 ([rpc] Add getnodeaddresses RPC command by chris-belcher)
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.
scravy approved
scravy commented at 3:09 PM on August 21, 2018: contributor

ACK, looks good to me
laanwj commented at 4:13 PM on September 10, 2018: member

yes, this makes sense, otherwise clang-format will mess up the tables utACK d9d79576f423cd9c5cef4547c7e3648dbb339460
laanwj merged this on Sep 10, 2018
laanwj closed this on Sep 10, 2018
laanwj referenced this in commit 838b85e120 on Sep 10, 2018
DrahtBot locked this on Sep 8, 2021

Contributors

Labels