[DRE-commits] [SCM] Debian Ruby packaging policy branch, master, updated. 8cb551b187b0a8787536b58790f14406d0d7d81d

[Vincent Fourmond]

The following commit has been merged in the master branch:
commit 8cb551b187b0a8787536b58790f14406d0d7d81d
Author: Vincent Fourmond <fourmond at debian.org>
Date:   Fri May 13 00:21:42 2011 +0200

    Integrate policy for Ruby interpreters too

diff --git a/ruby-policy.xml b/ruby-policy.xml
index 58ed431..c53b914 100644
--- a/ruby-policy.xml
+++ b/ruby-policy.xml
@@ -126,11 +126,61 @@
 
     <sect1 id="interpreters">
       <title>Ruby interpreters</title>
-      
+
+      <para>
+        All Ruby interpreters &must; be installable at the same
+        time.
+      </para>
+
+      <para>
+        The main executable &must; be placed in
+        <literal>/usr/bin</literal> and match the name of the
+        principal binary package.
+      </para>
+
       <para>
-        Requirements for the interpreters (load path, virtual packages
-        provided...)
+        Only one interpreter &may; provide a
+        <literal>/usr/bin/ruby</literal> symlink to its main
+        executable. This interpreter is said to be the default Ruby
+        interpreter. At the time of the writing of this policy, it is
+        <literal>ruby1.8</literal>, but that may change in the
+        future.
       </para>
+
+      <para>
+        All Ruby interpreters &must; provide the
+        <literal>ruby-interpreter</literal> virtual package.
+      </para>
+
+      <sect2>
+        <title>Load path</title>
+        <para>
+          In addition to its own location for standard library code,
+          all Ruby interpreters &must; add the following directories to
+          their library load path:
+          <itemizedlist>
+            <listitem>
+              <para>
+                <filename>/usr/lib/vendor_ruby</filename>, a location
+                containing plain Ruby files;
+              </para>
+            </listitem>
+            <listitem>
+              <para>
+                <filename>/usr/lib/vendor_ruby/</filename>&pkg;, where
+                &pkg; is the package name (and the interpreter name
+                too), and/or a subdirectory of that directory whose
+                name is architecture-dependant. This
+                architecture-specific directory &must; be stored in
+                the
+                <literal>RbConfig::CONFIG['vendorarchdir']</literal>
+                Ruby configuration variable.
+              </para>
+            </listitem>
+          </itemizedlist>
+        </para>
+      </sect2>
+
     </sect1>
 
     <sect1 id="libraries">
@@ -159,7 +209,7 @@
           <itemizedlist>
             <listitem>
               <para>
-                ruby interpreters, , such as
+                ruby interpreters, such as
                 <literal>ruby-1.9.1</literal> or
                 <literal>jruby</literal>;
               </para>
@@ -304,21 +354,21 @@
 
   </chapter>
   
-  <chapter id="advices">
-    <title>Advices to Ruby packagers</title>
+  <!-- <chapter id="advices"> -->
+  <!--   <title>Advices to Ruby packagers</title> -->
     
-    <para>
-      The contents of this chapter are not part of the Policy per
-      se. However, they should prove useful for developers wishing to
-      package Ruby-related packages.
-    </para>
+  <!--   <para> -->
+  <!--     The contents of this chapter are not part of the Policy per -->
+  <!--     se. However, they should prove useful for developers wishing to -->
+  <!--     package Ruby-related packages. -->
+  <!--   </para> -->
 
-    <para>
-      Nothing here yet.
-    </para>
+  <!--   <para> -->
+  <!--     Nothing here yet. -->
+  <!--   </para> -->
     
     
-  </chapter>
+  <!-- </chapter> -->
   
 </book>
 <!-- vim: expandtab sw=2 ts=2 -->

-- 
Debian Ruby packaging policy