mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-05-28 18:58:15 +02:00
5e4632f021
Improve documentation by preserving paragraphs in the nm-settings-nmcli man pages. To do that structure of src/libnm-client-impl/nm-settings-docs-gir.xml was changed to have "description" as subnode to property node instead of attribute of property node. Another subnode "description-docbook" was added - this node is then used when generating man pages. tools/generate-docs-nm-settings-docs-gir.py and man/nm-settings-dbus.xsl were also changed to accomodate for changes mentioned above. Replace xsltproc tool with python script when generating ./src/libnmc-setting/settings-docs.h. Deleted settings-docs.xsl since it was replaced by python script. Change src/libnmc-setting/settings-docs.h.in accodring to newly generated src/libnmc-setting/settings-docs.h https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues/661 https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/1260
58 lines
1.5 KiB
Meson
58 lines
1.5 KiB
Meson
# SPDX-License-Identifier: LGPL-2.1-or-later
|
|
|
|
if enable_docs
|
|
assert(enable_introspection, '-Ddocs=true requires -Dintrospection=true')
|
|
settings_docs_input_xml = custom_target(
|
|
'settings-docs-input.xml',
|
|
input: [nm_settings_docs_xml_gir, nm_property_infos_xml['nmcli']],
|
|
output: 'settings-docs-input.xml',
|
|
command: [
|
|
python.path(),
|
|
join_paths(meson.source_root(), 'tools', 'generate-docs-nm-settings-docs-merge.py'),
|
|
'@OUTPUT@',
|
|
nm_property_infos_xml['nmcli'],
|
|
nm_settings_docs_xml_gir,
|
|
],
|
|
)
|
|
|
|
settings_docs_source = custom_target(
|
|
'settings-docs.h',
|
|
input: settings_docs_input_xml,
|
|
output: 'settings-docs.h',
|
|
command: [
|
|
python.path(),
|
|
join_paths(meson.source_root(), 'tools', 'generate-docs-settings-docs.py'),
|
|
'--output', '@OUTPUT@',
|
|
'--xml', '@INPUT@'
|
|
],
|
|
)
|
|
|
|
test(
|
|
'check-settings-docs',
|
|
find_program(join_paths(source_root, 'tools', 'check-compare-generated.sh')),
|
|
args: [
|
|
source_root,
|
|
build_root,
|
|
'src/libnmc-setting/settings-docs.h',
|
|
],
|
|
)
|
|
else
|
|
settings_docs_source = configure_file(
|
|
input: 'settings-docs.h.in',
|
|
output: '@BASENAME@',
|
|
configuration: configuration_data(),
|
|
)
|
|
endif
|
|
|
|
libnmc_setting = static_library(
|
|
'nmc-setting',
|
|
sources: [settings_docs_source] + files(
|
|
'nm-meta-setting-access.c',
|
|
'nm-meta-setting-base-impl.c',
|
|
'nm-meta-setting-desc.c',
|
|
),
|
|
dependencies: [
|
|
libnm_dep,
|
|
],
|
|
link_depends: settings_docs_source,
|
|
)
|