Merge branch '3120-recent-editions-9-17-22-onwards-of-arm-have-many-empty-grammar-descriptions' into 'main'

Fix empty grammar descriptions in the ARM Closes #3120 See merge request isc-projects/bind9!5784
2022-02-01 17:15:08 +00:00
parent a8ac23c73c 34a3b35b08
commit 858e522b4e
30 changed files with 90 additions and 32 deletions
--- a/doc/arm/Makefile.am
+++ b/doc/arm/Makefile.am
@@ -40,7 +40,7 @@ EXTRA_DIST =					\
 	../misc/master.zoneopt.rst		\
 	../misc/mirror.zoneopt.rst		\
 	../misc/options.grammar.rst		\
-	../misc/parentals.grammar.rst		\
+	../misc/parental-agents.grammar.rst	\
 	../misc/primaries.grammar.rst		\
 	../misc/redirect.zoneopt.rst		\
 	../misc/server.grammar.rst		\
--- a/doc/arm/reference.rst
+++ b/doc/arm/reference.rst
@@ -851,14 +851,14 @@ At ``debug`` level 4 or higher, the detailed context information logged at
 ``debug`` level 2 is logged for errors other than SERVFAIL and for negative
 responses such as NXDOMAIN.

-.. _parentals_grammar:
+.. _parental_agents_grammar:

 ``parental-agents`` Statement Grammar
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-.. include:: ../misc/parentals.grammar.rst
+.. include:: ../misc/parental-agents.grammar.rst

-.. _parentals_statement:
+.. _parental_agents_statement:

 ``parental-agents`` Statement Definition and Usage
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--- a/doc/misc/Makefile.am
+++ b/doc/misc/Makefile.am
@@ -38,7 +38,8 @@ OPTIONS_FILES =				\
 	trust-anchors.grammar.rst	\
 	managed-keys.grammar.rst	\
 	trusted-keys.grammar.rst	\
-	http.grammar.rst
+	http.grammar.rst		\
+	parental-agents.grammar.rst

 EXTRA_DIST =			\
 	$(OPTIONS_FILES)	\
@@ -104,79 +105,82 @@ delegation-only.zoneopt: cfg_test
 in-view.zoneopt: cfg_test
 	$(AM_V_CFG_TEST)$(builddir)/cfg_test --zonegrammar in-view --active > $@

-../../bin/named/named.conf.rst: options.active
+../../bin/named/named.conf.rst: options.active rst-options.pl
 	$(AM_V_RST_OPTIONS)$(PERL) $(srcdir)/rst-options.pl options.active > $@

-master.zoneopt.rst: master.zoneopt
+master.zoneopt.rst: master.zoneopt rst-zoneopt.pl
 	$(AM_V_RST_ZONEOPT)$(PERL) $(srcdir)/rst-zoneopt.pl master.zoneopt > $@

-slave.zoneopt.rst: slave.zoneopt
+slave.zoneopt.rst: slave.zoneopt rst-zoneopt.pl
 	$(AM_V_RST_ZONEOPT)$(PERL) $(srcdir)/rst-zoneopt.pl slave.zoneopt > $@

-mirror.zoneopt.rst: mirror.zoneopt
+mirror.zoneopt.rst: mirror.zoneopt rst-zoneopt.pl
 	$(AM_V_RST_ZONEOPT)$(PERL) $(srcdir)/rst-zoneopt.pl mirror.zoneopt > $@

-forward.zoneopt.rst: forward.zoneopt
+forward.zoneopt.rst: forward.zoneopt rst-zoneopt.pl
 	$(AM_V_RST_ZONEOPT)$(PERL) $(srcdir)/rst-zoneopt.pl forward.zoneopt > $@

-hint.zoneopt.rst: hint.zoneopt
+hint.zoneopt.rst: hint.zoneopt rst-zoneopt.pl
 	$(AM_V_RST_ZONEOPT)$(PERL) $(srcdir)/rst-zoneopt.pl hint.zoneopt > $@

-stub.zoneopt.rst: stub.zoneopt
+stub.zoneopt.rst: stub.zoneopt rst-zoneopt.pl
 	$(AM_V_RST_ZONEOPT)$(PERL) $(srcdir)/rst-zoneopt.pl stub.zoneopt > $@

