[tor-bugs] #24032 [Core Tor/Tor]: Add comments everywhere that C and Rust must stay in sync

[Tor Bug Tracker & Wiki]

#24032: Add comments everywhere that C and Rust must stay in sync
--------------------------+------------------------------------
 Reporter:  nickm         |          Owner:  chelseakomlo
     Type:  defect        |         Status:  assigned
 Priority:  High          |      Milestone:  Tor: 0.3.3.x-final
Component:  Core Tor/Tor  |        Version:
 Severity:  Normal        |     Resolution:
 Keywords:  rust, doc     |  Actual Points:
Parent ID:                |         Points:
 Reviewer:                |        Sponsor:
--------------------------+------------------------------------

Comment (by chelseakomlo):

 See `git at github.com:chelseakomlo/tor_patches.git`, branch `24032-cargo-
 rust-sync`. I can make a PR in oniongit if that makes review easier; these
 are all documentation changes.

 I annotated only where data needs to stay in sync (such as enums and
 constants). If we change actual logic/behavior in `src/or/protover`,
 `src/rust/protover` will definitely need to change as well. I can put a
 comment in `src/rust/protover/lib.rs` to say that the overall module needs
 to track the C implementation if that would be helpful.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/24032#comment:2>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online