[med-svn] [kmc] 03/03: finish manpage building

[Sascha Steinbiss]

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

sascha-guest pushed a commit to branch master
in repository kmc.

commit 158dd9c28c2ce929ca458e64f9acd8f987728af5
Author: Sascha Steinbiss <sascha at steinbiss.name>
Date:   Tue Dec 22 22:07:38 2015 +0000

    finish manpage building
---
 debian/control                  |  1 +
 debian/kmc.manpages             |  1 +
 debian/man_src/kmc_tools.1.ronn | 24 +++++++++++++-----------
 debian/rules                    |  8 +++++++-
 debian/usage_to_man             | 11 ++++++-----
 5 files changed, 28 insertions(+), 17 deletions(-)

diff --git a/debian/control b/debian/control
index 83cfdce..dda4057 100644
--- a/debian/control
+++ b/debian/control
@@ -11,6 +11,7 @@ Build-Depends: debhelper (>= 9),
                zlib1g-dev,
                libbz2-dev,
                help2man,
+               ruby-ronn,
                d-shlibs
 Standards-Version: 3.9.6
 Vcs-Browser: https://anonscm.debian.org/cgit/debian-med/kmc.git
diff --git a/debian/kmc.manpages b/debian/kmc.manpages
index bf519d7..71aae3a 100644
--- a/debian/kmc.manpages
+++ b/debian/kmc.manpages
@@ -1 +1,2 @@
 man/*.1
+debian/man/*.1
diff --git a/debian/man_src/kmc_tools.1.ronn b/debian/man_src/kmc_tools.1.ronn
index dd52525..05c996d 100644
--- a/debian/man_src/kmc_tools.1.ronn
+++ b/debian/man_src/kmc_tools.1.ronn
@@ -1,30 +1,30 @@
-kmc_tools(1) - additional operations on KMC databases
-=====================================================
+kmc_tools(1) - additional operations on k-mer databases
+=======================================================
 
 ## SYNOPSIS
 
-kmc_tools [global parameters] <operation> [operation parameters]
+    kmc_tools [global parameters] <operation> [operation parameters]
 
 ## DESCRIPTION
 
 This command and its various subcomments implement a number of operations on
 KMC databases.
 
-### k-mers sets' operations for 2 KMC's databases:
+### k-mers sets operations for 2 KMC databases
 
   * `intersect`:
-    intersection of 2 k-mers' sets
+    intersection of 2 k-mers sets
 
   * `kmers_subtract`:
-    subtraction of 2 k-mers' sets
+    subtraction of 2 k-mers sets
 
   * `counters_subtract`:
-    counters' subtraction of 2 k-mers' sets
+    counters subtraction of 2 k-mer sets
 
   * `union`:
-    union of 2 k-mers' sets
+    union of 2 k-mers sets
 
-### operations for single kmc database:
+### operations for single kmc database
 
   * `sort`:
     sorts k-mers from database generated by KMC2.x
@@ -46,7 +46,7 @@ KMC databases.
   * `complex`:
     complex operations with a number of input databases
 
-### other operatations:
+### other operations:
 
   * `filter`:
     filter out reads with too small number of k-mers
@@ -57,9 +57,11 @@ KMC databases.
 
   * `-t<value>`:
     total number of threads (default: no. of CPU cores)
+
   * `-v`:
     enable verbose mode (shows some information) (default: false)
-  * `-hp`
+
+  * `-hp`:
     hide percentage progress (default: false)
 
 ## EXAMPLE
diff --git a/debian/rules b/debian/rules
index 8e5019a..6a1079a 100755
--- a/debian/rules
+++ b/debian/rules
@@ -5,7 +5,6 @@ DEBVERS := $(shell dpkg-parsechangelog | sed -n -e 's/^Version: //p')
 VERSION := $(shell echo '$(DEBVERS)' | sed -e 's/^[0-9-]*://' -e 's/[~-].*//')
 OVERSION := $(shell echo '$(DEBVERS)' | sed -e 's/^[[:digit:]]*://' -e 's/[+].*//')
 
-
 mandir := $(CURDIR)/debian/man
 debfolder := $(CURDIR)/debian
 
@@ -15,9 +14,16 @@ debfolder := $(CURDIR)/debian
 override_dh_install:
 	dh_install
 
+override_dh_auto_clean:
+	rm -rf $(debfolder)/man_src/*.html $(debfolder)/man_src/*.?
+	rm -rf $(mandir)
+	dh_auto_clean --
+
 override_dh_installman:
 	mkdir -p $(mandir)
 	$(debfolder)/usage_to_man
+	ronn $(debfolder)/man_src/*.ronn
+	cp $(debfolder)/man_src/*.? $(mandir)
 	dh_installman --
 
 get-orig-source:
diff --git a/debian/usage_to_man b/debian/usage_to_man
index 6d58013..a129284 100755
--- a/debian/usage_to_man
+++ b/debian/usage_to_man
@@ -21,7 +21,8 @@ sub createManPages {
 
   my @files;
 
-  push(@files,`ls $source/kmc*`);
+  push(@files,"$source/kmc");
+  push(@files,"$source/kmc_dump");
 
   if ( scalar @files > 0 ) {
 
@@ -42,7 +43,7 @@ sub createManPages {
 
       my $kmc_dump_short_description = q{list k-mers from kmc-generated database};
       my $kmc_dump_long_description = q{KMC's end product is a database of k-mers stored in compact binary form. The kmc_dump program allows the production of a textual list of k-mers together with their counters for the analysis ran};
-      
+
 
       my $cmd = "help2man -N -m $filename -n $filename --no-discard-stderr $file | sed 's/usage://gi'";
       my @output;
@@ -52,7 +53,7 @@ sub createManPages {
 	$line =~ s/\n$//;
 
       }
-      
+
       my @lines_not_to_print;
       my @lines_to_print;
       if ($filename eq 'kmc') {
@@ -72,7 +73,7 @@ sub createManPages {
 	      if ($output_line =~ m/^K\\-Mer Counter/) {
 		  $output_line = $kmc_long_description;
 	      }
-	      
+
 	      if ($output_line =~ m/^\.SS \"Parameters\:\"/ && ! $ss_param_seen) {
 		  push(@lines_not_to_print, $i);
 		  push(@lines_not_to_print, $i + 1);
@@ -181,7 +182,7 @@ sub createManPages {
 	  for my $line(@parameters_lines) {
 	      push(@lines_to_print, $line);
 	  }
-	  
+
       }
       open (my $man_fh, ">", $man_file);
       for my $line(@lines_to_print) {

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/kmc.git