aboutsummaryrefslogtreecommitdiff
path: root/spec/pt-spec
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-14 19:14:57 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-14 19:14:57 -0400
commit646fef090ac364bd16701a6f00da0670bd7045ed (patch)
tree730f921933ad2652c9349af551b07fcd42f5a5a2 /spec/pt-spec
parent4ebef6db0a7c4acddba4192f836592cfe8f421ee (diff)
downloadtorspec-646fef090ac364bd16701a6f00da0670bd7045ed.tar.gz
torspec-646fef090ac364bd16701a6f00da0670bd7045ed.zip
Enforce the rule that every md has a toplevel (\#) section.
Diffstat (limited to 'spec/pt-spec')
-rw-r--r--spec/pt-spec/configuration-environment.md8
-rw-r--r--spec/pt-spec/ipc.md12
-rw-r--r--spec/pt-spec/naming.md2
-rw-r--r--spec/pt-spec/per-connection-args.md2
-rw-r--r--spec/pt-spec/shutdown.md2
5 files changed, 13 insertions, 13 deletions
diff --git a/spec/pt-spec/configuration-environment.md b/spec/pt-spec/configuration-environment.md
index 767c37b..f2f0eb5 100644
--- a/spec/pt-spec/configuration-environment.md
+++ b/spec/pt-spec/configuration-environment.md
@@ -1,6 +1,6 @@
<a id="pt-spec.txt-3.2"></a>
-## Pluggable Transport Configuration Environment Variables {#envvars}
+# Pluggable Transport Configuration Environment Variables {#envvars}
All Pluggable Transport proxy instances are configured by their
parent process at launch time via a set of well defined
@@ -12,7 +12,7 @@ specification.
<a id="pt-spec.txt-3.2.1"></a>
-### Common Environment Variables {#common}
+## Common Environment Variables {#common}
When launching either a client or server Pluggable Transport proxy,
the following common environment variables MUST be set.
@@ -102,7 +102,7 @@ TOR_PT_OUTBOUND_BIND_ADDRESS_V6=\[2001:db8::4\]
<a id="pt-spec.txt-3.2.2"></a>
-### Pluggable Transport Client Environment Variables {#client}
+## Pluggable Transport Client Environment Variables {#client}
Client-side Pluggable Transport forward proxies are configured
via the following environment variables.
@@ -143,7 +143,7 @@ Examples:
<a id="pt-spec.txt-3.2.3"></a>
-### Pluggable Transport Server Environment Variables {#server}
+## Pluggable Transport Server Environment Variables {#server}
Server-side Pluggable Transport reverse proxies are configured
via the following environment variables.
diff --git a/spec/pt-spec/ipc.md b/spec/pt-spec/ipc.md
index 8c5d001..d419fba 100644
--- a/spec/pt-spec/ipc.md
+++ b/spec/pt-spec/ipc.md
@@ -1,6 +1,6 @@
<a id="pt-spec.txt-3.3"></a>
-## Pluggable Transport To Parent Process Communication
+# Pluggable Transport To Parent Process Communication
All Pluggable Transport Proxies communicate to the parent process
via writing NL-terminated lines to stdout. The line metaformat is:
@@ -21,7 +21,7 @@ unknown keywords.
<a id="pt-spec.txt-3.3.1"></a>
-### Common Messages
+## Common Messages
When a PT proxy first starts up, it must determine which version
of the Pluggable Transports Specification to use to configure
@@ -96,7 +96,7 @@ ENV-ERROR No TOR_PT_AUTH_COOKIE_FILE when TOR_PT_EXTENDED_SERVER_PORT set
<a id="pt-spec.txt-3.3.2"></a>
-### Pluggable Transport Client Messages {#client-messages}
+## Pluggable Transport Client Messages {#client-messages}
After negotiating the Pluggable Transport Specification version,
PT client proxies MUST first validate "TOR_PT_PROXY" (3.2.2) if
@@ -178,7 +178,7 @@ Notes:
<a id="pt-spec.txt-3.3.3"></a>
-### Pluggable Transport Server Messages {#server-messages}
+## Pluggable Transport Server Messages {#server-messages}
PT server reverse proxies iterate over the requested transports
in "TOR_PT_CLIENT_TRANSPORTS" and initialize the listeners.
@@ -245,7 +245,7 @@ initialization is complete.
<a id="pt-spec.txt-3.3.4"></a>
-### Pluggable Transport Log Message {#log-messages}
+## Pluggable Transport Log Message {#log-messages}
This message is for a client or server PT to be able to signal back to the
parent process via stdout or stderr any log messages.
@@ -276,7 +276,7 @@ Example:
<a id="pt-spec.txt-3.3.5"></a>
-### Pluggable Transport Status Message {#status-messages}
+## Pluggable Transport Status Message {#status-messages}
This message is for a client or server PT to be able to signal back to the
parent process via stdout or stderr any status messages.
diff --git a/spec/pt-spec/naming.md b/spec/pt-spec/naming.md
index 394b420..f86c5e3 100644
--- a/spec/pt-spec/naming.md
+++ b/spec/pt-spec/naming.md
@@ -1,6 +1,6 @@
<a id="pt-spec.txt-3.1"></a>
-## Pluggable Transport Naming
+# Pluggable Transport Naming
Pluggable Transport names serve as unique identifiers, and every
PT MUST have a unique name.
diff --git a/spec/pt-spec/per-connection-args.md b/spec/pt-spec/per-connection-args.md
index 90becab..e1a133a 100644
--- a/spec/pt-spec/per-connection-args.md
+++ b/spec/pt-spec/per-connection-args.md
@@ -1,6 +1,6 @@
<a id="pt-spec.txt-3.5"></a>
-## Pluggable Transport Client Per-Connection Arguments
+# Pluggable Transport Client Per-Connection Arguments
Certain PT transport protocols require that the client provides
per-connection arguments when making outgoing connections. On
diff --git a/spec/pt-spec/shutdown.md b/spec/pt-spec/shutdown.md
index cd826d9..aeba498 100644
--- a/spec/pt-spec/shutdown.md
+++ b/spec/pt-spec/shutdown.md
@@ -1,6 +1,6 @@
<a id="pt-spec.txt-3.4"></a>
-## Pluggable Transport Shutdown
+# Pluggable Transport Shutdown
The recommended way for Pluggable Transport using applications and
Pluggable Transports to handle graceful shutdown is as follows.