system/NetworkManager
system/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager synced 2024-07-22 02:35:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: rename "nm-property-docs.xml" to "nm-settings-docs-gir.xml"

Browse source 
The name is bad. For one, we will have more files of the same format
("nm-settings-docs-nmcli.xml").

Also, "libnm/nm-settings-docs.xml" and "libnm/nm-property-docs.xml" had
basically the same file format. Their name should be similar.

Also the tool to generate the file should have a name that reminds to
the file that it creates.
This commit is contained in:
Thomas Haller 2020-05-28 19:09:12 +02:00
parent a9001261fb
commit 960ab39739
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
5 changed files with 20 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.gitignore vendored
View file

@ -147,10 +147,10 @@ test-*.trs
/libnm-core/nm-dbus-types.xml
/libnm-core/nm-vpn-dbus-types.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-gir.xml
/libnm/nm-settings-docs.xml
/libnm/tests/test-libnm
/libnm/tests/test-nm-client
@ -325,6 +325,7 @@ test-*.trs
/libnm/fake-typelib/typelibs.c
/libnm/nm-ifcfg-rh-docs.xml
/libnm/nm-keyfile-docs.xml
/libnm/nm-property-docs.xml
/libnm/nm-setting-docs-overrides.xml
/libnm/nm-setting-docs.xml
/libnm/nm-settings-docs-overrides.xml

16
Makefile.am
View file

@ -1553,10 +1553,10 @@ libnm/libnm.typelib: libnm/libnm.gir
INTROSPECTION_GIRS += libnm/NM-1.0.gir
libnm_noinst_data = \
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-gir.xml \
libnm/nm-settings-docs.xml \
$(NULL)
@ -1567,30 +1567,28 @@ libnm_docs_sources = $(libnm_core_lib_c_settings_real)
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
# it was not loaded as initial library.
libnm/nm-property-docs.xml: libnm/generate-setting-docs.py $(libnm_docs_sources) | libnm/NM-1.0.gir libnm/NM-1.0.typelib libnm/libnm.la
libnm/nm-settings-docs-gir.xml: libnm/generate-docs-nm-settings-docs-gir.py libnm/NM-1.0.gir libnm/NM-1.0.typelib libnm/libnm.la $(libnm_docs_sources)
$(AM_V_GEN) \
export GI_TYPELIB_PATH=$(abs_builddir)/libnm$${GI_TYPELIB_PATH:+:$$GI_TYPELIB_PATH}; \
export LD_LIBRARY_PATH=$(abs_builddir)/libnm/.libs$${LD_LIBRARY_PATH:+:$$LD_LIBRARY_PATH}; \
$(call set_sanitizer_env,$(abs_builddir)/libnm/.libs/libnm.so); \
"$(PYTHON)" \
$(srcdir)/libnm/generate-setting-docs.py \
$(srcdir)/libnm/generate-docs-nm-settings-docs-gir.py \
--gir $(builddir)/libnm/NM-1.0.gir \
--output $@
libnm/nm-settings-docs.xml: libnm/nm-property-infos-dbus.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-settings-docs-gir.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,$^)
EXTRA_DIST += $(libnm_noinst_data)
DISTCLEANFILES += $(libnm_noinst_data)
endif
EXTRA_DIST += \
libnm/generate-docs-nm-property-infos.pl \
libnm/generate-docs-nm-settings-docs-merge.py \
libnm/generate-setting-docs.py \
libnm/generate-docs-nm-settings-docs-gir.py \
libnm/meson.build \
libnm/nm-enum-types.c.template \
libnm/nm-enum-types.h.template \
@ -4366,7 +4364,7 @@ $(clients_common_libnmc_base_la_OBJECTS): clients/common/.dirstamp
clients_common_settings_doc_h = clients/common/settings-docs.h
if HAVE_INTROSPECTION
$(clients_common_settings_doc_h): clients/common/settings-docs.xsl libnm/nm-property-docs.xml clients/common/.dirstamp
$(clients_common_settings_doc_h): clients/common/settings-docs.xsl libnm/nm-settings-docs-gir.xml clients/common/.dirstamp
$(AM_V_GEN) $(XSLTPROC) --output $@ $< $(word 2,$^)
DISTCLEANFILES += $(clients_common_settings_doc_h)
check-local-settings-docs: $(clients_common_settings_doc_h)

2
clients/common/meson.build
View file

@ -34,7 +34,7 @@ settings_docs = 'settings-docs.h'
if enable_introspection
settings_docs_source = custom_target(
settings_docs,
input: nm_property_docs,
input: nm_settings_docs_xml['gir'],
output: settings_docs,
command: [xsltproc, '--output', '@OUTPUT@', join_paths(meson.current_source_dir(), 'settings-docs.xsl'), '@INPUT@'],
)

0
libnm/generate-setting-docs.py → libnm/generate-docs-nm-settings-docs-gir.py
View file

17
libnm/meson.build
View file

@ -273,15 +273,14 @@ if enable_introspection
'LD_LIBRARY_PATH=' + ld_library_path,
]
name = 'nm-property-docs.xml'
nm_property_docs = custom_target(
name,
nm_settings_docs_xml_gir = custom_target(
'nm-settings-docs-gir.xml',
input: libnm_gir[0],
output: name,
output: 'nm-settings-docs-gir.xml',
command: [
generate_setting_docs_env,
python.path(),
join_paths(meson.current_source_dir(), 'generate-setting-docs.py'),
join_paths(meson.current_source_dir(), 'generate-docs-nm-settings-docs-gir.py'),
'--lib-path', meson.current_build_dir(),
'--gir', '@INPUT@',
'--output', '@OUTPUT@'
@ -289,17 +288,21 @@ if enable_introspection
depends: libnm_gir,
)
nm_settings_docs_xml = {
'gir': nm_settings_docs_xml_gir,
}
name = 'nm-settings-docs.xml'
nm_settings_docs = custom_target(
name,
input: [nm_property_docs, nm_property_infos_xml['dbus']],
input: [nm_settings_docs_xml_gir, 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_property_infos_xml['dbus'],
nm_property_docs,
nm_settings_docs_xml_gir,
],
depends: libnm_gir,
)