commit ed4d9bc33987c42cdb861230395d8bdb240deae7
parent f0e5bb765151ddce58b9300dd6236ba1eefe9518
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date: Sat, 9 Sep 2023 08:42:44 +0200
structure
Diffstat:
| A | about.rst | | | 52 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| M | index.rst | | | 20 | +++----------------- |
| D | intro.rst | | | 49 | ------------------------------------------------- |
| A | registries.rst | | | 17 | +++++++++++++++++ |
4 files changed, 72 insertions(+), 66 deletions(-)
diff --git a/about.rst b/about.rst
@@ -0,0 +1,52 @@
+About GANA
+==========
+
+The GNUnet Assigned Numbers Authority (GANA) contains various registries
+we maintain, for GNUnet other projects that need names and numbers for
+use in network protocols. If you need to open a new registry, please
+feel free to contact us at gana@gnunet.org.
+
+The registry sources can be found here: https://git.gnunet.org/gana.git
+
+History
+-------
+
+Barry Leiba `wrote on April 4th 2020 <https://datatracker.ietf.org/doc/conflict-review-dold-payto/ballot/>`_ that “Neither IANA nor participants
+in the IETF will have any necessary expertise to evaluate registration
+requests in the sort of registry described, and no one will be well
+served by the creation of such a registry at IANA. It would be far
+better to have a registration process be described in this document
+involving experts from the industry as reviewers and maintenance of the
+registrations by an industry organization, rather than by IANA.”
+
+So here we are. As IETF/IANA “lack the necessary expertise to operate a
+registry” for names and numbers used in network protocols, the GNUnet
+project is happy to step up.
+
+License
+-------
+
+The GANA database is licensed under the GPL. See ``COPYING`` in the Git
+repository.
+
+Design
+------
+
+Each registry must have a unique name and all associated information
+lives in a directory under that unique name in the Git repository.
+
+Each registry must include at least the following files:
+
+- ``README[.*]``: document describing the purpose of the registry in
+ English
+- ``POLICY[.*]``: registration policy, explaining required fields and
+ the procedure for adding, updating and deleting entries
+- ``registry.rec``: GNU recutils data file with all of the current
+ entries in the registry
+- ``Makefile``: GNU make makefile with a ``make check`` target to run
+ the validation logic. Ideally, the registry.rec should be written
+ such that the ``check`` target is simply invoking
+ ``recfix --check registry.rec``. Additional targets to convert
+ ``data.rec`` to various formats may be defined. In particular, see
+ ``format.sh`` in the root directory of the Git repository (try
+ ``--help``).
diff --git a/index.rst b/index.rst
@@ -3,22 +3,8 @@ The GNUnet Assigned Numbers Authority (GANA)
############################################
-Introduction
-============
-
-.. include:: intro.rst
-
.. toctree::
- :maxdepth: 1
+ :maxdepth: 2
- dot-alt/dot_alt.rst
- gnu-name-system-default-tlds/tlds.rst
- gnu-name-system-record-flags/gnu_name_system_record_flags.rst
- gnu-name-system-record-types/gnu_name_system_record_types.rst
- gnunet-error-codes/gnunet_error_codes.rst
- gnunet-protocols/gnunet_overlay_protocols.rst
- gnunet-signatures/gnunet_signatures.rst
- gnunet-dht-block-types/gnunet_dht_block_types.rst
- gnu-taler-db-events/taler_dbevents.rst
- gnu-taler-error-codes/taler_error_codes.rst
- payto-payment-target-types/payto_payment_target_types.rst
+ about
+ registries
diff --git a/intro.rst b/intro.rst
@@ -1,49 +0,0 @@
-The GNUnet Assigned Numbers Authority (GANA) contains various registries
-we maintain, for GNUnet other projects that need names and numbers for
-use in network protocols. If you need to open a new registry, please
-feel free to contact us at gana@gnunet.org.
-
-The registry sources can be found here: https://git.gnunet.org/gana.git
-
-History
--------
-
-Barry Leiba `wrote on April 4th 2020 <https://datatracker.ietf.org/doc/conflict-review-dold-payto/ballot/>`_ that “Neither IANA nor participants
-in the IETF will have any necessary expertise to evaluate registration
-requests in the sort of registry described, and no one will be well
-served by the creation of such a registry at IANA. It would be far
-better to have a registration process be described in this document
-involving experts from the industry as reviewers and maintenance of the
-registrations by an industry organization, rather than by IANA.”
-
-So here we are. As IETF/IANA “lack the necessary expertise to operate a
-registry” for names and numbers used in network protocols, the GNUnet
-project is happy to step up.
-
-License
--------
-
-The GANA database is licensed under the GPL. See ``COPYING`` in the Git
-repository.
-
-Design
-------
-
-Each registry must have a unique name and all associated information
-lives in a directory under that unique name in the Git repository.
-
-Each registry must include at least the following files:
-
-- ``README[.*]``: document describing the purpose of the registry in
- English
-- ``POLICY[.*]``: registration policy, explaining required fields and
- the procedure for adding, updating and deleting entries
-- ``registry.rec``: GNU recutils data file with all of the current
- entries in the registry
-- ``Makefile``: GNU make makefile with a ``make check`` target to run
- the validation logic. Ideally, the registry.rec should be written
- such that the ``check`` target is simply invoking
- ``recfix --check registry.rec``. Additional targets to convert
- ``data.rec`` to various formats may be defined. In particular, see
- ``format.sh`` in the root directory of the Git repository (try
- ``--help``).
diff --git a/registries.rst b/registries.rst
@@ -0,0 +1,17 @@
+Registries
+==========
+
+.. toctree::
+ :maxdepth: 1
+
+ dot-alt/dot_alt.rst
+ gnu-name-system-default-tlds/tlds.rst
+ gnu-name-system-record-flags/gnu_name_system_record_flags.rst
+ gnu-name-system-record-types/gnu_name_system_record_types.rst
+ gnunet-error-codes/gnunet_error_codes.rst
+ gnunet-protocols/gnunet_overlay_protocols.rst
+ gnunet-signatures/gnunet_signatures.rst
+ gnunet-dht-block-types/gnunet_dht_block_types.rst
+ gnu-taler-db-events/taler_dbevents.rst
+ gnu-taler-error-codes/taler_error_codes.rst
+ payto-payment-target-types/payto_payment_target_types.rst
