Commit Graph

198 Commits

Author SHA1 Message Date
Nick Mathewson f7949a440f Add a CONTRIBUTING file
This file contains pointers to other important top-level resources,
and some info about acceptable licenses.  Also, add that info to
CodingStandards.md
2018-05-11 13:19:37 -04:00
Alex Xu (Hello71) 2a3998a2e8 Add Travis CI instructions. fixes #23883 2018-05-08 09:12:46 -04:00
David Goulet e12d4286bf doc: Add Module.md explaining Tor modules
Initial document that contains guidelines to write a new module in Tor.

Closes #25991

Signed-off-by: David Goulet <dgoulet@torproject.org>
2018-05-03 11:39:19 -04:00
Nick Mathewson def2404083 typo fix in doc/HACKING/ReleasingTor 2018-03-29 11:08:09 -04:00
Nick Mathewson a3c1d78c29 Merge branch 'maint-0.3.3' 2018-03-28 08:11:46 -04:00
Georg Koppen 684aef40f9 Bug 25664: Update libc version requirement for Rust
When merging the patches for #25310 the libc version requirement in
`GettingStartedRust.md` and `configure.ac` did not get updated to the
now needed 0.2.39.
2018-03-28 08:07:27 -04:00
Nick Mathewson 03e787e220 Merge branch 'maint-0.3.3' 2018-03-21 17:05:42 -04:00
Isis Lovecruft 9799394375 maint: Add script for vendoring/updating Rust dependencies.
* ADD documentation for usage both inside the script and in
   doc/HACKING/CodingStandardsRust.md
 * FIXES part of #25310: https://bugs.torproject.org/25310
2018-03-21 17:04:28 -04:00
Isis Lovecruft f9ccb2543d doc: Document our current rough-draft policy on Rust dependencies.
* FIXES #25310: https://bugs.torproject.org/25310
2018-03-21 17:04:04 -04:00
Nick Mathewson cae7387ef2 Merge branch 'maint-0.3.3' 2018-03-20 07:59:13 -04:00
Nick Mathewson 74c767af29 Note that we require latest stable rust. 2018-03-20 07:58:29 -04:00
teor 01a977b492
Update the primitive types explanation in the Rust coding standards
Part of #25368.
Includes c_double in anticipation of #23061.
2018-02-27 15:55:13 +11:00
Nick Mathewson d489e4847b Fix a variable name in tor-rust-dependencies 2018-02-21 11:55:25 -05:00
Nick Mathewson d2bdb54d37 Wrap GettingStartedRust.md to 72 columns. 2018-02-21 11:55:07 -05:00
Deepesh Pathak ca6682f3f8 Fix spelling mistakes corresponding to ticket #23650 2018-02-07 10:41:57 -05:00
Nick Mathewson 03ab24b44c Make more notes about important stuff in ReleasingTor.md 2018-01-26 14:39:08 -05:00
Nick Mathewson 73e5be5619 ReleasingTor.md: check for recommendation, listing on dl page
Closes ticket 23118.
2018-01-26 14:34:25 -05:00
teor 7b59199663
Fix a typo in CodingStandards.md
Closes #24596.
2017-12-12 12:32:50 +11:00
Nick Mathewson 5ee0cccd49 Merge branch 'macro_free_v2_squashed' 2017-12-08 14:58:43 -05:00
Nick Mathewson 7ca5f4bf03 document our allocator conventions 2017-12-08 14:47:19 -05:00
Isis Lovecruft bb4993395c
doc: Document how to build with Rust dependencies in offline-mode.
* CLOSES #22907: https://bugs.torproject.org/22907
2017-11-28 22:39:55 +00:00
Alexander Færøy 251983eb8e
Add initial instructions on using Simpleperf for Android CPU profiling.
See: https://bugs.torproject.org/24062
2017-11-20 17:42:51 +01:00
Nick Mathewson ebcd1a57c0 Note in the rust doc that these comments are bidirectional 2017-11-13 10:04:40 -05:00
Nick Mathewson edf3d6b7ee Merge remote-tracking branch 'chelseakomlo/24032-cargo-rust-sync' 2017-11-13 09:59:10 -05:00
Chelsea Holland Komlo 05662f35ea update rust getting started for new build 2017-11-13 09:55:29 -05:00
Chelsea Holland Komlo 1c50331b9a annotate where C and Rust need to stay in sync 2017-11-11 23:19:34 -05:00
Nick Mathewson 2ed4a3e61e new email address for yuri; close 24241 2017-11-11 12:47:13 -05:00
David Goulet dfe03a55fc doc: Add fedora packager point of contact
This is a link to the user page on the Fedora project website:

