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
Roger Dingledine
ec25c1f6ca
another changelog heuristic based on 0.2.3.1-alpha
2011-05-10 21:30:55 -04:00
Andrew Lewman
be7e8f5bb9
fix the website directions.
2011-05-05 15:28:29 -04:00
Nick Mathewson
29f1ffa0fe
More notes on how to upload tarballs from erinn
2011-05-04 17:21:33 -04:00
Nick Mathewson
033c27ac5e
Add a couple of notes to doc/HACKING based on 0.2.2.25-alpha process
2011-05-02 16:55:50 -04:00
Roger Dingledine
93b0183d3c
add another heuristic for changes stanzas
2011-04-29 01:35:21 -04:00
Nick Mathewson
676190e895
Update hacking file with terse notes on formatting changelog
2011-04-28 23:44:48 -04:00
Nick Mathewson
48c4d53281
Add a step to the release process: tell trac about the version.
2011-03-10 16:10:53 -05:00
Roger Dingledine
dbd4a01756
steps roger takes when making a new release
2011-03-08 16:06:32 -05:00
Roger Dingledine
9c72324ae8
update spec locations
2011-03-08 15:31:04 -05:00
Roger Dingledine
95edd51116
make nickm's proposed convention from 2003 be gospel
2011-03-08 14:59:30 -05:00
Nick Mathewson
2be5effe9a
Initial oprofile instructions based on original by weasel.
2010-09-12 19:37:04 -04:00
Roger Dingledine
1ac1f048ef
minor formatting / comment fixes
2010-08-13 17:18:45 -04:00
Chris Ball
16970d83cc
doc/HACKING: Explain how to find when a given change was introduced
2010-08-12 02:38:58 +02:00
Sebastian Hahn
41c0d52810
check-speces is a typo.
2010-04-27 19:01:08 +02:00
Nick Mathewson
8ec5f939a6
Add new sections to the HACKING file
...
The main changes are to explain how we use git branches, how we use
changes files, and what should go into a patch. Putting these in
HACKING means that we shouldn't need to constantly refer to the or-dev
emails where we explain this stuff.
2010-04-27 12:24:35 -04:00
Nick Mathewson
b92ef5fa0e
Convert HACKING file to asciidoc: I am tired of re-numbering the sections.
2010-04-16 12:58:13 -04:00
Roger Dingledine
1efb643224
fix the wiki link in doc pages. remove obsolete FAQ.
2009-10-01 04:45:59 -04:00
Sebastian Hahn
81895dbd52
Our test script moved from src/or/test to src/test/test.
...
Update the HACKING document and the cross compilation helper
2009-09-23 00:24:43 -04:00
Roger Dingledine
b02b11c4b4
a mish-mash of stuff in my sandbox
2009-09-17 01:58:39 -04:00
Nick Mathewson
7d84b84608
Clearer valgrind instructions for non-Debian openssls
2009-05-19 10:40:20 -04:00
Nick Mathewson
ee706649f6
Say more about comment conventions in doc/HACKING
...
svn:r17703
2008-12-19 18:51:40 +00:00
Nick Mathewson
c4bf882d43
r17433@tombo: nickm | 2008-07-29 10:58:07 -0400
...
Docment gcov in HACKING
svn:r16254
2008-07-30 13:04:19 +00:00
Nick Mathewson
4630f0453d
Explain how my emacs setup works in the HACKING file. Someone else may care too.
...
svn:r15228
2008-06-13 19:57:52 +00:00
Roger Dingledine
67916707b5
are we really that bad at speeling?
...
svn:r14364
2008-04-12 21:36:28 +00:00
Jacob Appelbaum
c7f754d366
Added buildbot notes.
...
svn:r14258
2008-03-31 10:27:27 +00:00
Nick Mathewson
5855ca92a3
r14514@tombo: nickm | 2008-02-27 02:11:38 -0500
...
Add notes on dataflow (originally written for Dan) to HACKING document.
svn:r13749
2008-02-27 07:13:14 +00:00
Roger Dingledine
70f1c25729
now that i hunted these command-lines down, let's keep them for
...
posterity.
svn:r10973
2007-07-29 22:13:08 +00:00
Nick Mathewson
f2984faada
r12362@catbus: nickm | 2007-04-14 12:59:38 -0400
...
Note indentation and terminal-width conventions in HACKING
svn:r9953
2007-04-14 16:59:44 +00:00
Nick Mathewson
9e7e9e1bfe
r11811@catbus: nickm | 2007-02-14 02:51:43 -0500
...
Mention --enable-gcc-warnings and "make check-spaces" in HACKING
svn:r9584
2007-02-14 16:46:47 +00:00
Roger Dingledine
233eddc9a7
now i'll remember where the buildbot is. maybe.
...
svn:r9313
2007-01-09 05:41:48 +00:00
Roger Dingledine
7f3fc70945
simplify a section of the HACKING file
...
svn:r8689
2006-10-11 20:45:01 +00:00
Roger Dingledine
9e861cfe52
touch up the TODO and HACKING files
...
svn:r6713
2006-07-04 03:33:17 +00:00
Roger Dingledine
5c85d97496
a few minor cleanups to HACKING
...
svn:r4438
2005-06-16 20:32:40 +00:00
Roger Dingledine
05608eeb16
HACKING is nearly dead now; long live HACKING.
...
svn:r4407
2005-06-11 06:07:43 +00:00
Roger Dingledine
a92ff1c4e9
blow away obsolete stuff
...
svn:r4324
2005-06-06 20:30:25 +00:00
Roger Dingledine
c5b986ec6c
clean up hacking file, based on patch from tyranix
...
svn:r4237
2005-05-17 01:38:25 +00:00
Roger Dingledine
aa48b96036
migrate to the new URL
...
svn:r3296
2005-01-05 00:06:51 +00:00
Nick Mathewson
21c92dace0
More whitespace normalization
...
svn:r2768
2004-11-10 01:20:17 +00:00
Roger Dingledine
d18528a2ab
fix a typo in our doxygen instructions
...
svn:r1822
2004-05-09 16:32:33 +00:00
Nick Mathewson
d15a95145e
Add Doxygen config file and make target, along with section in HACKING document
...
svn:r1819
2004-05-07 17:03:52 +00:00
Roger Dingledine
414dff42c5
update hacking to mention loglevel notice
...
svn:r1385
2004-03-30 03:20:38 +00:00
Roger Dingledine
10548ae9ec
a few minor updates to hacking
...
svn:r908
2003-12-13 22:55:12 +00:00
Roger Dingledine
fbb0a450ee
update the FAQ so it's just useless, not wrong
...
svn:r802
2003-11-12 17:34:41 +00:00
Roger Dingledine
c098d7769f
first pass over HACKING doc
...
svn:r568
2003-10-09 08:33:54 +00:00
Nick Mathewson
43a2e32ace
First cut at HACKING document
...
svn:r567
2003-10-09 02:05:13 +00:00
Roger Dingledine
22526c62a5
add log convention to hacking file
...
this thing needs to get revamped into a 'guide to tor' document
svn:r534
2003-10-03 19:37:38 +00:00
Roger Dingledine
1ae95f66ed
bring docs closer to reality
...
svn:r221
2003-04-05 19:04:05 +00:00
Roger Dingledine
8fb1056a7c
identical FAQ and HACKING files, now in /doc
...
svn:r194
2003-03-18 03:28:03 +00:00
