2
0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-08-22 01:59:26 +00:00
bind/doc/arm/_ext/mergegrammar.py
Aydın Mercan 5c9b4f3163
Remove build requirements from building arm
The meson build switched to generating the file grammars and using meson
to build the manpages/ARM. This is because meson doesn't work well when
writing files outside the build directory.

However, this has been suboptimal when someone only wants to build the
documentation (like RTD). Sphinx can now be used outside meson like it
was with autoconf.

Grammars are now updated by the developer with CI checking if one is
needed or not, like clang-format.
2025-06-23 13:45:04 +03:00

68 lines
1.9 KiB
Python

############################################################################
# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
#
# SPDX-License-Identifier: MPL-2.0
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, you can obtain one at https://mozilla.org/MPL/2.0/.
#
# See the COPYRIGHT file distributed with this work for additional
# information regarding copyright ownership.
############################################################################
# Depends on CWD - Sphinx plugin
import json
from pathlib import Path
import parsegrammar
misc_path = Path(__file__).resolve().parent.parent.parent / "misc"
options_path = misc_path / "options"
def read_zone():
zone_grammars = {}
for file in misc_path.glob("*.zoneopt"):
# in-view is not really a zone type
if file.stem == "in-view":
zone_type = "in-view"
else:
zone_type = f"type {file.stem}"
with file.open(encoding="ascii") as fp:
zonegrammar = parsegrammar.parse_mapbody(fp)
assert len(zonegrammar) == 1
assert "zone" in zonegrammar
zone_grammars[zone_type] = zonegrammar["zone"]
zone_grammars[zone_type]["_pprint_name"] = "zone"
return {"zone": {"_mapbody": zone_grammars, "_ignore_this_level": True}}
def read_main():
with options_path.open(encoding="ascii") as fp:
optgrammar = parsegrammar.parse_mapbody(fp)
return optgrammar
def combine():
zones = read_zone()
assert zones
rest = read_main()
assert rest
rest.update(zones)
# this is a terrible hack
# but cfg_test cannot print zone grammars inside view
rest["view"]["_mapbody"].update(zones)
return rest
if __name__ == "__main__":
full_grammar = combine()
print(json.dumps(full_grammar))