2019-07-30 21:18:51 +02:00
|
|
|
SUBDIRS = sphinx devel
|
2015-02-18 21:05:05 +01:00
|
|
|
|
2019-07-18 11:18:05 +02:00
|
|
|
EXTRA_DIST = images/kea-logo-100x70.png
|
2019-07-18 08:50:12 +02:00
|
|
|
|
2018-01-02 10:48:16 +01:00
|
|
|
nobase_dist_doc_DATA = examples/agent/comments.json
|
2021-02-12 19:26:16 +01:00
|
|
|
nobase_dist_doc_DATA += examples/agent/https.json
|
2022-05-13 18:33:04 +02:00
|
|
|
nobase_dist_doc_DATA += examples/agent/rbac.json
|
2018-01-02 10:48:16 +01:00
|
|
|
nobase_dist_doc_DATA += examples/agent/simple.json
|
2021-08-16 13:39:09 +02:00
|
|
|
nobase_dist_doc_DATA += examples/ddns/all-keys.json
|
|
|
|
|
nobase_dist_doc_DATA += examples/ddns/all-keys-netconf.json
|
2018-01-02 10:48:16 +01:00
|
|
|
nobase_dist_doc_DATA += examples/ddns/comments.json
|
2021-08-19 12:30:39 +02:00
|
|
|
nobase_dist_doc_DATA += examples/ddns/gss-tsig.json
|
2017-02-07 12:41:03 +01:00
|
|
|
nobase_dist_doc_DATA += examples/ddns/sample1.json
|
2015-10-29 17:51:12 +00:00
|
|
|
nobase_dist_doc_DATA += examples/ddns/template.json
|
2017-06-02 11:34:16 +02:00
|
|
|
nobase_dist_doc_DATA += examples/https/httpd2/kea-httpd2.conf
|
2017-05-29 20:29:38 +02:00
|
|
|
nobase_dist_doc_DATA += examples/https/nginx/kea-nginx.conf
|
2017-08-30 15:52:29 +02:00
|
|
|
nobase_dist_doc_DATA += examples/https/shell/kea-stunnel.conf
|
2016-12-20 15:54:23 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/advanced.json
|
2019-08-16 12:56:37 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/all-keys.json
|
|
|
|
|
nobase_dist_doc_DATA += examples/kea4/all-keys-netconf.json
|
2020-10-13 20:30:52 +03:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/all-options.json
|
2016-06-23 14:40:11 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/backends.json
|
2016-08-19 19:38:18 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/classify.json
|
2018-04-06 16:22:09 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/classify2.json
|
2017-12-03 19:23:00 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/comments.json
|
2019-05-23 09:36:21 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/config-backend.json
|
2016-12-18 09:59:12 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/dhcpv4-over-dhcpv6.json
|
2018-11-27 20:08:46 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/global-reservations.json
|
2022-08-20 19:36:07 +03:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/ha-load-balancing-server1-mt-with-tls.json
|
|
|
|
|
nobase_dist_doc_DATA += examples/kea4/ha-load-balancing-server2-mt.json
|
2015-10-29 17:51:12 +00:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/hooks.json
|
2018-04-27 07:19:05 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/hooks-radius.json
|
2015-11-12 12:48:30 +00:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/leases-expiration.json
|
2014-12-09 10:38:48 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/multiple-options.json
|
2016-08-29 15:53:56 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/mysql-reservations.json
|
2016-08-29 16:51:38 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/pgsql-reservations.json
|
2014-12-19 19:19:36 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/reservations.json
|
2015-10-29 17:51:12 +00:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/several-subnets.json
|
2017-09-13 10:59:40 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/shared-network.json
|
2015-10-29 17:51:12 +00:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/single-subnet.json
|
2017-01-12 21:16:43 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/with-ddns.json
|
2021-01-25 12:28:14 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea4/vivso.json
|
|
|
|
|
nobase_dist_doc_DATA += examples/kea4/vendor-specific.json
|
2014-12-16 20:23:24 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/advanced.json
|
2019-08-16 12:56:37 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/all-keys.json
|
|
|
|
|
nobase_dist_doc_DATA += examples/kea6/all-keys-netconf.json
|
2020-10-13 20:30:52 +03:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/all-options.json
|
2016-06-23 14:40:11 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/backends.json
|
2016-08-19 19:38:18 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/classify.json
|
2018-04-06 16:22:09 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/classify2.json
|
2017-12-03 19:23:00 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/comments.json
|
2019-05-23 09:36:21 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/config-backend.json
|
2016-12-18 09:59:12 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/dhcpv4-over-dhcpv6.json
|
|
|
|
|
nobase_dist_doc_DATA += examples/kea6/duid.json
|
2018-11-27 20:08:46 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/global-reservations.json
|
2022-08-20 19:36:07 +03:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/ha-hot-standby-server1-with-tls.json
|
|
|
|
|
nobase_dist_doc_DATA += examples/kea6/ha-hot-standby-server2.json
|
2015-10-29 17:51:12 +00:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/hooks.json
|
2017-10-19 10:27:54 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/iPXE.json
|
2015-10-26 13:58:13 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/leases-expiration.json
|
2015-10-29 17:51:12 +00:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/multiple-options.json
|
2016-08-29 16:32:51 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/mysql-reservations.json
|
2016-08-29 16:51:38 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/pgsql-reservations.json
|
2015-01-26 20:25:06 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/reservations.json
|
2015-10-29 17:51:12 +00:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/several-subnets.json
|
2017-09-13 10:59:40 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/shared-network.json
|
2015-10-29 17:51:12 +00:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/simple.json
|
2016-10-26 08:18:05 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/softwire46.json
|
2015-10-29 17:51:12 +00:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/stateless.json
|
2019-05-28 20:16:36 +02:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/tee-times.json
|
2017-01-12 21:16:43 +01:00
|
|
|
nobase_dist_doc_DATA += examples/kea6/with-ddns.json
|
2018-11-28 22:54:14 +01:00
|
|
|
nobase_dist_doc_DATA += examples/netconf/kea-dhcp6-operations/boot.json
|
|
|
|
|
nobase_dist_doc_DATA += examples/netconf/kea-dhcp6-operations/logging.xml
|
|
|
|
|
nobase_dist_doc_DATA += examples/netconf/kea-dhcp6-operations/netconf.json
|
|
|
|
|
nobase_dist_doc_DATA += examples/netconf/kea-dhcp6-operations/startup.xml
|
|
|
|
|
nobase_dist_doc_DATA += examples/netconf/kea-dhcp6-operations/twopools.xml
|
|
|
|
|
nobase_dist_doc_DATA += examples/netconf/kea-dhcp6-operations/twosubnets.xml
|
2018-09-26 23:09:16 +02:00
|
|
|
nobase_dist_doc_DATA += examples/netconf/comments.json
|
2018-09-28 14:24:25 +02:00
|
|
|
nobase_dist_doc_DATA += examples/netconf/simple-dhcp4.json
|
2018-11-28 23:21:24 +01:00
|
|
|
nobase_dist_doc_DATA += examples/netconf/simple-dhcp6.json
|
2021-06-21 19:49:24 +02:00
|
|
|
|
2021-09-23 14:22:48 +02:00
|
|
|
nobase_dist_doc_DATA += examples/template-power-user-home/info.md
|
|
|
|
|
nobase_dist_doc_DATA += examples/template-power-user-home/kea-ca-1.conf
|
|
|
|
|
nobase_dist_doc_DATA += examples/template-power-user-home/kea-ca-2.conf
|
|
|
|
|
nobase_dist_doc_DATA += examples/template-power-user-home/kea-dhcp4-1.conf
|
|
|
|
|
nobase_dist_doc_DATA += examples/template-power-user-home/kea-dhcp4-2.conf
|
|
|
|
|
|
2022-08-20 19:36:07 +03:00
|
|
|
nobase_dist_doc_DATA += examples/template-ha-mt-tls/info.md
|
|
|
|
|
nobase_dist_doc_DATA += examples/template-ha-mt-tls/kea-ca-1.conf
|
|
|
|
|
nobase_dist_doc_DATA += examples/template-ha-mt-tls/kea-ca-2.conf
|
|
|
|
|
nobase_dist_doc_DATA += examples/template-ha-mt-tls/kea-dhcp4-1.conf
|
|
|
|
|
nobase_dist_doc_DATA += examples/template-ha-mt-tls/kea-dhcp4-2.conf
|
|
|
|
|
|
2021-06-22 20:18:45 +02:00
|
|
|
# If there's any new parameter added for any grammar in one of the daemons, someone should go through
|
|
|
|
|
# this procedure:
|
|
|
|
|
#
|
|
|
|
|
# 1. autoreconf -i && ./configure --enable-generate-docs --enable-generate-parser
|
|
|
|
|
# 2. cd doc
|
|
|
|
|
# 3. make grammar
|
|
|
|
|
# 4. make -C sphinx html
|
|
|
|
|
# 5. Inspect the html output and make sure it's ok.
|
|
|
|
|
# 6. Review changes in doc/sphinx/grammar/*
|
|
|
|
|
# 7. Check in changed files in doc/sphinx/grammar/*
|
|
|
|
|
#
|
|
|
|
|
# Make sure you commit only relevant changes, skip the timestamp only updates.
|
2021-06-21 19:49:24 +02:00
|
|
|
grammar:
|
|
|
|
|
if GENERATE_DOCS
|
|
|
|
|
if GENERATE_PARSER
|
2021-06-22 15:24:01 +02:00
|
|
|
mkdir -p $(abs_top_srcdir)/doc/sphinx/grammar
|
2021-06-22 19:40:13 +02:00
|
|
|
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/dhcp4/dhcp4_parser \
|
|
|
|
|
--markdown ':ref:`dhcp4`' > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-dhcp4-parser.rst
|
|
|
|
|
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/dhcp6/dhcp6_parser \
|
|
|
|
|
--markdown ':ref:`dhcp6`' > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-dhcp6-parser.rst
|
|
|
|
|
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/d2/d2_parser \
|
|
|
|
|
--markdown ':ref:`dhcp-ddns-server`' > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-d2-parser.rst
|
|
|
|
|
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/agent/agent_parser \
|
|
|
|
|
--markdown ':ref:`kea-ctrl-agent`' > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-ca-parser.rst
|
|
|
|
|
$(abs_top_srcdir)/tools/extract_bnf.sh $(abs_top_srcdir)/src/bin/netconf/netconf_parser \
|
|
|
|
|
--markdown ':ref:`netconf`' > $(abs_top_srcdir)/doc/sphinx/grammar/grammar-netconf-parser.rst
|
2021-06-21 19:49:24 +02:00
|
|
|
else
|
|
|
|
|
@echo "ERROR: You need to enable both docs (--enable-generate-docs) and parser (--enable-generate-parser)"
|
|
|
|
|
@echo "ERROR: to regenerate grammar documentation."
|
|
|
|
|
false
|
|
|
|
|
endif
|
|
|
|
|
else
|
|
|
|
|
@echo "ERROR: You need to enable both docs (--enable-generate-docs) and parser (--enable-generate-parser)"
|
|
|
|
|
@echo "ERROR: to regenerate grammar documentation."
|
|
|
|
|
false
|
|
|
|
|
endif
|
