[hamradio-commits] [soapysdr] 05/06: Install API docs into new libsoapysdr-doc package

[Andreas E. Bombe]

This is an automated email from the git hooks/post-receive script.

aeb pushed a commit to branch master
in repository soapysdr.

commit a406eaca1596738ea1ebd611788d142d23613a17
Author: Andreas Bombe <aeb at debian.org>
Date:   Wed Aug 24 04:00:07 2016 +0200

    Install API docs into new libsoapysdr-doc package
    
    Add patch install-dev-docs to make the build install the HTML
    documentation files. These are then installed into a new architecture
    all package libsoapysdr-doc.
    
    A new Build-Depends-Indep on doxygen is added so that the documentation
    is actually built.
---
 debian/changelog                         | 10 ++++++++++
 debian/control                           | 14 ++++++++++++++
 debian/libsoapysdr-doc.doc-base          |  9 +++++++++
 debian/libsoapysdr-doc.install           |  1 +
 debian/libsoapysdr-doc.lintian-overrides |  3 +++
 debian/patches/install-dev-docs          | 19 +++++++++++++++++++
 debian/patches/series                    |  1 +
 7 files changed, 57 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index f4015d2..fc28280 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,13 @@
+soapysdr (0.5.2-1) UNRELEASED; urgency=medium
+
+  * New upstream version 0.5.2
+  * Add patch install-dev-docs to make the build install the HTML
+    documentation files
+  * Add Build-Depends-Indep on doxygen and create new architecture all
+    package libsoapysdr-doc
+
+ -- Andreas Bombe <aeb at debian.org>  Wed, 24 Aug 2016 02:43:23 +0200
+
 soapysdr (0.5.1-1) unstable; urgency=medium
 
   * New upstream version 0.5.1
diff --git a/debian/control b/debian/control
index 403e7f5..aa5578e 100644
--- a/debian/control
+++ b/debian/control
@@ -9,6 +9,8 @@ Build-Depends:
     swig,
     python-dev,
     python3-dev
+Build-Depends-Indep:
+    doxygen
 Standards-Version: 3.9.8
 Homepage: https://github.com/pothosware/SoapySDR/wiki
 Vcs-Browser: https://anonscm.debian.org/cgit/pkg-hamradio/soapysdr.git
@@ -33,6 +35,7 @@ Architecture: any
 Depends:
     libsoapysdr0.5-2 (= ${binary:Version}),
     ${misc:Depends}
+Suggests: libsoapysdr-doc
 Description: SoapySDR library development files
  SoapySDR is a library providing a common interface to SDR (software
  defined radio) hardware. Support for different hardware is added through
@@ -40,6 +43,17 @@ Description: SoapySDR library development files
  .
  This package contains the development files for the library.
 
+Package: libsoapysdr-doc
+Section: doc
+Architecture: all
+Depends: ${misc:Depends}
+Description: SoapySDR library development documentation
+ SoapySDR is a library providing a common interface to SDR (software
+ defined radio) hardware. Support for different hardware is added through
+ external modules.
+ .
+ This package contains the development documentation for the library.
+
 Package: soapysdr-tools
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}
diff --git a/debian/libsoapysdr-doc.doc-base b/debian/libsoapysdr-doc.doc-base
new file mode 100644
index 0000000..b9dbf6a
--- /dev/null
+++ b/debian/libsoapysdr-doc.doc-base
@@ -0,0 +1,9 @@
+Document: soapysdr
+Title: SoapySDR Library Reference Manual
+Author: Josh Blum
+Abstract: This manual is an API reference for libsoapysdr
+Section: Programming/C++
+
+Format: HTML
+Index: /usr/share/doc/libsoapysdr-doc/html/index.html
+Files: /usr/share/doc/libsoapysdr-doc/html/*
diff --git a/debian/libsoapysdr-doc.install b/debian/libsoapysdr-doc.install
new file mode 100644
index 0000000..9d4be1d
--- /dev/null
+++ b/debian/libsoapysdr-doc.install
@@ -0,0 +1 @@
+usr/share/doc/libsoapysdr-doc/
diff --git a/debian/libsoapysdr-doc.lintian-overrides b/debian/libsoapysdr-doc.lintian-overrides
new file mode 100644
index 0000000..d79e6ff
--- /dev/null
+++ b/debian/libsoapysdr-doc.lintian-overrides
@@ -0,0 +1,3 @@
+# The embedded jquery.js is autogenerated by doxygen and can not be replaced.
+# See /usr/share/doc/doxygen/README.jquery
+libsoapysdr-doc: embedded-javascript-library
diff --git a/debian/patches/install-dev-docs b/debian/patches/install-dev-docs
new file mode 100644
index 0000000..e5157bb
--- /dev/null
+++ b/debian/patches/install-dev-docs
@@ -0,0 +1,19 @@
+Description: Install API reference manual
+ The HTML reference manual that is built when doxygen is available is
+ not installed in the upstream cmake scripts. This patch changes that
+ to install them in /usr/share/doc/libsoapysdr-doc/html for later
+ installation in its own package.
+Author: Andreas Bombe <aeb at debian.org>
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+--- a/docs/CMakeLists.txt
++++ b/docs/CMakeLists.txt
+@@ -42,4 +42,8 @@
+         COMMENT "Generating documentation with doxygen"
+     )
+     add_custom_target(docs ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN})
++    install(
++	DIRECTORY ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN}
++	DESTINATION share/doc/libsoapysdr-doc
++    )
+ endif()
diff --git a/debian/patches/series b/debian/patches/series
index 377bdd2..ab3d4b0 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1 +1,2 @@
 version-string
+install-dev-docs

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-hamradio/soapysdr.git