Disambiguate TMDI and GCDI (for ctags)

This commit is contained in:
str4d
2015-06-27 13:40:17 +00:00
parent 1bfe56460c
commit c040cb56b5
5 changed files with 14 additions and 17 deletions

View File

@ -394,7 +394,7 @@ Change from Session Tags to
<li>{% trans tunnelmessage=site_url('docs/spec/tunnel-message') -%}
Several of these ideas may require a new I2NP message type, or
set a flag in the
<a href="{{ tunnelmessage }}#delivery">Delivery Instructions</a>,
<a href="{{ tunnelmessage }}#struct_TunnelMessageDeliveryInstructions">Delivery Instructions</a>,
or set a magic number in the first few bytes of the Session Key field
and accept a small risk of the random Session Key matching the magic number.
{%- endtrans %}</li>

View File

@ -153,8 +153,7 @@ the tunnel encryption is sufficient.
<p>{% trans commonstructures=site_url('docs/spec/common-structures'),
elgamalaes=site_url('docs/how/elgamal-aes'),
i2cp=site_url('docs/protocol/i2cp'),
i2npspec=site_url('docs/spec/i2np'),
tunnelmessage=site_url('docs/spec/tunnel-message') -%}
i2npspec=site_url('docs/spec/i2np') -%}
At the layer above tunnels, I2P delivers end-to-end messages between
<a href="{{ commonstructures }}#struct_Destination">Destinations</a>.
Just as within a single tunnel, we use
@ -163,7 +162,7 @@ Each client message as delivered to the router through the
<a href="{{ i2cp }}">I2CP interface</a> becomes a single
<a href="{{ i2npspec }}#struct_GarlicClove">Garlic Clove</a>
with its own
<a href="{{ tunnelmessage }}#delivery">Delivery Instructions</a>,
<a href="{{ i2npspec }}#struct_GarlicCloveDeliveryInstructions">Delivery Instructions</a>,
inside a
<a href="{{ i2npspec }}#msg_Garlic">Garlic Message</a>.
Delivery Instructions may specify a Destination, Router, or Tunnel.
@ -177,12 +176,11 @@ cloves in the Garlic Message:
<img src="/_static/images/garliccloves.png" alt="{{ _('Garlic Message Cloves') }}" title="{{ _('Garlic Message Cloves') }}" style="text-align:center;"/>
<ol>
<li>{% trans i2npspec=site_url('docs/spec/i2np'),
tunnelmessage=site_url('docs/spec/tunnel-message') -%}
<li>{% trans i2npspec=site_url('docs/spec/i2np') -%}
A
<a href="{{ i2npspec }}#msg_DeliveryStatus">Delivery Status Message</a>,
with
<a href="{{ tunnelmessage }}#delivery">Delivery Instructions</a>
<a href="{{ i2npspec }}#struct_GarlicCloveDeliveryInstructions">Delivery Instructions</a>
specifying that it be sent back to the originating router as an acknowledgment.
This is similar to the "reply block" or "reply onion"
described in the references.
@ -193,14 +191,13 @@ or take other actions.
{%- endtrans %}</li>
<li>{% trans i2npspec=site_url('docs/spec/i2np'),
commonstructures=site_url('docs/spec/common-structures'),
tunnelmessage=site_url('docs/spec/tunnel-message'),
netdb=site_url('docs/how/network-database') -%}
A
<a href="{{ i2npspec }}#msg_DatabaseStore">Database Store Message</a>,
containing a
<a href="{{ commonstructures }}#struct_LeaseSet">LeaseSet</a>
for the originating Destination, with
<a href="{{ tunnelmessage }}#delivery">Delivery Instructions</a>
<a href="{{ i2npspec }}#struct_GarlicCloveDeliveryInstructions">Delivery Instructions</a>
specifying the far-end destination's router.
By periodically bundling a LeaseSet, the router ensures that the far-end will be able
to maintain communications.
@ -256,7 +253,7 @@ so it is not visible to the tunnel's outbound gateway.
The Garlic Message mechanism is very flexible and provides a structure for
implementing many types of mixnet delivery methods.
Together with the unused delay option in the
<a href="{{ tunnelmessage }}#delivery">tunnel message Delivery Instructions</a>,
<a href="{{ tunnelmessage }}#struct_TunnelMessageDeliveryInstructions">tunnel message Delivery Instructions</a>,
a wide spectrum of batching, delay, mixing, and routing strategies are possible.
{%- endtrans %}</p>

