[DRE-commits] [ruby-coveralls] 07/07: Add man page

[Miguel Landaeta]

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

nomadium pushed a commit to branch master
in repository ruby-coveralls.

commit bf9be605e3eed99c41b7a3e361a2291fac490bd2
Author: Miguel Landaeta <nomadium at debian.org>
Date:   Tue Mar 4 20:07:44 2014 -0300

    Add man page
---
 debian/clean         |  1 +
 debian/coveralls.mkd | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 debian/manpages      |  1 +
 debian/rules         |  4 +++
 4 files changed, 82 insertions(+)

diff --git a/debian/clean b/debian/clean
new file mode 100644
index 0000000..ba5a192
--- /dev/null
+++ b/debian/clean
@@ -0,0 +1 @@
+debian/coveralls.1
diff --git a/debian/coveralls.mkd b/debian/coveralls.mkd
new file mode 100644
index 0000000..1225921
--- /dev/null
+++ b/debian/coveralls.mkd
@@ -0,0 +1,76 @@
+coveralls(1) -- Coveralls API client utility
+============================================
+
+## SYNOPSIS
+
+__coveralls__ _sub-command_
+
+## DESCRIPTION
+
+Coveralls is a command-line utility to interact with Coveralls web service
+to help you track your code coverage over time, and ensure that all your
+new code is fully covered.
+
+Coveralls automatically collects your code coverage data, uploads it
+to their servers and gives you a nice interface to dig into it.
+
+Any type of Ruby project or test framework supported by SimpleCov is
+supported by the Coveralls gem. This includes all your favorites, like
+RSpec, Cucumber, and Test::Unit.
+
+## SUB-COMMANDS
+
+  * `help` COMMAND:
+    Describe available commands or one specific command.
+  * `last`:
+    View the last build for this repository on Coveralls.
+  * `open`:
+    View this repository on Coveralls.
+  * `push`:
+    Runs your test suite and pushes the coverage results to Coveralls.
+  * `report`:
+    Runs your test suite locally and displays coverage statistics.
+  * `service`:
+    View this repository on your CI service's website.
+  * `version`:
+    See version.
+
+## CONFIGURATION
+
+Coveralls for Ruby uses an optional `.coveralls.yml` file at the root
+level of your repository to configure options.
+
+The option `repo_token` (found on your repository's page on Coveralls)
+is used to specify which project on Coveralls your project maps to.
+This is only needed for repos not using a CI and should be kept
+secret -- anyone could use it to submit coverage data on your repo's
+behalf. This shouldn't be a concern for private repos, however.
+
+Another important option is `service_name` which allows you to specify
+where Coveralls should look to find additional information about your
+builds. This can be any string, but using travis-ci or travis-pro will
+allow Coveralls to fetch branch data, comment on pull requests, and more.
+
+## FILES
+
+_.coveralls.yml_
+
+Coveralls configuration file for Ruby. See __CONFIGURATION__.
+
+## SEE ALSO
+
+  For more information, you may visit Coveralls web site: <https://coveralls.io/> or <https://coveralls.io/docs/ruby>.
+
+  This manual page was generated from Markdown with __ronn(1)__ <http://rtomayko.github.com/ronn/ronn.1.html>
+
+## AUTHOR
+   Coveralls was written by Wil Gieseler <supapuerco at gmail.com>, 
+   with contributions from the community.
+
+## DOCUMENTATION
+   This manual page was written by Miguel Landaeta <nomadium at debian.org>.
+
+## LICENSE
+   Both Coveralls and this documentation are released under the terms of the
+   MIT License. You may view the license online: <https://github.com/lemurheavy/coveralls-ruby/blob/master/LICENSE>
+
diff --git a/debian/manpages b/debian/manpages
new file mode 100644
index 0000000..ba5a192
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1 @@
+debian/coveralls.1
diff --git a/debian/rules b/debian/rules
index 978ce74..a9e09c5 100755
--- a/debian/rules
+++ b/debian/rules
@@ -14,6 +14,10 @@
 %:
 	dh $@ --buildsystem=ruby --with ruby
 
+override_dh_auto_build:
+	dh_auto_build
+	ronn --roff debian/coveralls.mkd
+
 override_dh_auto_clean:
 	dh_auto_clean
 	-rm -rf coverage/

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