upstream/bind9
1
0
Fork 0
mirror of https://github.com/isc-projects/bind9.git synced 2026-03-11 02:30:44 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
bind9/doc/misc/Makefile.am

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

77 lines
1.8 KiB
Makefile
Raw Normal View History

Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
include $(top_srcdir)/Makefile.top
include $(top_srcdir)/Makefile.docs
Rebuild the file in doc/misc only when in maintainer mode The files in doc/misc requires all the BIND 9 libraries to be built before the documentation can be built. One of the extra automake features is maintainer mode that allows to conditionally build and clean files that require special tools. Make use of the automake maintainer mode to not rebuild the files in doc/misc under normal circumstances.
2020-06-22 07:03:07 -04:00
OPTIONS_FILES = \
Add rndc.conf grammar into doc/misc It uses the same mechanism as all other grammars, but the file is named differently to distinguish it from named.conf grammars.
2022-05-11 03:20:51 -04:00
rndc.grammar \
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
options \
remove old zone type documentation we now document zone type as either "primary" or "secondary", omitting the old terms (though they are still accepted).
2022-02-23 20:18:38 -05:00
primary.zoneopt \
secondary.zoneopt \
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
mirror.zoneopt \
forward.zoneopt \
hint.zoneopt \
stub.zoneopt \
static-stub.zoneopt \
redirect.zoneopt \
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-06-24 07:16:53 -04:00
in-view.zoneopt
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
Rebuild the file in doc/misc only when in maintainer mode The files in doc/misc requires all the BIND 9 libraries to be built before the documentation can be built. One of the extra automake features is maintainer mode that allows to conditionally build and clean files that require special tools. Make use of the automake maintainer mode to not rebuild the files in doc/misc under normal circumstances.
2020-06-22 07:03:07 -04:00
EXTRA_DIST = \
$(OPTIONS_FILES) \
Add utility to search for context-dependent configuration statements The utility detects statements which use the same name (e.g. max-zone-ttl) but use different grammar in different contexts. These typically need special case in docs.
2022-05-09 12:04:40 -04:00
checkgrammar.py \
Add a new library to parse grammar format produced by cfg_test It transforms named.conf/rndc.conf grammar from text format into Python dictionary. This allows granular access to grammar elements. Beware: It heavity depens on cfg_test output format!
2022-05-03 03:09:16 -04:00
parsegrammar.py \
Fix "make dist" Make various adjustments necessary to enable "make dist" to build a BIND source tarball whose contents are complete enough to build binaries, run unit & system tests, and generate documentation on Unix systems. Known outstanding issues: - "make distcheck" does not work yet. - Tests do not work for out-of-tree source-tarball-based builds. - Source tarballs are not complete enough for building on Windows. All of the above will be addressed in due course.
2020-06-04 13:02:27 -04:00
sort-options.pl
Rebuild the file in doc/misc only when in maintainer mode The files in doc/misc requires all the BIND 9 libraries to be built before the documentation can be built. One of the extra automake features is maintainer mode that allows to conditionally build and clean files that require special tools. Make use of the automake maintainer mode to not rebuild the files in doc/misc under normal circumstances.
2020-06-22 07:03:07 -04:00
if MAINTAINER_MODE
MAINTAINERCLEANFILES = $(OPTIONS_FILES)
noinst_PROGRAMS = cfg_test
Fix the remaining cases of <prog>_CFLAGS -> <prog>_CPPFLAGS Building BIND 9 with older version of BIND 9 installed would result in build failure. Fix the last two remaining cases where <prog>_CFLAGS was being used leading to wrong order of the build flags on the command line.
2022-03-13 12:42:09 -04:00
cfg_test_CPPFLAGS = \
$(AM_CPPFLAGS) \
Rebuild the file in doc/misc only when in maintainer mode The files in doc/misc requires all the BIND 9 libraries to be built before the documentation can be built. One of the extra automake features is maintainer mode that allows to conditionally build and clean files that require special tools. Make use of the automake maintainer mode to not rebuild the files in doc/misc under normal circumstances.
2020-06-22 07:03:07 -04:00
$(LIBISC_CFLAGS) \
$(LIBDNS_CFLAGS) \
$(LIBISCCFG_CFLAGS)
cfg_test_LDADD = \
$(LIBISC_LIBS) \
$(LIBDNS_LIBS) \
$(LIBISCCFG_LIBS)
Add support for User Statically Defined Tracing (USDT) probes This adds support for User Statically Defined Tracing (USDT). On Linux, this uses the header from SystemTap and dtrace utility, but the support is universal as long as dtrace is available. Also add the required infrastructure to add probes to libisc, libdns and libns libraries, where most of the probes will be.
2023-01-30 09:36:49 -05:00
BUILT_SOURCES += \
Rebuild the file in doc/misc only when in maintainer mode The files in doc/misc requires all the BIND 9 libraries to be built before the documentation can be built. One of the extra automake features is maintainer mode that allows to conditionally build and clean files that require special tools. Make use of the automake maintainer mode to not rebuild the files in doc/misc under normal circumstances.
2020-06-22 07:03:07 -04:00
$(OPTIONS_FILES)
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
Add rndc.conf grammar into doc/misc It uses the same mechanism as all other grammars, but the file is named differently to distinguish it from named.conf grammars.
2022-05-11 03:20:51 -04:00
rndc.grammar: cfg_test
$(AM_V_CFG_TEST)$(builddir)/cfg_test --rndc --grammar | $(PERL) $(srcdir)/sort-options.pl > $@
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
options: cfg_test
Un-format grammar files in doc/misc The next commit is going to add parser for ISC configuration format. To simplify the parser the grammar files in doc/misc are no longer line-wrapped as handling it would make the grammar parser unnecessairly complicated. This affects visible output in the ARM, but in the end we are going to replace the auto-generated .rst files with grammar pretty printed, so formatting of these files does not matter in practical terms.
2022-05-11 03:20:51 -04:00
$(AM_V_CFG_TEST)$(builddir)/cfg_test --named --grammar | $(PERL) $(srcdir)/sort-options.pl > $@
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
remove old zone type documentation we now document zone type as either "primary" or "secondary", omitting the old terms (though they are still accepted).
2022-02-23 20:18:38 -05:00
primary.zoneopt: cfg_test
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-06-24 07:16:53 -04:00
$(AM_V_CFG_TEST)$(builddir)/cfg_test --zonegrammar primary > $@
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
remove old zone type documentation we now document zone type as either "primary" or "secondary", omitting the old terms (though they are still accepted).
2022-02-23 20:18:38 -05:00
secondary.zoneopt: cfg_test
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-06-24 07:16:53 -04:00
$(AM_V_CFG_TEST)$(builddir)/cfg_test --zonegrammar secondary > $@
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
mirror.zoneopt: cfg_test
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-06-24 07:16:53 -04:00
$(AM_V_CFG_TEST)$(builddir)/cfg_test --zonegrammar mirror > $@
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
forward.zoneopt: cfg_test
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-06-24 07:16:53 -04:00
$(AM_V_CFG_TEST)$(builddir)/cfg_test --zonegrammar forward > $@
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
hint.zoneopt: cfg_test
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-06-24 07:16:53 -04:00
$(AM_V_CFG_TEST)$(builddir)/cfg_test --zonegrammar hint > $@
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
stub.zoneopt: cfg_test
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-06-24 07:16:53 -04:00
$(AM_V_CFG_TEST)$(builddir)/cfg_test --zonegrammar stub > $@
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
static-stub.zoneopt: cfg_test
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-06-24 07:16:53 -04:00
$(AM_V_CFG_TEST)$(builddir)/cfg_test --zonegrammar static-stub > $@
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
redirect.zoneopt: cfg_test
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-06-24 07:16:53 -04:00
$(AM_V_CFG_TEST)$(builddir)/cfg_test --zonegrammar redirect > $@
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
in-view.zoneopt: cfg_test
Remove auto-generated rst files in repo in favour of grammar pretty printer
2022-06-24 07:16:53 -04:00
$(AM_V_CFG_TEST)$(builddir)/cfg_test --zonegrammar in-view > $@
Add missing parental-agents grammar generation Formerly parental-agents grammar was an exception and it did not auto-generate itself from source code. From now on it is generated using the same mechanism as other grammars. For consistency with rest of the system, I've also renamed the grammar file and the link anchors from "parentals" to "parental-agents". Technically this is fixup for commit 0311705d4b36c536dd541b0b193bd01b68fe90b3. Related: !5234
2022-02-01 07:04:21 -05:00
Rebuild the file in doc/misc only when in maintainer mode The files in doc/misc requires all the BIND 9 libraries to be built before the documentation can be built. One of the extra automake features is maintainer mode that allows to conditionally build and clean files that require special tools. Make use of the automake maintainer mode to not rebuild the files in doc/misc under normal circumstances.
2020-06-22 07:03:07 -04:00
endif
Reference in a new issue Copy permalink