From 7a370ea5302b7c36eb8586fbda603419fb74ec2e Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Fri, 13 Oct 2023 18:07:26 -0400 Subject: Add backticks to more things that look like html. --- spec/dir-spec/exchanging-votes.md | 2 +- spec/dir-spec/extra-info-document-format.md | 6 +++--- spec/dir-spec/limited-ed-diff-format.md | 2 +- spec/dir-spec/outline.md | 2 +- spec/dir-spec/serving-bandwidth-list-files.md | 4 ++-- .../guard-spec/still-non-addressed-issues-sectiontodo.md | 2 +- ...luggable-transport-client-per-connection-arguments.md | 2 +- .../pluggable-transport-configuration-environment.md | 2 +- ...luggable-transport-to-parent-process-communication.md | 16 ++++++++-------- 9 files changed, 19 insertions(+), 19 deletions(-) diff --git a/spec/dir-spec/exchanging-votes.md b/spec/dir-spec/exchanging-votes.md index aac1d4b..066f825 100644 --- a/spec/dir-spec/exchanging-votes.md +++ b/spec/dir-spec/exchanging-votes.md @@ -38,7 +38,7 @@ at `http:///tor/status-vote/next/.z` -where is the fingerprint of the other authority's identity key. +where `` is the fingerprint of the other authority's identity key. And at `http:///tor/status-vote/next/d/.z` diff --git a/spec/dir-spec/extra-info-document-format.md b/spec/dir-spec/extra-info-document-format.md index a821ecc..7307885 100644 --- a/spec/dir-spec/extra-info-document-format.md +++ b/spec/dir-spec/extra-info-document-format.md @@ -128,13 +128,13 @@ per protocol family. List of mappings from pluggable transport names to the number of unique IP addresses that have connected using that pluggable transport. Unobfuscated connections are counted -using the reserved pluggable transport name "" (without +using the reserved pluggable transport name "``" (without quotes). If we received a connection from a transport proxy but we couldn't figure out the name of the pluggable transport, we use the reserved pluggable transport name -"". +"``". -("" and "" are reserved because normal pluggable +("``" and "``" are reserved because normal pluggable transport names MUST match the following regular expression: "[a-zA-Z_][a-zA-Z0-9_]*" ) diff --git a/spec/dir-spec/limited-ed-diff-format.md b/spec/dir-spec/limited-ed-diff-format.md index 53fa334..f6a2d61 100644 --- a/spec/dir-spec/limited-ed-diff-format.md +++ b/spec/dir-spec/limited-ed-diff-format.md @@ -27,7 +27,7 @@ lines are only ever referred to by their position in the original file. If there are any directory signatures on the original document, the -first command MUST be a ",$d" form to remove all of the directory +first command MUST be a "`,$d`" form to remove all of the directory signatures. Using this format ensures that the client will successfully apply the diff even if they have an unusual encoding for the signatures. diff --git a/spec/dir-spec/outline.md b/spec/dir-spec/outline.md index 55deb49..faa848a 100644 --- a/spec/dir-spec/outline.md +++ b/spec/dir-spec/outline.md @@ -170,7 +170,7 @@ The Initial Item must be the first item in the document. The Signature Item has the following format: - [arguments] NL SIGNATURE NL +` [arguments] NL SIGNATURE NL` The "SIGNATURE" Object contains a signature (using the signing key) of the PKCS#1 1.5 padded digest of the entire document, taken from the diff --git a/spec/dir-spec/serving-bandwidth-list-files.md b/spec/dir-spec/serving-bandwidth-list-files.md index 1263e43..253f2d6 100644 --- a/spec/dir-spec/serving-bandwidth-list-files.md +++ b/spec/dir-spec/serving-bandwidth-list-files.md @@ -347,9 +347,9 @@ This sorting algorithm is used for consensus-method 22 and later. Deciding which descriptors to include. -A tuple belongs to an identity if it is a new tuple that +A tuple belongs to an `` identity if it is a new tuple that matches both ID parts, or if it is an old tuple (one with no Ed opinion) -that matches the RSA part. A tuple belongs to an identity if its +that matches the RSA part. A tuple belongs to an `` identity if its RSA identity matches. A tuple matches another tuple if all the fields that are present in both diff --git a/spec/guard-spec/still-non-addressed-issues-sectiontodo.md b/spec/guard-spec/still-non-addressed-issues-sectiontodo.md index 4edb761..89e60ba 100644 --- a/spec/guard-spec/still-non-addressed-issues-sectiontodo.md +++ b/spec/guard-spec/still-non-addressed-issues-sectiontodo.md @@ -9,7 +9,7 @@ Simulate actual behavior. For all lifetimes: instead of storing the "this began at" time, store the "remove this at" time, slightly randomized. -Clarify that when you get a circuit, you might need to +Clarify that when you get a `` circuit, you might need to relaunch circuits through that same guard immediately, if they are circuits that have to be independent. diff --git a/spec/pt-spec/pluggable-transport-client-per-connection-arguments.md b/spec/pt-spec/pluggable-transport-client-per-connection-arguments.md index 869fb59..90becab 100644 --- a/spec/pt-spec/pluggable-transport-client-per-connection-arguments.md +++ b/spec/pt-spec/pluggable-transport-client-per-connection-arguments.md @@ -10,7 +10,7 @@ as part of the "SMETHOD" message. On the client side, arguments are passed via the authentication fields that are part of the SOCKS protocol. -First the "=" formatted arguments MUST be escaped, +First the "`=`" formatted arguments MUST be escaped, such that all backslash, equal sign, and semicolon characters are escaped with a backslash. diff --git a/spec/pt-spec/pluggable-transport-configuration-environment.md b/spec/pt-spec/pluggable-transport-configuration-environment.md index 0fd9571..19bd351 100644 --- a/spec/pt-spec/pluggable-transport-configuration-environment.md +++ b/spec/pt-spec/pluggable-transport-configuration-environment.md @@ -200,7 +200,7 @@ forwarding is done externally. The `
:` combination MUST be an IP address supported by `bind()`, and MUST NOT be a host name. -Applications MUST NOT set more than one
: pair +Applications MUST NOT set more than one `
:` pair per PT name. If there is no specific `
:` combination to be diff --git a/spec/pt-spec/pluggable-transport-to-parent-process-communication.md b/spec/pt-spec/pluggable-transport-to-parent-process-communication.md index 985bcb5..21fd18b 100644 --- a/spec/pt-spec/pluggable-transport-to-parent-process-communication.md +++ b/spec/pt-spec/pluggable-transport-to-parent-process-communication.md @@ -83,7 +83,7 @@ respond with an error message and terminate. The "ENV-ERROR" message is used to signal the PT proxy's failure to parse the configuration environment variables (3.2). -The SHOULD consist of a useful error message +The `` SHOULD consist of a useful error message that can be used to diagnose and correct the root cause of the failure. @@ -111,7 +111,7 @@ PROXY DONE The "PROXY DONE" message is used to signal the PT proxy's acceptance of the upstream proxy specified by "TOR_PT_PROXY". -PROXY-ERROR +`PROXY-ERROR ` The "PROXY-ERROR" message is used to signal that the upstream proxy is malformed/unsupported or otherwise unusable. @@ -130,7 +130,7 @@ and initialize the listeners. For each transport initialized, the PT proxy reports the listener status back to the parent via messages to stdout. -CMETHOD <'socks4','socks5'> +`CMETHOD <'socks4','socks5'> ` The "CMETHOD" message is used to signal that a requested PT transport has been launched, the protocol which the parent @@ -139,9 +139,9 @@ and port that the PT transport's forward proxy is listening on. Example: -CMETHOD trebuchet socks5 127.0.0.1:19999 +`CMETHOD trebuchet socks5 127.0.0.1:19999` -CMETHOD-ERROR +`CMETHOD-ERROR ` The "CMETHOD-ERROR" message is used to signal that requested PT transport was unable to be launched. @@ -186,7 +186,7 @@ in "TOR_PT_CLIENT_TRANSPORTS" and initialize the listeners. For each transport initialized, the PT proxy reports the listener status back to the parent via messages to stdout. -SMETHOD [options] +`SMETHOD [options]` The "SMETHOD" message is used to signal that a requested PT transport has been launched, the protocol which will be @@ -202,7 +202,7 @@ per-transport information back to the parent process. The currently recognized 'options' are: -ARGS:[=,]+[=] +`ARGS:[=,]+[=]` ```text The "ARGS" option is used to pass additional key/value @@ -264,7 +264,7 @@ The format of the message: `LOG SEVERITY=Severity MESSAGE=Message` The SEVERITY value indicate at which logging level the message applies. -The accepted values for are: error, warning, notice, info, debug +The accepted values for `` are: error, warning, notice, info, debug The MESSAGE value is a human readable string formatted by the PT. The `` contains the log message which can be a String or CString (see -- cgit v1.2.3-54-g00ecf