uonedb-qt team mailing list archive

[Christian Dywan <christian.dywan@xxxxxxxxxxxxx>]

Christian Dywan has proposed merging lp:~kalikiana/u1db-qt/docs2 into lp:u1db-qt.

Commit message:
Build docs in binary dir, BUILD_DOCS option, add -doc package

Requested reviews:
  Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot): continuous-integration
  U1DB Qt developers (uonedb-qt)

For more details, see:
https://code.launchpad.net/~kalikiana/u1db-qt/docs2/+merge/159181

Build docs in binary dir, BUILD_DOCS option, add -doc package
-- 
https://code.launchpad.net/~kalikiana/u1db-qt/docs2/+merge/159181
Your team U1DB Qt developers is requested to review the proposed merge of lp:~kalikiana/u1db-qt/docs2 into lp:u1db-qt.

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2013-04-12 13:36:54 +0000
+++ CMakeLists.txt	2013-04-16 15:29:28 +0000
@@ -70,13 +70,20 @@
 
 # Unit-Test
 enable_testing()
-
 add_custom_target(check COMMAND "env" "CTEST_OUTPUT_ON_FAILURE=1" "${CMAKE_CTEST_COMMAND}")
-add_custom_target(doc "qdoc" "u1db.qdocconf"
-    COMMAND "sed" "-r" "-i" "'s@(</head>)@<link rel=\"stylesheet\" type=\"text/css\" href=\"style/base.css\" />\\1@'" "./output/html/*.html"
-    COMMAND "qhelpgenerator" "./output/html/u1dbqt.qhp"
-    COMMAND "assistant" "-register" "./output/html/u1dbqt.qch"
-    WORKING_DIRECTORY "documentation")
+
+option(BUILD_DOCS "Build documentation" OFF)
+if (BUILD_DOCS)
+    set(ALL "ALL")
+endif ()
+set(U1DB_DOCS "${PROJECT_BINARY_DIR}/documentation/output")
+add_custom_target(doc ${ALL} "mkdir" "-p" "${U1DB_DOCS}"
+    COMMAND "qdoc" "-outputdir" "${U1DB_DOCS}" "${CMAKE_SOURCE_DIR}/documentation/u1db.qdocconf" "1>/dev/null" "2>/dev/null"
+    COMMAND "sed" "-r" "-i" "'s@(</head>)@<link rel=\"stylesheet\" type=\"text/css\" href=\"style/base.css\" />\\1@'" "${U1DB_DOCS}/*.html"
+    COMMAND "qhelpgenerator" "${U1DB_DOCS}/u1dbqt.qhp"
+    COMMAND "assistant" "-register" "${U1DB_DOCS}/u1dbqt.qch"
+    SOURCES "${CMAKE_SOURCE_DIR}/documentation/u1db.qdocconf"
+    WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}/documentation")
 add_subdirectory(modules)
 add_subdirectory(tests)
 add_subdirectory(examples)
@@ -88,6 +95,13 @@
     LIBRARY DESTINATION lib${LIB_SUFFIX}
     )
 
+if (BUILD_DOCS)
+    install(FILES "${U1DB_DOCS}/u1dbqt.qch"
+        DESTINATION "${CMAKE_INSTALL_PREFIX}/share/qt5/phrasebooks/"
+        )
+endif ()
+
+
 install(FILES src/global.h src/database.h src/document.h src/index.h src/query.h
     DESTINATION ${INCLUDE_INSTALL_DIR}
     )

=== modified file 'debian/control'
--- debian/control	2013-04-12 13:52:00 +0000
+++ debian/control	2013-04-16 15:29:28 +0000
@@ -11,6 +11,7 @@
                qtdeclarative5-test-plugin,
                qtdeclarative5-qtquick2-plugin,
                libqt5sql5-sqlite,
+               qttools5-dev-tools,
                qtdeclarative5-dev-tools
 Standards-Version: 3.9.3
 Vcs-Bzr: https://launchpad.net/u1db-qt/trunk
@@ -46,3 +47,14 @@
  .
  This package contains the examples demonstrating the use of the Qt binding for U1DB
 
+Package: libu1db-qt5-doc
+Section: doc
+Architecture: all
+Depends: ${misc:Depends},
+         libu1db-qt5-1 (= ${binary:Version}),
+         qttools5-dev-tools
+Description: Qt5 binding and QtQuick2 plugin for U1DB - offline documentation
+ Simple Qt5 binding and QtQuick2 plugin for U1DB (https://launchpad.net/u1db).
+ .
+ This package contains the offline documentation for the Qt binding for U1DB
+

=== added file 'debian/libu1db-qt5-doc.install'
--- debian/libu1db-qt5-doc.install	1970-01-01 00:00:00 +0000
+++ debian/libu1db-qt5-doc.install	2013-04-16 15:29:28 +0000
@@ -0,0 +1,1 @@
+usr/share/qt5/phrasebooks/*

=== modified file 'debian/rules'
--- debian/rules	2013-04-09 11:32:11 +0000
+++ debian/rules	2013-04-16 15:29:28 +0000
@@ -12,7 +12,7 @@
 override_dh_auto_configure:
 	PATH=/opt/qt5/bin:$(PATH) \
 	dh_auto_configure -- -DCMAKE_MODULE_PATH=/opt/qt5/lib/cmake \
-	-DLD_LIBRARY_PATH=/opt/qt5/lib:$(LD_LIBRARY_PATH)
+	-DLD_LIBRARY_PATH=/opt/qt5/lib:$(LD_LIBRARY_PATH) -DBUILD_DOCS=ON
 
 override_dh_auto_build:
 	dh_auto_build