[DRE-commits] r3507 - in website/src: . ruby-pkg-tools
Paul van Tilburg
paulvt at alioth.debian.org
Tue May 5 11:53:41 UTC 2009
Author: paulvt
Date: 2009-05-05 11:53:41 +0000 (Tue, 05 May 2009)
New Revision: 3507
Modified:
website/src/30.subversion.en.page
website/src/50.upstream-devs.en.page
website/src/ruby-pkg-tools/50.sources.en.page
Log:
More tweaks and fixes for RedCloth 4.
Modified: website/src/30.subversion.en.page
===================================================================
--- website/src/30.subversion.en.page 2009-05-05 11:16:17 UTC (rev 3506)
+++ website/src/30.subversion.en.page 2009-05-05 11:53:41 UTC (rev 3507)
@@ -46,8 +46,7 @@
|-- libfeedparser-ruby_0.1-1.dsc
|-- libfeedparser-ruby_0.1-1_i386.changes
|-- libfeedparser-ruby_0.1.orig.tar.gz
-`-- libxfeedparser-ruby_0.1-1_all.deb
-</code></pre>
+`-- libxfeedparser-ruby_0.1-1_all.deb</code></pre>
Then just do:
<pre><code>svn-inject -v -o libfeedparser-ruby_0.1-1.dsc \
@@ -64,8 +63,7 @@
$ cd libfoo-ruby
$ svn remove branches
[...]
-$ svn commit -m "Deleted branches directory."
-</pre></code>
+$ svn commit -m "Deleted branches directory."</code></pre>
h3. Checking out
@@ -85,11 +83,11 @@
Then you have to change do the trunk directory:
-<code><pre>$ cd libfoo-ruby/trunk</pre></code>
+<pre><code>$ cd libfoo-ruby/trunk</code></pre>
Inside @trunk/@, you can build the package with @svn-buildpackage@:
-<code><pre>$ svn-buildpackage -rfakeroot</pre></code>
+<pre><code>$ svn-buildpackage -rfakeroot</code></pre>
h3. Releasing and tagging
Modified: website/src/50.upstream-devs.en.page
===================================================================
--- website/src/50.upstream-devs.en.page 2009-05-05 11:16:17 UTC (rev 3506)
+++ website/src/50.upstream-devs.en.page 2009-05-05 11:53:41 UTC (rev 3507)
@@ -22,7 +22,7 @@
If your library is only a native library, using @extconf.rb@ might be a suitable alternative. However, all extconf use-cases are covered by @setup.rb at .
- at install.rb@ is deprecated, and should not be used.
+Note that @install.rb@ is deprecated, and should not be used.
h3. Remove all references to rubygems in the software you ship
@@ -31,23 +31,25 @@
* causes manually-installed (or installed with a package manager) libraries to be ignored after RubyGems has been loaded.
Do not use:
-<code><pre>
-begin
+
+bc.. begin
require 'rubygems'
rescue LoadError
end
-</pre></code>
-As this will succeed on systems with rubygems installed.
+p. As this will succeed on systems with rubygems installed.
+
Instead, make the loading of rubygems conditional, using a global constant that you can easily disable before releasing:
-<code><pre>require 'rubygems' if DEVELOPER_MODE</pre></code>
+bc. require 'rubygems' if DEVELOPER_MODE
+
For the same reason, @require_gem@ must not be used.
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:
-<code><pre>require 'rake/testtask'
+
+bc.. require 'rake/testtask'
require 'rake/packagetask'
require 'rake/rdoctask'
require 'rake'
@@ -117,17 +119,18 @@
pkg.need_tar = true
end
rescue LoadError
-end</pre></code>
+end
h3. Make your tests and examples usable outside of your directory tree
*Do not* do things like <code>require '../lib/yourpackagename'</code>. Instead, use the following example:
-<code><pre>$:.unshift '../lib'
-require 'yourpackagename'</pre></code>
+bc.. $:.unshift '../lib'
-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.
+require 'yourpackagename'
+p. 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.
+
h3. Use a shebang that works everywhere
The Ruby interpreter can be installed in different places. Instead of using <code>#!/usr/bin/ruby</code> or <code>#!/usr/local/bin/ruby</code>, use <code>#!/usr/bin/env ruby</code>.
Modified: website/src/ruby-pkg-tools/50.sources.en.page
===================================================================
--- website/src/ruby-pkg-tools/50.sources.en.page 2009-05-05 11:16:17 UTC (rev 3506)
+++ website/src/ruby-pkg-tools/50.sources.en.page 2009-05-05 11:53:41 UTC (rev 3507)
@@ -10,16 +10,16 @@
A basic usage scenario for @pkg-ruby-get-sources@ is to do a checkout, get the upstream source and build:
- $ cd Debian/packages
- $ svn co svn+ssh://svn.debian.org/svn/pkg-ruby-extras/packages/libfoo-ruby
- [...]
- $ cd libfoo-ruby/trunk
- $ mkdir ../tarballs
- $ pkg-ruby-get-sources
- [100%] http://somesite/path/to/foo-ruby-0.1.tar.gz
- $ ls ../tarballs
- libfoo-ruby_0.1.orig.tar.gz
- $ svn-buildpackage [...]
+<pre><code>$ cd Debian/packages
+$ svn co svn+ssh://svn.debian.org/svn/pkg-ruby-extras/packages/libfoo-ruby
+[...]
+$ cd libfoo-ruby/trunk
+$ mkdir ../tarballs
+$ pkg-ruby-get-sources
+[100%] http://somesite/path/to/foo-ruby-0.1.tar.gz
+$ ls ../tarballs
+libfoo-ruby_0.1.orig.tar.gz
+$ svn-buildpackage [...]</code></pre>
Note that @pkg-ruby-get-sources@ retrieves the tarball and takes care of the naming of the file locally so that it suits the Debian source package name. For example see above where @foo-ruby-0.1.tar.gz@ is automatically renamed to @libfoo-ruby_0.1.orig.tar.gz at .
@@ -40,7 +40,7 @@
To check the contents of this file, run
-<pre><code> uscan --report </code></pre>
+<pre><code>$ uscan --report</code></pre>
Look at the @uscan@ manual page for more information.
@@ -53,13 +53,10 @@
and edit it. This file follows the "YAML":http://yaml.org/ format.
* For adding a new package @libfoo-ruby@ version 0.1, append:
-
<pre><code>libfoo-ruby:
"0.1": http://somesite/path/to/foo-ruby-0.1.tar.gz</pre></code>
-* For adding a new upstream version 0.2 for @libfoo-ruby@, append to the previous
- lines:
-
+* For adding a new upstream version 0.2 for @libfoo-ruby@, append to the previous lines:
<pre><code> "0.2": http://somesite/path/to/foo-ruby-0.2.tar.gz</code></pre>
h3. Other features
More information about the Pkg-ruby-extras-commits
mailing list