https://koji.fedoraproject.org/koji/userinfo?userID=2234

Fixes #24015

Signed-off-by: David Goulet <dgoulet@torproject.org>
2017-10-26 10:07:56 -04:00
Nick Mathewson bc6769e0d4 Merge remote-tracking branch 'catalyst-oniongit/bug23739' 2017-10-03 09:04:21 -04:00
Taylor Yu 6a2a49e661 Improve docs on using gcov
Add more explanation in doc/HACKING about how to read gcov output,
including a reference to the gcov documentation in the GCC manual.
Also add details about how our postprocessing scripts modify gcov
output.
2017-10-03 07:45:36 -05:00
Nick Mathewson 7bc85d8204 Merge remote-tracking branch 'isis/bug23695' 2017-10-03 08:03:22 -04:00
Isis Lovecruft 40f1287978
doc: Add a good resource for learning to write Rust FFI. 2017-09-29 01:04:18 +00:00
Nick Mathewson cbea334d6b Mention even more about changes files in doc/HACKING 2017-09-22 15:14:36 -04:00
Nick Mathewson 2032d7ca6f Update CodingStandards.md for changes-file stuff
'check-changes' is now part of "make check", and must pass.
2017-09-21 16:39:49 -04:00
Nick Mathewson 3c9ff0af96 small tweaks to releasingtor.md 2017-09-18 14:49:06 -04:00
Nick Mathewson faf1242bed add frebsd ports maintainer to releasingtor list 2017-09-17 20:32:27 -04:00
Martin Kepplinger 8d913cc352 doc: make introduction paragraph point to correct data
doc/HACKING/GettingStarted.md says "you might like reading doc/HACKING",
which the reader obviously is already doing. Instead point to the "torguts"
documents that are mentioned a few lines below too.
2017-09-15 08:18:37 -04:00
Taylor Yu 55fef0534d Add guidelines for floating point use 2017-09-08 12:15:41 -05:00
David Goulet 2080a986ed
doc: Add our Ubuntu packager to ReleasingTor.md
His full name is: Simon Deziel.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2017-09-07 12:35:31 -04:00
Nick Mathewson 8421756da3 Talk about assertions in CodingStandards.md 2017-09-07 09:37:39 -04:00
Nick Mathewson babe31fc7c Not all invizbox people have the same TLD... :/ 2017-09-05 10:43:31 -04:00
Nick Mathewson a229d6c2f8 Merge branch 'bug22818_squashed' 2017-09-04 11:44:56 -04:00
Isis Lovecruft 1645c5503d docs: Add notes on behaviours which Rust considers undefined. 2017-09-04 11:44:48 -04:00
Isis Lovecruft 12cf04646c docs: More Rust coding standards, based on without boats' comments. 2017-09-04 11:44:48 -04:00
Isis Lovecruft aeef8a093f
docs: More Rust coding standards w.r.t. fuzzing and safety. 2017-08-30 21:54:41 +00:00
Isis Lovecruft f9dc514e8f
docs: Clarify some portions of the Rust coding standards.
* THANKS TO Henry de Valence for review.
2017-08-30 21:38:13 +00:00
Isis Lovecruft fe66d06a45
docs: Document coding standards, build instructions, etc. for Rust code.
* FIXES #22818
2017-08-29 23:25:02 +00:00
Nick Mathewson cbfc50d485 add another invizbox maintainer to ReleasingTor.md 2017-08-24 16:20:26 -04:00
Nick Mathewson 18115b5aa9 Document some operators usage conventions. 2017-08-01 10:50:52 -04:00
Matt Traudt d730449ba2 Add more details about git branch use in tor 2017-07-10 14:02:11 -04:00