[DRE-commits] [ruby-hoe] 04/09: total reconfiguration of documentation

[Caitlin Matos]

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

cm-guest pushed a commit to branch master
in repository ruby-hoe.

commit c6b4c71a20ab091673ce2d703944b351d154e491
Author: Caitlin Matos <caitlin.matos at zoho.com>
Date:   Wed Aug 6 15:29:06 2014 -0400

    total reconfiguration of documentation
    
    Upstream is now providing documentation in rdoc format instead of *.txt.
    The Debian sow.1 manpage contained many errors.
    
    * install upstream rdocs
      - requires BD libjs-jquery
    * install upstream changelog
    * sow.1 revamped
      - spelling + grammar fixes
      - formatting fixes
      - SEE ALSO section points to available documentation
---
 debian/control        |  2 +-
 debian/ruby-hoe.docs  |  3 ++-
 debian/ruby-hoe.links |  1 +
 debian/rules          | 11 +++++++++++
 debian/sow.1          | 34 ++++++++++++++++++++--------------
 5 files changed, 35 insertions(+), 16 deletions(-)

diff --git a/debian/control b/debian/control
index 7de833a..650e35d 100644
--- a/debian/control
+++ b/debian/control
@@ -3,7 +3,7 @@ Section: ruby
 Priority: optional
 Maintainer: Debian Ruby Extras Maintainers <pkg-ruby-extras-maintainers at lists.alioth.debian.org>
 Uploaders: Clint Byrum <clint at ubuntu.com>
-Build-Depends: debhelper (>= 7.0.50~), gem2deb (>= 0.2.2), ruby-minitest (>= 2.12), rake (>= 0.8.7)
+Build-Depends: debhelper (>= 7.0.50~), gem2deb (>= 0.2.2), ruby-minitest (>= 2.12), rake (>= 0.8.7), libjs-jquery
 Standards-Version: 3.9.5
 Vcs-Git: git://anonscm.debian.org/pkg-ruby-extras/ruby-hoe.git
 Vcs-Browser: http://anonscm.debian.org/gitweb?p=pkg-ruby-extras/ruby-hoe.git;a=summary
diff --git a/debian/ruby-hoe.docs b/debian/ruby-hoe.docs
index 71dfd5b..3aabd31 100644
--- a/debian/ruby-hoe.docs
+++ b/debian/ruby-hoe.docs
@@ -1 +1,2 @@
-README.txt
+rdoc
+README.rdoc
diff --git a/debian/ruby-hoe.links b/debian/ruby-hoe.links
new file mode 100644
index 0000000..c28ce5e
--- /dev/null
+++ b/debian/ruby-hoe.links
@@ -0,0 +1 @@
+usr/share/javascript/jquery/jquery.js usr/share/doc/ruby-hoe/rdoc/js/jquery.js
diff --git a/debian/rules b/debian/rules
index 370cd49..c7b5377 100755
--- a/debian/rules
+++ b/debian/rules
@@ -14,3 +14,14 @@
 
 %:
 	dh $@ --buildsystem=ruby --with ruby
+
+override_dh_installdocs:
+	rdoc --op rdoc --main README.rdoc --title=Hoe README.rdoc History.rdoc
+	dh_installdocs
+
+override_dh_installchangelogs:
+	dh_installchangelogs History.rdoc
+
+override_dh_clean:
+	$(RM) -r rdoc
+	dh_clean
diff --git a/debian/sow.1 b/debian/sow.1
index 78ea913..422c422 100644
--- a/debian/sow.1
+++ b/debian/sow.1
@@ -1,36 +1,42 @@
-.TH SOW "1" "" "" "ruby-hoe"
+.TH SOW "1" "August 2014" "hoe 3.12.0" "sow (ruby-hoe)"
 .SH NAME
-sow \- command line interface to the Hoe gem creation helper library
+sow \- command line interface for the Hoe gem creation helper library
 .SH SYNOPSIS
 .B sow
 [\fIoptions\fR] \fIproject_name\fR
-
 .SH DESCRIPTION
-
 .B sow
-is a command-line utility around the Ruby Hoe library, a
-which provides extensions to rake to automate every step of the development
-process from genesis to release. It provides project creation, configuration,
-and a multitude of tasks including project maintenance, testing, analysis, and
-release. 
+is a command-line interface for \fBhoe\fR.
 
+.B hoe 
+is a rake/rubygems helper for Rakefiles. It helps you manage, maintain,
+and release your project and includes a dynamic plug-in system allowing for
+easy extensibility. The included plug-ins help with your usual project tasks,
+including rdoc generation, testing, packaging, deployment, and announcement.
+Many third-party plug-ins are also available.
 
 .SH OPTIONS
 .TP
 \fB\-t\fR, \fB\-\-trunk\fR
-Add a project to a subdirectory named \fIproject_name/\fBtrunk/\fR
+Add project to \fIproject_name/trunk/\fR
 .TP
 \fB\-d\fR, \fB\-\-dev\fR
-Add a project to a subdirectory named \fIproject_name/\fBdev/\fR
+Add project to \fIproject_name/dev/\fR
 .TP
 \fB\-s\fR \fIstyle\fR, \fB\-\-style\fR \fIstyle\fR
 Use the template \fIstyle\fR
 .TP
 \fB\-h\fR, \fB\-\-help\fR
-Show a help message similar to this manpage.
+Show a help message similar to this page.
 
 .SH AUTHORS
+.B sow
+and
+.B hoe
+were created by Ryan Davis.
 
-Hoe has been written by Ryan Davis. This man page has been written for the
-Debian project be can be used by others.
+This page was written for the Debian project be can be used by others.
 
+.SH SEE ALSO
+.nh
+More comprehensive documentation for \fBhoe\fR is located under \fI/usr/share/doc/ruby-hoe/rdoc/index.html\fR, and online at \fIhttp://docs.seattlerb.org/hoe\fR. An additional manual is available at \fIhttp://docs.seattlerb.org/hoe/Hoe.pdf\fR.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-hoe.git