summaryrefslogtreecommitdiff
path: root/doc/dev
Commit message (Collapse)AuthorAgeFilesLines
...
* Merge branch 'rpc_verb_methods' into 'main'David Goulet2024-10-161-0/+14
|\ | | | | | | | | | | | | rpc spec: Start to document method naming convention Closes #1678 See merge request tpo/core/arti!2539
| * rpc spec: Start to document method naming conventionNick Mathewson2024-10-091-0/+14
| | | | | | | | | | All but one of our current methods follows this convention, and we're about to rename it.
* | rpc spec: use valid JS syntax.Nick Mathewson2024-10-091-1/+1
| |
* | rpc-draft: clarify how we should handle error changes.Nick Mathewson2024-10-091-0/+11
| | | | | | | | | | | | | | This is based on a suggestion from @diziet, but edited to say that: - we will take this approach when possible, and that we're not making a categorical promise. - this approach only applies to stable fields.
* | rpc spec: Revise design for `error.data` fieldNick Mathewson2024-10-091-24/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | IIUC: Previously, `error.data` was meant to be the serialized error object from Arti. As such, it was specified to be deliberately unstable, and likely to change. This didn't seem like such great idea, especially as we started to come up with structured and stable data that we _did_ want to put in `error.data`. With this commit I'm taking a new approach to `error.data`. Specifically: * `error.data`, if present, is always an object. * Unlike before, it can have multiple keys. * The keys of `error.data` are always namespaced. * There is a requirement that documentation exist for every key in an`error.data` document, including the type, semantics, and stability of its values. There is also new "anticipated use of error.data" section to clarify our plans: * We plan to use error.data deliberately when it actually serves a purpose. * We don't plan to have an on-by-default serialization or Debug of every Arti error. (If we wanted an optional one, there is a short sketch of what it might look like.)
* | RPC spec: move the data field back into ErrorNick Mathewson2024-10-091-30/+25
|/ | | | | | This is *not* how we actually want the `data` field to behave! But moving it as a separate commit will make it easier to see what changes we do make.
* rpc spec: correct the name of a field.Nick Mathewson2024-10-071-2/+1
|
* Merge branch 'rpc-forward-compat' into 'main'Nick Mathewson2024-10-031-3/+112
|\ | | | | | | | | rpc-meta-draft: describe compatibility rules and mechanisms See merge request tpo/core/arti!2475
| * rpc-meta-draft: add TODO note about unsupported_featuresNick Mathewson2024-10-031-1/+5
| |
| * rpc-meta-draft: Use SHOULD NOT instead of USUALLY NOT RECOMMENDEDNick Mathewson2024-10-031-2/+1
| | | | | | | | AIUI they mean the same thing
| * rpc-meta-draft: describe rules for remembering feature supportNick Mathewson2024-10-031-0/+20
| | | | | | | | From a suggestion from @diziet
| * rpc-meta-draft: describe feature namespacing.Nick Mathewson2024-10-031-2/+12
| |
| * rpc-meta-draft: describe compatibility rules and mechanismsNick Mathewson2024-09-301-3/+79
| | | | | | | | | | | | This tries to memorialize the mechanism that @diziet and I came up with and memorialized on #1634. Once this is merged I can implement it.
* | doc/dev: Rename client authorization to restricted discovery.Gabriela Moldovan2024-10-033-4/+4
| | | | | | | | | | | | This renames "client auth" to "restricted discovery" where appropriate. Closes #1476
* | doc: Note that client authorization was renamed.Gabriela Moldovan2024-10-035-0/+14
|/ | | | | This adds a note mentioning the new "restricted discovery" terminology to the various docs that talk about client authorization.
* rpc-meta-draft.md: correct some minor typosJim Newsome2024-09-251-7/+7
|
* Merge branch 'mq-tidy' into 'main'David Goulet2024-09-171-172/+8
|\ | | | | | | | | memquota: be more firm about avoiding panics, and tidy up docs See merge request tpo/core/arti!2404
| * memory-limit.md: Make the rubric accurateIan Jackson2024-09-101-8/+4
| | | | | | | | And remove the rest of the now-obsolete text.
| * tor-memquota: Use clippy::arithmetic_side_effects, against panicsIan Jackson2024-09-101-6/+0
| | | | | | | | | | | | This detect possibly-panicking operations. Empirically this lint seems rather better now.
| * memory-limit: Fix heading depth for cache discussionsIan Jackson2024-09-101-4/+4
| |
| * memory-limit.md: Remove obsolete overview docsIan Jackson2024-09-101-31/+0
| | | | | | | | All of this is now documented in the lib.rs.
| * tor-memquota: Move some information into the proper docsIan Jackson2024-09-101-2/+0
| | | | | | | | | | This sentence is very important piece of overall explanation, but didn't make it into the crate level docs.
| * memory-limit.md: Remove obsolete docs of implemented channel facilityIan Jackson2024-09-101-121/+0
| | | | | | | | All of this is now implemented. Delete the obsolete sketch.
* | Merge branch 's101-2024-q2' into 'main'Alexander Hansen Færøy2024-09-171-0/+26
|\ \ | | | | | | | | | | | | Update s101 numbers for Q2 2024 See merge request tpo/core/arti!2245
| * | Update s101 numbers for Q2 2024Alexander Færøy2024-07-081-0/+26
| | |
* | | rpc-draft: move cancel method to connection object.Nick Mathewson2024-09-111-1/+1
| | |
* | | rpc: Add a "client implementation strategies" section.Nick Mathewson2024-09-111-1/+24
| | |
* | | rpc: Document pipelining and concurrency.Nick Mathewson2024-09-111-2/+15
| | |
* | | rpc: Add a "Cancelled" code to our docs.Nick Mathewson2024-09-111-0/+1
| | |
* | | rpc: Replace strong/weak objectIds with reference/handle againNick Mathewson2024-09-111-5/+18
| | | | | | | | | | | | | | | Diziet prefers this terminology; we'll defer a reckoning here till #849 is resolved.
* | | rpc-draft: Adopt a stricter-but-looser rule for anti-framing defenseNick Mathewson2024-09-111-13/+46
| | | | | | | | | | | | | | | | | | | | | Instead of saying "no errors before authentication", we now say "no syntax errors ever." This should be easier to implement.
* | | rpc-draft: A few more tweaks based on review.Nick Mathewson2024-09-111-10/+12
| | |
* | | Several rpc-draft suggestions from diziet.Nick Mathewson2024-09-111-11/+22
| | |
* | | rpc-meta: Note that the appendix is obsolete.Nick Mathewson2024-09-111-0/+3
| | |
* | | rpc-meta: Note that most listed requests are hypotheticalNick Mathewson2024-09-111-0/+4
| | |
* | | rpc-meta: remove example apis sectionNick Mathewson2024-09-111-58/+0
| | | | | | | | | | | | (This is obsoleted by arti-rpc-client-core.)
* | | rpc-meta: update cancellation to latest thinkingNick Mathewson2024-09-111-16/+6
| | |
* | | rpc-meta: Tweaks to "authentication" section.Nick Mathewson2024-09-111-5/+10
| | |
* | | rpc-meta: clarify current method name rules.Nick Mathewson2024-09-111-8/+9
| | | | | | | | | | | | | | | | | | | | | | | | Notably, identifiers SHOULD be C identifiers, and everything has a namespace. Reserve "rpc" as a namespace for things that were previously unnamespaced.
* | | rpc-meta: Light edits to parameter description.Nick Mathewson2024-09-111-3/+3
| | |
* | | rpc-meta: Rewrite and move documentation on object semantics.Nick Mathewson2024-09-111-32/+117
| | | | | | | | | | | | | | | This is probably still far too informal, but it is better than our previous documentation.
* | | rpc-meta: clarify status of Sessions.Nick Mathewson2024-09-111-0/+7
| | | | | | | | | | | | | | | (Note what isn't implemented, and one more kind of authentication we'll likely build someday.)
* | | rpc-meta: rewrite front matterNick Mathewson2024-09-111-29/+38
| | |
* | | rpc-meta: Add a top-level heading, and shift other headingsNick Mathewson2024-09-111-35/+37
| |/ |/| | | | | (Markdown convention deprecates having more than one top-level heading.)
* | Fix typosDimitris Apostolou2024-09-031-2/+2
| |
* | Sponsor 101 -> Project 101.Alexander Færøy2024-09-021-2/+2
| | | | | | | | See: tpo/team#313.
* | Merge branch 'torclient-doc' into 'main'gabi-2502024-08-151-0/+111
|\ \ | | | | | | | | | | | | doc/dev/notes: keymgr-porcelain: Add note about moving keymgr functions out of TorClient. See merge request tpo/core/arti!2314
| * | doc/dev/notes: keymgr-porcelain: Add note about alternative API.Gabriela Moldovan2024-08-141-0/+12
| | |
| * | doc/dev/notes: keymgr-porcelain: Add note about moving keymgr functions out ↵Gabriela Moldovan2024-08-061-0/+99
| | | | | | | | | | | | | | | | | | of TorClient. This would a possible long-term fix for #1496.
* | | dov/dev/notes: Add note about live reloads in restricted discovery mode.Gabriela Moldovan2024-08-121-0/+243
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This describes a couple of options for extending the config reloading logic to support watching for changes in the `restricted_disovery.key_dirs` directories. Note: the options we have here are, in a sense, two extremes * one is about refactoring some of the existing code into a reusable component, and leaving most of the configuration logic unchanged * the other involves rethinking the entire config watching/reloading mechanism to support watching for changes in arbitrary directories I am leaning towards the simpler option, because I'm not sure the other one is worth the added complexity (we currently only have a single use case for it).
generated by cgit v1.2.3 (git 2.46.0) at 2026-08-27 08:34:25 +0000