From: Michal Nowikowski Date: Mon, 12 Aug 2019 15:46:51 +0000 (+0200) Subject: list of api and mes files are independently available in Makefile.am and conf.py now X-Git-Tag: Kea-1.6.0~41^2~121 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4b72e2cc22b5ba446c44f16039ff460cc2884544;p=thirdparty%2Fkea.git list of api and mes files are independently available in Makefile.am and conf.py now --- diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am index 2a84bcebb3..e41ed80944 100644 --- a/doc/sphinx/Makefile.am +++ b/doc/sphinx/Makefile.am @@ -73,164 +73,16 @@ man8s=$(foreach rst,$(rst_man_sources), $(sphinxbuilddir)/$(basename $(rst))) EXTRA_DIST += $(main_sources) $(man_sources) mes2doc.py api2doc.py # list of messages files that are used to generate kea-messages.rst and then kea-messages.pdf -mes_files= -mes_files+=$(top_srcdir)/src/hooks/dhcp/mysql_cb/mysql_cb_messages.mes -mes_files+=$(top_srcdir)/src/hooks/dhcp/lease_cmds/lease_cmds_messages.mes -mes_files+=$(top_srcdir)/src/hooks/dhcp/high_availability/ha_messages.mes -mes_files+=$(top_srcdir)/src/hooks/dhcp/stat_cmds/stat_cmds_messages.mes -mes_files+=$(top_srcdir)/src/hooks/dhcp/user_chk/user_chk_messages.mes -mes_files+=$(top_srcdir)/src/lib/config/config_messages.mes -mes_files+=$(top_srcdir)/src/lib/hooks/hooks_messages.mes -mes_files+=$(top_srcdir)/src/lib/dhcpsrv/dhcpsrv_messages.mes -mes_files+=$(top_srcdir)/src/lib/dhcpsrv/alloc_engine_messages.mes -mes_files+=$(top_srcdir)/src/lib/dhcpsrv/hosts_messages.mes -mes_files+=$(top_srcdir)/src/lib/http/http_messages.mes -mes_files+=$(top_srcdir)/src/lib/dhcp_ddns/dhcp_ddns_messages.mes -mes_files+=$(top_srcdir)/src/lib/database/db_messages.mes -mes_files+=$(top_srcdir)/src/lib/log/log_messages.mes -mes_files+=$(top_srcdir)/src/lib/log/logimpl_messages.mes -mes_files+=$(top_srcdir)/src/lib/log/tests/log_test_messages.mes -mes_files+=$(top_srcdir)/src/lib/process/process_messages.mes -mes_files+=$(top_srcdir)/src/lib/asiodns/asiodns_messages.mes -mes_files+=$(top_srcdir)/src/lib/eval/eval_messages.mes -mes_files+=$(top_srcdir)/src/bin/dhcp4/dhcp4_messages.mes -mes_files+=$(top_srcdir)/src/bin/agent/ca_messages.mes -mes_files+=$(top_srcdir)/src/bin/d2/d2_messages.mes -mes_files+=$(top_srcdir)/src/bin/dhcp6/dhcp6_messages.mes -mes_files+=$(top_srcdir)/src/bin/lfc/lfc_messages.mes -mes_files+=$(top_srcdir)/src/bin/netconf/netconf_messages.mes +mes_files1=$(shell cat mes-files.txt) +mes_files=$(foreach mf,$(mes_files1), $(top_srcdir)/$(mf)) -# this env variable is used in sphinx's conf.py where mes2doc.py is invoked -export KEA_MES_FILES=$(mes_files) # list of api files that are used to generate api.rst -api_files= -api_files+=$(srcdir)/api/build-report.json -api_files+=$(srcdir)/api/cache-clear.json -api_files+=$(srcdir)/api/cache-get.json -api_files+=$(srcdir)/api/cache-get-by-id.json -api_files+=$(srcdir)/api/cache-insert.json -api_files+=$(srcdir)/api/cache-load.json -api_files+=$(srcdir)/api/cache-remove.json -api_files+=$(srcdir)/api/cache-size.json -api_files+=$(srcdir)/api/cache-write.json -api_files+=$(srcdir)/api/class-add.json -api_files+=$(srcdir)/api/class-del.json -api_files+=$(srcdir)/api/class-get.json -api_files+=$(srcdir)/api/class-list.json -api_files+=$(srcdir)/api/class-update.json -api_files+=$(srcdir)/api/config-get.json -api_files+=$(srcdir)/api/config-reload.json -api_files+=$(srcdir)/api/config-set.json -api_files+=$(srcdir)/api/config-test.json -api_files+=$(srcdir)/api/config-write.json -api_files+=$(srcdir)/api/dhcp-disable.json -api_files+=$(srcdir)/api/dhcp-enable.json -api_files+=$(srcdir)/api/ha-continue.json -api_files+=$(srcdir)/api/ha-heartbeat.json -api_files+=$(srcdir)/api/ha-scopes.json -api_files+=$(srcdir)/api/ha-sync.json -api_files+=$(srcdir)/api/lease4-add.json -api_files+=$(srcdir)/api/lease4-del.json -api_files+=$(srcdir)/api/lease4-get-all.json -api_files+=$(srcdir)/api/lease4-get.json -api_files+=$(srcdir)/api/lease4-update.json -api_files+=$(srcdir)/api/lease4-wipe.json -api_files+=$(srcdir)/api/lease6-add.json -api_files+=$(srcdir)/api/lease6-bulk-apply.json -api_files+=$(srcdir)/api/lease6-del.json -api_files+=$(srcdir)/api/lease6-get-all.json -api_files+=$(srcdir)/api/lease6-get.json -api_files+=$(srcdir)/api/lease6-update.json -api_files+=$(srcdir)/api/lease6-wipe.json -api_files+=$(srcdir)/api/leases-reclaim.json -api_files+=$(srcdir)/api/libreload.json -api_files+=$(srcdir)/api/list-commands.json -api_files+=$(srcdir)/api/network4-add.json -api_files+=$(srcdir)/api/network4-del.json -api_files+=$(srcdir)/api/network4-get.json -api_files+=$(srcdir)/api/network4-list.json -api_files+=$(srcdir)/api/network4-subnet-add.json -api_files+=$(srcdir)/api/network4-subnet-del.json -api_files+=$(srcdir)/api/network6-add.json -api_files+=$(srcdir)/api/network6-del.json -api_files+=$(srcdir)/api/network6-get.json -api_files+=$(srcdir)/api/network6-list.json -api_files+=$(srcdir)/api/network6-subnet-add.json -api_files+=$(srcdir)/api/network6-subnet-del.json -api_files+=$(srcdir)/api/remote-global-parameter4-del.json -api_files+=$(srcdir)/api/remote-global-parameter4-get-all.json -api_files+=$(srcdir)/api/remote-global-parameter4-get.json -api_files+=$(srcdir)/api/remote-global-parameter4-set.json -api_files+=$(srcdir)/api/remote-global-parameter6-del.json -api_files+=$(srcdir)/api/remote-global-parameter6-get-all.json -api_files+=$(srcdir)/api/remote-global-parameter6-get.json -api_files+=$(srcdir)/api/remote-global-parameter6-set.json -api_files+=$(srcdir)/api/remote-network4-del.json -api_files+=$(srcdir)/api/remote-network4-get.json -api_files+=$(srcdir)/api/remote-network4-list.json -api_files+=$(srcdir)/api/remote-network4-set.json -api_files+=$(srcdir)/api/remote-network6-del.json -api_files+=$(srcdir)/api/remote-network6-get.json -api_files+=$(srcdir)/api/remote-network6-list.json -api_files+=$(srcdir)/api/remote-network6-set.json -api_files+=$(srcdir)/api/remote-option-def4-del.json -api_files+=$(srcdir)/api/remote-option-def4-get-all.json -api_files+=$(srcdir)/api/remote-option-def4-get.json -api_files+=$(srcdir)/api/remote-option-def4-set.json -api_files+=$(srcdir)/api/remote-option-def6-del.json -api_files+=$(srcdir)/api/remote-option-def6-get-all.json -api_files+=$(srcdir)/api/remote-option-def6-get.json -api_files+=$(srcdir)/api/remote-option-def6-set.json -api_files+=$(srcdir)/api/remote-option4-global-del.json -api_files+=$(srcdir)/api/remote-option4-global-get-all.json -api_files+=$(srcdir)/api/remote-option4-global-get.json -api_files+=$(srcdir)/api/remote-option4-global-set.json -api_files+=$(srcdir)/api/remote-option6-global-del.json -api_files+=$(srcdir)/api/remote-option6-global-get-all.json -api_files+=$(srcdir)/api/remote-option6-global-get.json -api_files+=$(srcdir)/api/remote-option6-global-set.json -api_files+=$(srcdir)/api/remote-subnet4-del-by-id.json -api_files+=$(srcdir)/api/remote-subnet4-del-by-prefix.json -api_files+=$(srcdir)/api/remote-subnet4-get-by-id.json -api_files+=$(srcdir)/api/remote-subnet4-get-by-prefix.json -api_files+=$(srcdir)/api/remote-subnet4-list.json -api_files+=$(srcdir)/api/remote-subnet4-set.json -api_files+=$(srcdir)/api/remote-subnet6-del-by-id.json -api_files+=$(srcdir)/api/remote-subnet6-del-by-prefix.json -api_files+=$(srcdir)/api/remote-subnet6-get-by-id.json -api_files+=$(srcdir)/api/remote-subnet6-get-by-prefix.json -api_files+=$(srcdir)/api/remote-subnet6-list.json -api_files+=$(srcdir)/api/remote-subnet6-set.json -api_files+=$(srcdir)/api/reservation-add.json -api_files+=$(srcdir)/api/reservation-del.json -api_files+=$(srcdir)/api/reservation-get.json -api_files+=$(srcdir)/api/reservation-get-all.json -api_files+=$(srcdir)/api/reservation-get-page.json -api_files+=$(srcdir)/api/shutdown.json -api_files+=$(srcdir)/api/statistic-get-all.json -api_files+=$(srcdir)/api/statistic-get.json -api_files+=$(srcdir)/api/statistic-remove-all.json -api_files+=$(srcdir)/api/statistic-remove.json -api_files+=$(srcdir)/api/statistic-reset-all.json -api_files+=$(srcdir)/api/statistic-reset.json -api_files+=$(srcdir)/api/stat-lease4-get.json -api_files+=$(srcdir)/api/stat-lease6-get.json -api_files+=$(srcdir)/api/subnet4-add.json -api_files+=$(srcdir)/api/subnet4-del.json -api_files+=$(srcdir)/api/subnet4-get.json -api_files+=$(srcdir)/api/subnet4-list.json -api_files+=$(srcdir)/api/subnet4-update.json -api_files+=$(srcdir)/api/subnet6-add.json -api_files+=$(srcdir)/api/subnet6-del.json -api_files+=$(srcdir)/api/subnet6-get.json -api_files+=$(srcdir)/api/subnet6-list.json -api_files+=$(srcdir)/api/subnet6-update.json -api_files+=$(srcdir)/api/version-get.json - -# this env variable is used in sphinx's conf.py where api2doc.py is invoked -export KEA_API_FILES=$(api_files) +api_files1=$(shell cat api-files.txt) +api_files=$(foreach af,$(api_files1), $(srcdir)/$(af)) +EXTRA_DIST += mes-files.txt +EXTRA_DIST += api-files.txt EXTRA_DIST += $(api_files) if HAVE_PDFLATEX diff --git a/doc/sphinx/api-files.txt b/doc/sphinx/api-files.txt new file mode 100644 index 0000000000..3467bb9697 --- /dev/null +++ b/doc/sphinx/api-files.txt @@ -0,0 +1,122 @@ +api/build-report.json +api/cache-clear.json +api/cache-get.json +api/cache-get-by-id.json +api/cache-insert.json +api/cache-load.json +api/cache-remove.json +api/cache-size.json +api/cache-write.json +api/class-add.json +api/class-del.json +api/class-get.json +api/class-list.json +api/class-update.json +api/config-get.json +api/config-reload.json +api/config-set.json +api/config-test.json +api/config-write.json +api/dhcp-disable.json +api/dhcp-enable.json +api/ha-continue.json +api/ha-heartbeat.json +api/ha-scopes.json +api/ha-sync.json +api/lease4-add.json +api/lease4-del.json +api/lease4-get-all.json +api/lease4-get.json +api/lease4-update.json +api/lease4-wipe.json +api/lease6-add.json +api/lease6-bulk-apply.json +api/lease6-del.json +api/lease6-get-all.json +api/lease6-get.json +api/lease6-update.json +api/lease6-wipe.json +api/leases-reclaim.json +api/libreload.json +api/list-commands.json +api/network4-add.json +api/network4-del.json +api/network4-get.json +api/network4-list.json +api/network4-subnet-add.json +api/network4-subnet-del.json +api/network6-add.json +api/network6-del.json +api/network6-get.json +api/network6-list.json +api/network6-subnet-add.json +api/network6-subnet-del.json +api/remote-global-parameter4-del.json +api/remote-global-parameter4-get-all.json +api/remote-global-parameter4-get.json +api/remote-global-parameter4-set.json +api/remote-global-parameter6-del.json +api/remote-global-parameter6-get-all.json +api/remote-global-parameter6-get.json +api/remote-global-parameter6-set.json +api/remote-network4-del.json +api/remote-network4-get.json +api/remote-network4-list.json +api/remote-network4-set.json +api/remote-network6-del.json +api/remote-network6-get.json +api/remote-network6-list.json +api/remote-network6-set.json +api/remote-option-def4-del.json +api/remote-option-def4-get-all.json +api/remote-option-def4-get.json +api/remote-option-def4-set.json +api/remote-option-def6-del.json +api/remote-option-def6-get-all.json +api/remote-option-def6-get.json +api/remote-option-def6-set.json +api/remote-option4-global-del.json +api/remote-option4-global-get-all.json +api/remote-option4-global-get.json +api/remote-option4-global-set.json +api/remote-option6-global-del.json +api/remote-option6-global-get-all.json +api/remote-option6-global-get.json +api/remote-option6-global-set.json +api/remote-subnet4-del-by-id.json +api/remote-subnet4-del-by-prefix.json +api/remote-subnet4-get-by-id.json +api/remote-subnet4-get-by-prefix.json +api/remote-subnet4-list.json +api/remote-subnet4-set.json +api/remote-subnet6-del-by-id.json +api/remote-subnet6-del-by-prefix.json +api/remote-subnet6-get-by-id.json +api/remote-subnet6-get-by-prefix.json +api/remote-subnet6-list.json +api/remote-subnet6-set.json +api/reservation-add.json +api/reservation-del.json +api/reservation-get.json +api/reservation-get-all.json +api/reservation-get-page.json +api/shutdown.json +api/statistic-get-all.json +api/statistic-get.json +api/statistic-remove-all.json +api/statistic-remove.json +api/statistic-reset-all.json +api/statistic-reset.json +api/stat-lease4-get.json +api/stat-lease6-get.json +api/subnet4-add.json +api/subnet4-del.json +api/subnet4-get.json +api/subnet4-list.json +api/subnet4-update.json +api/subnet6-add.json +api/subnet6-del.json +api/subnet6-get.json +api/subnet6-list.json +api/subnet6-update.json +api/version-get.json diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 482f047c72..8a68b8a266 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -193,10 +193,16 @@ def run_generate_docs(_): sys.path.append(src_dir) import api2doc - api2doc.generate(os.getenv('KEA_API_FILES').split(), os.path.join(src_dir, 'api.rst')) + with open(os.path.join(src_dir, 'api-files.txt')) as af: + api_files = af.read().split() + api_files = [os.path.abspath(os.path.join(src_dir, af)) for af in api_files] + api2doc.generate(api_files, os.path.join(src_dir, 'api.rst')) import mes2doc - mes2doc.generate(os.getenv('KEA_MES_FILES').split(), os.path.join(src_dir, 'kea-messages.rst')) + with open(os.path.join(src_dir, 'mes-files.txt')) as mf: + mes_files = mf.read().split() + mes_files = [os.path.abspath(os.path.join(src_dir, '../..', mf)) for mf in mes_files] + mes2doc.generate(mes_files, os.path.join(src_dir, 'kea-messages.rst')) # custom setup hook diff --git a/doc/sphinx/mes-files.txt b/doc/sphinx/mes-files.txt new file mode 100644 index 0000000000..11b5feae5a --- /dev/null +++ b/doc/sphinx/mes-files.txt @@ -0,0 +1,25 @@ +src/hooks/dhcp/mysql_cb/mysql_cb_messages.mes +src/hooks/dhcp/lease_cmds/lease_cmds_messages.mes +src/hooks/dhcp/high_availability/ha_messages.mes +src/hooks/dhcp/stat_cmds/stat_cmds_messages.mes +src/hooks/dhcp/user_chk/user_chk_messages.mes +src/lib/config/config_messages.mes +src/lib/hooks/hooks_messages.mes +src/lib/dhcpsrv/dhcpsrv_messages.mes +src/lib/dhcpsrv/alloc_engine_messages.mes +src/lib/dhcpsrv/hosts_messages.mes +src/lib/http/http_messages.mes +src/lib/dhcp_ddns/dhcp_ddns_messages.mes +src/lib/database/db_messages.mes +src/lib/log/log_messages.mes +src/lib/log/logimpl_messages.mes +src/lib/log/tests/log_test_messages.mes +src/lib/process/process_messages.mes +src/lib/asiodns/asiodns_messages.mes +src/lib/eval/eval_messages.mes +src/bin/dhcp4/dhcp4_messages.mes +src/bin/agent/ca_messages.mes +src/bin/d2/d2_messages.mes +src/bin/dhcp6/dhcp6_messages.mes +src/bin/lfc/lfc_messages.mes +src/bin/netconf/netconf_messages.mes diff --git a/hammer.py b/hammer.py index 92ac5af789..5deed30329 100755 --- a/hammer.py +++ b/hammer.py @@ -162,7 +162,7 @@ def get_system_revision(): """Return tuple containing system name and its revision.""" system = platform.system() if system == 'Linux': - system, revision, _ = platform.dist() # pylit: disable=deprecated-method + system, revision, _ = platform.dist() # pylint: disable=deprecated-method if system == 'debian': revision = revision.split('.')[0] elif system == 'redhat':