Commit Graph

298 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
Nick Mathewson
9e317641f9 impact -> affect 2017-07-10 10:03:45 -04:00
Chelsea H. Komlo
934f85f87a
specify when to run make distcheck 2017-07-09 16:17:21 -04:00
Chelsea H. Komlo
24d29c7ae0
make check is required for all code submissions
integration tests should be run for feature changes/major patches
2017-06-28 20:40:15 -04:00
Nick Mathewson
80ad374b84 Remove old callgraph scripts; recommend calltool instead. 2017-06-14 17:44:15 -04:00
Nick Mathewson
1405bdebb0 Update releasing-tor to reflect current versions and tooling
(Note that a lot of the removed guidance is stuff that the tools
will do automatically.)
2017-05-26 10:01:04 -04:00
Nick Mathewson
6bf82a4910 More clarification on 13802 2017-04-25 10:40:30 -04:00
David Goulet
cb8ac1f331 trace: Add a basic event-tracing infrastructure.
This commit adds the src/trace directory containing the basics for our tracing
subsystem. It is not used in the code base. The "src/trace/debug.h" file
contains an example on how we can map our tor trace events to log_debug().

The tracing subsystem can only be enabled by tracing framework at compile
time. This commit introduces the "--enable-tracing-debug" option that will
make all "tor_trace()" function be maped to "log_debug()".

Closes #13802

