Petr Špaček
f5faddd08a
Cleanup tag filtering code for statementlist:: RST directive
...
Technically this is fixup for
33931c97faaa0f728b4194b8077825e75c351e12
but that commit is already merged.
2022-07-01 08:59:24 +02:00
Petr Špaček
d88fefbb4a
Add link anchor and hyperlinks to keys statement
...
This is super confusing because statement "keys" exists in context
controls and server blocks where it refers to symmetric TSIG key, and it
_also_ exists in dnssec-policy block where it specifies public-private
key pair parameters.
In an (unsuccessful) attempt to disambiguate these two I added bunch of
hyperlinks and a warning.
2022-07-01 08:59:24 +02:00
Petr Špaček
82e2f0b37e
Describe rndc server block using .. rndcconf syntax
...
We need to split the description to silence warnings about undescribed
statements.
2022-07-01 08:59:24 +02:00
Petr Špaček
10f88bffe5
Define default-source-address, default-source-address-v6 for rndc
2022-07-01 08:59:24 +02:00
Petr Špaček
1687b40849
Document ipv4only-* options in the ARM
...
Statements ipv4only-contact, ipv4only-enable, ipv4only-server did not
have their own section in the ARM. Now they have.
2022-07-01 08:59:23 +02:00
Petr Špaček
40b3ce727c
Add missing link anchor for dlz search statement
2022-07-01 08:59:23 +02:00
Petr Špaček
261bdc7358
Special-case zone in-view
...
It is not really a zone type, so let's not generate "type in-view"
anchor for it.
2022-07-01 08:59:23 +02:00
Petr Špaček
1af157eb20
Remove extra whitespace in grammar for null statement
2022-07-01 08:59:23 +02:00
Petr Špaček
08a8acffdc
Add ability to filter tables using blocks
...
A new syntax
.. namedconf:statementlist::
:filter_blocks: type secondary
allows to generate tables with statements allowed within specified
blocks.
2022-07-01 08:59:23 +02:00
Petr Špaček
0392144e99
Pretty-print grammar for zones
...
It turns out the tree of dictionaries is not the best structure to
represent our grammar, unfortunatelly. The problem is that "zone" has
several context-dependent variants which change meaning of "zone" based
on inner field "type".
Redesigning the whole structure does not seem to be worth, so I settled
on this terrible hack.
2022-07-01 08:59:23 +02:00
Petr Špaček
435cbb61ba
Add zone definitions into the view grammar
...
I cannot see a reasonable way to achieve this without the hack in this
commit.
2022-07-01 08:59:23 +02:00
Petr Špaček
1f5bc4fe3b
Add option to suppress grammar rendering
...
A new flag
.. namedconf:statement::
:suppress_grammar:
suppresses pretty-printing grammar.
It is useful mostly for zones because each zone has it's own grammar, so
printing all of them at once usually does not make sense.
2022-07-01 08:59:23 +02:00
Petr Špaček
0bbbdc6244
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-07-01 08:59:23 +02:00
Petr Špaček
7b4ad8a3ff
Warn about experimental and deprecated options
2022-07-01 08:59:23 +02:00
Petr Špaček
c6fe8970f6
Render statement's grammar
...
This is replacement for auto-generated *.rst files stored in the repo.
2022-07-01 08:59:23 +02:00
Petr Špaček
eba3b1ad16
Render list of blocks accepting a given statement
2022-07-01 08:59:23 +02:00
Petr Špaček
d61d998e3b
Detect unsupported statement:: directives with multiple names
2022-07-01 08:59:23 +02:00
Petr Špaček
ebe6ede2ec
Warn about statements not found in the grammar
2022-07-01 08:59:23 +02:00
Petr Špaček
cbad1803a5
Warn about statements in grammar not described in docs
...
Skip over obsolete options.
2022-07-01 08:59:22 +02:00
Petr Špaček
1c6f2c5ad1
Give Sphinx configuration domains access to grammar
2022-07-01 08:59:22 +02:00
Petr Špaček
a691ebd0c9
Add helper to unify options and zone block grammars
...
A helper is needed to combine cfg_test output for generic options and
all the type-dependent zone block variants.
2022-07-01 08:59:22 +02:00
Petr Špaček
563eb8e1b9
Accept rst syntax in .. statement:: short: text
...
Nested rst syntax is now parsed and rendered. E.g.:
.. namedconf:statement:: example
:short: Use ``this`` **cool** syntax!
2022-06-30 18:04:44 +02:00
Petr Špaček
0e7ca5b5e0
Disambiguate address_match_list link anchor
...
Let's keep just the :term: produced by grammar glossary.
2022-06-30 18:04:41 +02:00
Suzanne Goldlust
3cf976bd78
Add the :tags: and :short: descriptions for the category "transfer"
2022-06-30 18:04:40 +02:00
Suzanne Goldlust
7187a5cf77
Add the :tags: and :short: descriptions for the category "query"
2022-06-30 18:04:40 +02:00
Petr Špaček
2630cf8e76
Resurrect DNS NOTIFY chapter in the ARM
...
It was accidentally removed in the heat of
25eb91d23c5a2056f36902c90dfe8ca69f6a9400.
2022-06-30 18:04:40 +02:00
Michał Kępień
887c666caf
Obsolete the "glue-cache" option
...
The "glue-cache" option was marked as deprecated by commit
5ae33351f286feb25a965bf3c9e6b122ab495342 (first released in BIND 9.17.6,
back in October 2020), so now obsolete that option, removing all code
and documentation related to it.
Note: this causes the glue cache feature to be permanently enabled, not
disabled.
2022-06-30 15:24:08 +02:00
Petr Špaček
4ce1f25210
Declare Debian 9 (Stretch) community-maintained
2022-06-28 17:54:48 +02:00
Matthijs Mekking
fb517eb52a
Add some clarifications wrt dynamic zones
...
These were suggested by GitLab user @elmaimbo.
2022-06-27 11:01:33 +02:00
Ron Aitchison
d44cb9f194
Added explanations or Argument, Value, and Directive to the ARM
2022-06-24 16:20:46 +02:00
Petr Špaček
bb2a19d655
Add link to glob definition for include directive
2022-06-24 09:40:51 +02:00
Suzanne Goldlust
f4503061ba
Minor text nitpicking around dnssec-policy grammar reference
2022-06-24 09:40:51 +02:00
Petr Špaček
fbcaa44851
Remove ambiguous link anchors for logging { file } statement
...
Unfortunatelly logging and zone blocks use file statements with
different semantics but the same name.
There is no sane way to disambiguate them in text, so let's remove the
link anchor from logging so we can link to the file statement in zone.
My assumption is that linking to logging { file } is very unlikely
because logging is self-contained in one block but zone config is all
over the place.
2022-06-24 09:40:51 +02:00
Petr Špaček
d6b2423c99
Remove ambiguous link anchors for keys statement
...
Unfortunatelly dnssec-policy and servers blocks use keys statements with
a totally different grammar and semantics but the same name.
There is no sane way to disambiguate them in text, so let's remove the
link anchors to prevent errorneous linking.
2022-06-24 09:40:51 +02:00
Petr Špaček
caf2675ef8
Change statement->argument terminology for control channel
...
control { inet ... allow keys read-only }; are not actual statements
but in fact arguments of a statement. Remove .. namedconf:statement::
syntax to avoid collisions with other statements of the same name.
2022-06-24 09:40:51 +02:00
Petr Špaček
3233414a53
Deduplicate dnssec-policy definition in the ARM
2022-06-24 09:40:51 +02:00
Petr Špaček
fa2ba5423b
Deduplicate null definition in the ARM logging section
2022-06-24 09:40:51 +02:00
Petr Špaček
cd1b9aa052
Deduplicate {use,avoid}-v{4,6}-udp-ports definitions in the ARM
...
Statements affected:
use-v4-udp-ports
use-v6-udp-ports
avoid-v4-udp-ports
avoid-v6-udp-ports
2022-06-24 09:40:00 +02:00
Petr Špaček
6e634c43cd
Deduplicate request-expire definition in the ARM
2022-06-24 08:14:32 +02:00
Petr Špaček
22e6c8a29e
Deduplicate provide-ixfr definition in the ARM
2022-06-24 08:14:31 +02:00
Petr Špaček
14389bc446
Deduplicate request-ixfr definition in the ARM
...
Let's be consistent and put all definitions in the options block.
2022-06-24 08:14:31 +02:00
Petr Špaček
08a3cd7ae4
Deduplicate notify-source, notify-source-v6 definitions in the ARM
2022-06-24 08:14:31 +02:00
Petr Špaček
e91529a48b
Deduplicate request-nsid definition in the ARM
2022-06-24 08:14:31 +02:00
Petr Špaček
92a125b9c4
Deduplicate query-source, query-source-v6 definitions in the ARM
2022-06-24 08:14:31 +02:00
Petr Špaček
538f5a7520
Deduplicate transfer-source, transfer-source-v6 definitions in the ARM
2022-06-24 08:14:31 +02:00
Petr Špaček
b6eb0b298d
Deduplicate transfer-format definition in the ARM
2022-06-24 08:14:31 +02:00
Petr Špaček
7937c4bc9c
Deduplicate send-cookie definition in the ARM
2022-06-24 08:14:31 +02:00
Petr Špaček
8ac82b4f30
Deduplicate max-udp-size definition in the ARM
2022-06-24 08:14:31 +02:00
Petr Špaček
624bbf403c
Deduplicate edns-udp-size definition in the ARM
2022-06-24 08:14:31 +02:00
Petr Špaček
405a0931ea
Deduplicate max-zone-ttl definition in the ARM
...
This is confusing as hell, but we cannot fix that in the manual itself.
At least now the user is made aware of two distinct defaults.
2022-06-24 08:14:31 +02:00