aboutsummaryrefslogtreecommitdiff
path: root/doc/developer-notes.md
diff options
context:
space:
mode:
authorRussell Yanofsky <russ@yanofsky.org>2021-11-11 09:54:21 -0500
committerRussell Yanofsky <russ@yanofsky.org>2021-11-15 12:08:49 -0500
commit9b575f1c734c052b695ce921fb6412b22c18fdb4 (patch)
treeaa4c80b07b92e0385ae0c45c62b44fcb86045310 /doc/developer-notes.md
parent7f0f853373703a020529dd9394fca525475086b7 (diff)
downloadbitcoin-9b575f1c734c052b695ce921fb6412b22c18fdb4.tar.xz
Improve fs::PathToString documentation
Diffstat (limited to 'doc/developer-notes.md')
-rw-r--r--doc/developer-notes.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index 7ff1d36442..1888897856 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -1254,6 +1254,12 @@ A few guidelines for introducing and reviewing new RPC interfaces:
- *Rationale*: User-facing consistency.
+- Use `fs::path::u8string()` and `fs::u8path()` functions when converting path
+ to JSON strings, not `fs::PathToString` and `fs::PathFromString`
+
+ - *Rationale*: JSON strings are Unicode strings, not byte strings, and
+ RFC8259 requires JSON to be encoded as UTF-8.
+
Internal interface guidelines
-----------------------------