nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-27 22:03:31 +01:00
Code Issues Packages Projects Releases Wiki Activity
cb8ac1f331
tor/doc/HACKING
History
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
..
CodingStandards.md check-spaces is run as part of make check 2016-12-21 17:08:06 -05:00
Fuzzing.md Small fixes to fuzzing documentation. 2017-02-24 10:57:58 -05:00
GettingStarted.md Delete trailing whitespace in md files 2015-11-05 09:53:05 -05:00
HelpfulTools.md Remove trailing whitespace 2017-01-13 12:31:57 -05:00
HowToReview.md Stop recommending --enable-gcc-warnings in doc/HACKING 2016-05-23 14:40:27 -04:00
README.1st.md added some markdown formatting 2015-11-05 09:13:53 -05:00
ReleasingTor.md Add a release checklist step to highlight changes 2017-04-03 16:11:52 +02:00
Tracing.md trace: Add a basic event-tracing infrastructure. 2017-04-25 10:37:31 -04:00
WritingTests.md Fix typo 2016-11-21 12:15:44 -05:00

README.1st.md

In this directory

This directory has helpful information about what you need to know to hack on Tor!

First, read GettingStarted.md to learn how to get a start in Tor development.

If you've decided to write a patch, CodingStandards.txt will give you a bunch of information about how we structure our code.

It's important to get code right! Reading WritingTests.md will tell you how to write and run tests in the Tor codebase.

There are a bunch of other programs we use to help maintain and develop the codebase: HelpfulTools.md can tell you how to use them with Tor.

If it's your job to put out Tor releases, see ReleasingTor.md so that you don't miss any steps!

For full information on how Tor is supposed to work, look at the files in https://gitweb.torproject.org/torspec.git/tree.

For an explanation of how to change Tor's design to work differently, look at https://gitweb.torproject.org/torspec.git/blob_plain/HEAD:/proposals/001-process.txt.

For the latest version of the code, get a copy of git, and

git clone https://git.torproject.org/git/tor

We talk about Tor on the tor-talk mailing list. Design proposals and discussion belong on the tor-dev mailing list. We hang around on irc.oftc.net, with general discussion happening on #tor and development happening on #tor-dev.

The other files in this HACKING directory may also be useful as you get started working with Tor.

Happy hacking!

XXXXX also describe

doc/HACKING/WritingTests.md

torguts.git

torspec.git

The design paper

freehaven.net/anonbib

XXXX describe these and add links.