2.2. Requisiti di documentazione per i registri
2.2. Requisiti di documentazione per i registri (Documentation Requirements for Registries)
I documenti che creano un nuovo spazio dei nomi (o modificano la definizione di uno spazio esistente) e che si aspettano che IANA svolga un ruolo nel mantenimento di tale spazio (fungendo da repository per i valori registrati) devono fornire istruzioni chiare sui dettagli dello spazio dei nomi, sia nella sezione IANA Considerations sia riferite da essa.
In particolare, tali istruzioni devono includere:
Il nome del registro (The name of the registry)
Questo nome apparirà sulla pagina web di IANA e sarà riferito nei documenti futuri che devono allocare un valore dal nuovo spazio. Il nome completo (e l'abbreviazione, se appropriata) dovrebbe essere fornito. È altamente auspicabile che il nome scelto non sia facilmente confuso con il nome di un altro registro.
Quando si crea un registro, il gruppo di cui fa parte deve essere identificato utilizzando il suo nome completo, esattamente come appare nell'elenco dei registri di protocollo.
Fornire un URL per identificare con precisione il registro aiuta IANA a comprendere la richiesta. Tali URL possono essere rimossi dal RFC prima della pubblicazione finale o lasciati nel documento per riferimento. Se si includono URL iana.org, IANA fornirà correzioni, se necessario, durante la loro revisione.
Informazioni richieste per le registrazioni (Required information for registrations)
Questo indica ai registranti quali informazioni devono includere nelle loro richieste di registrazione. Alcuni registri richiedono solo il valore richiesto e un riferimento a un documento in cui è definito l'uso del valore. Altri registri richiedono un modello di registrazione più dettagliato che descrive le considerazioni di sicurezza pertinenti, le considerazioni di internazionalizzazione e altre informazioni simili.
Politica di registrazione applicabile (Applicable registration policy)
La politica che si applicherà a tutte le richieste future di registrazione. Vedere la sezione 4.
Dimensione, formato e sintassi delle voci del registro (Size, format, and syntax of registry entries)
Quali campi registrare nel registro, eventuali requisiti tecnici sulle voci del registro (intervalli validi per gli interi, limitazioni di lunghezza sulle stringhe, ecc.) e il formato esatto in cui i valori del registro devono essere visualizzati. Per le assegnazioni numeriche, si dovrebbe specificare se i valori devono essere registrati in decimale, in esadecimale o in qualche altro formato.
Le stringhe dovrebbero essere ASCII e dovrebbe essere chiaramente specificato se la distinzione tra maiuscole e minuscole è importante e se, ad esempio, le stringhe dovrebbero essere mostrate nel registro in maiuscolo o minuscolo.
Le stringhe che rappresentano parametri di protocollo raramente, se mai, avranno bisogno di contenere caratteri non ASCII. Se i caratteri non ASCII sono davvero necessari, le istruzioni dovrebbero rendere molto chiaro che sono consentiti e che i caratteri non ASCII dovrebbero essere rappresentati come caratteri Unicode utilizzando la convenzione "(U+XXXX)". Chiunque crei un tale registro dovrebbe pensarci attentamente e considerare consigli di internazionalizzazione come quelli in [RFC7564], sezione 10.
Assegnazioni e riserve iniziali (Initial assignments and reservations)
Eventuali assegnazioni o registrazioni iniziali da includere. Inoltre, eventuali intervalli che devono essere riservati per "Uso privato", "Riservato", "Non assegnato", ecc. (vedere la sezione 6) dovrebbero essere indicati.
Ad esempio, un documento potrebbe specificare un nuovo registro includendo:
---------------------------------------------------------------
X. Considerazioni IANA
Questo documento definisce una nuova opzione DHCP, intitolata "FooBar" (vedere
sezione y), e assegna un valore di TBD1 dallo spazio delle opzioni DHCP
<https://www.iana.org/assignments/bootp-dhcp-parameters>
[RFC2132] [RFC2939]:
Data
Tag Name Length Meaning
---- ---- ------ -------
TBD1 FooBar N Server FooBar
L'opzione FooBar definisce anche un campo FooType a 8 bit, per il quale
IANA deve creare e mantenere un nuovo registro intitolato
"FooType values" utilizzato dall'opzione FooBar. I valori iniziali per il
registro DHCP FooBar FooType sono riportati di seguito; le assegnazioni future
devono essere effettuate tramite Expert Review [BCP26]. Le assegnazioni consistono
in un nome DHCP FooBar FooType e il suo valore associato.
Value DHCP FooBar FooType Name Definition
---- ------------------------ ----------
0 Reserved
1 Frobnitz RFCXXXX, Sezione y.1
2 NitzFrob RFCXXXX, Sezione y.2
3-254 Unassigned
255 Reserved
---------------------------------------------------------------
Per esempi di documenti che stabiliscono registri, consultare [RFC3575], [RFC3968] e [RFC4520].
Ogni volta che IANA include nomi e informazioni di contatto nel registro pubblico, alcune persone potrebbero preferire che le loro informazioni di contatto non siano rese pubbliche. In tali casi, possono essere presi accordi con IANA per mantenere private le informazioni di contatto.