commit c9bda21875ea1775f88b71de735d527132e45922 parent ed4d9bc33987c42cdb861230395d8bdb240deae7 Author: Martin Schanzenbach <schanzen@gnunet.org> Date: Sat, 9 Sep 2023 12:51:09 +0200 add proper header generation with policy and info for html Diffstat:
32 files changed, 111 insertions(+), 16 deletions(-)
diff --git a/dot-alt/Makefile b/dot-alt/Makefile @@ -13,7 +13,12 @@ clean: dot_alt.rst.tmp: registry.rec rst.template ../format.sh rst.template < registry.rec > $@ -dot_alt.rst: rst.header dot_alt.rst.tmp - cat rst.header dot_alt.rst.tmp > $@ +rst.header.tmp: + cat rst.header.template README POLICY > $@ + echo "Entries" >> $@ + echo "^^^^^^^" >> $@ + +dot_alt.rst: rst.header.tmp dot_alt.rst.tmp + cat rst.header.tmp dot_alt.rst.tmp > $@ .PHONY: check diff --git a/dot-alt/POLICY b/dot-alt/POLICY @@ -1,3 +1,6 @@ +Policy +^^^^^^ + [REFERENCE .ALT RFC once published here!] The "Label" must be unique in the entire registry. The value must be a @@ -9,3 +12,4 @@ committer review. The current contact(s) for review are reachable at alt-registry@gnunet.org. + diff --git a/dot-alt/README b/dot-alt/README @@ -2,3 +2,4 @@ This registry is for the .ALT Top-Level-Domains (TLDs) of the Domain Name System This registry is used to ensure that names of alternative name systems do not conflict with DNS names or with each other. + diff --git a/dot-alt/rst.header b/dot-alt/rst.header.template diff --git a/gnu-name-system-default-tlds/Makefile b/gnu-name-system-default-tlds/Makefile @@ -19,8 +19,13 @@ tlds.conf: tlds.header tlds.conf.tmp tlds.rst.tmp: registry.rec rst.template ../format.sh rst.template < registry.rec > $@ -tlds.rst: rst.header tlds.rst.tmp - cat rst.header tlds.rst.tmp > $@ +rst.header.tmp: + cat rst.header.template README POLICY > $@ + echo "Entries" >> $@ + echo "^^^^^^^" >> $@ + +tlds.rst: rst.header.tmp tlds.rst.tmp + cat rst.header.tmp tlds.rst.tmp > $@ .PHONY: check clean distclean diff --git a/gnu-name-system-default-tlds/POLICY b/gnu-name-system-default-tlds/POLICY @@ -1,3 +1,6 @@ +Policy +^^^^^^ + Each registry entry should contain three values: the "Key" of the authoritative zone of a TLD, the "Name" of the TLDS, an optional "Contact", and a "Reference" with links to further information about the @@ -11,3 +14,4 @@ GNUnet who will define appropriate bribes on a case-by-case basis. The current contact(s) for expert review are reachable at gns-registry@gnunet.org. + diff --git a/gnu-name-system-default-tlds/README b/gnu-name-system-default-tlds/README @@ -2,3 +2,4 @@ This registry is the default Top-Level-Domains (TLDs) for the GNU Name System. This registry is used to ensure that GNS resolvers ship with a default configuration of TLDs in order to ease transition and enable instant use. + diff --git a/gnu-name-system-default-tlds/rst.header b/gnu-name-system-default-tlds/rst.header.template diff --git a/gnu-name-system-record-flags/Makefile b/gnu-name-system-record-flags/Makefile @@ -18,8 +18,13 @@ gnu_name_system_record_flags.h: h.header gnu_name_system_record_flags.h.tmp h.fo gnu_name_system_record_flags.rst.tmp: registry.rec rst.template ../format.sh rst.template < registry.rec > $@ -gnu_name_system_record_flags.rst: rst.header gnu_name_system_record_flags.rst.tmp rst.footer - cat rst.header gnu_name_system_record_flags.rst.tmp rst.footer > $@ +rst.header.tmp: + cat rst.header.template README POLICY > $@ + echo "Entries" >> $@ + echo "^^^^^^^" >> $@ + +gnu_name_system_record_flags.rst: rst.header.tmp gnu_name_system_record_flags.rst.tmp rst.footer + cat rst.header.tmp gnu_name_system_record_flags.rst.tmp rst.footer > $@ .PHONY: check clean distclean diff --git a/gnu-name-system-record-flags/POLICY b/gnu-name-system-record-flags/POLICY @@ -1,3 +1,6 @@ +Policy +^^^^^^ + Each registry entry should contain three values: the "Number" of the record flags, which must be between 0 and 15, the "Name" of the record flag, and a "Reference" with links @@ -14,3 +17,4 @@ appropriate for the record flag. The current contact(s) for expert review are reachable at gns-registry@gnunet.org. + diff --git a/gnu-name-system-record-flags/README b/gnu-name-system-record-flags/README @@ -7,3 +7,4 @@ This registry is used to ensure that the names and numeric values used to identify record flags are uniquely defined and to allow GNS resolvers implementors to find out details about the respective semantics and human-readable syntax. + diff --git a/gnu-name-system-record-flags/rst.header b/gnu-name-system-record-flags/rst.header.template diff --git a/gnu-name-system-record-types/Makefile b/gnu-name-system-record-types/Makefile @@ -18,8 +18,13 @@ gnu_name_system_record_types.h: h.header gnu_name_system_record_types.h.tmp h.fo gnu_name_system_record_types.rst.tmp: registry.rec rst.template ../format.sh rst.template < registry.rec > $@ -gnu_name_system_record_types.rst: rst.header gnu_name_system_record_types.rst.tmp rst.footer - cat rst.header gnu_name_system_record_types.rst.tmp rst.footer > $@ +rst.header.tmp: + cat rst.header.template README POLICY > $@ + echo "Entries" >> $@ + echo "^^^^^^^" >> $@ + +gnu_name_system_record_types.rst: rst.header.tmp gnu_name_system_record_types.rst.tmp rst.footer + cat rst.header.tmp gnu_name_system_record_types.rst.tmp rst.footer > $@ .PHONY: check clean distclean diff --git a/gnu-name-system-record-types/POLICY b/gnu-name-system-record-types/POLICY @@ -1,3 +1,6 @@ +Policy +^^^^^^ + Each registry entry should contain three values: the "Number" of the record type, which must be above 65535 (to avoid conflicts with legacy DNS record types), the "Name" of the record type, and a "Reference" with links @@ -14,3 +17,4 @@ appropriate for the record type. The current contact(s) for expert review are reachable at gns-registry@gnunet.org. + diff --git a/gnu-name-system-record-types/README b/gnu-name-system-record-types/README @@ -7,3 +7,4 @@ This registry is used to ensure that the names and numeric values used to identify record types are uniquely defined and to allow GNS resolvers implementors to find out details about the respective semantics and human-readable syntax. + diff --git a/gnu-name-system-record-types/rst.header b/gnu-name-system-record-types/rst.header.template diff --git a/gnunet-dht-block-types/Makefile b/gnunet-dht-block-types/Makefile @@ -18,8 +18,13 @@ gnunet_dht_block_types.h: h.header gnunet_dht_block_types.h.tmp h.footer gnunet_dht_block_types.rst.tmp: registry.rec rst.template ../format.sh rst.template < registry.rec > $@ -gnunet_dht_block_types.rst: rst.header gnunet_dht_block_types.rst.tmp rst.footer - cat rst.header gnunet_dht_block_types.rst.tmp rst.footer > $@ +rst.header.tmp: + cat rst.header.template README POLICY > $@ + echo "Entries" >> $@ + echo "^^^^^^^" >> $@ + +gnunet_dht_block_types.rst: rst.header.tmp gnunet_dht_block_types.rst.tmp rst.footer + cat rst.header.tmp gnunet_dht_block_types.rst.tmp rst.footer > $@ .PHONY: check clean distclean diff --git a/gnunet-dht-block-types/POLICY b/gnunet-dht-block-types/POLICY @@ -0,0 +1,11 @@ +Policy +^^^^^^ + +Developers working on GNUnet or packages based on GNUnet should +feel free to extend this registry. Entries may be deleted if +no code using them is still expected to be in production anywhere. + +Updating the name of the package or subsystem is allowed provided +that the code using the signature is being moved, as those fields +are merely informational or used for code generation. + diff --git a/gnunet-dht-block-types/README b/gnunet-dht-block-types/README @@ -7,3 +7,4 @@ This registry is used to ensure that the names and numeric values used to identify block types are uniquely defined and to allow DHT implementors to find out details about the respective semantics and human-readable syntax. + diff --git a/gnunet-dht-block-types/rst.header b/gnunet-dht-block-types/rst.header.template diff --git a/gnunet-error-codes/Makefile b/gnunet-error-codes/Makefile @@ -62,7 +62,12 @@ gnunet_error_codes.go: go.header gnunet_error_codes.go.tmp go.footer gnunet_error_codes.rst.tmp: combined.tmp rst.template ../format.sh rst.template < combined.tmp > $@ -gnunet_error_codes.rst: rst.header gnunet_error_codes.rst.tmp rst.footer - cat rst.header gnunet_error_codes.rst.tmp rst.footer > $@ +rst.header.tmp: + cat rst.header.template README POLICY > $@ + echo "Entries" >> $@ + echo "^^^^^^^" >> $@ + +gnunet_error_codes.rst: rst.header.tmp gnunet_error_codes.rst.tmp rst.footer + cat rst.header.tmp gnunet_error_codes.rst.tmp rst.footer > $@ .PHONY: check clean distclean prep diff --git a/gnunet-error-codes/POLICY b/gnunet-error-codes/POLICY @@ -0,0 +1,11 @@ +Policy +^^^^^^ + +Developers working on GNUnet or packages based on GNUnet should +feel free to extend this registry. Entries may be deleted if +no code using them is still expected to be in production anywhere. + +Updating the name of the package or subsystem is allowed provided +that the code using the signature is being moved, as those fields +are merely informational or used for code generation. + diff --git a/gnunet-error-codes/README b/gnunet-error-codes/README @@ -0,0 +1,2 @@ +GNUnet error code registry. + diff --git a/gnunet-error-codes/rst.header b/gnunet-error-codes/rst.header.template diff --git a/gnunet-protocols/Makefile b/gnunet-protocols/Makefile @@ -18,8 +18,13 @@ gnunet_overlay_protocols.h: h.header gnunet_overlay_protocols.h.tmp h.footer gnunet_overlay_protocols.rst.tmp: registry.rec rst.template ../format.sh rst.template < registry.rec > $@ -gnunet_overlay_protocols.rst: rst.header gnunet_overlay_protocols.rst.tmp rst.footer - cat rst.header gnunet_overlay_protocols.rst.tmp rst.footer > $@ +rst.header.tmp: + cat rst.header.template README POLICY > $@ + echo "Entries" >> $@ + echo "^^^^^^^" >> $@ + +gnunet_overlay_protocols.rst: rst.header.tmp gnunet_overlay_protocols.rst.tmp rst.footer + cat rst.header.tmp gnunet_overlay_protocols.rst.tmp rst.footer > $@ .PHONY: check clean distclean diff --git a/gnunet-protocols/POLICY b/gnunet-protocols/POLICY @@ -1,3 +1,6 @@ +Policy +^^^^^^ + Each registry entry should contain three values: the "Number" of the protocol, which must be above 255 (to avoid conflicts with legacy Internet protocols), the "Name" of the protocol, and a "Reference" with links @@ -14,3 +17,4 @@ appropriate for the record type. The current contact(s) for expert review are reachable at gns-registry@gnunet.org. + diff --git a/gnunet-protocols/README b/gnunet-protocols/README @@ -7,3 +7,4 @@ This registry is used to ensure that the names and numeric values used to identify the protocols are uniquely defined and to allow implementors to find out details about the respective semantics and specifications. + diff --git a/gnunet-protocols/rst.header b/gnunet-protocols/rst.header.template diff --git a/gnunet-signatures/Makefile b/gnunet-signatures/Makefile @@ -15,8 +15,13 @@ gnunet_signatures.h: h.header gnunet_signatures.h.tmp h.footer gnunet_signatures.rst.tmp: registry.rec rst.template ../format.sh rst.template 'Package = "GNUnet"' < registry.rec > $@ -gnunet_signatures.rst: rst.header gnunet_signatures.rst.tmp rst.footer - cat rst.header gnunet_signatures.rst.tmp rst.footer > $@ +rst.header.tmp: + cat rst.header.template README POLICY > $@ + echo "Entries" >> $@ + echo "^^^^^^^" >> $@ + +gnunet_signatures.rst: rst.header.tmp gnunet_signatures.rst.tmp rst.footer + cat rst.header.tmp gnunet_signatures.rst.tmp rst.footer > $@ .PHONY: check clean distclean diff --git a/gnunet-signatures/POLICY b/gnunet-signatures/POLICY @@ -1,3 +1,6 @@ +Policy +^^^^^^ + Developers working on GNUnet or packages based on GNUnet should feel free to extend this registry. Entries may be deleted if no code using them is still expected to be in production anywhere. @@ -5,3 +8,4 @@ no code using them is still expected to be in production anywhere. Updating the name of the package or subsystem is allowed provided that the code using the signature is being moved, as those fields are merely informational or used for code generation. + diff --git a/gnunet-signatures/README b/gnunet-signatures/README @@ -5,3 +5,4 @@ signature functions, the signer must provide a "purpose" that provides the context for the signature. By signing over the "purpose", it is not possible for an adversary to use a signature made in one context in another context. + diff --git a/gnunet-signatures/rst.header b/gnunet-signatures/rst.header.template