[DRE-commits] [ruby-ffi-yajl] 05/06: Convert documentation to HTML

Tiago Ilieve myhro-guest at moszumanska.debian.org
Thu May 5 16:34:26 UTC 2016


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

myhro-guest pushed a commit to branch master
in repository ruby-ffi-yajl.

commit a006ea67627698c5107840959326b74bb4a406e1
Author: Tiago Ilieve <tiago.myhro at gmail.com>
Date:   Wed May 4 19:52:05 2016 -0300

    Convert documentation to HTML
---
 debian/clean                           |  1 +
 debian/control                         |  1 +
 debian/patches/0002-Clean-README.patch | 41 ++++++++++++++++++++++++++++++++++
 debian/patches/series                  |  1 +
 debian/ruby-ffi-yajl.docs              |  2 +-
 debian/rules                           |  4 ++++
 6 files changed, 49 insertions(+), 1 deletion(-)

diff --git a/debian/clean b/debian/clean
new file mode 100644
index 0000000..daa30a3
--- /dev/null
+++ b/debian/clean
@@ -0,0 +1 @@
+README.html
diff --git a/debian/control b/debian/control
index a6a010a..3c5a742 100644
--- a/debian/control
+++ b/debian/control
@@ -5,6 +5,7 @@ Maintainer: Debian Ruby Extras Maintainers <pkg-ruby-extras-maintainers at lists.al
 Uploaders: Antonio Terceiro <terceiro at debian.org>,
            Tiago Ilieve <tiago.myhro at gmail.com>
 Build-Depends: debhelper (>= 9~),
+               discount,
                gem2deb,
                libyajl-dev,
                rake,
diff --git a/debian/patches/0002-Clean-README.patch b/debian/patches/0002-Clean-README.patch
new file mode 100644
index 0000000..7c73489
--- /dev/null
+++ b/debian/patches/0002-Clean-README.patch
@@ -0,0 +1,41 @@
+Description: the README file will be converted from Markdown to HTML during
+build time. Two things have been done to clean it:
+.
+To avoid fetching content from external sources when it is accessed, the
+status image from Travis CI and Code Climate were removed.
+.
+The "How to Install" section was removed, as users of binary packages doesn't
+need them.
+Forwarded: not-needed
+Author: Tiago Ilieve <tiago.myhro at gmail.com>
+
+--- a/README.md
++++ b/README.md
+@@ -1,6 +1,3 @@
+-
+-[![Build Status](https://travis-ci.org/chef/ffi-yajl.png)](https://travis-ci.org/chef/ffi-yajl)  [![Code Climate](https://codeclimate.com/github/chef/ffi-yajl.png)](https://codeclimate.com/github/chef/ffi-yajl)
+-
+ # FFI YAJL
+ 
+ ffi-yajl is a Ruby adapter for the [yajl](http://lloyd.github.io/yajl/)
+@@ -9,20 +6,6 @@
+ order to be compatible with as many Ruby implementations as possible
+ while providing good performance where possible.
+ 
+-## How to Install
+-
+-Install from the command-line:
+-
+-```
+-gem install ffi-yajl
+-```
+-
+-Or use a Gemfile:
+-
+-```
+-gem 'ffi-yajl'
+-```
+-
+ ## Supported Ruby VMs:
+ 
+ * Ruby MRI 1.9.3/2.0.0/2.1.x/2.2.x
diff --git a/debian/patches/series b/debian/patches/series
index d69acbc..15c7306 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1 +1,2 @@
 0001-Use-the-system-libyajl2.patch
+0002-Clean-README.patch
diff --git a/debian/ruby-ffi-yajl.docs b/debian/ruby-ffi-yajl.docs
index b43bf86..daa30a3 100644
--- a/debian/ruby-ffi-yajl.docs
+++ b/debian/ruby-ffi-yajl.docs
@@ -1 +1 @@
-README.md
+README.html
diff --git a/debian/rules b/debian/rules
index 1caa6d1..ea9ec3c 100755
--- a/debian/rules
+++ b/debian/rules
@@ -5,6 +5,10 @@ export GEM2DEB_TEST_RUNNER = --check-dependencies
 %:
 	dh $@ --buildsystem=ruby --with ruby
 
+override_dh_auto_build:
+	dh_auto_build
+	mkd2html README.md
+
 override_dh_auto_install:
 	dh_auto_install
 	# included binary is not useful on end user systems

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



More information about the Pkg-ruby-extras-commits mailing list