From dfa7599f3342ba3bb5d21832b233d0cd05e73f08 Mon Sep 17 00:00:00 2001 From: Laurent Bigonville Date: Fri, 3 Jun 2011 11:54:24 +0200 Subject: [PATCH] Generate PDF and html doc and install it in nut-doc package --- debian/changelog | 5 ++++- debian/control | 23 ++++++++++++++++++--- debian/nut-doc.doc-base.nut-developer-guide | 13 ++++++++++++ debian/nut-doc.doc-base.nut-faq | 12 +++++++++++ debian/nut-doc.doc-base.nut-packager-guide | 15 ++++++++++++++ debian/nut-doc.doc-base.nut-user-manual | 15 ++++++++++++++ debian/nut-doc.install | 1 + debian/rules | 18 ++++++++++++++++ 8 files changed, 98 insertions(+), 4 deletions(-) create mode 100644 debian/nut-doc.doc-base.nut-developer-guide create mode 100644 debian/nut-doc.doc-base.nut-faq create mode 100644 debian/nut-doc.doc-base.nut-packager-guide create mode 100644 debian/nut-doc.doc-base.nut-user-manual create mode 100644 debian/nut-doc.install diff --git a/debian/changelog b/debian/changelog index 5783c14..c23369c 100644 --- a/debian/changelog +++ b/debian/changelog @@ -5,16 +5,19 @@ nut (2.6.1-2) UNRELEASED; urgency=low * Re-add and refresh debian/patches/0001-fix_spelling_and_typo.patch: Some typos and spelling errors remain. * Split nut package into nut-client and nut-server, keep nut package as + * Generate PDF and html doc and install it in nut-doc package metapackage * debian/rules: - List non-installed files - Includes python-module.mk + - Add flags to build documentation and install it * debian/control: - Add python-nut package and add python build-dependency - Set nut-powerman-pdu priority to extras - Add nut-monitor package + - Add nut-doc package and add required C/R/P - -- Laurent Bigonville Mon, 27 Jun 2011 17:26:59 +0200 + -- Laurent Bigonville Fri, 15 Jul 2011 14:59:36 +0200 nut (2.6.1-1) unstable; urgency=low diff --git a/debian/control b/debian/control index 81bcef2..53f2c66 100644 --- a/debian/control +++ b/debian/control @@ -15,6 +15,9 @@ Build-Depends: debhelper (>= 8), libpowerman0-dev (>= 2.3.3), libwrap0-dev (>= 7.6), python (>= 2.6.6-3~) +Build-Depends-Indep: asciidoc (>= 8.6.3), + dblatex (>= 0.2.5), + libxml2-utils Standards-Version: 3.9.2 Homepage: http://www.networkupstools.org/ Vcs-Browser: http://git.debian.org/?p=collab-maint/nut.git;a=summary @@ -37,9 +40,9 @@ Package: nut-server Architecture: any Depends: ${shlibs:Depends}, ${misc:Depends}, adduser, lsb-base (>= 3.0-6), ${udev}, nut-client (= ${binary:Version}) Suggests: nut-cgi, nut-snmp, nut-dev, nut-xml -Provides: ups-monitor, nut-doc, nut-usb -Conflicts: ups-monitor, nut-doc, nut-hal-drivers, nut-usb (<< 2.1.0-3), nut-dev (<< 2.2.2) -Replaces: nut-doc, nut (<< 2.6.1) +Provides: ups-monitor, nut-usb +Conflicts: ups-monitor, nut-hal-drivers, nut-usb (<< 2.1.0-3), nut-dev (<< 2.2.2) +Replaces: nut (<< 2.6.1) Breaks: nut (<< 2.6.1) Description: network UPS tools - core system Network UPS Tools (NUT) is a client/server monitoring system that @@ -127,6 +130,20 @@ Description: network UPS tools - PowerMan PDU driver This package provides powerman-pdu, which allows NUT clients to communicate with the PowerMan daemon to support PDUs. +Package: nut-doc +Architecture: all +Section: doc +Depends: ${misc:Depends} +Suggests: doc-base +Description: network UPS tools - documentation + Network UPS Tools (NUT) is a client/server monitoring system that + allows computers to share uninterruptible power supply (UPS) and + power distribution unit (PDU) hardware. Clients access the hardware + through the server, and are notified whenever the power status + changes. + . + This package contains FAQ, user, developer and packager documentation. + Package: libupsclient1 Architecture: any Depends: ${shlibs:Depends}, ${misc:Depends} diff --git a/debian/nut-doc.doc-base.nut-developer-guide b/debian/nut-doc.doc-base.nut-developer-guide new file mode 100644 index 0000000..ed3ad0d --- /dev/null +++ b/debian/nut-doc.doc-base.nut-developer-guide @@ -0,0 +1,13 @@ +Document: nut-developer-guide +Title: Network UPS Tools Developer Guide +Author: Russell Kroll, Arnaud Quette, Charles Lepple and Peter Selinger +Abstract: This document intend to describe how NUT is designed, + and the way to develop new device drivers and client applications. +Section: Programming + +Format: PDF +Files: /usr/share/doc/nut-doc/pdf/developer-guide.pdf + +Format: HTML +Index: /usr/share/doc/nut-doc/html/developer-guide/index.html +Files: /usr/share/doc/nut-doc/html/developer-guide/*.html diff --git a/debian/nut-doc.doc-base.nut-faq b/debian/nut-doc.doc-base.nut-faq new file mode 100644 index 0000000..098042f --- /dev/null +++ b/debian/nut-doc.doc-base.nut-faq @@ -0,0 +1,12 @@ +Document: nut-faq +Title: NUT Frequently asked questions +Author: Arnaud Quette +Abstract: Frequently asked questions for Network UPS Tools (NUT) +Section: Help/FAQ + +Format: PDF +Files: /usr/share/doc/nut-doc/pdf/FAQ.pdf + +Format: HTML +Index: /usr/share/doc/nut-doc/html/FAQ.html +Files: /usr/share/doc/nut-doc/html/FAQ.html diff --git a/debian/nut-doc.doc-base.nut-packager-guide b/debian/nut-doc.doc-base.nut-packager-guide new file mode 100644 index 0000000..61d6b46 --- /dev/null +++ b/debian/nut-doc.doc-base.nut-packager-guide @@ -0,0 +1,15 @@ +Document: nut-packager-guide +Title: NUT Packager and Integrators Guide +Author: Arnaud Quette +Abstract: Packaging is a final aim for software. + It eases and completes the software integration into an OS, + and allows users to have an easy software installation and support out of the box. + This document describes best practice for packaging NUT. +Section: Debian + +Format: PDF +Files: /usr/share/doc/nut-doc/pdf/packager-guide.pdf + +Format: HTML +Index: /usr/share/doc/nut-doc/html/packager-guide/index.html +Files: /usr/share/doc/nut-doc/html/packager-guide/*.html diff --git a/debian/nut-doc.doc-base.nut-user-manual b/debian/nut-doc.doc-base.nut-user-manual new file mode 100644 index 0000000..76db720 --- /dev/null +++ b/debian/nut-doc.doc-base.nut-user-manual @@ -0,0 +1,15 @@ +Document: nut-user-manual +Title: Network UPS Tools User Manual +Author: Russell Kroll, Arnaud Quette and Arjen de Korte +Abstract: This document intend to describe how to install software support + for your Power Devices (UPS, PDU, …), and how to use the NUT project. + It is not intended to explain what are, nor distinguish the different technologies that exist. + For such information, have a look at the General Power Devices Information. +Section: System/Administration + +Format: PDF +Files: /usr/share/doc/nut-doc/pdf/user-manual.pdf + +Format: HTML +Index: /usr/share/doc/nut-doc/html/user-manual/index.html +Files: /usr/share/doc/nut-doc/html/user-manual/*.html diff --git a/debian/nut-doc.install b/debian/nut-doc.install new file mode 100644 index 0000000..e3f78fa --- /dev/null +++ b/debian/nut-doc.install @@ -0,0 +1 @@ +debian/tmp/usr/share/doc/nut-doc/ diff --git a/debian/rules b/debian/rules index 3219e60..871ffb1 100755 --- a/debian/rules +++ b/debian/rules @@ -32,6 +32,11 @@ ifeq (linux,$(DEB_HOST_ARCH_OS)) DEB_CONFIGURE_EXTRA_FLAGS+=--with-udev-dir=/lib/udev endif +# only build documentation if asciidoc is installed +ifneq ($(shell which asciidoc),) + DEB_CONFIGURE_EXTRA_FLAGS+=--with-doc=html-chunked,pdf +endif + common-install-arch:: # install the bash completion script mkdir -p $(CURDIR)/debian/tmp/etc/bash_completion.d @@ -44,10 +49,23 @@ common-install-arch:: mv $${f} $(CURDIR)/debian/tmp/etc/nut/$${nf}; \ done +common-install-indep:: + #install documentation + mkdir -p $(CURDIR)/debian/tmp/usr/share/doc/nut-doc/pdf + mkdir -p $(CURDIR)/debian/tmp/usr/share/doc/nut-doc/html + cp $(CURDIR)/docs/*.pdf $(CURDIR)/debian/tmp/usr/share/doc/nut-doc/pdf + cp $(CURDIR)/docs/FAQ.html $(CURDIR)/debian/tmp/usr/share/doc/nut-doc/html + + for f in $(CURDIR)/docs/*.chunked/; do \ + nf=`basename $${f} | sed 's/\(.*\)\.chunked/\1/'`; \ + cp -a $${f} $(CURDIR)/debian/tmp/usr/share/doc/nut-doc/html/$${nf}/; \ + done + binary-install/nut-monitor:: dh_python2 -pnut-monitor DEB_DH_INSTALLINIT_ARGS_nut-server := --init-script=nut -- start 50 2 3 4 5 . stop 50 0 1 6 . +DEB_DH_COMPRESS_ARGS_nut-doc := -X.pdf ifeq (linux,$(DEB_HOST_ARCH_OS)) # for Debian