[hamradio-commits] [limesuite] 10/12: Install development documentation into new package liblimesuite-doc

[Andreas E. Bombe]

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

aeb pushed a commit to branch master
in repository limesuite.

commit a47a7f3a21ca83213c8667374867d1d487decc5e
Author: Andreas Bombe <aeb at debian.org>
Date:   Tue Sep 19 21:12:41 2017 +0200

    Install development documentation into new package liblimesuite-doc
    
    Add new package liblimesuite-doc to hold doxygen generated documentation
    and existing PDFs. Add doxygen to Build-Depends so that the API
    reference gets built. Extend .gitignore by docs/LMS_API_Documentation,
    the built documentation directory.
---
 .gitignore                                  |  1 +
 debian/changelog                            |  3 +++
 debian/clean                                |  1 +
 debian/control                              | 14 ++++++++++++++
 debian/liblimesuite-doc.doc-base.protocol   |  7 +++++++
 debian/liblimesuite-doc.doc-base.quickstart |  8 ++++++++
 debian/liblimesuite-doc.doc-base.reference  |  8 ++++++++
 debian/liblimesuite-doc.docs                |  3 +++
 debian/liblimesuite-doc.lintian-overrides   |  3 +++
 9 files changed, 48 insertions(+)

diff --git a/.gitignore b/.gitignore
index b208503..5104205 100644
--- a/.gitignore
+++ b/.gitignore
@@ -14,3 +14,4 @@ debian/limesuite*/
 debian/liblimesuite*/
 debian/soapysdr*-module-lms7/
 obj-*/
+docs/LMS_API_Documentation
diff --git a/debian/changelog b/debian/changelog
index 35ddb9a..e2ce02f 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -3,6 +3,9 @@ limesuite (17.09.0+dfsg-1) UNRELEASED; urgency=medium
   * New upstream release 17.09.0
   * Change liblimesuite ABI version from 17.06-1 to 17.09-1
   * Add newly written man pages for LimeUtil and LimeSuiteGUI
+  * Install API reference and development documentation into new package
+    liblimesuite-doc
+  * Add Build-Depends on doxygen to build the API reference
   * Also remove GROUP="660" assignment with udev-use-tag-uaccess patch
   * Disable auto detection of SIMD features during the configure step
   * Bump Standards-Version to 4.1.0, no changes required
diff --git a/debian/clean b/debian/clean
new file mode 100644
index 0000000..e817d8c
--- /dev/null
+++ b/debian/clean
@@ -0,0 +1 @@
+docs/LMS_API_Documentation/
diff --git a/debian/control b/debian/control
index 6ab5461..f4bc4d6 100644
--- a/debian/control
+++ b/debian/control
@@ -6,6 +6,7 @@ Uploaders: Andreas Bombe <aeb at debian.org>
 Build-Depends: debhelper (>= 10),
                cmake,
                pkg-config,
+               doxygen,
                libusb-1.0-0-dev,
                libwxgtk3.0-dev,
                libsoapysdr0.6-dev,
@@ -50,6 +51,7 @@ Architecture: any
 Multi-Arch: same
 Depends: liblimesuite17.09-1 (= ${binary:Version}),
          ${misc:Depends}
+Suggests: liblimesuite-doc
 Description: library to access LMS7 transceiver based hardware (development)
  Lime Suite is a collection of software supporting Lime Microsystems LMS7 RF
  transceiver based hardware such as the LimeSDR, LMS7002M UNITE board, or the
@@ -57,6 +59,18 @@ Description: library to access LMS7 transceiver based hardware (development)
  .
  This package contains the development files for liblimesuite.
 
+Package: liblimesuite-doc
+Section: doc
+Architecture: all
+Multi-Arch: foreign
+Depends: ${misc:Depends}
+Description: liblimesuite development documentation
+ Lime Suite is a collection of software supporting Lime Microsystems LMS7 RF
+ transceiver based hardware such as the LimeSDR, LMS7002M UNITE board, or the
+ Novena with LMS7 RF board.
+ .
+ This package contains the development documentation for liblimesuite.
+
 Package: soapysdr0.6-module-lms7
 Architecture: any
 Multi-Arch: same
diff --git a/debian/liblimesuite-doc.doc-base.protocol b/debian/liblimesuite-doc.doc-base.protocol
new file mode 100644
index 0000000..dd1004c
--- /dev/null
+++ b/debian/liblimesuite-doc.doc-base.protocol
@@ -0,0 +1,7 @@
+Document: limesuite-stream-protocol
+Title: LimeSDR Stream Protocol Specification
+Abstract: This document describes the stream format used by the LimeSDR
+Section: Programming/C++
+
+Format: PDF
+Files: /usr/share/doc/liblimesuite-doc/StreamProtocol.pdf.gz
diff --git a/debian/liblimesuite-doc.doc-base.quickstart b/debian/liblimesuite-doc.doc-base.quickstart
new file mode 100644
index 0000000..770112b
--- /dev/null
+++ b/debian/liblimesuite-doc.doc-base.quickstart
@@ -0,0 +1,8 @@
+Document: limesuite-api-quick-start
+Title: LMS API - Quick start guide
+Abstract: The scope of this document is compilation of the LMS API and
+ detailed description of the example applications that utilize LMS API.
+Section: Programming/C++
+
+Format: PDF
+Files: /usr/share/doc/liblimesuite-doc/lms7_api_quick_start_guide.pdf.gz
diff --git a/debian/liblimesuite-doc.doc-base.reference b/debian/liblimesuite-doc.doc-base.reference
new file mode 100644
index 0000000..b19dd6e
--- /dev/null
+++ b/debian/liblimesuite-doc.doc-base.reference
@@ -0,0 +1,8 @@
+Document: limesuite-api
+Title: LMS API Documentation
+Abstract: This manual is an API reference for liblimesuite
+Section: Programming/C++
+
+Format: HTML
+Index: /usr/share/doc/liblimesuite-doc/LMS_API_Documentation/index.html
+Files: /usr/share/doc/liblimesuite-doc/LMS_API_Documentation/*
diff --git a/debian/liblimesuite-doc.docs b/debian/liblimesuite-doc.docs
new file mode 100644
index 0000000..add0ad4
--- /dev/null
+++ b/debian/liblimesuite-doc.docs
@@ -0,0 +1,3 @@
+docs/lms7_api_quick_start_guide.pdf
+docs/StreamProtocol.pdf
+docs/LMS_API_Documentation
diff --git a/debian/liblimesuite-doc.lintian-overrides b/debian/liblimesuite-doc.lintian-overrides
new file mode 100644
index 0000000..64a9a2e
--- /dev/null
+++ b/debian/liblimesuite-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
+liblimesuite-doc: embedded-javascript-library

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