View File

@ -1009,9 +1009,9 @@ for standard options that are expected to be present in all router infos.
<h2 id="struct_DeliveryInstructions">Delivery Instructions</h2>
<p>{% trans tunnelmessage=site_url('docs/spec/tunnel-message') -%}
Tunnel Message Delivery Instructions are defined in the <a href="{{ tunnelmessage }}#delivery">Tunnel Message Specification</a>.
Tunnel Message Delivery Instructions are defined in the <a href="{{ tunnelmessage }}#struct_TunnelMessageDeliveryInstructions">Tunnel Message Specification</a>.
{% endtrans %}</p>
<p>{% trans i2npmessage=site_url('docs/spec/i2np') -%}
Garlic Message Delivery Instructions are defined in the <a href="{{ i2npmessage }}#struct_DeliveryInstructions">I2NP Message Specification</a>.
Garlic Message Delivery Instructions are defined in the <a href="{{ i2npmessage }}#struct_GarlicCloveDeliveryInstructions">I2NP Message Specification</a>.
{% endtrans %}</p>
{% endblock %}

View File

@ -450,7 +450,7 @@ Certificate :: Always NULL in the current implementation (3 bytes total, all zer
</ul>
<h3 id="struct_DeliveryInstructions">Garlic Clove Delivery Instructions</h3>
<h3 id="struct_GarlicCloveDeliveryInstructions">Garlic Clove Delivery Instructions</h3>
<p>
This specification is for Delivery Instructions inside Garlic Cloves only.
@ -458,7 +458,7 @@ Note that "Delivery Instructions" are also used inside
Tunnel Messages,
where the format is significantly different.
See the
<a href="{{ site_url('docs/spec/tunnel-message') }}#delivery">Tunnel Message documentation</a>
<a href="{{ site_url('docs/spec/tunnel-message') }}#struct_TunnelMessageDeliveryInstructions">Tunnel Message documentation</a>
for details.
Do NOT use the following specification for Tunnel Message Delivery Instructions!

View File

@ -136,7 +136,7 @@ Zero ::
Delivery Instructions ::
length varies but is typically 7, 39, 43, or 47 bytes
Indicates the fragment and the routing for the fragment
See <a href="#delivery">below</a> for specification
See <a href="#struct_TunnelMessageDeliveryInstructions">below</a> for specification
Message Fragment ::
1 to 996 bytes, actual maximum depends on delivery instruction size
@ -157,7 +157,7 @@ and take the Hash of that.
</li></ul>
<h2 id="delivery">Tunnel Message Delivery Instructions</h2>
<h2 id="struct_TunnelMessageDeliveryInstructions">Tunnel Message Delivery Instructions</h2>
<p>The instructions are encoded with a single control byte, followed by any
necessary additional information. The first bit (MSB) in that control byte determines
@ -171,7 +171,7 @@ Note that "Delivery Instructions" are also used inside
<a href="{{ site_url('docs/spec/i2np') }}#struct_GarlicClove">Garlic Cloves</a>,
where the format is significantly different.
See the
<a href="{{ site_url('docs/spec/i2np') }}#struct_DeliveryInstructions">I2NP documentation</a>
<a href="{{ site_url('docs/spec/i2np') }}#struct_GarlicCloveDeliveryInstructions">I2NP documentation</a>
for details.
Do NOT use the following specification for Garlic Clove Delivery Instructions!