fdo-mirrors/dbus
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/dbus/dbus.git synced 2025-12-23 00:10:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
dbus/doc/CMakeLists.txt

230 lines
8.9 KiB
Text
Raw Normal View History

Fix broken meinproc4 based docbook generating by already used xsltproc Using xsltproc helps to reduce manual editing of xml doc and avoids cyclic dependency (kdelibs depends on dbus and dbus depends on kdelibs). It is available on all platforms (in the opposite to xmlto) and supports freedesktop CI out of the box. This commit adds docbook-xml and docbook-xsl as new dependency for cmake and removes obsolate xmlto support, which depends on xsltproc.
2018-11-20 14:06:17 +01:00
#
# api documentation
#
* cmake: added doxygen support
2007-03-14 00:16:05 +00:00
find_package(Doxygen)
Update doxygen doc only if an associated source or Doxyfile has been changed Use doxygen.stamp as output for generating doxygen doc similar to autotools.
2019-01-25 19:05:47 +01:00
# always check doc target
Cleanup of cmake doc-related targets There is now a top-level target "doc" that is always built. Depending on the detected generators it depends on optional targets like apidoc' and 'devhelp2'.
2018-11-20 13:56:39 +01:00
add_custom_target(doc ALL)
* cmake: added doxygen support
2007-03-14 00:16:05 +00:00
if(DOXYGEN_EXECUTABLE)
Adjust indents of CMakeLists.txt files always to 4 spaces
2019-01-24 08:57:55 +01:00
option(DBUS_ENABLE_DOXYGEN_DOCS "build DOXYGEN documentation (requires Doxygen)" ON)
cmake: rename tristateoption() to add_auto_option() and make signature compatible to option()
2020-05-18 12:02:36 +02:00
add_auto_option(ENABLE_QT_HELP "build qt help documentation (requires qhelpgenerator(-qt5)); set INSTALL_QCH_DIR for custom qch installation path" AUTO)
Remove obsolete parameter in end... cmake keywords
2019-01-24 08:12:19 +01:00
endif()
* cmake: added doxygen support
2007-03-14 00:16:05 +00:00
Remove spaces between cmake command and opening bracket
2019-01-24 08:11:00 +01:00
if(DBUS_ENABLE_DOXYGEN_DOCS)
set(top_srcdir ${CMAKE_SOURCE_DIR})
Make the output directory used by doxygen absolute to avoid dependency on a particular working directory
2019-01-24 00:07:07 +01:00
set(top_builddir ${CMAKE_BINARY_DIR})
Do not let doxygen build man pages on Windows This fixes an issue on gitlab CI not been able to create man page output dir. Also man pages does not make sense on Windows.
2019-03-13 10:13:09 +01:00
if(WIN32)
set(DBUS_GENERATE_MAN NO)
else()
set(DBUS_GENERATE_MAN YES)
endif()
Add support to generate the api documentation in Qt help format Qt help files are used by Qt Creator and KDevelop, for example, to support the development of Qt-based applications and libraries. Generating api documentation in Qt help format is controlled by two user specific options named --enable-qt-help and --with-qchdir (autotools) and -DENABLE_QT_HELP and -DINSTALL_QCH_DIR (cmake).
2020-04-28 19:03:59 +02:00
if(NOT DEFINED INSTALL_QCH_DIR)
set(INSTALL_QCH_DIR ${CMAKE_INSTALL_DATADIR}/doc/dbus)
endif()
find_program(QHELPGENERATOR_EXECUTABLE NAMES qhelpgenerator qhelpgenerator-qt5)
cmake: Add macro check_auto_option() as an addition to add_auto_option() check_auto_option() checks the values given to an auto-option and prints a fatal error in case of invalid combinations.
2020-05-18 12:51:03 +02:00
check_auto_option(ENABLE_QT_HELP "Qt help" QHELPGENERATOR_EXECUTABLE "qhelpgenerator")
Add support to generate the api documentation in Qt help format Qt help files are used by Qt Creator and KDevelop, for example, to support the development of Qt-based applications and libraries. Generating api documentation in Qt help format is controlled by two user specific options named --enable-qt-help and --with-qchdir (autotools) and -DENABLE_QT_HELP and -DINSTALL_QCH_DIR (cmake).
2020-04-28 19:03:59 +02:00
if(ENABLE_QT_HELP AND QHELPGENERATOR_EXECUTABLE)
message(STATUS "${QHELPGENERATOR_EXECUTABLE} found")
set(DOXYGEN_GENERATE_QHP YES)
set(DOXYGEN_QHG_LOCATION ${QHELPGENERATOR_EXECUTABLE})
set(DOXYGEN_QCH_FILE ${CMAKE_CURRENT_BINARY_DIR}/api/qch/dbus-${VERSION}.qch)
set(DBUS_ENABLE_QTHELP_DOCS ON PARENT_SCOPE)
install(FILES ${DOXYGEN_QCH_FILE} DESTINATION ${INSTALL_QCH_DIR})
else()
set(DOXYGEN_GENERATE_QHP NO)
set(DBUS_ENABLE_QTHELP_DOCS OFF PARENT_SCOPE)
endif()
Move cmake related build system to top level Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2019-01-10 19:42:52 +01:00
configure_file(../Doxyfile.in ${CMAKE_BINARY_DIR}/Doxyfile )
Update doxygen doc only if an associated source or Doxyfile has been changed Use doxygen.stamp as output for generating doxygen doc similar to autotools.
2019-01-25 19:05:47 +01:00
file(GLOB dbus_files "${CMAKE_SOURCE_DIR}/dbus/*.[ch]*")
Add generating dbus.devhelp2 to cmake build system
2018-11-16 23:01:03 +01:00
add_custom_command(
Update doxygen doc only if an associated source or Doxyfile has been changed Use doxygen.stamp as output for generating doxygen doc similar to autotools.
2019-01-25 19:05:47 +01:00
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/doxygen.stamp
DEPENDS ${CMAKE_SOURCE_DIR}/Doxyfile.in ${CMAKE_BINARY_DIR}/Doxyfile ${dbus_files}
Try to fix doxygen error on CI reporting "Output directory ... does not exist and cannot be created"
2019-01-25 22:11:46 +01:00
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/api/html
cmake: Create all output directories for Doxygen CI builds intermittently fail with error: Could not create output directory /.../doc/api/xml or error: Could not create output directory /.../doc/api/man Fixes: https://gitlab.freedesktop.org/dbus/dbus/issues/266 Signed-off-by: Simon McVittie <smcv@collabora.com>
2019-04-25 12:22:13 +01:00
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/api/man
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/api/xml
* cmake: added doxygen support
2007-03-14 00:16:05 +00:00
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile
Update doxygen doc only if an associated source or Doxyfile has been changed Use doxygen.stamp as output for generating doxygen doc similar to autotools.
2019-01-25 19:05:47 +01:00
COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/doxygen.stamp
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen"
* cmake: added doxygen support
2007-03-14 00:16:05 +00:00
)
Cleanup of cmake doc-related targets There is now a top-level target "doc" that is always built. Depending on the detected generators it depends on optional targets like apidoc' and 'devhelp2'.
2018-11-20 13:56:39 +01:00
add_custom_target(apidoc
Update doxygen doc only if an associated source or Doxyfile has been changed Use doxygen.stamp as output for generating doxygen doc similar to autotools.
2019-01-25 19:05:47 +01:00
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/doxygen.stamp
Cleanup of cmake doc-related targets There is now a top-level target "doc" that is always built. Depending on the detected generators it depends on optional targets like apidoc' and 'devhelp2'.
2018-11-20 13:56:39 +01:00
)
add_dependencies(doc apidoc)
Install devhelp2 and api doc with cmake Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2019-01-15 11:56:36 +01:00
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/api/html/ DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/dbus/api)
Remove obsolete parameter in end... cmake keywords
2019-01-24 08:12:19 +01:00
endif()
* cmake\doc\CMakeLists.txt: added prelimary xml doc support, needs cmake find script.
2007-03-15 12:10:07 +00:00
Add generating dbus.devhelp2 to cmake build system
2018-11-16 23:01:03 +01:00
find_program(XSLTPROC_EXECUTABLE xsltproc)
if(XSLTPROC_EXECUTABLE)
message(STATUS "${XSLTPROC_EXECUTABLE} found")
set(DBUS_HAVE_XSLTPROC 1)
endif()
cmake: Don't build dbus.devhelp2 if Doxygen is disabled Previously this would be attempted whenever xsltproc was found, but would fail if Doxygen documentation was disabled.
2020-02-20 11:04:25 +01:00
if(DBUS_HAVE_XSLTPROC AND DBUS_ENABLE_DOXYGEN_DOCS)
Add generating dbus.devhelp2 to cmake build system
2018-11-16 23:01:03 +01:00
add_custom_command(
Cleanup dbus.devhelp2 make target pathes Use absolute paths to avoid confusion about where the associated file is located.
2019-01-25 18:57:16 +01:00
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/dbus.devhelp2
COMMAND ${XSLTPROC_EXECUTABLE}
-o ${CMAKE_CURRENT_BINARY_DIR}/dbus.devhelp2
${CMAKE_CURRENT_SOURCE_DIR}/doxygen_to_devhelp.xsl
${CMAKE_CURRENT_BINARY_DIR}/api/xml/index.xml
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/doxygen_to_devhelp.xsl
Update doxygen doc only if an associated source or Doxyfile has been changed Use doxygen.stamp as output for generating doxygen doc similar to autotools.
2019-01-25 19:05:47 +01:00
${CMAKE_CURRENT_BINARY_DIR}/doxygen.stamp
Add generating dbus.devhelp2 to cmake build system
2018-11-16 23:01:03 +01:00
)
Add target devhelp2 only when xsltproc has been found It doesn't make sense to add a make target if it can't be created.
2019-01-25 18:42:16 +01:00
add_custom_target(devhelp2
Target devhelp2 does not require dependencies that have already been specified in dbus.devhelp2
2019-01-25 18:57:43 +01:00
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/dbus.devhelp2
Add target devhelp2 only when xsltproc has been found It doesn't make sense to add a make target if it can't be created.
2019-01-25 18:42:16 +01:00
)
add_dependencies(doc devhelp2)
Install devhelp2 and api doc with cmake Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2019-01-15 11:56:36 +01:00
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/dbus.devhelp2 DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/dbus)
Add generating dbus.devhelp2 to cmake build system
2018-11-16 23:01:03 +01:00
endif()
fixed xml doc generating for cmake build system - supported docbook generator is currently kde's meinproc4, xmlto may also work but need still some checks
2010-02-10 09:26:52 +01:00
#
Fix broken meinproc4 based docbook generating by already used xsltproc Using xsltproc helps to reduce manual editing of xml doc and avoids cyclic dependency (kdelibs depends on dbus and dbus depends on kdelibs). It is available on all platforms (in the opposite to xmlto) and supports freedesktop CI out of the box. This commit adds docbook-xml and docbook-xsl as new dependency for cmake and removes obsolate xmlto support, which depends on xsltproc.
2018-11-20 14:06:17 +01:00
# docbook based documentation
fixed xml doc generating for cmake build system - supported docbook generator is currently kde's meinproc4, xmlto may also work but need still some checks
2010-02-10 09:26:52 +01:00
#
Fix broken meinproc4 based docbook generating by already used xsltproc Using xsltproc helps to reduce manual editing of xml doc and avoids cyclic dependency (kdelibs depends on dbus and dbus depends on kdelibs). It is available on all platforms (in the opposite to xmlto) and supports freedesktop CI out of the box. This commit adds docbook-xml and docbook-xsl as new dependency for cmake and removes obsolate xmlto support, which depends on xsltproc.
2018-11-20 14:06:17 +01:00
find_package(DocBookXSL)
if(DOCBOOKXSL_DIR AND XSLTPROC_EXECUTABLE)
option(DBUS_ENABLE_XML_DOCS "build XML documentation" ON)
set(DBUS_XML_DOCS_ENABLED 1)
message(STATUS "xsltproc docbook generator found")
add_custom_target(xmldoc)
add_dependencies(doc xmldoc)
endif()
if(DBUS_ENABLE_XML_DOCS)
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
#
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
# generate output file from docbook xml source template or file
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
#
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
# @param _target base name for the generated file
# @param TEMPLATE <file> docbook xml template file to generated the output from
# (with '@var@' variable substitution)
# @param SOURCE <file> alternative docbook xml file to generated the output from
# (without variable substitution)
# @param MAN_CATEGORY <cat> category for creating man pages (also used for html output)
# @param FORMATS <formats> list with output formats to generate ('html' and/or 'man')
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
#
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
macro(add_docbook _target)
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
set(options)
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
set(oneValueArgs SOURCE TEMPLATE MAN_CATEGORY)
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
set(multiValueArgs FORMATS)
cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
foreach(_format ${ARGS_FORMATS})
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
if(ARGS_TEMPLATE)
set(_xmlfile "${CMAKE_CURRENT_BINARY_DIR}/${_target}-${_format}.xml")
get_filename_component(_infile ${ARGS_TEMPLATE} ABSOLUTE)
configure_file(${_infile} ${_xmlfile})
else()
get_filename_component(_infile ${ARGS_SOURCE} ABSOLUTE)
set(_xmlfile ${_infile})
endif()
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
if(${_format} STREQUAL "man")
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
set(_outname "${_target}.${ARGS_MAN_CATEGORY}")
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
set(STYLESHEET "${DOCBOOKXSL_DIR}/manpages/docbook.xsl")
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
set(INSTALL_DIR ${CMAKE_INSTALL_DATADIR}/man/man${ARGS_MAN_CATEGORY})
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
else()
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
set(_outname "${_target}.${ARGS_MAN_CATEGORY}.html")
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
set(STYLESHEET "${DOCBOOKXSL_DIR}/html/docbook.xsl")
set(INSTALL_DIR ${CMAKE_INSTALL_DATADIR}/doc/dbus)
endif()
set(_outfile ${CMAKE_CURRENT_BINARY_DIR}/${_outname})
add_custom_command(
OUTPUT ${_outfile}
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
COMMAND ${XSLTPROC_EXECUTABLE} --output ${_outfile} --nonet --xinclude --param passivetex.extensions '1' --param generate.consistent.ids '1' ${STYLESHEET} ${_xmlfile}
DEPENDS ${XSLTPROC_EXECUTABLE} ${_xmlfile}
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
cmake: fix for ninja phony cycle related configuring errors A prefix has been added to the custom target names in docbook-related macros to fix the reported error: ninja: error: build.ninja:xxx: multiple rules generate doc/dbus-xxx.1.html [-w dupbuild=err] Fixes #377 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:04:55 +01:00
add_custom_target(xmldoc-${_outname} DEPENDS ${_outfile})
add_dependencies(xmldoc xmldoc-${_outname})
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
install(FILES ${_outfile} DESTINATION ${INSTALL_DIR})
endforeach()
Remove obsolete parameter in end... cmake keywords
2019-01-24 08:12:19 +01:00
endmacro()
* cmake\doc\CMakeLists.txt: added prelimary xml doc support, needs cmake find script.
2007-03-15 12:10:07 +00:00
### copy tests to builddir so that generated tests and static tests
### are all in one place.
### todo how to add more filetypes
Use lower case cmake keywords in CMakeLists.txt files
2019-01-24 08:09:52 +01:00
macro(COPYDIR _src _type)
foreach(FILE_TYPE ${_type})
foreach(DIR ${_src})
file(GLOB FILES "${DIR}/${FILE_TYPE}" )
file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/${DIR})
foreach(FILE ${FILES})
get_filename_component(FILENAME ${FILE} NAME)
set(TARGET ${CMAKE_BINARY_DIR}/${DIR}/${FILENAME})
Replace tabs by 4 spaces in CMakeLists.txt files
2019-01-24 08:08:41 +01:00
configure_file(${FILE} ${TARGET} COPYONLY)
Use lower case cmake keywords in CMakeLists.txt files
2019-01-24 08:09:52 +01:00
if(CONFIG_VERBOSE)
message("FROM: ${FILE}\nTO: ${TARGET}\n")
Remove obsolete parameter in end... cmake keywords
2019-01-24 08:12:19 +01:00
endif()
endforeach()
endforeach()
endforeach()
endmacro()
* cmake\doc\CMakeLists.txt: added prelimary xml doc support, needs cmake find script.
2007-03-15 12:10:07 +00:00
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
# copy source files from doc directory into associated binary directory
# which is required to run generated xml docs from build directory
* cmake\doc\CMakeLists.txt: added prelimary xml doc support, needs cmake find script.
2007-03-15 12:10:07 +00:00
COPYDIR(doc *.png)
COPYDIR(doc *.svg)
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
# setup variables used in docbook templates
set(EXPANDED_SYSCONFDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR})
set(EXPANDED_DATADIR ${CMAKE_INSTALL_FULL_DATADIR})
Fix dependency chain for doc files generated from docbook source
2019-01-25 19:12:32 +01:00
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
set(formats html)
Fix broken meinproc4 based docbook generating by already used xsltproc Using xsltproc helps to reduce manual editing of xml doc and avoids cyclic dependency (kdelibs depends on dbus and dbus depends on kdelibs). It is available on all platforms (in the opposite to xmlto) and supports freedesktop CI out of the box. This commit adds docbook-xml and docbook-xsl as new dependency for cmake and removes obsolate xmlto support, which depends on xsltproc.
2018-11-20 14:06:17 +01:00
if(UNIX)
cmake: let macro docbook handle all requested formats in one call Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-02-17 14:01:56 +01:00
list(APPEND formats man)
Generate man pages from xml docbook sources for cmake buildsystem. [removed commented line -smcv] Bug: https://bugs.freedesktop.org/show_bug.cgi?id=59805 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2013-02-05 03:10:59 +01:00
endif()
cmake: Fix race condition on creating docbook based files With the previous implementation, race conditions could arise because a generated intermediate file was used by multiple targets. To fix the mentioned problem, the macro 'generate_docbook_file' has been integrated into a in a new macro 'add_docbook' to simplify the dependency chain and make it easier to use. When using an xml template with the 'TEMPLATE' parameter, a separate intermediate xml file is used for each generated output file to avoid overwriting each other, which was the main cause of the described problem. Due to the adaptation of the calling conventions it was necessary to introduce the parameter 'MAN_CATEGORY'. Fixes #381 Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2022-03-03 12:40:17 +01:00
# generate docbook output
add_docbook(dbus-cleanup-sockets TEMPLATE dbus-cleanup-sockets.1.xml.in MAN_CATEGORY 1 FORMATS ${formats})
add_docbook(dbus-daemon TEMPLATE dbus-daemon.1.xml.in MAN_CATEGORY 1 FORMATS ${formats})
add_docbook(dbus-launch TEMPLATE dbus-launch.1.xml.in MAN_CATEGORY 1 FORMATS ${formats})
add_docbook(dbus-monitor TEMPLATE dbus-monitor.1.xml.in MAN_CATEGORY 1 FORMATS ${formats})
add_docbook(dbus-run-session TEMPLATE dbus-run-session.1.xml.in MAN_CATEGORY 1 FORMATS ${formats})
add_docbook(dbus-send TEMPLATE dbus-send.1.xml.in MAN_CATEGORY 1 FORMATS ${formats})
add_docbook(dbus-test-tool TEMPLATE dbus-test-tool.1.xml.in MAN_CATEGORY 1 FORMATS ${formats})
add_docbook(dbus-uuidgen TEMPLATE dbus-uuidgen.1.xml.in MAN_CATEGORY 1 FORMATS ${formats})
add_docbook(dbus-update-activation-environment TEMPLATE dbus-update-activation-environment.1.xml.in MAN_CATEGORY 1 FORMATS ${formats})
Fix broken meinproc4 based docbook generating by already used xsltproc Using xsltproc helps to reduce manual editing of xml doc and avoids cyclic dependency (kdelibs depends on dbus and dbus depends on kdelibs). It is available on all platforms (in the opposite to xmlto) and supports freedesktop CI out of the box. This commit adds docbook-xml and docbook-xsl as new dependency for cmake and removes obsolate xmlto support, which depends on xsltproc.
2018-11-20 14:06:17 +01:00
fixed xml doc generating for cmake build system - supported docbook generator is currently kde's meinproc4, xmlto may also work but need still some checks
2010-02-10 09:26:52 +01:00
#
# handle html index file
#
Generate documentation html index file from doc/index.html.in for autotools and cmake Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2019-01-15 11:56:14 +01:00
configure_file(index.html.in ${CMAKE_CURRENT_BINARY_DIR}/index.html)
In cmake use variables provided from GNUInstallDirs consequently This is required to support a custom installation layout, e.g. the KDE binary factory.
2018-12-21 19:36:37 +01:00
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/index.html DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/dbus)
fixed xml doc generating for cmake build system - supported docbook generator is currently kde's meinproc4, xmlto may also work but need still some checks
2010-02-10 09:26:52 +01:00
cmake: install missing files to keep in sync with autotools builds
2019-03-07 14:25:47 +01:00
#
# misc files
#
set(DTD_DATA
diagram.png
diagram.svg
)
install(FILES ${DTD_DATA} DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/dbus)
set(DOC_DATA
system-activation.txt
)
install(FILES ${DOC_DATA} DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/dbus)
doc: Introduce XML catalog This adds a nice way of loading the DTD files based on the identifier in the DOCTYPE declaration, no matter where the DTDs are installed. See also ‘XML catalog’ Wikipedia entry and update-xmlcatalog(8).
2021-02-11 06:00:45 +01:00
set(DBUS_DTD_DIR "${CMAKE_INSTALL_DATADIR}/xml/dbus-1" CACHE STRING "Directory for installing DTD files")
set(DBUS_XML_CATALOG_DIR "${DBUS_DTD_DIR}" CACHE STRING "Directory for installing XML catalog file")
Remove spaces between cmake command and opening bracket
2019-01-24 08:11:00 +01:00
set(EXTRA_DIST
Move cmake related build system to top level Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
2019-01-10 19:42:52 +01:00
busconfig.dtd
introspect.dtd
introspect.xsl
fixed xml doc generating for cmake build system - supported docbook generator is currently kde's meinproc4, xmlto may also work but need still some checks
2010-02-10 09:26:52 +01:00
)
doc: Introduce XML catalog This adds a nice way of loading the DTD files based on the identifier in the DOCTYPE declaration, no matter where the DTDs are installed. See also ‘XML catalog’ Wikipedia entry and update-xmlcatalog(8).
2021-02-11 06:00:45 +01:00
install(FILES ${EXTRA_DIST} DESTINATION ${DBUS_DTD_DIR})
configure_file(
"${CMAKE_CURRENT_SOURCE_DIR}/catalog.xml.in"
"${CMAKE_CURRENT_BINARY_DIR}/catalog.xml"
@ONLY)
install(FILES "${CMAKE_CURRENT_BINARY_DIR}/catalog.xml" DESTINATION ${DBUS_XML_CATALOG_DIR})
* cmake\doc\CMakeLists.txt: added prelimary xml doc support, needs cmake find script.
2007-03-15 12:10:07 +00:00
Fix broken meinproc4 based docbook generating by already used xsltproc Using xsltproc helps to reduce manual editing of xml doc and avoids cyclic dependency (kdelibs depends on dbus and dbus depends on kdelibs). It is available on all platforms (in the opposite to xmlto) and supports freedesktop CI out of the box. This commit adds docbook-xml and docbook-xsl as new dependency for cmake and removes obsolate xmlto support, which depends on xsltproc.
2018-11-20 14:06:17 +01:00
endif()
Reference in a new issue Copy permalink