From: Nick Mathewson <nickm@torproject.org>
Date: Mon, 13 Nov 2017 15:04:40 +0000 (-0500)
Subject: Note in the rust doc that these comments are bidirectional
X-Git-Tag: tor-0.3.3.1-alpha~229
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ebcd1a57c0f784d97bfebfc071dffbd0bff93ec8;p=thirdparty%2Ftor.git

Note in the rust doc that these comments are bidirectional
---

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
 -----------------------------------------------