Commit Graph

216 Commits

Author SHA1 Message Date
David Goulet
91748cd17c doc: Add Maintaining.md documentation
Closes #28225

Signed-off-by: David Goulet <dgoulet@torproject.org>
2018-10-29 16:30:34 -04:00
rl1987
d49133d9ca Mention that we require Python 2.7 or newer 2018-09-24 11:25:33 -04:00
Nick Mathewson
c8aecd14fe Merge branch 'pr275_squashed' 2018-08-16 08:43:05 -04:00
cypherpunks
fef2ba2267 rust/docs: fix critical typo for missing_docs lint
Fix typo from fe66d06a45.
The exclamation point is what lets an attribute apply to
an entire crate, without the ! it's practically a placebo.

Fix on commits af182d4ab5 and
b6059297d7, and note there are
still missing docs in both crypto and protover, for now.

https://doc.rust-lang.org/reference/attributes.html
2018-08-16 08:42:57 -04:00
Nick Mathewson
a7ea639f12 Merge branch 'maint-0.3.4' 2018-08-16 08:35:31 -04:00
Nick Mathewson
2deee972a3 Merge branch 'maint-0.3.3' into maint-0.3.4 2018-08-16 08:35:31 -04:00
Nick Mathewson
4847e22168 Merge branch 'maint-0.3.2' into maint-0.3.3 2018-08-16 08:35:27 -04:00
teor
db3414dd51
Rust: Say that we support rust stable in GettingStartedRust.md
In 24765, we said that we supported rust stable in CodingStandardsRust.md.
But we left GettingStartedRust.md saying that we support rust nightly.

Closes 27160.
2018-08-16 18:58:47 +10:00
teor
62ecb5e88f
doc: Document Appveyor and Jenkins in doc/HACKING/HelpfulTools.md
Closes 26852.
2018-07-18 12:11:08 +10:00
Roger Dingledine
baff5e2b9d Faravahar hasn't been voting on versions for a while now 2018-07-13 16:58:46 -04:00
Nick Mathewson
4793d91350 Describe "check-includes" in the CodingStandards.md file 2018-07-10 11:09:25 -04:00
Nick Mathewson
fa2d53aa6a Stop mentioning src/or and src/common in doc/HACKING 2018-07-10 11:03:45 -04:00
Nick Mathewson
23dc770f87 Add an initial CodeStructure.md file to doc/HACKING.
Not complete or pretty, but better than nothing.
2018-07-10 11:01:09 -04:00
Nick Mathewson
f720a5a439 Fix everything that previously referred to src/or 2018-07-05 17:15:50 -04:00
Nick Mathewson
81cb0afb2b Start splitting src/or
This is a very gentle commit that just lays the groundwork in the
build system: it puts the include files to build libtor-app.a into
src/core, and to build the tor executable into src/app.  The
executable is now "src/app/tor".
2018-07-05 17:15:50 -04:00
Nick Mathewson
9fa73003fc Remove dmalloc support; closes #26426
Dmalloc hasn't seen a release in over a decade, and there are much
better tools to use these days.
2018-06-20 10:21:34 -04:00
Nick Mathewson
9af6c48d24 remove EOL@EOF advice 2018-06-18 16:18:44 -04:00
juga0
cc09ff253e Add explanation about editorconf in coding standards
so that developers know what is .editorconfig for.
2018-06-11 21:29:40 +00:00
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