commit 4847e221689f702f74d6dd15181216aeabbb6785 Merge: 0fc171a47 db3414dd5 Author: Nick Mathewson nickm@torproject.org Date: Thu Aug 16 08:35:27 2018 -0400

Merge branch 'maint-0.3.2' into maint-0.3.3

doc/HACKING/GettingStartedRust.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)

diff --cc doc/HACKING/GettingStartedRust.md index a533ba8a2,920596cad..aa29c097d --- a/doc/HACKING/GettingStartedRust.md +++ b/doc/HACKING/GettingStartedRust.md @@@ -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 -----------------------------------------------