[DRE-commits] [rubygems-integration] 04/05: Documentation update

[Antonio Terceiro]

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

terceiro pushed a commit to branch master
in repository rubygems-integration.

commit 1396c11162e4a35616890657c3e313d322f71408
Author: Antonio Terceiro <terceiro at softwarelivre.org>
Date:   Thu Apr 10 16:46:56 2014 -0300

    Documentation update
---
 README.markdown  | 29 ++++++++++++++++++++++-------
 debian/copyright |  2 +-
 2 files changed, 23 insertions(+), 8 deletions(-)

diff --git a/README.markdown b/README.markdown
index 4245bc4..30e503d 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,19 +1,34 @@
 # rubygems-integration
 
 This package makes Debian Ruby recognizable by Rubygems. The packages will be
-listed by `gem list` and will be recognized by Rubygems. They can be used to
-satisfy dependencies both with plain Rubygems and with Bundler. As a special
-case, they can be used to satisfy dependencies of Rails 3 applications.
+listed by `gem list` and will be recognized by Rubygems as being installed.
+They can be used to satisfy dependencies both with plain Rubygems and with
+Bundler. As a special case, they can be used to satisfy dependencies of Rails 3
+applications.
 
 # How to make a Debian Ruby package work with rubygems-integration
 
-Install a gemspec file to /usr/share/rubygems-integration/$VERSION to make the
-package available for Ruby $VERSION (e.g. if $VERSION is 1.9.1 the the package
-will be visible to Rubygems on Ruby 1.9)
+Install a gemspec file to
+/usr/share/rubygems-integration/$VERSION/specifications to make the package
+available for Ruby $VERSION (e.g. if $VERSION is 1.9.1 the the package will be
+visible to Rubygems on Ruby 1.9)
+
+For packages that should work with any Ruby version, you must install the
+gemspec to /usr/share/rubygems-integration/all/specifications instead.
+
+`dh_ruby(1)` from the `gem2deb` package will do the above automatically for
+you.
+
+# Disabling rubygems-integration
+
+Even though rubygems-integration is insanely useful, there might be some cases
+where you want to disable it. To do that, export a environment variable named
+`DEBIAN_DISABLE_RUBYGEMS_INTEGRATION`. Only the presence of this variable
+matters, its value is completely ignored.
 
 # Copyright
 
-Copyright © 2012 Antonio Terceiro <terceiro at debian.org>
+Copyright © 2012-2014 Antonio Terceiro <terceiro at debian.org>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
diff --git a/debian/copyright b/debian/copyright
index 1f27a4d..dc3c70a 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -3,7 +3,7 @@ Upstream-Name: rubygems-integration
 Source: http://git.debian.org/?p=pkg-ruby-extras/rubygems-integration.git;a=summary
 
 Files: *
-Copyright: 2012 Antonio Terceiro <terceiro at debian.org>
+Copyright: 2012-2014 Antonio Terceiro <terceiro at debian.org>
 License: Expat
  Permission is hereby granted, free of charge, to any person obtaining
  a copy of this software and associated documentation files (the

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