メインコンテンツまでスキップ

2.2. レジストリの文書化要件

2.2. レジストリの文書化要件 (Documentation Requirements for Registries)​

新しい名前空間を作成する（または既存の空間の定義を変更する）文書であり、IANA がその空間の維持に役割を果たすこと（登録された値のリポジトリとして機能すること）を期待する文書は、IANA Considerations セクション内またはそこから参照される場所で、名前空間の詳細に関する明確な指示を提供する必要があります。

特に、そのような指示には以下を含める必要があります：

レジストリの名前 (The name of the registry)​

この名前は IANA のウェブページに表示され、新しい空間から値を割り当てる必要がある将来の文書で参照されます。完全な名前（および適切な場合は略語）を提供する必要があります。選択した名前が別のレジストリの名前と簡単に混同されないことが非常に望ましいです。

レジストリを作成する際は、それが属するグループを、プロトコルレジストリリストに表示されているとおりの完全な名前を使用して識別する必要があります。

レジストリを正確に識別するための URL を提供することは、IANA がリクエストを理解するのに役立ちます。このような URL は、最終公開前に RFC から削除することも、参照用に文書に残すこともできます。iana.org URL を含める場合、IANA はレビュー中に必要に応じて修正を提供します。

登録に必要な情報 (Required information for registrations)​

これは、登録申請者が登録リクエストに含める必要がある情報を登録者に伝えます。一部のレジストリでは、要求された値と値の使用が定義されている文書への参照のみが必要です。他のレジストリでは、関連するセキュリティの考慮事項、国際化の考慮事項、およびその他のそのような情報を記述するより詳細な登録テンプレートが必要です。

適用される登録ポリシー (Applicable registration policy)​

将来のすべての登録リクエストに適用されるポリシー。セクション 4 を参照してください。

レジストリエントリのサイズ、形式、構文 (Size, format, and syntax of registry entries)​

レジストリに記録するフィールド、レジストリエントリに関する技術的要件（整数の有効範囲、文字列の長さ制限など）、およびレジストリ値を表示する正確な形式。数値割り当ての場合、値を 10 進数、16 進数、またはその他の形式で記録するかどうかを指定する必要があります。

文字列は ASCII であることが期待され、大文字と小文字が重要かどうか、たとえば、文字列をレジストリで大文字または小文字で表示するかどうかを明確に指定する必要があります。

プロトコルパラメータを表す文字列が非 ASCII 文字を含む必要があることはめったにありません。非 ASCII 文字が本当に必要な場合、指示は、それらが許可されていること、および非 ASCII 文字が「(U+XXXX)」規約を使用して Unicode 文字として表現されるべきであることを非常に明確にする必要があります。そのようなレジストリを作成する人は、これについて慎重に検討し、[RFC7564] のセクション 10 などの国際化アドバイスを検討する必要があります。

初期割り当てと予約 (Initial assignments and reservations)​

含めるべき初期割り当てまたは登録。さらに、「プライベート使用」、「予約済み」、「未割り当て」などのために予約される範囲（セクション 6 を参照）を示す必要があります。

たとえば、文書は以下を含めることで新しいレジストリを指定できます：

---------------------------------------------------------------

X. IANA の考慮事項

この文書は、「FooBar」という新しい DHCP オプションを定義し（セクション y を参照）、
DHCP オプション空間から TBD1 の値を割り当てます
<https://www.iana.org/assignments/bootp-dhcp-parameters>
[RFC2132] [RFC2939]：
                                Data
       Tag     Name            Length      Meaning
       ----    ----            ------      -------
       TBD1    FooBar          N           FooBar サーバー

FooBar オプションは、8 ビットの FooType フィールドも定義しており、
IANA は、FooBar オプションで使用される「FooType values」という新しい
レジストリを作成および維持する必要があります。DHCP FooBar FooType レジストリの
初期値を以下に示します。将来の割り当ては Expert Review [BCP26] を通じて
行われます。割り当ては、DHCP FooBar FooType 名とそれに関連付けられた値で構成されます。

       Value    DHCP FooBar FooType Name   Definition
       ----     ------------------------   ----------
       0        Reserved
       1        Frobnitz                   RFCXXXX, セクション y.1
       2        NitzFrob                   RFCXXXX, セクション y.2
       3-254    Unassigned
       255      Reserved
---------------------------------------------------------------

レジストリを確立する文書の例については、[RFC3575]、[RFC3968]、および [RFC4520] を参照してください。

IANA が公開レジストリに名前と連絡先情報を含める場合、一部の個人は連絡先情報を公開しないことを好む場合があります。そのような場合、連絡先情報を非公開に保つために IANA と取り決めを行うことができます。

に最終更新