[Pkg-ruby-extras-maintainers] r404 - in website/src: .
ruby-pkg-tools
Paul van Tilburg
paulvt at costa.debian.org
Thu Mar 23 09:13:06 UTC 2006
Author: paulvt
Date: 2006-03-23 09:13:05 +0000 (Thu, 23 Mar 2006)
New Revision: 404
Modified:
website/src/00.index.en.page
website/src/00.index.es.page
website/src/00.index.nl.page
website/src/10.join.en.page
website/src/20.create.en.page
website/src/35.policy.en.page
website/src/40.rubygems.en.page
website/src/50.upstream-devs.en.page
website/src/ruby-pkg-tools/10.sources.en.page
website/src/ruby-pkg-tools/20.team-members.en.page
website/src/ruby-pkg-tools/30.cdbs.en.page
website/src/ruby-pkg-tools/40.uploaders.en.page
Log:
* Fixed some style inconsistencies.
* Updated content to mention the existence of two CBDS classes and explain
the usage.
* All h1 and h2 are now title-cases. h3, h4 can have a normal sentence-style.
* Wrapped some lines to < 80 chars. ;-)
Modified: website/src/00.index.en.page
===================================================================
--- website/src/00.index.en.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/00.index.en.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -3,7 +3,7 @@
inMenu: true
directoryName: Debian/Ruby Extras
---
-h2. Welcome to the Debian/Ruby Extras site
+h2. Welcome to the Debian/Ruby Extras Site
We're currently busy setting up this site, our Subversion infrastructure
and tools. This page will be updated regularly, so please keep visiting.
@@ -14,7 +14,7 @@
For general Debian/Ruby information the main
"Debian Ruby list":http://lists.debian.org/debian-ruby/.
-h2. About us
+h2. About Us
The Debian/Ruby Extras team currently has two goals:
# Creating and maintaining a @libruby-extras@ package that bundles small
Modified: website/src/00.index.es.page
===================================================================
--- website/src/00.index.es.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/00.index.es.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -3,7 +3,7 @@
inMenu: true
directoryName: Debian/Ruby Extras
---
-h2. Bienvenido a la página del proyecto Debian/Ruby Extras
+h2. Bienvenido a la Página del Proyecto Debian/Ruby Extras
Actualmente estamos ocupados poniendo a punto esta página, nuestra
infraestructura para Subversion y nuestras herramientas. Esta página se
@@ -14,7 +14,7 @@
correo":http://lists.alioth.debian.org/mailman/listinfo/pkg-ruby-extras-maintainers/
en Alioth. Hay información más general sobre Ruby en Debian en la "lista de Ruby en Debian":http://lists.debian.org/debian-ruby/.
-h2. Sobre nosotros
+h2. Sobre Nosotros
El equipo de Debian/Ruby Extras tiene dos objetivos:
Modified: website/src/00.index.nl.page
===================================================================
--- website/src/00.index.nl.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/00.index.nl.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -1,9 +1,9 @@
---
-title:
+title: Welkom
inMenu: true
directoryName: Debian/Ruby Extra's
---
-h2. Welkom op de Debian/Ruby Extra's site
+h2. Welkom op de Debian/Ruby Extra's Site
Op dit moment zijn we nog bezig om deze site op te zetten, net als onze
Subversion infrastructuur en gereedschappen. Deze pagina zal regelmatig
@@ -16,7 +16,7 @@
Zie voor algemene informatie over Debian en Ruby de
"Debian Ruby lijst":http://lists.debian.org/debian-ruby/.
-h2. Over het team
+h2. Over het Team
Het Debian/Ruby Extra's team heeft op dit moment twee hoofddoelen:
# Het creëren en onderhouden van het @libruby-extras@ pakket, dat
Modified: website/src/10.join.en.page
===================================================================
--- website/src/10.join.en.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/10.join.en.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -2,7 +2,7 @@
title: Joining the Team
inMenu: true
---
-h2. How to join the team?
+h2. How to Join the Team?
We always welcome people to help us out. If you want to, please
follow the following guidelines.
Modified: website/src/20.create.en.page
===================================================================
--- website/src/20.create.en.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/20.create.en.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -2,26 +2,28 @@
title: Creating a Package
inMenu: true
---
-h2. How to create a Debian/Ruby package?
+h2. How to Create a Debian/Ruby Package?
-_This page still has to be written..._
+_This page still has to be finished..._
h3. Preparing the source
+...
+
h3. Using CDBS
-First of all, the CDBS class is only for libraries using setup.rb (or
-install.rb). If the library you want to package doesn't use setup.rb, you'll
-have to either (1) add it yourself and make sure it works as expected, or (2)
-simply not use the class and package manually.
+First of all, the CDBS classes that are available can only be used for for
+libraries or applications that use @setup.rb@ (or @install.rb@) or
+ at extconf.rb@. If the library you want to package doesn't use @setup.rb@ or
+ at extconf.rb@ you'll have to either (1) add it yourself and make sure it
+works as expected, or (2) simply not use the class and package manually.
-If you want to use the CDBS class, you have to depend on ruby-pkg-tools. Then,
-in your debian/rules, you'll have to include it, and uploaders.mk if you are in
-the Ruby maintainers team. If you also include debhelper.mk, your rules will
-resemble this example:
+If you want to use the CDBS classes, you have to build-depend on
+ at ruby-pkg-tools@. Then, in your @debian/rules@, you'll have to include it,
+and @uploaders.mk@ if you are in the Ruby Extras maintainers team. If you
+also include @debhelper.mk@, your rules will resemble this example:
-<pre><code>
-#!/usr/bin/make -f
+<pre><code>#!/usr/bin/make -f
include /usr/share/cdbs/1/rules/debhelper.mk
include /usr/share/ruby-pkg-tools/1/class/ruby-setup-rb.mk
@@ -31,14 +33,14 @@
There are a number of configuration variables you can set. For more
information, see the "CDBS class information page":ruby-pkg-tools/cdbs.html.
-h3. Using Debhelper Directly
+h3. Using debhelper directly
-h3. Adding the Package to the Subversion Repository
+h3. Adding the package to the Subversion repository
First, you have to build your package outside of the SVN tree. You should
-get something like that :
+get something like that:
<pre><code>.
-|-- libfeedparser-ruby-0.1 (build dir)
+|-- libfeedparser-ruby-0.1/ (build dir)
|-- libfeedparser-ruby1.8-dev_0.1-1_all.deb
|-- libfeedparser-ruby1.8_0.1-1_all.deb
|-- libfeedparser-ruby_0.1-1.diff.gz
@@ -48,8 +50,8 @@
`-- libxfeedparser-ruby_0.1-1_all.deb
</code></pre>
-Then just do :
+Then just do:
<pre><code>svn-inject -v -o libfeedparser-ruby_0.1-1.dsc \
svn+ssh://LOGIN@svn.debian.org/svn/pkg-ruby-extras/packages/</code></pre>
-You should not try to import your package manually : this is a difficult process since you'll have to set a subversion property etc.
+You should not try to import your package manually: this is a difficult process since you'll have to set a subversion property etc.
Modified: website/src/35.policy.en.page
===================================================================
--- website/src/35.policy.en.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/35.policy.en.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -4,28 +4,38 @@
---
h1. Debian Ruby Policy
-This document SHOULD NOT be considered policy yet. It is only a support for discussion. Other documents worth reading:
-* "Debian Ruby Policy":http://pkg-ruby.alioth.debian.org/ruby-policy.html/index.html : a draft policy written by the pkg-ruby alioth team.
-* "Debian Python Policy":http://www.debian.org/doc/packaging-manuals/python-policy/ : an interesting read, since Python shares several problems with Ruby.
+This document SHOULD NOT be considered policy yet. It is only a support
+for discussion. Other documents worth reading:
+* "Debian Ruby Policy":http://pkg-ruby.alioth.debian.org/ruby-policy.html/index.html:
+ a draft policy written by the pkg-ruby alioth team.
+* "Debian Python Policy":http://www.debian.org/doc/packaging-manuals/python-policy/:
+ an interesting read, since Python shares several problems with Ruby.
h2. Packaging Variants
-There are two ways to package Ruby modules
+There are two ways to package Ruby modules:
-# Support only the default Ruby version
-# Support several Ruby versions
+# Support only the default Ruby version.
+# Support several Ruby versions.
h3. Support only the default Ruby version
-* Name you package libfoo-ruby
-* Depend on ruby (>= 1.X), ruby (<< 1.X+1) (you will trigger a conflict when the default ruby version is changed, so you will have to provide a new version ASAP, since your package will block the upgrade of ruby)
+* Name you package @libfoo-ruby at .
+* Depend on @ruby (>= 1.X)@, @ruby (<< 1.X+1)@ (you will trigger a conflict
+ when the default Ruby version is changed, so you will have to provide a
+ new version ASAP, since your package will block the upgrade of Ruby).
h3. Support several Ruby versions
-* Create a package libfoo-ruby which depends on libfoo-ruby1.X (1.X being the default ruby version)
-* Create libfoo-ruby1.X, libfoo-ruby1.Y for each ruby version you want to support
+* Create a package @libfoo-ruby@ which depends on @libfoo-ruby1.X@ (@1.X@ being
+ the default Ruby version).
+* Create @libfoo-ruby1.X@, @libfoo-ruby1.Y@ for each Ruby version you want
+ to support.
-h2. Documentation and examples
+h2. Documentation and Examples
-* If the documentation for your library is small enough, put in in libfoo-ruby (even if you are supporting several ruby versions)
-* If the documentation is too big, provide it in libfoo-ruby-doc, and make all other packages suggest libfoo-ruby-doc.
+* If the documentation for your library is small enough, put in in
+ @libfoo-ruby@ (even if you are supporting several Ruby versions).
+
+* If the documentation is too big, provide it in @libfoo-ruby-doc@, and
+ make all other packages suggest @libfoo-ruby-doc at .
Modified: website/src/40.rubygems.en.page
===================================================================
--- website/src/40.rubygems.en.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/40.rubygems.en.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -16,7 +16,7 @@
However, the Debian/Ruby Extras team fear that Rubygems will make it much more
difficult to package and distribute Ruby software in Debian (similar concerns
-have been raised by other individuals and GNU/Linux distributions) :
+have been raised by other individuals and GNU/Linux distributions):
* Rubygems packages are not compatible with the FHS. Rubygems follows the "one
directory per package and version" rule.
@@ -30,7 +30,7 @@
* There are currently no plans to improve RubyGems to ease the work of Debian
and RPM packagers.
-h2. Position of the Debian/Ruby Extras team
+h2. Position of the Debian/Ruby Extras Team
# We do not oppose Ruby having a packaging system. However, since Debian has
its own system already, we prefer to use upstream sources so that we can
@@ -56,7 +56,7 @@
These utilites would not solve any problems, just ease the initial
(re)packaging work a bit.
-h2. For reference : file system layout of the rmail package
+h2. For Reference: file system layout of the rmail package
h3. Content of /usr/lib/ruby/gems added after the execution of **gem install rmail**
@@ -127,9 +127,9 @@
/usr/share/doc/librmail-ruby1.8/NEWS.gz
/usr/share/doc/librmail-ruby1.8/changelog.Debian.gz</pre></code>
-h2. rubygems package
+h2. @rubygems@ package
-Daigo Moriwaki maintains an unofficial rubygems package :
+Daigo Moriwaki maintains an unofficial rubygems package:
<code><pre>deb http://www.sgtpepper.net/hyspro/deb unstable/
deb-src http://www.sgtpepper.net/hyspro/deb unstable/</pre></code>
Modified: website/src/50.upstream-devs.en.page
===================================================================
--- website/src/50.upstream-devs.en.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/50.upstream-devs.en.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -2,27 +2,37 @@
title: Upstream Developers
inMenu: false
---
-h1. Upstream developers, be nice to distributions (re)packagers !
+h2. Upstream Developers, Be Nice to Distributions (Re)Packagers!
Dear developer,
-Your library/application is very good, and we would like to integrate it into our favorite distribution, so many more people would benefit easily from it. However, it would be great if you could make our work as easy as possible by following those guidelines.
+Your library/application is very good, and we would like to integrate it
+into our favorite distribution, so many more people would benefit easily
+from it. However, it would be great if you could make our work as easy as
+possible by following those guidelines.
-h2. Don't distribute only as a gem.
+h3. Don't distribute only as a gem.
-"RubyGems":http://docs.rubygems.org/ is nice for people who aren't using another packaging system, but it makes it hard to package your application for our distribution. Please distribute your software as a *.tgz* (or *.tar.gz*) too.
+"RubyGems":http://docs.rubygems.org/ is nice for people who aren't using
+another packaging system, but it makes it hard to package your application
+for our distribution. Please distribute your software as a *.tgz* (or
+*.tar.gz*) too.
-h2. Don't depend on RubyGems
+h3. Don't depend on RubyGems
-Make sure you are using <code>require</code>, not <code>require_gem</code>, to allow users to use your library without using rubygems.
+Make sure you are using <code>require</code>, not <code>require_gem</code>,
+to allow users to use your library without using RubyGems.
-h2. Use setup.rb
+h3. Use setup.rb
-*TODO* explain differences between "setup.rb":http://i.loveruby.net/en/projects/setup/, extconf.rb, install.rb
+_TODO:_ explain differences between
+"setup.rb":http://i.loveruby.net/en/projects/setup/, extconf.rb, and
+install.rb.
-h2. Don't make your Rakefile depend on RubyGems
+h3. Don't make your Rakefile depend on RubyGems
-If you provide a Rakefile, make sure it is usable without RubyGems installed. The following example is known to work :
+If you provide a Rakefile, make sure it is usable without RubyGems
+installed. The following example is known to work:
<code><pre>require 'rake/testtask'
require 'rake/packagetask'
require 'rake/rdoctask'
@@ -96,23 +106,32 @@
rescue LoadError
end</pre></code>
-h2. Make your tests and examples usable outside of your directory tree
+h3. Make your tests and examples usable outside of your directory tree
-*Don't* do things like <code>require '../lib/yourpackagename'</code>. Instead, use the following example :
+*Don't* do things like <code>require '../lib/yourpackagename'</code>.
+Instead, use the following example:
<code><pre>$:.unshift '../lib'
require 'yourpackagename'</pre></code>
-This way, example and test scripts can be moved to other locations, but will still be able to use the global installation of your library. And since '../lib' is added at the beginning of the search patch, you will be able to use the version of your library you are working on during development.
-h2. Use a shebang that works everywhere
+This way, example and test scripts can be moved to other locations, but
+will still be able to use the global installation of your library. And
+since '../lib' is added at the beginning of the search patch, you will be
+able to use the version of your library you are working on during
+development.
-The ruby interpreter can be installed in different places. Instead of using <code>#!/usr/bin/ruby</code> or <code>#!/usr/local/bin/ruby</code>, consider using <code>#!/usr/bin/env ruby</code>.
+h3. Use a shebang that works everywhere
-h2. Provide man pages for your binaries
+The Ruby interpreter can be installed in different places. Instead of
+using <code>#!/usr/bin/ruby</code> or <code>#!/usr/local/bin/ruby</code>,
+consider using <code>#!/usr/bin/env ruby</code>.
-Some distributions (e.g Debian) require all executables to have a man page. It would be great if you could provide it yourself.
+h3. Provide man pages for your binaries
-h2. References
+Some distributions (e.g. Debian) require all executables to have a man page.
+It would be great if you could provide it yourself.
+h3. References
+
* "RPA-base: Good Pratices":http://rpa-base.rubyforge.org/wiki/wiki.cgi?GoodPractices
* "RPA-base: Packaging Nitpick Checklist":http://rpa-base.rubyforge.org/wiki/wiki.cgi?PackagingNitpickChecklist
Modified: website/src/ruby-pkg-tools/10.sources.en.page
===================================================================
--- website/src/ruby-pkg-tools/10.sources.en.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/ruby-pkg-tools/10.sources.en.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -2,7 +2,7 @@
title: Upstream Sources
inMenu: true
---
-h2. Retrieving upstream sources
+h2. Retrieving Upstream Sources
Since after much discussion it was decided _not_ to put all the upstream
sources of every package into the Subversion repository, a tool was added
Modified: website/src/ruby-pkg-tools/20.team-members.en.page
===================================================================
--- website/src/ruby-pkg-tools/20.team-members.en.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/ruby-pkg-tools/20.team-members.en.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -2,7 +2,7 @@
title: Team Member List
inMenu: true
---
-h2. The Team Member list
+h2. The Team Member List
A list of team members of the Debian Ruby Extras Maintainers is kept in
@/usr/share/ruby-pkg-tools/pkg-ruby-extras.team at . If you have joined the
Modified: website/src/ruby-pkg-tools/30.cdbs.en.page
===================================================================
--- website/src/ruby-pkg-tools/30.cdbs.en.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/ruby-pkg-tools/30.cdbs.en.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -1,20 +1,21 @@
---
-title: The CDBS Class
+title: The CDBS Classes
inMenu: true
---
-h2. The CDBS class
+h2. The CDBS Classes
-The tools includes a CDBS class, @ruby-setup-rb.mk@, for automating the
-building of a package for upstream source that uses @install.rb@ or
- at setup.rb@ as builder/installer. The class tries to create a package that
-adheres to the Debian/Ruby policy
-("draft version":http://pkg-ruby.alioth.debian.org/ruby-policy.html/index.html)
-and takes a lot of common standard and often the same work out of your
-hands.
+The tools includes two CDBS classes, @ruby-setup-rb.mk@ and
+ at ruby-extconf-rb.mk@, for automating the building of a package for upstream
+source that uses @install.rb@, @setup.rb@ or @extconf.rb@ as
+builder/installer. The classes try to create a package that adheres to the
+Debian/Ruby policy ("draft
+version":http://pkg-ruby.alioth.debian.org/ruby-policy.html/index.html) and
+takes a lot of common standard and often the same work out of your hands.
h3. Basic usage
-A common @debian/rules@ file using this class would look like this:
+A common @debian/rules@ file for @setup.rb@ using this @ruby-setup-rb@
+class would look like this:
<pre><code>#!/usr/bin/make -f
#
@@ -23,10 +24,19 @@
include /usr/share/cdbs/1/rules/debhelper.mk
include /usr/share/ruby-pkg-tools/1/class/ruby-setup-rb.mk</code></pre>
+For @extconf.rb@ it would look like this:
+
+<pre><code>#!/usr/bin/make -f
+#
+# CDBS file to build the Foo Ruby package.
+
+include /usr/share/cdbs/1/rules/debhelper.mk
+include /usr/share/ruby-pkg-tools/1/class/ruby-extconf-rb.mk</code></pre>
+
Note that it is still possible to configure and override the behaviour of
-the class and also debhelper. No control is lost.
-For more information about how to use the class, see the
-"CDBS HOWTO":https://perso.duckcorp.org/duck/cdbs-doc/cdbs-doc.xhtml.
+the class and debhelper. No control is lost. For more information about
+how to use the class, see the "CDBS
+HOWTO":https://perso.duckcorp.org/duck/cdbs-doc/cdbs-doc.xhtml.
-*N.B.* When using the class, don't forget to add "ruby-pkg-tools" to
-the Build-Depends(-Indep) field!
+*N.B.* When using either of these classes, don't forget to add
+"ruby-pkg-tools" to the Build-Depends(-Indep) field!
Modified: website/src/ruby-pkg-tools/40.uploaders.en.page
===================================================================
--- website/src/ruby-pkg-tools/40.uploaders.en.page 2006-03-23 07:00:14 UTC (rev 403)
+++ website/src/ruby-pkg-tools/40.uploaders.en.page 2006-03-23 09:13:05 UTC (rev 404)
@@ -2,7 +2,7 @@
title: The Uploader Rule
inMenu: true
---
-h2. The Uploader rule
+h2. The Uploader Rule
Regardless whether the CDBS class is used or a plain old rules file, one
can use the uploader rule, @uploader.mk@, to automatically inject the
More information about the pkg-ruby-extras-maintainers
mailing list