[kde-doc-english] [kdelibs/frameworks] /: Always generate documentation

Aleix Pol aleixpol at kde.org
Wed Nov 20 16:15:20 UTC 2013 

Git commit f14b4f3ee2d3c41b64aeaeb021b02df45dbd35cf by Aleix Pol.
Committed on 20/11/2013 at 16:15.
Pushed by apol into branch 'frameworks'.

Always generate documentation

DocBook generation tools should be working, just make sure you
have your system set up proprely so that meinproc can find the
documentation (you should have XDG_DATA_DIRS defined).
Also made sure everything is generated successfully.

I didn't enable it for sonnet though, it's in tier1 and kdoctools
is tier2, I'm unsure of what to do about this one.

CCMAIL: kde-frameworks-devel at kde.org

M  +1    -0    tier1/sonnet/CMakeLists.txt
M  +5    -2    tier3/kconfigwidgets/CMakeLists.txt
M  +5    -2    tier3/kio/CMakeLists.txt
M  +1    -1    tier3/kio/docs/kcookiejar5/CMakeLists.txt
M  +1    -1    tier3/kio/docs/kcookiejar5/man-kcookiejar5.8.docbook
M  +5    -2    tier3/kjsembed/CMakeLists.txt
M  +5    -2    tier3/kross/CMakeLists.txt
M  +6    -2    tier3/kservice/CMakeLists.txt
M  +10   -3    tier4/kde4support/CMakeLists.txt

http://commits.kde.org/kdelibs/f14b4f3ee2d3c41b64aeaeb021b02df45dbd35cf

