Merge lp:~thomir-deactivatedaccount/mir/add-docs-package into lp:~mir-team/mir/trunk

[Thomi Richards]

Build documentation automatically as part of the build.

This branch modified the cmake scripts & debian/ control files to:

 * Automatically build the API documentation as part of a normal build.
 * Build a 'mir-doc' package that contains the mir API documentation.

This package is required before we can post the API documentation online as part of the autolanding process.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:469
http://jenkins.qa.ubuntu.com/job/mir-ci/33/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/33//console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/mir-ci/33//rebuild/?

review: Approve (continuous-integration)

[Robert Ancell (robert-ancell)]

Worked for me

review: Approve

[Alan Griffiths (alan-griffiths)]

I'm not convinced I like running doxygen over the whole codebase on every little rebuild.

[Robert Ancell (robert-ancell)]

Is there a cmake method that does this like --enable-doc does on autotools?

[Thomi Richards (thomir-deactivatedaccount)]

Hi Robert,

alf's fixed that already - you can run with -DBUILD_DOXYGEN if you want the docs to be built - the debian package builder does this by default now.

=== modified file 'cmake/Doxygen.cmake'
--- cmake/Doxygen.cmake	2013-03-04 16:02:02 +0000
+++ cmake/Doxygen.cmake	2013-03-10 21:41:21 +0000
@@ -5,7 +5,8 @@
   message(STATUS "doxygen ${DOXYGEN_VERSION} (>= 1.8.0) available - enabling make target doc")
   configure_file(doc/Doxyfile.in
                  ${PROJECT_BINARY_DIR}/Doxyfile @ONLY IMMEDIATE)
-  add_custom_target(doc
+  add_custom_target(doc ALL
                     COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/Doxyfile
                     SOURCES ${PROJECT_BINARY_DIR}/Doxyfile)
+  install(DIRECTORY ${CMAKE_BINARY_DIR}/doc/html DESTINATION ${CMAKE_INSTALL_PATH}/share/doc/mir-doc/)
 endif()

=== modified file 'debian/control'
--- debian/control	2013-03-04 20:11:18 +0000
+++ debian/control	2013-03-10 21:41:21 +0000
@@ -6,6 +6,8 @@
 Build-Depends: cmake,
                cmake-data,
                debhelper (>= 9),
+               doxygen,
+               graphviz,
                libboost1.48-all-dev | libboost-all-dev,
                protobuf-compiler,
                libdrm-dev [!armhf],
@@ -27,7 +29,7 @@
 Depends: ${misc:Depends},
          ${shlibs:Depends},
 Description: Display server for Ubuntu - protocol implementation
- Mir is a display server running on linux systems, with a focus on efficiency, 
+ Mir is a display server running on linux systems, with a focus on efficiency,
  robust operation and a well-defined driver model.
  .
  Contains the protocol's shared library.
@@ -40,7 +42,7 @@
          ${misc:Depends},
          ${shlibs:Depends},
 Description: Display server for Ubuntu - protocol definition
- Mir is a display server running on linux systems, with a focus on efficiency, 
+ Mir is a display server running on linux systems, with a focus on efficiency,
  robust operation and a well-defined driver model.
  .
  Contains the protocol's definition files.
@@ -51,7 +53,7 @@
 Depends: ${misc:Depends},
          ${shlibs:Depends},
 Description: Display server for Ubuntu - server library
- Mir is a display server running on linux systems, with a focus on efficiency, 
+ Mir is a display server running on linux systems, with a focus on efficiency,
  robust operation and a well-defined driver model.
  .
  Contains the shared library needed by server applications for Mir.
@@ -63,7 +65,7 @@
          libmirprotobuf-dev (= ${source:Version}),
          ${misc:Depends},
 Description: Display server for Ubuntu - development headers
- Mir is a display server running on linux systems, with a focus on efficiency, 
+ Mir is a display server running on linux systems, with a focus on efficiency,
  robust operation and a well-defined driver model.
  .
  Contains header files required to build Mir servers.
@@ -74,7 +76,7 @@
 Depends: ${misc:Depends},
          ${shlibs:Depends},
 Description: Display server for Ubuntu - client library
- Mir is a display server running on linux systems, with a focus on efficiency, 
+ Mir is a display server running on linux systems, with a focus on efficiency,
  robust operation and a well-defined driver model.
  .
  Contains the shared library needed by client applications for Mir.
@@ -86,18 +88,18 @@
          libmirprotobuf-dev (= ${source:Version}),
          ${misc:Depends},
 Description: Display server for Ubuntu - development headers
- Mir is a display server running on linux systems, with a focus on efficiency, 
+ Mir is a display server running on linux systems, with a focus on efficiency,
  robust operation and a well-defined driver model.
  .
  Contains header files required to develop against Mir.
 
 Package: libmirclient-demos
 Architecture: any
-Depends: ${misc:Depends}, 
+Depends: ${misc:Depends},
         libmirclient-dev(= ${binary:Version}),
 Breaks: mir (<< 0.0.2-0ubuntu1)
-Description: Display server for Ubuntu - example client programs 
- Mir is a display server running on linux systems, with a focus on efficiency, 
+Description: Display server for Ubuntu - example client programs
+ Mir is a display server running on linux systems, with a focus on efficiency,
  robust operation and a well-defined driver model.
  .
  Contains demo applications (with source) that use the Mir display server
@@ -108,8 +110,14 @@
          ${shlibs:Depends},
          libmirserver0 (= ${binary:Version}),
 Description: Display server for Ubuntu - server executable
- Mir is a display server running on linux systems, with a focus on efficiency, 
+ Mir is a display server running on linux systems, with a focus on efficiency,
  robust operation and a well-defined driver model.
  .
  Contains the main server executable.
 
+Package: mir-doc
+Architecture: all
+Depends: ${misc:Depends}
+Description: API documentation for mir
+ This package installs the mir API documentation.
+

=== added file 'debian/mir-doc.install'
--- debian/mir-doc.install	1970-01-01 00:00:00 +0000
+++ debian/mir-doc.install	2013-03-10 21:41:21 +0000
@@ -0,0 +1,1 @@
+share/doc/mir-doc/

=== modified file 'debian/rules'
--- debian/rules	2013-01-28 20:54:07 +0000
+++ debian/rules	2013-03-10 21:41:21 +0000
@@ -32,7 +32,7 @@
 endif
 
 override_dh_installexamples:
-	dh_installexamples -p libmirclient-demos 
+	dh_installexamples -p libmirclient-demos
 
 override_dh_makeshlibs:
 	dh_makeshlibs -V