2007-03-14 00:16:05 +00:00
|
|
|
find_package(Doxygen)
|
|
|
|
|
|
|
|
|
|
if(DOXYGEN_EXECUTABLE)
|
|
|
|
|
OPTION(DBUS_ENABLE_DOXYGEN_DOCS "build DOXYGEN documentation (requires Doxygen)" ON)
|
|
|
|
|
endif(DOXYGEN_EXECUTABLE)
|
|
|
|
|
|
|
|
|
|
if (DBUS_ENABLE_DOXYGEN_DOCS)
|
2007-03-15 12:10:07 +00:00
|
|
|
set (top_srcdir ${CMAKE_SOURCE_DIR}/..)
|
|
|
|
|
configure_file(${CMAKE_SOURCE_DIR}/Doxyfile.cmake ${CMAKE_BINARY_DIR}/Doxyfile )
|
2007-03-14 00:16:05 +00:00
|
|
|
add_custom_target(doc
|
|
|
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile
|
|
|
|
|
)
|
|
|
|
|
endif (DBUS_ENABLE_DOXYGEN_DOCS)
|
2007-03-15 12:10:07 +00:00
|
|
|
|
2010-02-10 09:26:52 +01:00
|
|
|
#
|
|
|
|
|
# find docbook generator
|
|
|
|
|
#
|
2010-04-10 01:20:45 +02:00
|
|
|
find_program(MEINPROC4_EXECUTABLE meinproc4)
|
2007-03-15 12:10:07 +00:00
|
|
|
|
2010-02-10 09:26:52 +01:00
|
|
|
find_program(XMLTO_EXECUTABLE xmlto)
|
2007-03-15 12:10:07 +00:00
|
|
|
|
2010-04-10 01:20:45 +02:00
|
|
|
if (MEINPROC4_EXECUTABLE OR XMLTO_EXECUTABLE)
|
2010-02-10 09:26:52 +01:00
|
|
|
OPTION(DBUS_ENABLE_XML_DOCS "build XML documentation (requires xmlto or meinproc4)" ON)
|
2013-06-18 14:07:38 +02:00
|
|
|
ADD_CUSTOM_TARGET(xmldoc ALL)
|
2010-04-10 01:20:45 +02:00
|
|
|
endif (MEINPROC4_EXECUTABLE OR XMLTO_EXECUTABLE)
|
2007-03-15 12:10:07 +00:00
|
|
|
|
2013-01-28 19:55:10 +01:00
|
|
|
if (XMLTO_EXECUTABLE)
|
|
|
|
|
set (DOCBOOK_GENERATOR_NAME "xmlto" PARENT_SCOPE)
|
|
|
|
|
set(DBUS_XML_DOCS_ENABLED 1)
|
|
|
|
|
set(MEINPROC4_EXECUTABLE 0)
|
|
|
|
|
MESSAGE(STATUS "xmlto docbook generator found")
|
2013-02-28 12:22:33 +00:00
|
|
|
set(STYLESHEET_MAN "${DOCBOOKXSL_DIR}/manpages/docbook.xsl")
|
|
|
|
|
set(STYLESHEET_HTML "${DOCBOOKXSL_DIR}/html/docbook.xsl")
|
|
|
|
|
|
2013-01-28 19:55:10 +01:00
|
|
|
elseif (MEINPROC4_EXECUTABLE)
|
2010-02-10 09:26:52 +01:00
|
|
|
set(DOCBOOK_GENERATOR_NAME "meinproc4" PARENT_SCOPE)
|
|
|
|
|
set(DBUS_XML_DOCS_ENABLED 1)
|
2010-03-29 21:28:47 +02:00
|
|
|
if(WIN32)
|
2010-04-27 11:19:56 +02:00
|
|
|
get_filename_component(_a ${MEINPROC4_EXECUTABLE} PATH)
|
2010-03-29 21:28:47 +02:00
|
|
|
get_filename_component(_meinproc_install_path ${_a} PATH)
|
2013-02-28 12:22:33 +00:00
|
|
|
set(STYLESHEET_HTML "${_meinproc_install_path}/share/apps/ksgmltools2/docbook/xsl/html/docbook.xsl")
|
2010-03-29 21:28:47 +02:00
|
|
|
else(WIN32)
|
2013-02-28 12:22:33 +00:00
|
|
|
set(STYLESHEET_HTML file:///usr/share/kde4/apps/ksgmltools2/customization/kde-nochunk.xsl)
|
2010-03-29 21:28:47 +02:00
|
|
|
endif(WIN32)
|
2013-01-28 19:55:10 +01:00
|
|
|
endif ()
|
2007-03-15 12:10:07 +00:00
|
|
|
|
2010-02-10 09:26:52 +01:00
|
|
|
if (DBUS_ENABLE_XML_DOCS)
|
2007-03-15 12:10:07 +00:00
|
|
|
|
2013-02-05 03:10:59 +01:00
|
|
|
macro (DOCBOOK _sources _format)
|
2010-03-30 08:31:49 +02:00
|
|
|
get_filename_component(_infile ${_sources} ABSOLUTE)
|
2013-02-05 01:20:46 +01:00
|
|
|
get_filename_component(_name ${_infile} NAME)
|
2013-06-18 14:07:38 +02:00
|
|
|
set(_deps ${CMAKE_SOURCE_DIR}/CMakeLists.txt ${CMAKE_CURRENT_SOURCE_DIR}/CMakeLists.txt)
|
2010-02-10 09:26:52 +01:00
|
|
|
|
2013-02-05 03:10:59 +01:00
|
|
|
if (${_format} STREQUAL "man")
|
|
|
|
|
string(REPLACE ".xml" "" _outname ${_name})
|
2013-02-28 12:22:33 +00:00
|
|
|
set(STYLESHEET ${STYLESHEET_MAN})
|
2013-02-05 03:10:59 +01:00
|
|
|
else()
|
|
|
|
|
string(REPLACE ".xml" ".html" _outname ${_name})
|
2013-02-28 12:22:33 +00:00
|
|
|
set(STYLESHEET ${STYLESHEET_HTML})
|
2013-02-05 03:10:59 +01:00
|
|
|
endif ()
|
|
|
|
|
|
|
|
|
|
set(_outfile ${CMAKE_CURRENT_BINARY_DIR}/${_outname})
|
2010-02-10 09:26:52 +01:00
|
|
|
if (EXISTS ${_sources})
|
2010-04-10 01:20:45 +02:00
|
|
|
if (MEINPROC4_EXECUTABLE)
|
2013-06-18 14:07:38 +02:00
|
|
|
ADD_CUSTOM_COMMAND(
|
|
|
|
|
OUTPUT ${_outfile}
|
|
|
|
|
COMMAND ${MEINPROC4_EXECUTABLE} --stylesheet ${STYLESHEET} -o ${_outfile} ${_infile}
|
|
|
|
|
DEPENDS ${_infile} ${STYLESHEET} ${_deps}
|
2010-02-10 09:26:52 +01:00
|
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
|
|
|
)
|
|
|
|
|
endif ()
|
|
|
|
|
if (XMLTO_EXECUTABLE)
|
2013-06-18 14:07:38 +02:00
|
|
|
ADD_CUSTOM_COMMAND(
|
|
|
|
|
OUTPUT ${_outfile}
|
|
|
|
|
COMMAND ${XMLTO_EXECUTABLE} -vv ${_format} ${_infile}
|
|
|
|
|
DEPENDS ${_infile} ${_deps}
|
2010-02-10 09:26:52 +01:00
|
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
|
|
|
)
|
|
|
|
|
endif ()
|
2013-02-05 03:10:59 +01:00
|
|
|
if (${_format} STREQUAL "man")
|
|
|
|
|
install(FILES ${_outfile} DESTINATION share/man/man1)
|
|
|
|
|
else ()
|
|
|
|
|
install(FILES ${_outfile} DESTINATION share/doc/dbus)
|
|
|
|
|
endif ()
|
2010-02-10 09:26:52 +01:00
|
|
|
else ()
|
|
|
|
|
MESSAGE(STATUS "skipping xml doc generating for ${_infile}, file not found")
|
|
|
|
|
endif ()
|
2013-06-18 14:07:38 +02:00
|
|
|
ADD_CUSTOM_TARGET(${_outname} DEPENDS ${_outfile})
|
|
|
|
|
ADD_DEPENDENCIES(xmldoc ${_outname})
|
2007-03-15 12:10:07 +00:00
|
|
|
endmacro (DOCBOOK)
|
|
|
|
|
|
|
|
|
|
### 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)
|
|
|
|
|
|
|
|
|
|
DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-test-plan.xml html-nochunks)
|
|
|
|
|
DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-tutorial.xml html-nochunks)
|
|
|
|
|
DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-specification.xml html-nochunks)
|
|
|
|
|
DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-faq.xml html-nochunks)
|
2013-02-14 13:26:57 +00:00
|
|
|
configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-cleanup-sockets.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-cleanup-sockets.1.xml)
|
2013-02-05 01:20:46 +01:00
|
|
|
configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-daemon.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml)
|
2013-02-14 13:26:57 +00:00
|
|
|
configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-launch.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-launch.1.xml)
|
|
|
|
|
configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-monitor.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-monitor.1.xml)
|
|
|
|
|
configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-send.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-send.1.xml)
|
|
|
|
|
configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-uuidgen.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-uuidgen.1.xml)
|
|
|
|
|
DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-cleanup-sockets.1.xml html-nochunks)
|
2013-02-05 01:20:46 +01:00
|
|
|
DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml html-nochunks)
|
2013-02-14 13:26:57 +00:00
|
|
|
DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-launch.1.xml html-nochunks)
|
|
|
|
|
DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-monitor.1.xml html-nochunks)
|
|
|
|
|
DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-send.1.xml html-nochunks)
|
|
|
|
|
DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-uuidgen.1.xml html-nochunks)
|
2013-02-05 03:10:59 +01:00
|
|
|
if (UNIX)
|
|
|
|
|
DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml man)
|
2013-06-18 13:42:34 +02:00
|
|
|
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-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)
|
2013-02-05 03:10:59 +01:00
|
|
|
endif()
|
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)
|
|
|
|
|
|
|
|
|
|
set (EXTRA_DIST
|
|
|
|
|
${CMAKE_SOURCE_DIR}/../doc/busconfig.dtd
|
|
|
|
|
${CMAKE_SOURCE_DIR}/../doc/introspect.dtd
|
|
|
|
|
${CMAKE_SOURCE_DIR}/../doc/introspect.xsl
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
install(FILES ${EXTRA_DIST} DESTINATION share/doc/dbus)
|
2007-03-15 12:10:07 +00:00
|
|
|
|
2010-02-10 09:26:52 +01:00
|
|
|
endif(DBUS_ENABLE_XML_DOCS)
|