3.1. Dokumentationsanforderungen für Registrierungen
3.1. Dokumentationsanforderungen für Registrierungen (Documentation Requirements for Registrations)
Oft fordern Dokumente eine Zuweisung in einer bestehenden Registry an (eine, die durch ein zuvor veröffentlichtes Dokument erstellt wurde).
Solche Dokumente sollten die Registry, in die jeder Wert registriert werden soll, klar identifizieren. Verwenden Sie den genauen Registry-Namen, wie er auf der IANA-Webseite aufgeführt ist, und zitieren Sie das RFC, in dem die Registry definiert ist. Wenn auf eine bestehende Registry Bezug genommen wird, ist die Bereitstellung einer URL zur genauen Identifizierung der Registry hilfreich (siehe Abschnitt 2.2).
Es besteht keine Notwendigkeit zu erwähnen, was die Zuweisungsrichtlinie ist, wenn neue Zuweisungen in bestehenden Registries vorgenommen werden, da dies aus den Referenzen klar sein sollte. Wenn jedoch mehrere Zuweisungsrichtlinien anwendbar sein könnten, wie bei Registries mit unterschiedlichen Bereichen, die unterschiedliche Richtlinien haben, ist es wichtig klarzustellen, welcher Bereich angefordert wird, damit IANA weiß, welche Richtlinie anwendbar ist und einen Wert im richtigen Bereich zuweisen kann.
Stellen Sie sicher, dass Sie alle für eine Registrierung erforderlichen Informationen bereitstellen und alle speziellen Prozesse befolgen, die für die Registry festgelegt sind. Registries erfordern manchmal das Ausfüllen einer Registrierungsvorlage für die Registrierung oder bitten Registranten, ihre Anfrage vor der Registrierung zur Diskussion auf einer bestimmten Mailingliste zu veröffentlichen. Schlagen Sie das Referenzdokument der Registry nach: Die erforderlichen Informationen und speziellen Prozesse sollten dort dokumentiert sein.
Normalerweise werden zu verwendende numerische Werte von IANA ausgewählt, wenn das Dokument genehmigt wird; Entwürfe sollten keine endgültigen Werte angeben. Stattdessen sollten Platzhalter wie "TBD1" und "TBD2" im gesamten Dokument konsistent verwendet werden, wobei jedem zu registrierenden Element ein anderer Platzhalter zugewiesen wird. Die IANA Considerations sollten den RFC-Editor bitten, die Platzhaltennamen durch die von IANA zugewiesenen Werte zu ersetzen. Wenn Entwürfe numerische Werte für Tests oder frühe Implementierungen angeben müssen, werden sie entweder eine frühe Zuweisung beantragen (siehe Abschnitt 3.4) oder Werte verwenden, die bereits für Tests oder Experimente reserviert wurden (wenn die betreffende Registry dies ohne explizite Zuweisung zulässt). Es ist wichtig, dass Entwürfe nicht ihre eigenen Werte wählen, damit IANA nicht in der Zwischenzeit einen dieser Werte einem anderen Dokument zuweist. Ein Entwurf kann im Abschnitt IANA Considerations einen bestimmten Wert anfordern, und IANA wird solche Anfragen nach Möglichkeit berücksichtigen, aber die vorgeschlagene Nummer könnte bis zur Genehmigung des Entwurfs bereits einer anderen Verwendung zugewiesen worden sein.
Normalerweise werden zu verwendende Textzeichenkettenwerte im Dokument angegeben, da Kollisionen bei Textzeichenketten weniger wahrscheinlich sind. IANA wird sich mit den Autoren beraten, wenn tatsächlich eine Kollision vorliegt und ein anderer Wert verwendet werden muss. Wenn Entwürfe Zeichenkettenwerte für Tests oder frühe Implementierungen angeben müssen, verwenden sie manchmal den erwarteten endgültigen Wert. Es ist jedoch oft nützlich, stattdessen einen Entwurfswert zu verwenden, möglicherweise einschließlich der Entwurfsversionsnummer. Dies ermöglicht es, die frühen Implementierungen von denen zu unterscheiden, die die endgültige Version implementieren. Ein Dokument, das beabsichtigt, "foobar" in der endgültigen Version zu verwenden, könnte beispielsweise "foobar-testing-draft-05" für die -05-Version des Entwurfs verwenden.
Für einige Registries gibt es eine langjährige Richtlinie, die die Zuweisung von Namen oder Codes auf der Grundlage von Eitelkeit oder Organisationsnamen verbietet. Zum Beispiel könnten Codes immer sequenziell zugewiesen werden, es sei denn, es gibt einen triftigen Grund für eine Ausnahme. Nichts in diesem Dokument soll diese Richtlinien ändern oder ihre zukünftige Anwendung verhindern.
Als Beispiel könnte der folgende Text verwendet werden, um die Zuweisung einer DHCPv6-Optionsnummer anzufordern:
IANA wird gebeten, der DNS Recursive Name Server-Option einen
Optionscodewert von TBD1 und der Domain Search List-Option einen
Optionscodewert von TBD2 aus dem DHCP-Optionscoderaum zuzuweisen,
der in Abschnitt 24.3 von RFC 3315 definiert ist.
Der Abschnitt IANA Considerations sollte alle IANA-Aktionen zusammenfassen, mit Verweisen auf die relevanten Abschnitte an anderer Stelle im Dokument, falls angemessen. Die Angabe von Abschnittnummern ist besonders nützlich, wenn das Referenzdokument groß ist; die Abschnittnummern erleichtern es denjenigen, die das Referenzdokument durchsuchen, die relevanten Informationen zu finden.
Wenn mehrere Werte angefordert werden, ist es im Allgemeinen hilfreich, eine Zusammenfassungstabelle der Ergänzungen/Änderungen einzuschließen. Es ist auch hilfreich, wenn diese Tabelle im gleichen Format vorliegt, wie sie auf der IANA-Website erscheint oder erscheinen wird. Zum Beispiel:
Value Description Reference
-------- ------------------- ---------
TBD1 Foobar this RFC, Section 3.2
TBD2 Gumbo this RFC, Section 3.3
TBD3 Banana this RFC, Section 3.4
Hinweis: In Fällen, in denen Autoren das Gefühl haben, dass das Einschließen der vollständigen Änderungstabelle zu ausführlich oder repetitiv ist, sollten Autoren die Tabelle dennoch im Entwurf einschließen, können aber einen Hinweis hinzufügen, dass die Tabelle vor der Veröffentlichung des endgültigen RFC entfernt werden soll.