Signed-off-by: David Goulet <dgoulet@torproject.org>
2017-04-25 10:37:31 -04:00
Sebastian Hahn
2c001b483b Add a release checklist step to highlight changes
In an effort to better communicate with our users that they might need
to take certain actions when upgrading, we should extract from the
changelog the items that require some action (example: the new version
automatically generates keys, if you want them to be offline - make sure
to create them before upgrading).
2017-04-03 16:11:52 +02:00
Nick Mathewson
99ec44de45 Merge remote-tracking branch 'chelseakomlo/documentation_integ_tests' 2017-03-14 11:32:53 -04:00
Nick Mathewson
4d3310932a Small fixes to fuzzing documentation. 2017-02-24 10:57:58 -05:00
Nick Mathewson
491348cb8c Rename make fuzz to make test-fuzz-corpora 2017-02-14 18:04:10 -05:00
Nick Mathewson
195acd90c9 Fix an error in Fuzzing.md. (asn spotted this) 2017-01-30 08:46:47 -05:00
Nick Mathewson
558c04f5b1 Merge branch 'combined-fuzzing-v4' 2017-01-30 08:40:46 -05:00
Nick Mathewson
d71fc47438 Update documentation and testing integration for fuzzing 2017-01-30 08:37:27 -05:00
Nick Mathewson
44fa14c0e2 Try to tweak fuzzing.md to correspond to my changes 2017-01-30 08:37:24 -05:00
teor
0fb1156e9f Add a script for running multiple fuzzing sessions on multiple cores 2017-01-30 08:37:23 -05:00
Nick Mathewson
f009b13029 Copy fuzzing instructions by teor 2017-01-30 08:37:23 -05:00
Nick Mathewson
c93428f457 Remove trailing whitespace 2017-01-13 12:31:57 -05:00
Pierre-Antoine Rault
f634499044 improved doc/HelpfulTools.md on profiling Tor
(Based on join work at https://pad.riseup.net/p/profiling-tor)
2017-01-13 12:31:34 -05:00
Chelsea H. Komlo
dfde58db6b
check-spaces is run as part of make check 2016-12-21 17:08:06 -05:00
Chelsea H. Komlo
d95678ca8f
make distcheck should be a part of the local development process 2016-12-21 17:05:18 -05:00
Chelsea H. Komlo
064b1b6d1c
Adds standard to run code changes against test suite 2016-12-21 09:44:44 -05:00
Nick Mathewson
b310929ee3 Merge remote-tracking branch 'jryans/no-changes-unreleased' 2016-12-16 10:57:37 -05:00
Nick Mathewson
bd2a1d0231 Update description of release practices 2016-12-12 15:38:51 -05:00
J. Ryan Stinnett
231564ee5b Document no changes file needed for bugfixes on unreleased code
Fixes #20932.
2016-12-08 16:48:00 -10:00
overcaffeinated
6dc25e79b9 Fix typo
Remove stray 'To run'
2016-11-21 12:15:44 -05:00
Nick Mathewson
a9fb2b4047 typo fix in doc/HACKING/ReleasingTor.md 2016-11-07 18:54:51 -05:00
Chelsea H. Komlo
1a2aa4e3f8 adding instructions how to include new test files 2016-10-14 10:27:21 -04:00
Nick Mathewson
a601ed5c15 update packager emails list again 2016-08-26 09:44:25 -04:00
Nick Mathewson
b3f43a22ab Add two new packagers.
Also, stop implying that Roger still does all the source releases.
2016-08-22 16:51:33 -04:00
Nick Mathewson
2042080b21 ondrej is no longer making rpms 2016-06-15 12:55:40 -04:00
Nick Mathewson
771ca7c544 Stop recommending --enable-gcc-warnings in doc/HACKING 2016-05-23 14:40:27 -04:00
Nick Mathewson
4043f2c95f Adopt the LCOV convention for marking lines as unreachable by tests.
Document this convention.

Add a script to post-process .gcov files in order to stop nagging us
about excluded lines.

Teach cov-diff to handle these post-processed files.

Closes ticket 16792
2016-04-12 21:12:10 -04:00
Nick Mathewson
bd34edc18d Merge remote-tracking branch 'sebastian/stemtest' 2016-04-12 13:13:15 -04:00
Roger Dingledine
93c311daa8 majority of four is, alas, three 2016-03-29 10:57:01 -04:00
Nick Mathewson
e1f4d9552e Faravahar also versions. 2016-03-29 07:55:02 -04:00
Nick Mathewson
05b52eea6a Add more structure (and tests) to ReleasingTor.md 2016-03-28 16:07:19 -04:00
Sebastian Hahn
0c0bdbef28 Write a document on how to add a test to Stem 2016-03-28 17:21:28 +02:00
Nick Mathewson
5a164d50bb Add another admonishment to WritingTests.md 2016-02-11 13:17:21 -05:00
Nick Mathewson
311a13220c mention lintChanges.py in the coding standards 2016-02-01 16:47:47 -05:00
Nick Mathewson
4770db8e99 Clarify ReleasingTor.md on versions.wmi
Closes #17839.
2016-01-27 12:37:01 -05:00
cypherpunks
816207511b Remove the INLINE coding standard 2015-12-15 11:34:00 -05:00
Nick Mathewson
9f6b9e28cc forward-port changelog and releasenotes 2015-12-10 14:24:22 -05:00
Nick Mathewson
43609fba77 fix an email address in doc/HACKING/ReleasingTor.md 2015-11-13 09:01:55 -05:00
Nick Mathewson
5a37061885 Delete trailing whitespace in md files 2015-11-05 09:53:05 -05:00
Nick Mathewson
43ce4626f1 add release notes 2015-11-05 09:46:40 -05:00
tom lurge
617e0f8d26 added some markdown formatting 2015-11-05 09:13:53 -05:00
Nick Mathewson
8976e739af Fix filename endings in HACKING. Patch from "ckomlo", ticket #17515. 2015-11-03 08:23:08 -05:00
Nick Mathewson
92a6c578d7 hacking is now markdown
Not good markdown, mind you.
2015-10-29 10:31:38 -04:00
Nick Mathewson
e5976482a3 More issues that Karsten spotted 2015-10-29 10:29:21 -04:00
Karsten Loesing
f40dc287bd Clean up the doc/HACKING/* docs a bit. 2015-10-29 14:28:17 +01:00
Nick Mathewson
2929986049 Actually add HowToReview.txt 2015-10-22 10:03:04 -04:00
Nick Mathewson
609c1e8870 Start writing a how to review doc 2015-10-22 10:01:13 -04:00
Nick Mathewson
1a236c78aa Add another entry to ReleasingTor email list, per anonym 2015-10-21 17:06:10 -04:00
Nick Mathewson
34b4da709d Fix a bunch more memory leaks in the tests. 2015-10-21 10:00:05 -04:00
Nick Mathewson
49ccb7e7b8 Mention trunnel in CodingStandards; describe how in trunnel/README 2015-10-14 10:40:27 -04:00
Nick Mathewson
8182715a2b Add a doc/HACKING/README.1st 2015-10-09 10:40:53 -04:00
Nick Mathewson
a11cb74d29 Split the old doc/HACKING into several new files 2015-10-09 10:40:53 -04:00
Nick Mathewson
c751e5af4a Move hacking documentation into a new subdirectory. 2015-10-09 10:40:53 -04:00
Nick Mathewson
9e461588a6 Add my draft (in-progress) guide to getting started on tor development 2015-10-08 11:52:27 -04:00
Nick Mathewson
1eb2106375 Document callgraph analysis code 2015-08-25 11:53:20 -04:00
Nick Mathewson
5721627517 Update doc/HACKING with more coverage instructions 2015-08-03 13:30:25 -04:00
Nick Mathewson
a8accd55f2 Bump version (and explain how) 2015-07-23 13:48:13 -04:00
Andrea Shepard
95bcd2dc15 Update and clarify release checklist 2015-06-10 15:05:52 +00:00
teor
bc0a9843e5 Add instructions for clang sanitizers, static analyzer, and coverity
Document use of coverity, clang static analyzer, and clang dynamic
undefined behavior and address sanitizers in doc/HACKING.

Add clang dynamic sanitizer blacklist in
contrib/clang/sanitizer_blacklist.txt to exempt known undefined
behavior. Include detailed usage instructions in this blacklist file.

Patch by "teor".
2015-06-06 04:04:23 +10:00
Nick Mathewson
101fc13b99 Bump version to 0.2.7.1-alpha. (This is not the release yet.) 2015-05-11 10:10:29 -04:00
Nick Mathewson
f15e7d4a1b New email for Lukas Fleischer 2015-04-22 09:49:23 -04:00
Roger Dingledine
c759ed2c62 update url in HACKING file 2015-04-08 13:44:56 -04:00
Nick Mathewson
f0fa0d2b7b Add lukas to doc/HACKING pakager list 2015-04-07 07:40:46 -04:00
Nick Mathewson
f31dc84f03 More addrs in HACKING 2015-03-25 09:16:42 -04:00
Nick Mathewson
8adecae09d spelling fix 2015-03-24 11:55:35 -04:00
Nick Mathewson
95530bac83 Start adding people to the packager list in doc/HACKING 2015-03-24 09:29:28 -04:00
cypherpunks
9dc90a5b7b Add check-changes rule for checking formatting of changes files.
Additional fixes to make the change work;
- fix Python 2 vs 3 issues
- fix some PEP 8 warnings
- handle paths with numbers correctly
- mention the make rule in doc/HACKING.
2015-03-09 09:00:12 -04:00
Roger Dingledine
71613993e0 give dist-master an alias 2014-10-21 16:01:29 -04:00
Roger Dingledine
05791a0b72 explain how to publish tarballs now that webwml has gone to git 2014-10-19 21:27:41 -04:00
Nick Mathewson
f8f0cb0443 Mention "make check" in doc/HACKING 2014-09-12 16:14:49 -04:00
Sebastian Hahn
8448901148 Give an example how to run the unit tests 2014-09-12 22:08:27 +02:00
Nick Mathewson
b16254dce9 Update HACKING instructions to mention format_changelog script 2014-09-11 11:34:57 -04:00
Kevin Murray
eed942aed9 Add stanza on lcov coverage target
Adds a note about using `make coverage-html` to generate coverage
reports.

Signed-off-by: Kevin Murray <spam@kdmurray.id.au>
2014-07-16 05:54:34 -04:00
Roger Dingledine
d064773595 logic mixup, noticed by alphawolf 2014-06-21 15:56:03 -04:00
Nick Mathewson
29f2f7ce9a doc/HACKING: Improve documentation of how to bump version in maint
See discussion on 9553: Some of the build scripts don't like it when
you can't merge maint into release.
2014-05-20 15:02:35 -04:00
Nick Mathewson
34552740b1 Document that we're incrementing version numbers in maint.
(ticket 9553)
2014-05-16 09:14:38 -04:00
Nick Mathewson
703ad69587 Deal with the aftermath of sorting contrib
This basically amounts to grepping for every file that mentioned
contrib and adjusting its references to refer to the right place.
2014-04-28 11:59:55 -04:00
Nick Mathewson
3888427013 The #tor topic no longer includes a version. 2014-04-26 11:01:52 -04:00
Roger Dingledine
e4c7fdd48c bring hacking more up to date 2014-03-22 23:36:10 -04:00
Nick Mathewson
8a647291c8 extract some changelog principles into doc/HACKING 2014-03-19 20:24:15 -04:00
Nick Mathewson
d3c5df6cf6 Give the HTTPS url for jenkins in doc/HACKING 2014-03-06 10:03:24 -05:00
Nick Mathewson
6a6bc9da53 Document more coverage tricks in doc/HACKING 2014-01-21 16:44:48 -05:00
Roger Dingledine
bce775c159 name it correctly, maybe 2013-10-01 15:47:38 -04:00
Nick Mathewson
5baacf5a9c Mention "make test-network" in doc/HACKING 2013-10-01 12:50:48 -04:00
Nick Mathewson
11352b0ce1 Add a clarification to gcov instructions 2013-09-03 15:44:13 -04:00
Roger Dingledine
c7d3ecab57 new location for tarballs; and you should edit Makefile too 2013-08-10 18:33:37 -04:00
Nick Mathewson
ad49ceba1f Update coverage instructions 2013-08-06 12:00:28 -04:00
Nick Mathewson
74a534be15 Fix the biggest errors in doc/HACKING
We can wait for 0.2.5 for a full rewrite.  #8964
2013-06-12 21:27:30 -04:00
Nick Mathewson
4a9bc5658f Fix instructions for using Tor with gcov
It seems as if our new build system broke gcov for me.  I've tried to
fix doc/HACKING to describe what I needed to do in order to make it
work again.
2012-10-24 15:03:49 -04:00
Nick Mathewson
485b4b7eee Rename configure.in to configure.ac
This is the preferred filename to use with Autoconf 2.50 and later.
2012-09-04 11:12:00 -04:00
Roger Dingledine
e18fa28248 sebastian is the new karsten, i hear 2011-11-23 04:41:46 -05:00
Roger Dingledine
3888117318 add another heuristic for making release notes 2011-08-28 21:43:19 -04:00
Sebastian Hahn
5580fbb0c4 Update HACKING with some more release instructions 2011-07-14 09:51:24 -04:00
Roger Dingledine
b181985a8f explain that the ./publish should happen soon after the scp
otherwise you scp a tarball up but only one version of the website has it.
2011-06-21 00:37:18 -04:00