-static-stub.zoneopt.rst: static-stub.zoneopt
+static-stub.zoneopt.rst: static-stub.zoneopt rst-zoneopt.pl
 	$(AM_V_RST_ZONEOPT)$(PERL) $(srcdir)/rst-zoneopt.pl static-stub.zoneopt > $@

-redirect.zoneopt.rst: redirect.zoneopt
+redirect.zoneopt.rst: redirect.zoneopt rst-zoneopt.pl
 	$(AM_V_RST_ZONEOPT)$(PERL) $(srcdir)/rst-zoneopt.pl redirect.zoneopt > $@

-delegation-only.zoneopt.rst: delegation-only.zoneopt
+delegation-only.zoneopt.rst: delegation-only.zoneopt rst-zoneopt.pl
 	$(AM_V_RST_ZONEOPT)$(PERL) $(srcdir)/rst-zoneopt.pl delegation-only.zoneopt > $@

-in-view.zoneopt.rst: in-view.zoneopt
+in-view.zoneopt.rst: in-view.zoneopt rst-zoneopt.pl
 	$(AM_V_RST_ZONEOPT)$(PERL) $(srcdir)/rst-zoneopt.pl in-view.zoneopt > $@

-acl.grammar.rst: options.active
+acl.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active acl > $@

-controls.grammar.rst: options.active
+controls.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active controls > $@

-dnssec-policy.grammar.rst: options.active
+dnssec-policy.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active dnssec-policy > $@

-key.grammar.rst: options.active
+key.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active key > $@

-logging.grammar.rst: options.active
+logging.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active logging > $@

-primaries.grammar.rst: options.active
+primaries.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active primaries > $@

-options.grammar.rst: options.active
+options.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active options > $@

-server.grammar.rst: options.active
+server.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active server > $@

-statistics-channels.grammar.rst: options.active
+statistics-channels.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active statistics-channels > $@

-tls.grammar.rst: options.active
+tls.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active tls > $@

-trust-anchors.grammar.rst: options.active
+trust-anchors.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active trust-anchors > $@

-managed-keys.grammar.rst: options.active
+managed-keys.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active managed-keys > $@

-trusted-keys.grammar.rst: options.active
+trusted-keys.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active trusted-keys > $@

-http.grammar.rst: options.active
+http.grammar.rst: options.active rst-grammars.pl
 	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active http > $@

+parental-agents.grammar.rst: options.active rst-grammars.pl
+	$(AM_V_RST_GRAMMARS)$(PERL) $(srcdir)/rst-grammars.pl options.active parental-agents > $@
+
 endif
