From a9001261fbc0c7d8a51ed56e8cd3c5e880f0443b Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Thu, 28 May 2020 13:51:56 +0200 Subject: [PATCH] docs: rename "nm-property-infos" doc files The naming was inconsistent. Rename. - all the property infos of this kind a now consistently called "libnm/nm-property-infos-$TAG.xml". - the script to generate files "libnm/nm-property-infos-$TAG.xml" is now called "libnm/generate-docs-nm-property-infos.pl". --- .gitignore | 9 ++- Makefile.am | 31 ++++----- ....pl => generate-docs-nm-property-infos.pl} | 0 libnm/meson.build | 65 ++++++++++++------- man/meson.build | 4 +- 5 files changed, 64 insertions(+), 45 deletions(-) rename libnm/{generate-plugin-docs.pl => generate-docs-nm-property-infos.pl} (100%) diff --git a/.gitignore b/.gitignore index cfb77444e8..e3c7cd895f 100644 --- a/.gitignore +++ b/.gitignore @@ -147,11 +147,11 @@ test-*.trs /libnm-core/nm-dbus-types.xml /libnm-core/nm-vpn-dbus-types.xml -/libnm/nm-settings-ifcfg-rh-docs.xml /libnm/nm-property-docs.xml +/libnm/nm-property-infos-dbus.xml +/libnm/nm-property-infos-ifcfg-rh.xml +/libnm/nm-property-infos-keyfile.xml /libnm/nm-settings-docs.xml -/libnm/nm-settings-docs-overrides.xml -/libnm/nm-settings-keyfile-docs.xml /libnm/tests/test-libnm /libnm/tests/test-nm-client /libnm/tests/test-remote-settings-client @@ -327,6 +327,9 @@ test-*.trs /libnm/nm-keyfile-docs.xml /libnm/nm-setting-docs-overrides.xml /libnm/nm-setting-docs.xml +/libnm/nm-settings-docs-overrides.xml +/libnm/nm-settings-ifcfg-rh-docs.xml +/libnm/nm-settings-keyfile-docs.xml /libnm/tests/test-general /policy/org.freedesktop.NetworkManager.policy /policy/org.freedesktop.NetworkManager.policy.in diff --git a/Makefile.am b/Makefile.am index 8406a5af62..78c7a30932 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1554,17 +1554,18 @@ INTROSPECTION_GIRS += libnm/NM-1.0.gir libnm_noinst_data = \ libnm/nm-property-docs.xml \ - libnm/nm-settings-docs-overrides.xml \ + libnm/nm-property-infos-dbus.xml \ + libnm/nm-property-infos-ifcfg-rh.xml \ + libnm/nm-property-infos-keyfile.xml \ libnm/nm-settings-docs.xml \ - libnm/nm-settings-keyfile-docs.xml \ - libnm/nm-settings-ifcfg-rh-docs.xml + $(NULL) noinst_DATA += $(libnm_noinst_data) libnm_docs_sources = $(libnm_core_lib_c_settings_real) -libnm/nm-settings-docs-overrides.xml: libnm/generate-plugin-docs.pl $(libnm_docs_sources) - $(AM_V_GEN) $(srcdir)/libnm/generate-plugin-docs.pl dbus $@ $(filter-out $<,$^) +libnm/nm-property-infos-%.xml: libnm/generate-docs-nm-property-infos.pl $(libnm_docs_sources) + $(AM_V_GEN) $(srcdir)/libnm/generate-docs-nm-property-infos.pl $(patsubst nm-property-infos-%.xml,%,$(notdir $@)) $@ $(filter-out $<,$^) # When the python scripts loads libnm and the address sanitizers is # enabled, we must LD_PRELOAD libasan otherwise it will complain that @@ -1579,25 +1580,21 @@ libnm/nm-property-docs.xml: libnm/generate-setting-docs.py $(libnm_docs_sources) --gir $(builddir)/libnm/NM-1.0.gir \ --output $@ -libnm/nm-settings-docs.xml: libnm/nm-settings-docs-overrides.xml libnm/nm-property-docs.xml libnm/generate-docs-nm-settings-docs-merge.py +libnm/nm-settings-docs.xml: libnm/nm-property-infos-dbus.xml libnm/nm-property-docs.xml libnm/generate-docs-nm-settings-docs-merge.py $(AM_V_GEN) "$(PYTHON)" $(srcdir)/libnm/generate-docs-nm-settings-docs-merge.py $@ $(wordlist 1,2,$^) -libnm/nm-settings-keyfile-docs.xml: libnm/generate-plugin-docs.pl $(libnm_docs_sources) - $(AM_V_GEN) $(srcdir)/libnm/generate-plugin-docs.pl keyfile $@ $(filter-out $<,$^) -libnm/nm-settings-ifcfg-rh-docs.xml: libnm/generate-plugin-docs.pl $(libnm_docs_sources) - $(AM_V_GEN) $(srcdir)/libnm/generate-plugin-docs.pl ifcfg-rh $@ $(filter-out $<,$^) - EXTRA_DIST += $(libnm_noinst_data) endif EXTRA_DIST += \ - libnm/generate-plugin-docs.pl \ + libnm/generate-docs-nm-property-infos.pl \ libnm/generate-docs-nm-settings-docs-merge.py \ libnm/generate-setting-docs.py \ + libnm/meson.build \ libnm/nm-enum-types.c.template \ libnm/nm-enum-types.h.template \ - libnm/meson.build + $(NULL) ############################################################################### @@ -4966,11 +4963,15 @@ endif man_nm_settings_xml = \ man/nm-settings.xml \ man/nm-settings-keyfile.xml \ - man/nm-settings-ifcfg-rh.xml + man/nm-settings-ifcfg-rh.xml \ + $(NULL) if HAVE_INTROSPECTION -man/nm-setting%.xml: man/nm-setting%.xsl libnm/nm-setting%-docs.xml man/common.ent +man/nm-settings.xml: man/nm-settings.xsl libnm/nm-settings-docs.xml man/common.ent + $(AM_V_GEN) $(XSLTPROC) --output $@ $(xsltproc_flags) $< $(word 2,$^) + +man/nm-settings-%.xml: man/nm-settings-%.xsl libnm/nm-property-infos-%.xml man/common.ent $(AM_V_GEN) $(XSLTPROC) --output $@ $(xsltproc_flags) $< $(word 2,$^) CLEANFILES += $(man_nm_settings_xml) diff --git a/libnm/generate-plugin-docs.pl b/libnm/generate-docs-nm-property-infos.pl similarity index 100% rename from libnm/generate-plugin-docs.pl rename to libnm/generate-docs-nm-property-infos.pl diff --git a/libnm/meson.build b/libnm/meson.build index 1e8a4b388c..66fce80c8b 100644 --- a/libnm/meson.build +++ b/libnm/meson.build @@ -212,32 +212,47 @@ if enable_introspection install: true, ) - generate_plugin_docs = join_paths(meson.current_source_dir(), 'generate-plugin-docs.pl') - - name = 'nm-settings-keyfile-docs.xml' - nm_settings_keyfile_docs = custom_target( - name, - input: libnm_core_settings_sources, - output: name, - command: [perl, generate_plugin_docs, 'keyfile', '@OUTPUT@', '@INPUT@'], - ) - - name = 'nm-settings-docs-overrides.xml' - nm_settings_docs_overrides = custom_target( - name, - input: libnm_core_settings_sources, - output: name, - command: [perl, generate_plugin_docs, 'dbus', '@OUTPUT@', '@INPUT@'], - ) - + infos = [ 'dbus', 'keyfile' ] if enable_ifcfg_rh - name = 'nm-settings-ifcfg-rh-docs.xml' - nm_settings_ifcfg_rh_docs = custom_target( - name, + infos += [ 'ifcfg-rh' ] + endif + foreach info: infos + t = custom_target( + 'nm-propery-infos-' + info + '.xml', input: libnm_core_settings_sources, - output: name, - command: [perl, generate_plugin_docs, 'ifcfg-rh', '@OUTPUT@', '@INPUT@'], + output: 'nm-propery-infos-' + info + '.xml', + command: [ + perl, + join_paths(meson.current_source_dir(), 'generate-docs-nm-property-infos.pl'), + info, + '@OUTPUT@', + '@INPUT@' + ], ) + + # meson 0.47 doesn't support non-static keys for dicts + # nor extending dicts incrementally. Workaround. + if info == 'dbus' + nm_property_infos_xml_dbus = t + elif info == 'keyfile' + nm_property_infos_xml_keyfile = t + elif info == 'ifcfg-rh' + nm_property_infos_xml_ifcfg_rh = t + else + assert(false) + endif + endforeach + if enable_ifcfg_rh + nm_property_infos_xml = { + 'dbus': nm_property_infos_xml_dbus, + 'keyfile': nm_property_infos_xml_keyfile, + 'ifcfg-rh': nm_property_infos_xml_ifcfg_rh, + } + else + nm_property_infos_xml = { + 'dbus': nm_property_infos_xml_dbus, + 'keyfile': nm_property_infos_xml_keyfile, + } endif gi_typelib_path = run_command('printenv', 'GI_TYPELIB_PATH').stdout() @@ -277,13 +292,13 @@ if enable_introspection name = 'nm-settings-docs.xml' nm_settings_docs = custom_target( name, - input: [nm_property_docs, nm_settings_docs_overrides], + input: [nm_property_docs, nm_property_infos_xml['dbus']], output: name, command: [ python.path(), join_paths(meson.current_source_dir(), 'generate-docs-nm-settings-docs-merge.py'), '@OUTPUT@', - nm_settings_docs_overrides, + nm_property_infos_xml['dbus'], nm_property_docs, ], depends: libnm_gir, diff --git a/man/meson.build b/man/meson.build index 407d027e90..24e6a6dc20 100644 --- a/man/meson.build +++ b/man/meson.build @@ -57,12 +57,12 @@ endforeach if enable_introspection mans = [ - ['nm-settings-keyfile', '5', nm_settings_keyfile_docs], + ['nm-settings-keyfile', '5', nm_property_infos_xml['keyfile']], ['nm-settings', '5', nm_settings_docs], ] if enable_ifcfg_rh - mans += [['nm-settings-ifcfg-rh', '5', nm_settings_ifcfg_rh_docs]] + mans += [['nm-settings-ifcfg-rh', '5', nm_property_infos_xml['ifcfg-rh']]] endif foreach man: mans