summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Update Compatibility.mdNick Mathewson2026-02-251-50/+82
| | | | Closes #2194.
* Release.md: Re-number post-release steps.Nick Mathewson2026-02-191-7/+7
|
* docs: Move deleting semver.md files before unfreezing tree.Wesley Aptekar-Cassels2026-02-021-3/+3
| | | | | | | | | We frequently have merge conflicts when deleting the semver.md files. While this isn't the end of the world, it's annoying, so I think it's worth making a habit of deleting the semver.md files before unfreezing the tree. This also avoids any problems with inadvertently removing entries that were added after the release was cut.
* Rename maint/list_crates to kebab-caseIan Jackson2026-01-201-2/+2
| | | | | | | | | | Swap the symlink direction: now we have list_crates.py (the python module) with a symlink list-crates pointing to it. This allows the module to be imported but the command to be kebab case. The checking tooling doesn't understand this special arrangement. Lots of references to update!
* maint: Rename reproducible build scripts to kebab caseIan Jackson2026-01-201-1/+1
| | | | We had both maint/docker-... and maint/docker_...
* maint: Rename miscellaneous scripts to kebab caseIan Jackson2026-01-201-7/+7
|
* Rename remaining maint/check_ to maint/check-Ian Jackson2026-01-201-1/+1
|
* Rename cargo_audit and cargo_sort scripts to kebab-caseIan Jackson2026-01-201-1/+1
|
* Abolish now-done plans for encoded authcertsIan Jackson2026-01-151-81/+0
| | | | | | | The structural confusion hazard is now discussed extensively in torspec and referenced from the code. The proposal has been implemented.
* tor-netdoc: EncodedAuthCert: move future plans to a commentIan Jackson2026-01-151-22/+0
| | | | This probably isn't going to happen, but let's keep the idea in-tree.
* tor-netdoc: EncodedAuthCert: move/tidy rationale informationIan Jackson2026-01-151-53/+0
| | | | | Move the information which still seems relevant out of the plan document.
* Merge branch 'rpc-auto-spec' into 'main'Nick Mathewson2026-01-141-11/+54
|\ | | | | | | | | rpc: Document the intended behavior of inet-auto connpts See merge request tpo/core/arti!3587
| * rpc: Rename socket_stored_in_file => socket_address_fileNick Mathewson2026-01-141-2/+2
| |
| * Suggestions from @dizietNick Mathewson2026-01-141-0/+23
| |
| * rpc: Document the intended behavior of inet-auto connptsNick Mathewson2026-01-131-11/+31
| | | | | | | | Part of #1844.
* | authcert-in-consensus: Allow the `fingerprint` anomalyIan Jackson2026-01-121-1/+1
| | | | | | | | | | | | As per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/3565#note_3323304 https://gitlab.torproject.org/tpo/core/torspec/-/merge_requests/453#note_3323185
* | authcert-in-consensus: Fix some wrong intro item refsIan Jackson2026-01-121-2/+2
| | | | | | | | | | | | As per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/3565#note_3323305 https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/3565#note_3323306
* | authcert-in-consensus: Revised less-generic proposalIan Jackson2026-01-121-45/+67
| |
* | authcert-in-consensus: Improve, clarify, xref requirementsIan Jackson2026-01-121-13/+9
| |
* | authcert-in-consensus: Fix intro wording and semantic botchesIan Jackson2026-01-121-13/+12
| | | | | | | | | | | | | | Firstly, this only applies to votes, not other kinds of nestatus. Secondly, we wrote "netstatus" a couple of times instead of "vote" which is very confusing.
* | authcert-in-consensus: Fix typoIan Jackson2026-01-121-1/+1
| |
* | Notes about netdoc shift/reduce conflicts and authcert in netstatusIan Jackson2026-01-121-0/+139
|/
* Merge branch 'relay-conflux-note3' into 'main'David Goulet2025-12-181-0/+606
|\ | | | | | | | | | | | | doc/dev/notes: Add note on relay conflux Closes #2273 See merge request tpo/core/arti!3533
| * doc/dev/notes: Say we might want buffering on the inner MPSCsGabriela Moldovan2025-12-111-4/+7
| |
| * doc/dev/notes: Say that ConfluxController may be folded into StreamReactorGabriela Moldovan2025-12-111-1/+4
| |
| * doc/dev/notes: Add more details on the client sideGabriela Moldovan2025-12-111-7/+198
| |
| * doc/dev/notes: Say that the split StreamMap design is TBDGabriela Moldovan2025-12-111-4/+4
| |
| * doc/dev/notes: Clarify the parts that apply to both stream handling designsGabriela Moldovan2025-12-111-5/+6
| |
| * doc/dev/notes: Move clarification closer to the diagramGabriela Moldovan2025-12-111-6/+5
| | | | | | | | | | | | I am about to add some text that applies to both designs, so I want to move this closer to the diagram to avoid a confusing interleaving of text.
| * doc/dev/notes: Say that we will have a single stream taskGabriela Moldovan2025-12-111-20/+46
| | | | | | | | | | For the initial implementation, we don't plan to split the read and write sides of the stream handling task.
| * doc/dev/notes: Rename Stream{BWD,FWD} to Stream{Read,Write}Gabriela Moldovan2025-12-101-22/+22
| | | | | | | | | | As suggested in https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/3533#note_3305914
| * doc/dev/notes: Add note on relay confluxGabriela Moldovan2025-12-081-0/+383
| | | | | | | | Closes #2273
* | rpc-connect-spec: Describe new behavior.Nick Mathewson2025-12-171-0/+3
| |
* | Merge branch 'semver-experimental' into 'main'Nick Mathewson2025-12-111-0/+6
|\ \ | |/ |/| | | | | doc: Mention `experimental` feature in Semver.md See merge request tpo/core/arti!3545
| * Fix some wordingClara Engler2025-12-111-2/+2
| |
| * doc: Mention `experimental` feature in Semver.mdClara Engler2025-12-101-0/+6
| | | | | | | | | | | | | | | | | | The `experimental` feature flags are not explicitly mentioned anywhere in the `doc/Semver.md` file. This commit changes that by adding a paragraph documenting the status quo, namely that functionalities gated behind an opt-in experimental flag may break despite an unchanged major version number.
* | Fix the JSON in rpc-book/messages-and-json.md.Pier Angelo Vendrame2025-12-041-2/+2
|/ | | | | Added a missing quote and removed a trailing comma to make a JSON snippet from the RPC documentation valid.
* doc/hsc.md: Add clarification about KeystoreIdsIan Jackson2025-11-241-1/+2
| | | | | Applies @Dizet's suggestion from https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/3485#note_3291709
* doc/hsc.md: Use toml block for config exampleGabriela Moldovan2025-11-241-1/+1
|
* doc/hsc.md: Remove note about invalid keystoresGabriela Moldovan2025-11-241-7/+0
| | | | | | | | | | | I don't think we need to tell users a C Tor keystore cannot have more than one client entry for the same onion service, because they already know that: C Tor doesn't allow it, so if they are migrating an existing C Tor configuration, it will likely be valid. And if not, the error message will inform them what went wrong. So I am removing this section in the interest in keeping this guide short and sweet and straight to the point.
* doc/hsc.md: Warn against running tor/arti during the migrationGabriela Moldovan2025-11-241-0/+6
| | | | This is analogous to the warning from `doc/hss.md`.
* doc/hsc.md: s/ctor-keystore-id/ctor-clientGabriela Moldovan2025-11-241-3/+3
| | | | | Otherwise users might think it's idiomatic/necessary to add the `-id` suffix to their keystore identifiers.
* doc/hsc.md: Rephrase section about --batchGabriela Moldovan2025-11-241-5/+5
| | | | | This makes the language more consistent with the `hss ctor-migrate` docs.
* doc/hsc.md: Add missing text before example invocationGabriela Moldovan2025-11-241-0/+2
|
* doc/hsc.md: Say keystore identifiers must be uniqueGabriela Moldovan2025-11-241-0/+3
|
* doc/hsc.md: Add comments to the config exampleGabriela Moldovan2025-11-241-0/+12
| | | | | This should help clarify what each of those options means. It's also consistent with the analogous example from `doc/hss.md`.
* doc/hsc.md: Remove config from usage exampleGabriela Moldovan2025-11-241-1/+1
| | | | There's no need to pass a config file when using `-o`.
* doc/hsc.md: Rewrite usage section for better readabilityGabriela Moldovan2025-11-241-5/+3
|
* doc/hsc.md: Move warning higher up in the documentGabriela Moldovan2025-11-241-12/+12
|
* doc/hsc.md: Add a more user-friendly introGabriela Moldovan2025-11-241-2/+5
| | | | | | This a bit more user-friendly, because not all users will know what "a registered C Tor keystore is". It's also more consistent with the style from the `hss ctor-migrate` docs (for migrating service keys).