Commit Graph

255 Commits

Author SHA1 Message Date
Nick Mathewson 58d7f9e68b Remove Makefile from doc/HACKING/design 2019-11-06 15:47:29 -05:00
Nick Mathewson 83cab05398 Remove 00-overview.md as already subsumed by doxygen 2019-11-06 15:47:00 -05:00
Nick Mathewson 3ae87c3c7f Turn the "dataflow" document into a doxygen page. 2019-11-06 12:50:57 -05:00
Nick Mathewson e1cdca2e4f directory-level doxygen for "src/core" 2019-11-04 16:28:28 -05:00
Nick Mathewson 607b1ff776 Move much of 00-overview.md into doxygen. 2019-11-04 12:24:46 -05:00
Nick Mathewson a5085c52d0 Move most of crypto overview into doxygen. 2019-11-04 12:10:28 -05:00
Nick Mathewson 211a2e0a8f Move doc/HACKING/design/01b-collections.md into doxygen. 2019-11-04 12:07:38 -05:00
Nick Mathewson fb20618e28 Divide 01a-memory.md into doxygen. 2019-11-04 12:04:32 -05:00
Nick Mathewson 4bf73dfa26 Remove now-superseded part of doc/HACKING/design. 2019-11-04 11:52:49 -05:00
teor 0973575737 doc/HACKING: Update Module.md for the relay module
Also fix some typos, and delete some obsolete instructions.

Part of 32123.
2019-10-20 20:26:06 +10:00
Nick Mathewson 1332d3b6fa doc/HACKING/design: address comments from ahf 2019-10-14 15:53:04 -04:00
Nick Mathewson 358436592b Edit 01b-collections.md a bit for md and missing content 2019-10-14 15:05:47 -04:00
Nick Mathewson 77accf937e Edit 01a-memory.md 2019-10-14 15:02:26 -04:00
Nick Mathewson 8ef5d96c2e Rewrite "common" overview into a "lib" overview. 2019-10-14 13:49:27 -04:00
Nick Mathewson 908070bbd5 Rename common-utils to lib-overview. 2019-10-14 10:59:32 -04:00
Nick Mathewson 1b996b01f6 00-overview.md: Revise to describe intended document structure 2019-10-14 10:58:03 -04:00
Roger Dingledine aa56465934 fix typo in how-to-review guidelines 2019-10-07 00:48:11 -04:00
Nick Mathewson 469051f650 Copy architectural documentation from tor-guts.git repository
I started this repository a while ago to work on documentation for
Tor's internals.  It needs substantial revision, but first, let's
get it copied into Tor's repository.

These files are copied, "warts and all", from the tor-guts.git repo,
commit de1e34259178b09861c0dea319c760fa80d0099a.

Part of 31819.
2019-09-24 19:26:04 -04:00
Antoine Veuiller 3bf90e704c doc(hacking): update = to # on sections 2019-08-21 16:22:37 +02:00
Antoine Veuiller 0d6c8eed49 doc(hacking): enhance markdown style 2019-08-21 16:22:08 +02:00
Nick Mathewson 4313f1cce8 Merge branch 'ticket28453_v2' into ticket28453_v2_merged 2019-06-11 10:22:37 -04:00
Nick Mathewson 765e4364d9 Merge remote-tracking branch 'tor-github/pr/1064' into maint-0.4.1 2019-06-10 09:37:17 -04:00
Nick Mathewson 4ceec4760c change some CI-substitute logic 2019-06-05 15:38:25 -04:00
rl1987 5d4b4f948a Mention Travis/Appveyor/Jenkins URLs in ReleasingTor.md 2019-05-31 09:35:19 +03:00
Nick Mathewson d41427b054 A couple of suggestions from dgoulet on EndOfLife.md 2019-05-30 09:07:45 -04:00
Nick Mathewson 3ba2e04ee7 Minor tweaks on EOL process
First, clarify that this is for planned deprecations, not
security-related issues.

Second, we actually _don't_ want to remove the versions from the
approved list before the EOL date, or people will start getting
warnings too early.
2019-05-30 09:05:35 -04:00
teor 6263d9e13f doc: Add End of Life Tor instructions
Closes 28453.
2019-05-30 09:02:13 -04:00
teor c390f1dd7e doc: Add a new Travis CI cron job when there's a new maint branch
Part of 28453.
2019-05-30 09:02:13 -04:00
Nick Mathewson d20cfc00ce Note how to update the new website in the ReleasingTor.md instructions 2019-05-03 08:51:28 -04:00
teor ac5753d3ca Coding Standards: Document how to find git commits
Document how to find git commits and tags for bug fixes in
CodingStandards.md.

And update some changes file documentation.

Closes ticket 30261.
2019-04-23 10:03:18 +10:00
Elichai Turkel 0ebe290198 Removed the use of expect from CodingStandardsRust 2019-04-03 08:32:10 -04:00
Nick Mathewson e2512950b6 Improve failure message from check-best-practices 2019-03-13 09:27:29 -04:00
Roger Dingledine 5dcd44cbe2 fix some of the typos in Maintaining.md 2019-02-17 16:55:55 -05:00
Nick Mathewson b915b6cd21 Merge remote-tracking branch 'github/prop297' 2018-12-11 09:44:57 -05:00
Nick Mathewson 1f6d7bc4af Update ReleasingTor.md to reflect current practice
See #28479.
2018-12-05 07:58:53 -05:00
Nick Mathewson b16d6453ad Rewrite updateVersions script in Python, add datestamp functionality.
This updateVersions.pl script was one of the only essential perl
scripts left in out maint system, and was the only one that used
autoconf to fill in the script.

This script adds a feature to define an APPROX_RELEASE_DATE macro
that is updated when the version changes.  We'll use this to
implement prop297, so that we have an accurate view of when a
release date happens.
2018-11-24 20:44:37 -05:00
Nick Mathewson ed8a853bd8 Merge branch 'ticket28225_036_01_squashed' 2018-10-29 16:30:44 -04:00
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
teor b0c456e578 doc: Use `` for commands and "" for quotes in ReleasingTor.md 2018-10-29 13:49:47 +10:00
teor fe89d9df69 doc: Spell make test-network-all correctly in ReleasingTor.md
Closes ticket 28821.
2018-10-29 13:47:43 +10: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