r44172 - in /packages/mrmpi/trunk/debian: README.source changelog control mrmpi-doc.doc-base mrmpi-doc.docs rules

malat-guest at users.alioth.debian.org malat-guest at users.alioth.debian.org
Thu Dec 15 10:13:36 UTC 2011 

Author: malat-guest
Date: Thu Dec 15 10:13:34 2011
New Revision: 44172

URL: http://svn.debian.org/wsvn/debian-science/?sc=1&rev=44172
Log:
polish documentation

Added:
    packages/mrmpi/trunk/debian/README.source
    packages/mrmpi/trunk/debian/mrmpi-doc.doc-base
    packages/mrmpi/trunk/debian/mrmpi-doc.docs
Modified:
    packages/mrmpi/trunk/debian/changelog
    packages/mrmpi/trunk/debian/control
    packages/mrmpi/trunk/debian/rules

Added: packages/mrmpi/trunk/debian/README.source
URL: http://svn.debian.org/wsvn/debian-science/packages/mrmpi/trunk/debian/README.source?rev=44172&op=file
==============================================================================
--- packages/mrmpi/trunk/debian/README.source (added)
+++ packages/mrmpi/trunk/debian/README.source Thu Dec 15 10:13:34 2011
@@ -1,0 +1,9 @@
+This MRMPI release is a custom repackaged of MRMPI. This package does not
+contains neither the upstream *.html nor the *.pdf files. Both HTML and PDF
+files are regenerated from the *.txt files.
+
+Since the documentation required a 3rd party txt2html (different from txt2html
+package), we are including this single .cpp file as part of the MRMPI release.
+We are building this custom txt2html during the -indep step.
+
+ -- Mathieu Malaterre <mathieu.malaterre at gmail.com>  Thu, 15 Dec 2011 10:38:11 +0100

