aboutsummaryrefslogtreecommitdiff
path: root/doc/HACKING/GettingStartedRust.md
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2017-11-13 10:04:40 -0500
committerNick Mathewson <nickm@torproject.org>2017-11-13 10:04:40 -0500
commitebcd1a57c0f784d97bfebfc071dffbd0bff93ec8 (patch)
tree1faf42eed7a0535284da0f004fb46ca0eb32ab0e /doc/HACKING/GettingStartedRust.md
parentfdefda95bc2566f1ee37c99d89c33399b1364eaa (diff)
downloadtor-ebcd1a57c0f784d97bfebfc071dffbd0bff93ec8.tar.gz
tor-ebcd1a57c0f784d97bfebfc071dffbd0bff93ec8.zip
Note in the rust doc that these comments are bidirectional
Diffstat (limited to 'doc/HACKING/GettingStartedRust.md')
-rw-r--r--doc/HACKING/GettingStartedRust.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/HACKING/GettingStartedRust.md b/doc/HACKING/GettingStartedRust.md
index 7d8a74bfed..181535122c 100644
--- a/doc/HACKING/GettingStartedRust.md
+++ b/doc/HACKING/GettingStartedRust.md
@@ -131,7 +131,9 @@ as follows:
/// C_RUST_COUPLED: <path_to_file> `<name_of_c_object>`
-Where <name_of_c_object> can be an enum, struct, constant, etc.
+Where <name_of_c_object> can be an enum, struct, constant, etc. Then, do the
+same in the C code, to note that rust will need to be changed when the C
+does.
Adding your Rust module to Tor's build system
-----------------------------------------------