[DRE-commits] [SCM] Debian Ruby packaging policy branch, master, updated. 5995b388ae92508fa0588b4c472de6b32b1bb3e6
Antonio Terceiro
terceiro at softwarelivre.org
Mon May 9 19:16:08 UTC 2011
The following commit has been merged in the master branch:
commit 98f494d6f007e0cbe9386b2c671a240240f8d5c3
Author: Antonio Terceiro <terceiro at softwarelivre.org>
Date: Mon May 9 11:58:52 2011 -0700
Fix the indentation
diff --git a/ruby-policy.xml b/ruby-policy.xml
index 17855f9..2371a99 100644
--- a/ruby-policy.xml
+++ b/ruby-policy.xml
@@ -1,6 +1,6 @@
<?xml version='1.0'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "/usr/share/sgml/docbook/dtd/4.1/docbook.dtd"
+ "/usr/share/sgml/docbook/dtd/4.1/docbook.dtd"
[
<!ENTITY must "<emphasis>must</emphasis>">
<!ENTITY mustnot "<emphasis>must not</emphasis>">
@@ -36,31 +36,31 @@
<title>Debian Ruby policy draft</title>
<authorgroup>
<author>
- <surname>Fourmond</surname>
- <firstname>Vincent</firstname>
- <authorblurb>
- <para>
- <email>fourmond at debian.org</email>
- </para>
- </authorblurb>
+ <surname>Fourmond</surname>
+ <firstname>Vincent</firstname>
+ <authorblurb>
+ <para>
+ <email>fourmond at debian.org</email>
+ </para>
+ </authorblurb>
</author>
<author>
- <othername>the Debian Ruby mailing list</othername>
- <authorblurb>
- <para>
- &dr-ldo;
- </para>
- <para>
- Most of the points of this document were discussed in the
- Debian Ruby mailing list.
- </para>
- </authorblurb>
+ <othername>the Debian Ruby mailing list</othername>
+ <authorblurb>
+ <para>
+ &dr-ldo;
+ </para>
+ <para>
+ Most of the points of this document were discussed in the
+ Debian Ruby mailing list.
+ </para>
+ </authorblurb>
</author>
</authorgroup>
<abstract>
<title>Abstract</title>
<para>
- This is the ruby policy for Debian.
+ This is the ruby policy for Debian.
</para>
</abstract>
</bookinfo>
@@ -123,8 +123,8 @@
<title>Ruby interpreters</title>
<para>
- Requirements for the interpreters (load path, virtual packages
- provided...)
+ Requirements for the interpreters (load path, virtual packages
+ provided...)
</para>
</sect1>
@@ -132,121 +132,121 @@
<title>Ruby libraries</title>
<para>
- By library, we mean <quote>every package that contains ruby
- code and is not a Ruby interpreter</quote>. In particular,
- this also includes programs not necessarily meant to be used
- as libraries. For programs additional requirements and/or
- relaxing of some requirements listed here apply, see next
- section.
+ By library, we mean <quote>every package that contains ruby
+ code and is not a Ruby interpreter</quote>. In particular,
+ this also includes programs not necessarily meant to be used
+ as libraries. For programs additional requirements and/or
+ relaxing of some requirements listed here apply, see next
+ section.
</para>
<sect2>
- <title>Package names</title>
- <para>
- All binary packages that contains Ruby code &must; have a
- package name in the form <literal>ruby-</literal>&pkg;,
- where &pkg; is left to the choice of the packager. However,
- packagers &may; ignore this rule in the following cases:
- <itemizedlist>
- <listitem>
- <para>
- ruby interpreters;
- </para>
- </listitem>
+ <title>Package names</title>
+ <para>
+ All binary packages that contains Ruby code &must; have a
+ package name in the form <literal>ruby-</literal>&pkg;,
+ where &pkg; is left to the choice of the packager. However,
+ packagers &may; ignore this rule in the following cases:
+ <itemizedlist>
+ <listitem>
+ <para>
+ ruby interpreters;
+ </para>
+ </listitem>
- <listitem>
- <para>
- programs;
- </para>
- </listitem>
+ <listitem>
+ <para>
+ programs;
+ </para>
+ </listitem>
- <listitem>
- <para>
- packages providing ruby code to be use specifically as
- plugins for a given program, and that have no use
- outside of this program.
- </para>
- </listitem>
- </itemizedlist>
- The source package name &should; match the name of package
- that holds the code.
- </para>
- <para>
- In the case of software previoulsy relased with the old
- package name policy
- (<literal>lib-</literal>&pkg;<literal>-ruby</literal> and
- versioned variants thereof), packagers &should; provide
- transition packages with the old names depending on the new
- package.
- </para>
+ <listitem>
+ <para>
+ packages providing ruby code to be use specifically as
+ plugins for a given program, and that have no use
+ outside of this program.
+ </para>
+ </listitem>
+ </itemizedlist>
+ The source package name &should; match the name of package
+ that holds the code.
+ </para>
+ <para>
+ In the case of software previoulsy relased with the old
+ package name policy
+ (<literal>lib-</literal>&pkg;<literal>-ruby</literal> and
+ versioned variants thereof), packagers &should; provide
+ transition packages with the old names depending on the new
+ package.
+ </para>
</sect2>
<sect2>
- <title>Supported Ruby implementations</title>
- <para>
- Packages &should; support as many different implementations
- of Ruby as is possible. Reasons why this is not done
- &should; be documented visibly, such as in the
- <filename>README.Debian</filename> file.
- </para>
- <para>
- Packages &must; list the versions of Ruby supported in the
- source package using the <literal>XS-Ruby-Versions</literal>
- statement in <filename>debian/control</filename>. This
- statement &must; be a space-separated list of one or more of
- <literal>ruby1.8</literal>, <literal>ruby1.9</literal> or
- <literal>all</literal> (the latter meaning all the supported
- Ruby versions).
- </para>
- <para>
- All files for the different implementations &must; be
- shipped inside a single binary package. This binary package
- &must; have a <literal>XB-Ruby-Versions</literal> statement
- containing the space-separated list of Ruby implementations
- supported by the binary package, with fields identical to
- those for the source package, excepted that
- <literal>all</literal> cannot be used: the full list &must;
- be listed explicitly.
- </para>
+ <title>Supported Ruby implementations</title>
+ <para>
+ Packages &should; support as many different implementations
+ of Ruby as is possible. Reasons why this is not done
+ &should; be documented visibly, such as in the
+ <filename>README.Debian</filename> file.
+ </para>
+ <para>
+ Packages &must; list the versions of Ruby supported in the
+ source package using the <literal>XS-Ruby-Versions</literal>
+ statement in <filename>debian/control</filename>. This
+ statement &must; be a space-separated list of one or more of
+ <literal>ruby1.8</literal>, <literal>ruby1.9</literal> or
+ <literal>all</literal> (the latter meaning all the supported
+ Ruby versions).
+ </para>
+ <para>
+ All files for the different implementations &must; be
+ shipped inside a single binary package. This binary package
+ &must; have a <literal>XB-Ruby-Versions</literal> statement
+ containing the space-separated list of Ruby implementations
+ supported by the binary package, with fields identical to
+ those for the source package, excepted that
+ <literal>all</literal> cannot be used: the full list &must;
+ be listed explicitly.
+ </para>
</sect2>
<sect2>
- <title>Installation paths</title>
- <para>
- Pure ruby code (ie ruby files) &must; be installed under
- <filename>/usr/lib/ruby/vendor_ruby</filename>.
- </para>
- <para>
- Compiled extensions &must; be installed in the
- <literal>'vendorarchdir'</literal> path.
- </para>
+ <title>Installation paths</title>
+ <para>
+ Pure ruby code (ie ruby files) &must; be installed under
+ <filename>/usr/lib/ruby/vendor_ruby</filename>.
+ </para>
+ <para>
+ Compiled extensions &must; be installed in the
+ <literal>'vendorarchdir'</literal> path.
+ </para>
</sect2>
<sect2>
- <title>Dependencies</title>
- <para>
- All package &must; depend either on <literal>ruby1.8 |
- ruby-interpreter</literal> if the package supports all
- implementations of Ruby or on the specific implementations
- needed if that is not the case.
- </para>
+ <title>Dependencies</title>
+ <para>
+ All package &must; depend either on <literal>ruby1.8 |
+ ruby-interpreter</literal> if the package supports all
+ implementations of Ruby or on the specific implementations
+ needed if that is not the case.
+ </para>
</sect2>
<sect2>
- <title>Documentation</title>
- <para>
- Packages &may; build a <literal>rdoc</literal>
- documentation. Unless the documentation is really small, it
- &should; be packaged in a separate binary package named
- <literal>ruby-</literal>&pkg;<literal>-doc</literal>.
- </para>
+ <title>Documentation</title>
+ <para>
+ Packages &may; build a <literal>rdoc</literal>
+ documentation. Unless the documentation is really small, it
+ &should; be packaged in a separate binary package named
+ <literal>ruby-</literal>&pkg;<literal>-doc</literal>.
+ </para>
</sect2>
<sect2>
- <title>Rubygems</title>
- <para>
- Do we disallow the use of <literal>require
- 'rubygems'</literal> by policy ?
- </para>
+ <title>Rubygems</title>
+ <para>
+ Do we disallow the use of <literal>require
+ 'rubygems'</literal> by policy ?
+ </para>
</sect2>
</sect1>
@@ -255,20 +255,20 @@
<title>Ruby programs</title>
<para>
- Excepted for the package name, which does not have to comply
- to any rules, Ruby programs &must; obey all rules that apply
- to Ruby libraries (previous sections). In addition, they must
- obey the following rules.
+ Excepted for the package name, which does not have to comply
+ to any rules, Ruby programs &must; obey all rules that apply
+ to Ruby libraries (previous sections). In addition, they must
+ obey the following rules.
</para>
<sect2>
- <title>Shebang</title>
- <para>
- All the programs &must; have a <literal>#!
- /usr/bin/ruby1.8</literal> shebang, unless they rely on
- implementation specific libraries, in which case the shebang
- should reflect these requirements.
- </para>
+ <title>Shebang</title>
+ <para>
+ All the programs &must; have a <literal>#!
+ /usr/bin/ruby1.8</literal> shebang, unless they rely on
+ implementation specific libraries, in which case the shebang
+ should reflect these requirements.
+ </para>
</sect2>
</sect1>
@@ -292,3 +292,4 @@
</chapter>
</book>
+<!-- vim: expandtab sw=2 ts=2 -->
--
Debian Ruby packaging policy
More information about the Pkg-ruby-extras-commits
mailing list