upstream/bind9
1
0
Fork 0
mirror of https://github.com/isc-projects/bind9.git synced 2026-05-28 04:34:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Warn about experimental and deprecated options

Browse source 
(cherry picked from commit 7b4ad8a3ff)
This commit is contained in:
Petr Špaček 2022-06-24 09:55:01 +02:00
parent 3a692b068c
commit f34c1034f2
No known key found for this signature in database
GPG key ID: ABD587CDF06581AE
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
doc/arm/_ext/iscconf.py
View file

@ -185,6 +185,23 @@ def domain_factory(domainname, domainlabel, todolist, grammar):
grammarnode += nodetype(text=grammar_txt)
return grammarnode
def format_warnings(self, flags):
"""Return node with a warning box about deprecated and
experimental options"""
warn = nodes.warning()
if "deprecated" in flags:
warn += nodes.paragraph(
text=(
"This option is deprecated and will be removed in a future"
" version of BIND."
)
)
if "experimental" in flags:
warn += nodes.paragraph(
text="This option is experimental and subject to change."
)
return warn
def parse_nested_str(self, instr):
"""Parse string as nested rst syntax and produce a node"""
raw = nodes.paragraph(text=instr)
@ -214,10 +231,19 @@ def domain_factory(domainname, domainlabel, todolist, grammar):
grammars = iscconf.statement_grammar_groups[name]
multi_grammar = len(grammars) > 1
union_flags = set()
for grammar_grp in grammars:
for one_grammar_dict in grammar_grp:
union_flags = union_flags.union(
set(one_grammar_dict.subgrammar.get("_flags", []))
)
grammarnode = self.format_grammar(multi_grammar, grammar_grp)
contentnode.insert(0, grammarnode)
warn = self.format_warnings(union_flags)
if len(warn):
contentnode.insert(0, warn)
name = domainname
label = domainlabel