Skip to content

Commit 337d6f3

Browse files
committed
Merge bitcoin/bitcoin#28291: rpc: removed StrFormatInternalBug quote delimitation
6e8f646 removed StrFormatInternalBug quote delimitation (Reese Russell) Pull request description: This PR rectifies an unnecessary set of quotes delimiting the contents of ```StrFormatInternalBug```. This is a follow up to MarcoFalke bitcoin/bitcoin#28123 (comment). The method of action was to remove the escaped quotes that were a part of strprintf. A single functional test case was modified to reflect the new output format. ```STR_INTERNAL_BUG``` was applied to bitcoin/bitcoin#28123 in ```std::string RPCArg::ToString(const bool oneline)``` in ```rpc/util.cpp``` The results can be seen below. Previously ![image](https://github.com/bitcoin/bitcoin/assets/3104223/53f9ea59-317f-4c62-9fc1-04255eeb4641) This PR ![image](https://github.com/bitcoin/bitcoin/assets/3104223/5c6a3110-f1f3-4b3c-8e8a-9c8f1c3176e7) Additional context can be found here. bitcoin/bitcoin#28123 (comment) Thank you. ACKs for top commit: MarcoFalke: review ACK 6e8f646 stickies-v: ACK 6e8f646 Tree-SHA512: 35317e31a527630495b566407e37db9941dab7f81cfaeb1ea3309683c48e4273284645ad615f73e646a137b4f2ae35933603e9182a7dbdd22cac98d038c491dc
2 parents 6f03c45 + 6e8f646 commit 337d6f3

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

src/rpc/util.cpp

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1187,10 +1187,9 @@ std::string RPCArg::ToString(const bool oneline) const
11871187
if (oneline && !m_opts.oneline_description.empty()) {
11881188
if (m_opts.oneline_description[0] == '\"' && m_type != Type::STR_HEX && m_type != Type::STR && gArgs.GetBoolArg("-rpcdoccheck", DEFAULT_RPC_DOC_CHECK)) {
11891189
throw std::runtime_error{
1190-
strprintf("Internal bug detected: non-string RPC arg \"%s\" quotes oneline_description:\n%s\n%s %s\nPlease report this issue here: %s\n",
1191-
m_names, m_opts.oneline_description,
1192-
PACKAGE_NAME, FormatFullVersion(),
1193-
PACKAGE_BUGREPORT)};
1190+
STR_INTERNAL_BUG(strprintf("non-string RPC arg \"%s\" quotes oneline_description:\n%s",
1191+
m_names, m_opts.oneline_description)
1192+
)};
11941193
}
11951194
return m_opts.oneline_description;
11961195
}

src/util/check.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
std::string StrFormatInternalBug(std::string_view msg, std::string_view file, int line, std::string_view func)
2020
{
21-
return strprintf("Internal bug detected: \"%s\"\n%s:%d (%s)\n"
21+
return strprintf("Internal bug detected: %s\n%s:%d (%s)\n"
2222
"%s %s\n"
2323
"Please report this issue here: %s\n",
2424
msg, file, line, func, PACKAGE_NAME, FormatFullVersion(), PACKAGE_BUGREPORT);

test/functional/rpc_misc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def run_test(self):
2727
self.log.info("test CHECK_NONFATAL")
2828
assert_raises_rpc_error(
2929
-1,
30-
'Internal bug detected: "request.params[9].get_str() != "trigger_internal_bug""',
30+
'Internal bug detected: request.params[9].get_str() != "trigger_internal_bug"',
3131
lambda: node.echo(arg9='trigger_internal_bug'),
3232
)
3333

0 commit comments

Comments
 (0)