aboutsummaryrefslogtreecommitdiff
path: root/doc/HACKING
AgeCommit message (Collapse)Author
2023-07-26Include a basic Rust wrapper for Equi-X and HashXMicah Elizabeth Scott
The idea behind this is that we may want to start exporting more pieces of c-tor as Rust crates so that Arti can perform cross compatibility and comparison testing using Rust tooling. This turns the 'tor' repo into a Cargo workspace, and adds one crate to start with: "tor-c-equix", rooted in src/ext/equix. This actually includes both Equi-X itself and HashX, since there's less overall duplication if we package these together instead of packaging HashX separately. This patch adds a basic safe Rust interface, but doesn't expose any additional internals for testing purposes. No changes to the C code here or the normal Tor build system. Signed-off-by: Micah Elizabeth Scott <beth@torproject.org>
2023-06-19Merge branch 'maint-0.4.7'David Goulet
2023-06-19Change git.tpo URLs to gitlab.tpoDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2023-06-19Use the new Stem repository on GitlabDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2023-06-15Change git.tpo URLs to gitlab.tpoDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2023-01-19doc: Add tpo website update to ReleasingTor.mdDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2022-12-16Fix typosDimitris Apostolou
2022-08-12doc: Add git merge detail in release documentDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2022-08-11doc: Improve ReleasingTor.md and fix announcement MLDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2022-04-27doc: Clarify the release process for a first stableDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2022-04-07doc: Minor changes to the Releasing docDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2022-01-24doc: More clarification of the release process stepsDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2022-01-24Try to clarify maint vs release issues on ReleasingTor.mdNick Mathewson
I've tried to clarify what happens on "maint" vs what happens on "release". I'm not sure I've got it right wrt the patches generated by the scripts, though, so please review carefully and second-guess everything I'm saying here. :)
2021-12-16doc: One more poings in ReleasingTor.mdDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-12-16doc: Update ReleasingTor.md with missing stepsDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-12-16doc: Improve a bit the ReleasingTor.mdDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-11-02doc: Brand new ReleasingTor.mdDavid Goulet
Closes #40508 Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-10-06Remove last artifacts of Rust related codeDavid Goulet
Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-10-06rust: Remove Rust support from treeDavid Goulet
Closes #40469 Signed-off-by: David Goulet <dgoulet@torproject.org>
2021-07-23Correct another ReleasingTor.md issueNick Mathewson
2021-07-23Update ReleasingTor.md to reflect current practiceNick Mathewson
2021-06-07Add links to original design paper and anonbibEmily Bones
Closes #33742
2021-06-07Add a checklist to releasingtor.mdNick Mathewson
2021-05-25Rewrite documentation on primary branch usage for Tor.git.Alexander Færøy
This patch is part of a series of patches where we try to change our primary branch name of tor.git from master to main. See: tpo/core/team#2
2021-01-15add brave to security cc listNick Mathewson
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