summaryrefslogtreecommitdiff
path: root/doc/HACKING
AgeCommit message (Collapse)Author
2020-11-12Fix typos.Samanta Navarro
Typos found with codespell. Please keep in mind that this should have impact on actual code and must be carefully evaluated: src/core/or/lttng_circuit.inc - ctf_enum_value("CONTROLER", CIRCUIT_PURPOSE_CONTROLLER) + ctf_enum_value("CONTROLLER", CIRCUIT_PURPOSE_CONTROLLER)
2020-09-14Update remaining trac.tpo wiki urlsNick Mathewson
2020-08-14Revise trac.torproject.org urls to refer to gitlab replacements.Nick Mathewson
Closes #40101.
2020-08-13Update ReleasingTor.md to current practiceNick Mathewson
2020-08-11CodingStandards.md: allow "bugfix on all supported versions.Nick Mathewson
Closes tpo/core/team#1 .
2020-07-28WritingTests.md: add a section about shellsNick Mathewson
Closes #29485
2020-07-16Combine text into existing "what does not need a changes file" section.Nick Mathewson
2020-07-16doc: Update our requirements for changes fileDavid Goulet
Closes tpo/core/team#3. Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-16doc: Document circuit subsystem tracing eventsDavid Goulet
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-14doc: Fix aesthetic issues in HACKING/Tracing.mdDavid Goulet
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-13Merge branch 'maint-0.4.4'Nick Mathewson
2020-07-13Bug 31812: Change http URL's to httpsJeremyRand
2020-07-13Syntax highlighting in the docsGuinness
This adds the syntax highlights in the MarkDown files. Fixes #33741
2020-07-08doc: Add a WARNING section to Tracing.mdDavid Goulet
Explain what is safe or not with tracing data. Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-07-08trace: Comments and improve doc/HACKING/Tracing.mdDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2020-06-26Move remaining CodeStructure.md contents into doxygen.Nick Mathewson
2020-06-04doc: specify C99 coding standardsc
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-04-03doc: Also stop running practracker in hooksteor
When making a new maint branch, stop running practracker in hooks.
2020-04-03doc: Minor restructure for Release Lifecycleteor
* make end and beginning of life into second-level sections * write an intro for beginning * tweak intro for end
2020-04-03Re-apply: doc: Replace "underline" with "## Section name".teor
Re-applying changes after merge.
2020-04-03Merge remote-tracking branch 'tor-github/pr/1739'teor
Ignored conflicting style changes: they will be re-applied in the next commit.
2020-03-26doc: Remove TODO secion in README.1st.mdBartosz Duszel
It seems like this section is not valid anymore. Most of this topics are already explained in different files.
2020-03-26doc: Replace "underline" with "## Section name".Bartosz Duszel
This approach doesn't require variable-length underlines.
2020-03-26doc: Remove first, empty line in the file.Bartosz Duszel
2020-03-26doc: Updates paths to the top of the source tree.Bartosz Duszel
Example: .../doc/HACKING is now doc/HACKING
2020-03-23Edits requested by teorNick Mathewson
2020-03-22Update README files with common style.Bartosz Duszel
- 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-02-24Tweak a couple of URLs in gettingstarted.mdNick Mathewson
2020-02-14Rename EndOfLifeTor to ReleaseSeriesLifecycle; expand it.Nick Mathewson
Closes ticket 30917.
2020-02-03go in to fix one typo, end up fixing moreRoger Dingledine
2020-01-23update doc/HACKING/ReleasingTor.mdNick Mathewson
2020-01-16Define a "dircache" module.Nick Mathewson
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-06Merge remote-tracking branch 'tor-github/pr/1615'Nick Mathewson
2020-01-06Add documentation about building a TAGS file.Nick Mathewson
Patch from opara. Closes ticket 32779.
2019-12-17Add NSF support acknowledgment to circpad dev doc.Mike Perry
2019-12-16Add circuit padding developer and quickstart docs.Mike Perry
2019-11-25Merge branch 'maint-0.4.2'teor
Merge tor_free() notes with whitespace fixes.
2019-11-25CodingStandards: Use consistent spacingteor
* 2 newlines before ====== headers * 1 newline before ------ headers
2019-11-25Merge branch 'maint-0.4.2'teor
2019-11-25CodingStandards: Use the correct changes file formatteor
And remove a duplicate description of the format. Obviously correct changes to documentation.
2019-11-12Fold remainder of this-not-that.md into CodingStandards.mdNick Mathewson
2019-11-12Merge remote-tracking branch 'tor-github/pr/1367'Nick Mathewson
2019-11-12Remove 01e-os-compat: the module docs cover this much better.Nick Mathewson
2019-11-12HACKING/design: move 01c-time.md into doxygen.Nick Mathewson
2019-11-12Move 01g-strings.md into doxygen.Nick Mathewson
2019-11-1201f-threads.md becomes threading.dox.Nick Mathewson
2019-11-12HACKING/design: turn the remaining parts of crypto into a certs docNick Mathewson
2019-11-12HACKING/design: remove 03-modules as superseded.Nick Mathewson
The src/feature directory documentation now covers this better.
2019-11-06Remove Makefile from doc/HACKING/designNick Mathewson
2019-11-06Remove 00-overview.md as already subsumed by doxygenNick Mathewson