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

166 lines
6.1 KiB
Text
Raw Normal View History

Add generating dbus.devhelp2 to cmake build system
2018-11-16 23:01:03 +01:00
SET(DOC_DIR ${CMAKE_SOURCE_DIR}/../doc)
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)
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
# build doc always
add_custom_target(doc ALL)
* cmake: added doxygen support
2007-03-14 00:16:05 +00:00
if(DOXYGEN_EXECUTABLE)
OPTION(DBUS_ENABLE_DOXYGEN_DOCS "build DOXYGEN documentation (requires Doxygen)" ON)
endif(DOXYGEN_EXECUTABLE)
if (DBUS_ENABLE_DOXYGEN_DOCS)
* cmake\doc\CMakeLists.txt: added prelimary xml doc support, needs cmake find script.
2007-03-15 12:10:07 +00:00
set (top_srcdir ${CMAKE_SOURCE_DIR}/..)
Use Doxyfile.in for cmake build system too. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=64875 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2013-06-20 16:46:15 +02:00
configure_file(${CMAKE_SOURCE_DIR}/../Doxyfile.in ${CMAKE_BINARY_DIR}/Doxyfile )
Add generating dbus.devhelp2 to cmake build system
2018-11-16 23:01:03 +01:00
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/api/html/index.html
* cmake: added doxygen support
2007-03-14 00:16:05 +00:00
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile
Use Doxyfile.in for cmake build system too. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=64875 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2013-06-20 16:46:15 +02:00
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
* 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
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
)
add_dependencies(doc apidoc)
add_custom_target(devhelp2
Add generating dbus.devhelp2 to cmake build system
2018-11-16 23:01:03 +01:00
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/api/html/index.html ${CMAKE_CURRENT_BINARY_DIR}/dbus.devhelp2
)
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 devhelp2)
* cmake: added doxygen support
2007-03-14 00:16:05 +00:00
endif (DBUS_ENABLE_DOXYGEN_DOCS)
* 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()
if(DBUS_HAVE_XSLTPROC)
add_custom_command(
OUTPUT dbus.devhelp2
COMMAND ${XSLTPROC_EXECUTABLE} -o dbus.devhelp2 ${DOC_DIR}/doxygen_to_devhelp.xsl api/xml/index.xml
DEPENDS ${DOC_DIR}/doxygen_to_devhelp.xsl api/html/index.html
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
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)
macro(DOCBOOK _sources _format)
get_filename_component(_infile ${_sources} ABSOLUTE)
get_filename_component(_name ${_infile} NAME)
if(${_format} STREQUAL "man")
string(REPLACE ".xml" "" _outname ${_name})
set(STYLESHEET "${DOCBOOKXSL_DIR}/manpages/docbook.xsl")
else()
string(REPLACE ".xml" ".html" _outname ${_name})
set(STYLESHEET "${DOCBOOKXSL_DIR}/html/docbook.xsl")
endif()
set(_outfile ${CMAKE_CURRENT_BINARY_DIR}/${_outname})
set(_outfile ${CMAKE_CURRENT_BINARY_DIR}/${_outname})
if(EXISTS ${_sources})
if(XSLTPROC_EXECUTABLE)
add_custom_target(${_outname}
${XSLTPROC_EXECUTABLE} --output ${_outfile} --nonet --xinclude --param passivetex.extensions '1' ${STYLESHEET} ${_infile}
DEPENDS ${_infile}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
endif ()
add_dependencies(xmldoc ${_outname})
if (${_format} STREQUAL "man")
install(FILES ${_outfile} DESTINATION share/man/man1)
else()
install(FILES ${_outfile} DESTINATION share/doc/dbus)
endif()
else()
message(STATUS "skipping xml doc generating for ${_infile}, file not found")
endif()
endmacro(DOCBOOK)
* 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
MACRO (COPYDIR _src _type)
FOREACH(FILE_TYPE ${_type})
FOREACH(DIR ${_src})
FILE(GLOB FILES "${CMAKE_SOURCE_DIR}/../${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})
configure_file(${FILE} ${TARGET} COPYONLY)
IF (CONFIG_VERBOSE)
MESSAGE("FROM: ${FILE}\nTO: ${TARGET}\n")
ENDIF (CONFIG_VERBOSE)
ENDFOREACH(FILE)
ENDFOREACH(DIR)
ENDFOREACH(FILE_TYPE)
ENDMACRO (COPYDIR)
COPYDIR(doc *.png)
COPYDIR(doc *.svg)
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(${DOC_DIR}/dbus-test-plan.xml html)
docbook(${DOC_DIR}/dbus-tutorial.xml html)
docbook(${DOC_DIR}/dbus-specification.xml html)
docbook(${DOC_DIR}/dbus-faq.xml html)
configure_file(${DOC_DIR}/dbus-cleanup-sockets.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-cleanup-sockets.1.xml)
configure_file(${DOC_DIR}/dbus-daemon.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml)
configure_file(${DOC_DIR}/dbus-launch.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-launch.1.xml)
configure_file(${DOC_DIR}/dbus-monitor.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-monitor.1.xml)
configure_file(${DOC_DIR}/dbus-send.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-send.1.xml)
configure_file(${DOC_DIR}/dbus-test-tool.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-test-tool.1.xml)
configure_file(${DOC_DIR}/dbus-update-activation-environment.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-update-activation-environment.1.xml)
configure_file(${DOC_DIR}/dbus-uuidgen.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-uuidgen.1.xml)
if(UNIX)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml man)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-monitor.1.xml man)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-send.1.xml man)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-test-tool.1.xml man)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-launch.1.xml man)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-uuidgen.1.xml man)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-cleanup-sockets.1.xml man)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-update-activation-environment.1.xml 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()
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(${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml html)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-monitor.1.xml html)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-send.1.xml html)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-test-tool.1.xml html)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-launch.1.xml html)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-uuidgen.1.xml html)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-cleanup-sockets.1.xml html)
docbook(${CMAKE_BINARY_DIR}/doc/dbus-update-activation-environment.1.xml html)
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
#
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/index.html.cmake ${CMAKE_CURRENT_BINARY_DIR}/index.html )
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/index.html DESTINATION share/doc/dbus)
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
set (EXTRA_DIST
${DOC_DIR}/busconfig.dtd
${DOC_DIR}/introspect.dtd
${DOC_DIR}/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
)
install(FILES ${EXTRA_DIST} DESTINATION share/doc/dbus)
* 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