diff --git a/tier1/sonnet/CMakeLists.txt b/tier1/sonnet/CMakeLists.txt
index ceab49a..bad6191 100644
--- a/tier1/sonnet/CMakeLists.txt
+++ b/tier1/sonnet/CMakeLists.txt
@@ -29,6 +29,7 @@ ecm_setup_version(5.0.0 VARIABLE_PREFIX SONNET
 
 
 # Enable when kdoctools will be usable from the outside (macros are broken ATM)
+# apol: they are working now, but KDocTools is in a higher tier, I'm unsure if we should enable it back
 #add_subdirectory(docs)
 add_subdirectory(src)
 add_subdirectory(autotests)
diff --git a/tier3/kconfigwidgets/CMakeLists.txt b/tier3/kconfigwidgets/CMakeLists.txt
index 7487013..ec88983 100644
--- a/tier3/kconfigwidgets/CMakeLists.txt
+++ b/tier3/kconfigwidgets/CMakeLists.txt
@@ -18,6 +18,10 @@ if(NOT kdelibs_SOURCE_DIR)
   find_package(KGuiAddons 5.0.0 REQUIRED)
   find_package(KI18n 5.0.0 REQUIRED)
   find_package(KWidgetsAddons 5.0.0 REQUIRED)
+else()
+    set(_kdeBootStrapping TRUE)
+    include(${CMAKE_SOURCE_DIR}/tier2/kdoctools/KDocToolsMacros.cmake)
+    set(KDOCTOOLS_CUSTOMIZATION_DIR "${KDocTools_BINARY_DIR}/src/customization/")
 endif()
 
 include(FeatureSummary)
@@ -30,8 +34,7 @@ ecm_setup_version(5.0.0 VARIABLE_PREFIX KCONFIGWIDGETS
 remove_definitions(-DQT_NO_CAST_FROM_ASCII)
 remove_definitions(-DQT_NO_CAST_FROM_BYTEARRAY)
 
-# Enable when kdoctools will be usable from the outside (macros are broken ATM)
-#add_subdirectory(docs)
+add_subdirectory(docs)
 add_subdirectory(src)
 add_subdirectory(tests)
 add_subdirectory(autotests)
diff --git a/tier3/kio/CMakeLists.txt b/tier3/kio/CMakeLists.txt
index 7a3529e..b035c0e 100644
--- a/tier3/kio/CMakeLists.txt
+++ b/tier3/kio/CMakeLists.txt
@@ -43,6 +43,10 @@ if("${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")
   find_package(XmlGui ${KF5_VERSION} REQUIRED)
   find_package(KBookmarks ${KF5_VERSION} REQUIRED)
   find_package(KNotifications ${KF5_VERSION} REQUIRED) #needed for kpac
+else()
+    set(_kdeBootStrapping TRUE)
+    include(${CMAKE_SOURCE_DIR}/tier2/kdoctools/KDocToolsMacros.cmake)
+    set(KDOCTOOLS_CUSTOMIZATION_DIR "${KDocTools_BINARY_DIR}/src/customization/")
 endif()
 
 # TODO: Remove these
@@ -58,8 +62,7 @@ find_package(Qt5 ${QT_REQUIRED_VERSION} CONFIG REQUIRED Widgets DBus Network Con
 find_package(X11)
 set(HAVE_X11 ${X11_FOUND})
 
-# Enable when kdoctools will be usable from the outside (macros are broken ATM)
-#add_subdirectory(docs)
+add_subdirectory(docs)
 add_subdirectory(src)
 add_subdirectory(autotests)
 add_subdirectory(tests)
diff --git a/tier3/kio/docs/kcookiejar5/CMakeLists.txt b/tier3/kio/docs/kcookiejar5/CMakeLists.txt
index ef02397..c5ecbf9 100644
--- a/tier3/kio/docs/kcookiejar5/CMakeLists.txt
+++ b/tier3/kio/docs/kcookiejar5/CMakeLists.txt
@@ -1 +1 @@
-kdoctools_create_manpage(man-kcookiejar4.8.docbook 8 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
+kdoctools_create_manpage(man-kcookiejar5.8.docbook 8 INSTALL_DESTINATION ${MAN_INSTALL_DIR})
diff --git a/tier3/kio/docs/kcookiejar5/man-kcookiejar5.8.docbook b/tier3/kio/docs/kcookiejar5/man-kcookiejar5.8.docbook
index 5538269..1f7efd8 100644
--- a/tier3/kio/docs/kcookiejar5/man-kcookiejar5.8.docbook
+++ b/tier3/kio/docs/kcookiejar5/man-kcookiejar5.8.docbook
@@ -167,7 +167,7 @@ Reloads the configuration file.
 
 <refsect1>
 <title>Usage</title>
-<para><command>kcookiejar5</command> is a command line tool to access the kded module which manages cookies in <command>Konqueror</command> and other KDE applications.
+<para><command>kcookiejar5</command> is a command line tool to access the kded module which manages cookies in <command>Konqueror</command> and other KDE applications.</para>
 <para>
 When started without parameters it loads the kded module to provide the dbus interface to store cookies.
 </para>
diff --git a/tier3/kjsembed/CMakeLists.txt b/tier3/kjsembed/CMakeLists.txt
index 154b41d..86d8d4c 100644
--- a/tier3/kjsembed/CMakeLists.txt
+++ b/tier3/kjsembed/CMakeLists.txt
@@ -24,14 +24,17 @@ ecm_setup_version(${KF5_VERSION} VARIABLE_PREFIX KJSEMBED
 if("${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")
   find_package(KJS ${KF5_VERSION} REQUIRED)
   find_package(KI18n ${KF5_VERSION} REQUIRED)
+else()
+    set(_kdeBootStrapping TRUE)
+    include(${CMAKE_SOURCE_DIR}/tier2/kdoctools/KDocToolsMacros.cmake)
+    set(KDOCTOOLS_CUSTOMIZATION_DIR "${KDocTools_BINARY_DIR}/src/customization/")
 endif()
 
 add_definitions(-DQT_DISABLE_DEPRECATED_BEFORE=0)
 remove_definitions(-DQT_NO_CAST_FROM_ASCII)
 remove_definitions(-DQT_NO_CAST_FROM_BYTEARRAY)
 
-# Enable when kdoctools will be usable from the outside (macros are broken ATM)
-#add_subdirectory(docs)
+add_subdirectory(docs)
 add_subdirectory(src)
 add_subdirectory(examples/kjsconsole)
 
diff --git a/tier3/kross/CMakeLists.txt b/tier3/kross/CMakeLists.txt
index 58f93f4..6870d8b 100644
--- a/tier3/kross/CMakeLists.txt
+++ b/tier3/kross/CMakeLists.txt
@@ -43,12 +43,15 @@ if ("${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")
 #     find_package(KIconThemes ${KF5_VERSION} REQUIRED)
     find_package(KIO ${KF5_VERSION} REQUIRED)
     find_package(KParts ${KF5_VERSION} REQUIRED)
+else()
+    set(_kdeBootStrapping TRUE)
+    include(${CMAKE_SOURCE_DIR}/tier2/kdoctools/KDocToolsMacros.cmake)
+    set(KDOCTOOLS_CUSTOMIZATION_DIR "${KDocTools_BINARY_DIR}/src/customization/")
 endif()
 
 remove_definitions(-DQT_NO_CAST_FROM_ASCII)
 
-# Enable when kdoctools will be usable from the outside (macros are broken ATM)
-#add_subdirectory(docs)
+add_subdirectory(docs)
 add_subdirectory(src)
 #add_subdirectory(autotests)
 
diff --git a/tier3/kservice/CMakeLists.txt b/tier3/kservice/CMakeLists.txt
index 8506837..098a4a0 100644
--- a/tier3/kservice/CMakeLists.txt
+++ b/tier3/kservice/CMakeLists.txt
@@ -29,12 +29,17 @@ set(REQUIRED_QT_VERSION "5.2.0")
 find_package(Qt5 ${REQUIRED_QT_VERSION} CONFIG REQUIRED DBus Test Xml)
 
 if("${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")
+  find_package(KWindowSystem ${KF5_VERSION} REQUIRED)
   find_package(KConfig ${KF5_VERSION} REQUIRED)
   find_package(KCoreAddons ${KF5_VERSION} REQUIRED)
   find_package(KCrash ${KF5_VERSION} REQUIRED)
   find_package(KDBusAddons ${KF5_VERSION} REQUIRED)
   find_package(KI18n ${KF5_VERSION} REQUIRED)
   find_package(KDocTools REQUIRED)
+else()
+    set(_kdeBootStrapping TRUE)
+    include(${CMAKE_SOURCE_DIR}/tier2/kdoctools/KDocToolsMacros.cmake)
+    set(KDOCTOOLS_CUSTOMIZATION_DIR "${KDocTools_BINARY_DIR}/src/customization/")
 endif()
 
 # create a Config.cmake and a ConfigVersion.cmake file and install them
@@ -59,8 +64,7 @@ install(FILES "${CMAKE_CURRENT_BINARY_DIR}/KServiceConfig.cmake"
 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/kservice_version.h
         DESTINATION ${INCLUDE_INSTALL_DIR} COMPONENT Devel )
 
-# Enable when kdoctools will be usable from the outside (macros are broken ATM)
-#add_subdirectory(docs)
+add_subdirectory(docs)
 add_subdirectory(src)
 add_subdirectory(autotests)
 add_subdirectory(tests)
diff --git a/tier4/kde4support/CMakeLists.txt b/tier4/kde4support/CMakeLists.txt
index 9b546a2..b56e169 100644
--- a/tier4/kde4support/CMakeLists.txt
+++ b/tier4/kde4support/CMakeLists.txt
@@ -17,6 +17,14 @@ if(NOT WIN32)
     find_package(Qt5 ${QT_REQUIRED_VERSION} CONFIG REQUIRED X11Extras)
 endif()
 
+if("${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")
+    # add dependencies
+else()
+    set(_kdeBootStrapping TRUE)
+    include(${CMAKE_SOURCE_DIR}/tier2/kdoctools/KDocToolsMacros.cmake)
+    set(KDOCTOOLS_CUSTOMIZATION_DIR "${KDocTools_BINARY_DIR}/src/customization/")
+endif()
+
 find_package(Strigi 0.6.3 QUIET)
 set_package_properties(Strigi PROPERTIES DESCRIPTION "Desktop indexing and search support"
                        URL "http://strigi.sourceforge.net"
@@ -86,9 +94,8 @@ install(EXPORT KDE4SupportTargets DESTINATION "${CMAKECONFIG_INSTALL_DIR}" FILE
 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/kde4support_version.h
         DESTINATION ${INCLUDE_INSTALL_DIR} COMPONENT Devel )
 
-add_subdirectory( cmake )
-# Enable when kdoctools will be usable from the outside (macros are broken ATM)
-#add_subdirectory(docs)
+add_subdirectory(cmake)
+add_subdirectory(docs)
 add_subdirectory(src)
 add_subdirectory(autotests)
 add_subdirectory(tests)

More information about the kde-doc-english mailing list