Commit Graph

302 Commits

Author SHA1 Message Date
Nick Mathewson
563f8610fd Revise trac.torproject.org urls to refer to gitlab replacements.
Closes #40101.
2020-08-14 09:21:28 -04:00
Nick Mathewson
e82f36bccc Update ReleasingTor.md to current practice 2020-08-13 09:56:27 -04:00
Nick Mathewson
b56985f022 CodingStandards.md: allow "bugfix on all supported versions.
Closes tpo/core/team#1 .
2020-08-11 17:58:11 -04:00
Nick Mathewson
4e71fc92c8 WritingTests.md: add a section about shells
Closes #29485
2020-07-28 22:59:47 -04:00
Nick Mathewson
5f969681a0 Combine text into existing "what does not need a changes file" section. 2020-07-16 14:54:17 -04:00
David Goulet
ca1003b791 doc: Update our requirements for changes file
Closes tpo/core/team#3.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-16 13:34:52 -04:00
David Goulet
9c653e58b4 doc: Document circuit subsystem tracing events
Create a doc/tracing/ directory to contain a top level README.md which is the
previously named Tracing.md and add the EventsCircuit.md which describes the
circuit subsystem tracing events in depth.

Closes #40036

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-16 14:19:04 +00:00
David Goulet
770e047c83 doc: Fix aesthetic issues in HACKING/Tracing.md
Remove all the escape character "\" which is not needed for Markdown files.
This also fixes the tracing event include to the correct path.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-14 10:09:01 -04:00
Nick Mathewson
ecb43ce21c Merge branch 'maint-0.4.4' 2020-07-13 10:45:04 -04:00
JeremyRand
0be80fb650 Bug 31812: Change http URL's to https 2020-07-13 10:42:46 -04:00
Guinness
b119c55776 Syntax highlighting in the docs
This adds the syntax highlights in the MarkDown files.
Fixes #33741
2020-07-13 11:45:14 +02:00
David Goulet
942ecfa835 doc: Add a WARNING section to Tracing.md
Explain what is safe or not with tracing data.

Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-08 11:11:58 -04:00
David Goulet
79d6127a47 trace: Comments and improve doc/HACKING/Tracing.md
Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-08 09:12:36 -04:00
Nick Mathewson
5336ac2669 Move remaining CodeStructure.md contents into doxygen. 2020-06-26 10:11:42 -04:00
c
284e9459b8
doc: specify C99 coding standards
Make clear that Tor's C code targets C99 standards. This makes it more
explicit what to expect for new code, because guessing from existing
code is not always reliable, especially for code that predates the
change in standard.
2020-06-04 13:28:24 +00:00
teor
c0fe88b236
doc: Also stop running practracker in hooks
When making a new maint branch, stop running practracker in hooks.
2020-04-03 22:10:01 +10:00
teor
6db2e59f20
doc: Minor restructure for Release Lifecycle
* make end and beginning of life into second-level sections
* write an intro for beginning
* tweak intro for end
2020-04-03 22:06:27 +10:00
teor
0f10ddaa29
Re-apply: doc: Replace "underline" with "## Section name".
Re-applying changes after merge.
2020-04-03 22:02:11 +10:00
teor
0efcdb8918
Merge remote-tracking branch 'tor-github/pr/1739'
Ignored conflicting style changes: they will be re-applied in
the next commit.
2020-04-03 21:59:19 +10:00
Bartosz Duszel
df22ee26fb doc: Remove TODO secion in README.1st.md
It seems like this section is not valid anymore.
Most of this topics are already explained in different
files.
2020-03-26 16:32:13 +01:00
Bartosz Duszel
b210aefb7f doc: Replace "underline" with "## Section name".
This approach doesn't require variable-length underlines.
2020-03-26 16:19:42 +01:00
Bartosz Duszel
af4b5eba34 doc: Remove first, empty line in the file. 2020-03-26 15:59:17 +01:00
Bartosz Duszel
8863408cad doc: Updates paths to the top of the source tree.
Example:
.../doc/HACKING is now doc/HACKING
2020-03-26 15:54:29 +01:00
Nick Mathewson
b1a571f038 Edits requested by teor 2020-03-23 09:27:16 -04:00
Bartosz Duszel
fd6a35eb59 Update README files with common style.
- external links use markdown's []() format,
- local files are formated with backquotes,
- duplicated new lines were removed,
- unnecesary single spaces were removed,
- broken links and local paths were updated.
2020-03-22 13:50:58 +01:00
Nick Mathewson
c9bd3579f7 Tweak a couple of URLs in gettingstarted.md 2020-02-24 08:10:20 -05:00
Nick Mathewson
455ea05bdf Rename EndOfLifeTor to ReleaseSeriesLifecycle; expand it.
Closes ticket 30917.
2020-02-14 08:47:17 -05:00
Roger Dingledine
90bb4872b8 go in to fix one typo, end up fixing more 2020-02-03 23:21:58 -05:00
Nick Mathewson
7c76cedf0f update doc/HACKING/ReleasingTor.md 2020-01-23 08:55:55 -05:00
Nick Mathewson
888a0be0b9 Define a "dircache" module.
For now, this module is enabled whenever the relay module is
enabled, and disabled whenever the relay module is disabled.  Though
they are logically separate, the use cases for running one without
the other are rare enough that we don't really want to support
compiling them independently.
2020-01-16 07:48:17 -05:00
Nick Mathewson
9276c07a91 Merge remote-tracking branch 'tor-github/pr/1615' 2020-01-06 13:32:33 -05:00
Nick Mathewson
e08d07692f Add documentation about building a TAGS file.
Patch from opara.  Closes ticket 32779.
2020-01-06 13:31:30 -05:00
Mike Perry
b7dbb4a554 Add NSF support acknowledgment to circpad dev doc. 2019-12-17 17:10:40 -06:00
Mike Perry
981350815d Add circuit padding developer and quickstart docs. 2019-12-16 22:00:54 +02:00
teor
68b6d85248
Merge branch 'maint-0.4.2'
Merge tor_free() notes with whitespace fixes.
2019-11-25 12:52:10 +10:00
teor
eb81704081
CodingStandards: Use consistent spacing
* 2 newlines before ====== headers
* 1 newline before ------ headers
2019-11-25 12:50:15 +10:00
teor
03867b3dd7
Merge branch 'maint-0.4.2' 2019-11-25 12:37:26 +10:00
teor
969ee5d77f
CodingStandards: Use the correct changes file format
And remove a duplicate description of the format.

Obviously correct changes to documentation.
2019-11-25 11:44:22 +10:00
Nick Mathewson
f221a7aaf6 Fold remainder of this-not-that.md into CodingStandards.md 2019-11-12 12:28:14 -05:00
Nick Mathewson
c11c1d0623 Merge remote-tracking branch 'tor-github/pr/1367' 2019-11-12 12:18:14 -05:00
Nick Mathewson
e39423c78c Remove 01e-os-compat: the module docs cover this much better. 2019-11-12 12:14:56 -05:00
Nick Mathewson
6744f6b6bb HACKING/design: move 01c-time.md into doxygen. 2019-11-12 12:14:14 -05:00
Nick Mathewson
b0f9ecdbb1 Move 01g-strings.md into doxygen. 2019-11-12 12:09:53 -05:00
Nick Mathewson
d1a1631a05 01f-threads.md becomes threading.dox. 2019-11-12 12:05:05 -05:00
Nick Mathewson
91f377deec HACKING/design: turn the remaining parts of crypto into a certs doc 2019-11-12 12:01:33 -05:00
Nick Mathewson
89396bc726 HACKING/design: remove 03-modules as superseded.
The src/feature directory documentation now covers this better.
2019-11-12 11:56:53 -05:00
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