Modified: packages/mrmpi/trunk/debian/changelog
URL: http://svn.debian.org/wsvn/debian-science/packages/mrmpi/trunk/debian/changelog?rev=44172&op=diff
==============================================================================
--- packages/mrmpi/trunk/debian/changelog (original)
+++ packages/mrmpi/trunk/debian/changelog Thu Dec 15 10:13:34 2011
@@ -1,3 +1,9 @@
+mrmpi (1.0~20110621-1) UNRELEASED; urgency=low
+
+  * Build documentation
+
+ -- Mathieu Malaterre <mathieu.malaterre at gmail.com>  Thu, 15 Dec 2011 10:38:11 +0100
+
 mrmpi (1.0~20110620-1) experimental; urgency=low
 
   * Initial Debian Upload (Closes: #646757)

Modified: packages/mrmpi/trunk/debian/control
URL: http://svn.debian.org/wsvn/debian-science/packages/mrmpi/trunk/debian/control?rev=44172&op=diff
==============================================================================
--- packages/mrmpi/trunk/debian/control (original)
+++ packages/mrmpi/trunk/debian/control Thu Dec 15 10:13:34 2011
@@ -5,6 +5,7 @@
 DM-Upload-Allowed: yes
 Uploaders: Mathieu Malaterre <mathieu.malaterre at gmail.com>, Dominique Belhachemi <domibel at debian.org>
 Build-Depends: debhelper (>= 8), cmake (>= 2.6.3), mpi-default-dev
+Build-Depends-Indep: htmldoc
 Standards-Version: 3.9.2
 Homepage: http://www.cs.sandia.gov/~sjplimp/mapreduce.html
 Vcs-Browser: http://anonscm.debian.org/viewvc/debian-science/packages/mrmpi/trunk/
@@ -48,3 +49,20 @@
  .
  This package contains the libraries needed to run MapReduce-MPI applications.
 
+Package: mrmpi-doc
+Architecture: all
+Depends: ${misc:Depends}
+Description: Implements MapReduce operation on top of standard MPI message - doc
+ The MapReduce-MPI (MR-MPI) library is open-source software that implements the
+ MapReduce operation popularized by Google on top of standard MPI message
+ passing.
+ .
+ The MR-MPI library is written in C++ and is callable from hi-level langauges
+ such as C++, C, Fortran. A Python wrapper is also included, so MapReduce
+ programs can be written in Python, including map() and reduce() user callback
+ methods. A hi-level scripting interface to the MR-MPI library, called OINK, is
+ also included which can be used to develop and chain MapReduce algorithms
+ together in scripts with commands that simplify data management tasks. OINK has
+ its own manual and doc pages.
+ .
+ This package contains the documentation for MapReduce-MPI applications.

Added: packages/mrmpi/trunk/debian/mrmpi-doc.doc-base
URL: http://svn.debian.org/wsvn/debian-science/packages/mrmpi/trunk/debian/mrmpi-doc.doc-base?rev=44172&op=file
==============================================================================
--- packages/mrmpi/trunk/debian/mrmpi-doc.doc-base (added)
+++ packages/mrmpi/trunk/debian/mrmpi-doc.doc-base Thu Dec 15 10:13:34 2011
@@ -1,0 +1,23 @@
+Document: mrmpi-doc
+Title: MapReduce-MPI Library Users Manual
+Author: Sandia National Laboratories
+Abstract: The MapReduce-MPI (MR-MPI) library is open-source software that
+ implements the "MapReduce operation" popularized by Google on top
+ of standard MPI message passing.
+ .
+ The library is designed for parallel execution on distributed-memory
+ platforms, but will also operate on a single processor.  It requires
+ no additional software to build and run, except linking with an MPI
+ library if you wish to perform MapReduces in parallel.  Similar to the
+ original Google design, a user performs a MapReduce by writing a small
+ program that invokes the library.  The user typically provides two
+ application-specific functions, a "map()" and a "reduce()", that are
+ called back from the library when a MapReduce operation is executed.
+ "Map()" and "reduce()" are serial functions, meaning they are invoked
+ independently on individual processors on portions of your data when
+ performing a MapReduce operation in parallel.
+Section: Science/Data Analysis
+
+Format: HTML
+Index: /usr/share/doc/mrmpi-doc/index.html
+Files: /usr/share/doc/mrmpi-doc/*.html

Added: packages/mrmpi/trunk/debian/mrmpi-doc.docs
URL: http://svn.debian.org/wsvn/debian-science/packages/mrmpi/trunk/debian/mrmpi-doc.docs?rev=44172&op=file
==============================================================================
--- packages/mrmpi/trunk/debian/mrmpi-doc.docs (added)
+++ packages/mrmpi/trunk/debian/mrmpi-doc.docs Thu Dec 15 10:13:34 2011
@@ -1,0 +1,1 @@
+doc/*.html

Modified: packages/mrmpi/trunk/debian/rules
URL: http://svn.debian.org/wsvn/debian-science/packages/mrmpi/trunk/debian/rules?rev=44172&op=diff
==============================================================================
--- packages/mrmpi/trunk/debian/rules (original)
+++ packages/mrmpi/trunk/debian/rules Thu Dec 15 10:13:34 2011
@@ -16,6 +16,7 @@
 
 pkg_run = libmrmpi1
 pkg_dev = libmrmpi-dev
+pkg_doc = mrmpi-doc
 
 %:
 	dh $@ --buildsystem=cmake --parallel
@@ -23,12 +24,30 @@
 override_dh_auto_configure:
 	dh_auto_configure -- $(CMAKE_FLAGS)
 
-override_dh_install:
+override_dh_install-arch:
 	# Runtime Package
 	dh_install -p$(pkg_run) usr/lib/lib*.so.*
 	# Development Package
 	dh_install -p$(pkg_dev) usr/include
 	dh_install -p$(pkg_dev) usr/lib/lib*.so
+
+# Let's be smart with building doc
+override_dh_auto_build-indep:
+	# Need a custom txt2html
+	g++ ./txt2html/txt2html.cpp -o mrmpi_txt2html
+	# Generate html file for PDF:
+	./mrmpi_txt2html -b doc/*.txt
+	# Generate PDF from HTML
+	(cd doc && htmldoc --title --toctitle "Table of Contents" --tocfooter ..i --toclevels 4 \
+		--header ... --footer ..1 --size letter --linkstyle plain --linkcolor blue -f \
+		Manual.pdf Manual.html Background.html Whatis.html Start.html Program.html \
+		Interface_c++.html [a-z]*.html Interface_c.html Interface_python.html \
+		Interface_oink.html Technical.html Examples.html)
+	# Generate clean HTML files:
+	./mrmpi_txt2html doc/*.txt
+
+# No tests needed for docs
+override_dh_auto_test-indep:
 
 VER_FULL = $(shell dpkg-parsechangelog | grep '^Version' | cut -d' ' -f2 | cut -f1 -d-)
 
@@ -37,14 +56,21 @@
 DEBIAN_SRC_DIR = mrmpi-$(VER_FULL)
 DEBIAN_SRC_TAR = mrmpi_$(VER_FULL).orig.tar.gz
 
-$(UPSTREAM_SRC).tar.gz:
+txt2html.tar.gz:
+	wget http://www.cs.sandia.gov/~sjplimp/tars/$@
+
+$(UPSTREAM_SRC).tar.gz: txt2html.tar.gz
 	wget http://www.cs.sandia.gov/~sjplimp/tars/$@
 
 get-orig-source: $(UPSTREAM_SRC).tar.gz
 	tar xzf $(UPSTREAM_SRC).tar.gz
 	mv $(UPSTREAM_SRC_DIR) $(DEBIAN_SRC_DIR)
 	rm $(DEBIAN_SRC_DIR)/oinkdoc/Manual.pdf
+	rm $(DEBIAN_SRC_DIR)/oinkdoc/*.html
 	rm $(DEBIAN_SRC_DIR)/doc/Manual.pdf
+	rm $(DEBIAN_SRC_DIR)/doc/*.html
+	tar xfz txt2html.tar.gz -C $(DEBIAN_SRC_DIR)
 	GZIP="--best --no-name" tar czf $(DEBIAN_SRC_TAR) $(DEBIAN_SRC_DIR)
 	rm -rf $(DEBIAN_SRC_DIR)
 	rm $(UPSTREAM_SRC).tar.gz
+	rm txt2html.tar.gz

More information about the debian-science-commits mailing list