--- a/doc/misc/acl.grammar.rst
+++ b/doc/misc/acl.grammar.rst
@@ -9,4 +9,6 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  acl <string> { <address_match_element>; ... };
--- a/doc/misc/controls.grammar.rst
+++ b/doc/misc/controls.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  controls {
  	inet ( <ipv4_address> | <ipv6_address> |
  	    * ) [ port ( <integer> | * ) ] allow
--- a/doc/misc/delegation-only.zoneopt.rst
+++ b/doc/misc/delegation-only.zoneopt.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  zone <string> [ <class> ] {
  	type delegation-only;
  };
--- a/doc/misc/dnssec-policy.grammar.rst
+++ b/doc/misc/dnssec-policy.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  dnssec-policy <string> {
  	dnskey-ttl <duration>;
  	keys { ( csk | ksk | zsk ) [ ( key-directory ) ] lifetime
--- a/doc/misc/forward.zoneopt.rst
+++ b/doc/misc/forward.zoneopt.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  zone <string> [ <class> ] {
  	type forward;
  	delegation-only <boolean>;
--- a/doc/misc/hint.zoneopt.rst
+++ b/doc/misc/hint.zoneopt.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  zone <string> [ <class> ] {
  	type hint;
  	check-names ( fail | warn | ignore );
--- a/doc/misc/http.grammar.rst
+++ b/doc/misc/http.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  http <string> {
  	endpoints { <quoted_string>; ... };
  	listener-clients <integer>;
--- a/doc/misc/in-view.zoneopt.rst
+++ b/doc/misc/in-view.zoneopt.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  zone <string> [ <class> ] {
  	in-view <string>;
  };
--- a/doc/misc/key.grammar.rst
+++ b/doc/misc/key.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  key <string> {
  	algorithm <string>;
  	secret <string>;
--- a/doc/misc/logging.grammar.rst
+++ b/doc/misc/logging.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  logging {
  	category <string> { <string>; ... };
  	channel <string> {
--- a/doc/misc/managed-keys.grammar.rst
+++ b/doc/misc/managed-keys.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  managed-keys { <string> ( static-key
      | initial-key | static-ds |
      initial-ds ) <integer> <integer>
--- a/doc/misc/master.zoneopt.rst
+++ b/doc/misc/master.zoneopt.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  zone <string> [ <class> ] {
  	type ( master | primary );
  	allow-query { <address_match_element>; ... };
--- a/doc/misc/mirror.zoneopt.rst
+++ b/doc/misc/mirror.zoneopt.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  zone <string> [ <class> ] {
  	type mirror;
  	allow-notify { <address_match_element>; ... };
--- a/doc/misc/options.grammar.rst
+++ b/doc/misc/options.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  options {
  	allow-new-zones <boolean>;
  	allow-notify { <address_match_element>; ... };
--- a/doc/misc/parental-agents.grammar.rst
+++ b/doc/misc/parental-agents.grammar.rst
@@ -9,8 +9,10 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

-  parental-agents <string> [ port <integer> ] [ dscp
-      <integer> ] { ( <remote-servers> |
+::
+
+  parental-agents <string> [ port <integer> ] [
+      dscp <integer> ] { ( <remote-servers> |
      <ipv4_address> [ port <integer> ] |
      <ipv6_address> [ port <integer> ] ) [ key
      <string> ] [ tls <string> ]; ... };
--- a/doc/misc/primaries.grammar.rst
+++ b/doc/misc/primaries.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  primaries <string> [ port <integer> ] [ dscp
      <integer> ] { ( <remote-servers> |
      <ipv4_address> [ port <integer> ] |
--- a/doc/misc/redirect.zoneopt.rst
+++ b/doc/misc/redirect.zoneopt.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  zone <string> [ <class> ] {
  	type redirect;
  	allow-query { <address_match_element>; ... };
--- a/doc/misc/rst-grammars.pl
+++ b/doc/misc/rst-grammars.pl
@@ -39,6 +39,8 @@ print <<END;
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
 END

 # skip preamble
--- a/doc/misc/rst-zoneopt.pl
+++ b/doc/misc/rst-zoneopt.pl
@@ -38,6 +38,8 @@ print <<END;
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
 END

 while (<FH>) {
--- a/doc/misc/server.grammar.rst
+++ b/doc/misc/server.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  server <netprefix> {
  	bogus <boolean>;
  	edns <boolean>;
--- a/doc/misc/slave.zoneopt.rst
+++ b/doc/misc/slave.zoneopt.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  zone <string> [ <class> ] {
  	type ( slave | secondary );
  	allow-notify { <address_match_element>; ... };
--- a/doc/misc/static-stub.zoneopt.rst
+++ b/doc/misc/static-stub.zoneopt.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  zone <string> [ <class> ] {
  	type static-stub;
  	allow-query { <address_match_element>; ... };
--- a/doc/misc/statistics-channels.grammar.rst
+++ b/doc/misc/statistics-channels.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  statistics-channels {
  	inet ( <ipv4_address> | <ipv6_address> |
  	    * ) [ port ( <integer> | * ) ] [
--- a/doc/misc/stub.zoneopt.rst
+++ b/doc/misc/stub.zoneopt.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  zone <string> [ <class> ] {
  	type stub;
  	allow-query { <address_match_element>; ... };
--- a/doc/misc/tls.grammar.rst
+++ b/doc/misc/tls.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  tls <string> {
  	cert-file <quoted_string>;
  	ciphers <string>;
--- a/doc/misc/trust-anchors.grammar.rst
+++ b/doc/misc/trust-anchors.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  trust-anchors { <string> ( static-key |
      initial-key | static-ds | initial-ds )
      <integer> <integer> <integer>
--- a/doc/misc/trusted-keys.grammar.rst
+++ b/doc/misc/trusted-keys.grammar.rst
@@ -9,6 +9,8 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.

+::
+
  trusted-keys { <string> <integer>
      <integer> <integer>
      <quoted_string>; ... };, deprecated