]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
Merge branch 'maint-0.3.2' into maint-0.3.3
authorNick Mathewson <nickm@torproject.org>
Thu, 16 Aug 2018 12:35:27 +0000 (08:35 -0400)
committerNick Mathewson <nickm@torproject.org>
Thu, 16 Aug 2018 12:35:27 +0000 (08:35 -0400)
1  2 
doc/HACKING/GettingStartedRust.md

index a533ba8a27e00775fc66a29e698f4872760b41ea,920596cadf8a33c4b764c2702b8b519e1fa38817..aa29c097da07fac13efbdd03217c8d6efe95e58f
@@@ -122,23 -119,13 +122,25 @@@ the module calls.  Modules which call f
  
  Strive to change the C API as little as possible.
  
- We are currently targeting Rust nightly, *for now*. We expect this to
- change moving forward, as we understand more about which nightly
- features we need. It is on our TODO list to try to cultivate good
+ We are currently targetting Rust stable. (See CodingStandardsRust.md for more
+ details.)
 -It is on our TODO list to try to cultivate good standing with various distro
 -maintainers of `rustc` and `cargo`, in order to ensure that whatever version we
 -solidify on is readily available.
++It is on our TODO list to try to cultivate good
 +standing with various distro maintainers of `rustc` and `cargo`, in
 +order to ensure that whatever version we solidify on is readily
 +available.
 +
 +If parts of your Rust code needs to stay in sync with C code (such as
 +handling enums across the FFI boundary), annonotate these places in a
 +comment structured as follows:
 +
 +  /// C_RUST_COUPLED: <path_to_file> `<name_of_c_object>`
 +
 +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
  -----------------------------------------------