From: Sylvain Le Gall <sylvain.le-gall@polytechnique.org>
Date: Tue, 21 Oct 2003 20:12:34 +0000 (+0000)
Subject: No log message
X-Git-Tag: archive/raspbian/4.08.1-4+rpi1~3^2~641^2~19
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=5b65227e46417627bdc3dfda500dd52c49041fa0;p=ocaml.git

No log message
---

diff --git a/authors.xml b/authors.xml
index 986a59be..c566527a 100644
--- a/authors.xml
+++ b/authors.xml
@@ -1,4 +1,4 @@
-  <author>
+  <!--author>
    <firstname>Sven</firstname>
    <surname>Luther</surname>
    <affiliation>
@@ -21,5 +21,9 @@
     <orgname>The NM Debian Project</orgname>
     <address><email>sylvain.le-gall@polytechnique.org</email></address>
    </affiliation>
+  </author-->
+  <author>
+   <organization>The Debian OCaml Task Force</organization>
+   <address><email>debian-ocaml-maint@lists.debian.org</email></address>
   </author>
 
diff --git a/chapter-ocaml.xml b/chapter-ocaml.xml
index 1f6991d8..759fb792 100644
--- a/chapter-ocaml.xml
+++ b/chapter-ocaml.xml
@@ -2,14 +2,14 @@
     <title>Version</title>
     <para>
     At any given time, the package <application>ocaml</application>
-    should represent the current stable upstream version of Ocam 
-    revision 3.06.
+    should represent the current stable upstream version of &ocaml-name; 
+    revision &ocaml-version;.
     </para>
 
     <para>
     This package provides a virtual package called &ocaml-pkg;. 
     This will help to track incompatible changes made within the 
-    same version of Ocaml.
+    same version of &ocaml-name;.
     </para>
     
    </section>
@@ -19,13 +19,13 @@
     <para>
     In order to have a minimal installation, a virtual package 
     <application>ocaml-base</application> exists. It enable to have
-    a bare minimum install of Ocaml library.
+    a bare minimum install of &ocaml-name; library.
     </para>
 
     <para>
     As for <application>ocaml</application> this package provides
     a virtual package &ocaml-base-pkg;. This will help to track
-    incompatible changes made within the same version of Ocaml.
+    incompatible changes made within the same version of &ocaml-name;.
     </para>
 
    </section>
@@ -34,7 +34,7 @@
     <title>File terminology for Ocaml packaging</title>
 
     <para>
-     Ocaml is a complete language allowing to create :
+     &ocaml-name; is a complete language allowing to create :
      <simplelist>
       <listitem>bytecoded executable</listitem>
       <listitem>bytecoded library ( *.cma )</listitem>
@@ -45,6 +45,7 @@
       <listitem>bytecoded object ( *.cmo )</listitem>
       <listitem>native object ( *.cmx )</listitem>
       <listitem>configuration file for handling library ( META )</listitem>
+      <listitem>ocamldoc generated documentation ( *.odoc )</listitem>
      </simplelist>
     </para>
    
@@ -73,14 +74,15 @@
     </para>
 
     <para>
-    By default, ocaml will look for modules in this order :
+    By default, &ocaml-name; will look for modules in this order :
     <variablelist>
      <varlistentry>
       <term><varname>local</varname></term>
-      <simplelist>
-	      <listitem><filename>/usr/local/lib/ocaml/&ocaml-version;/</filename></listitem>
-	      <listitem><filename>/usr/local/lib/ocaml/&ocaml-version;/</filename></listitem>
-      </simplelist>
+      <para><filename>/usr/local/lib/ocaml/&ocaml-version;/</filename></para>
+     </varlistentry>
+     <varlistentry>
+      <term><varname>core</varname></term>
+      <para><filename>/usr/lib/ocaml/&ocaml-version;/</filename></para>
      </varlistentry>
     </variablelist>
     </para>
@@ -89,5 +91,21 @@
     <section id="documentation">
     <title>Documentation</title>
     <para>
+    The documentation is a joint effort of  &ocaml-force; and usptream. 
+    There is many way to have documentation : *.mli file, which is installed in 
+    <filename>/usr/lib/ocaml/&ocaml-version;/</filename> and his subdirectory.
+    You can also browse documentation with <application>ocamlbrowser</application>.
+    At last, for some package, a special scheme is used to handle documentation 
+    file : ocamldoc generated documentation. By this mean you can have different access
+    to library documentation : using <application>docbrowser</application> which is
+    shipped with <application>cameleon</application>, HTML pages registered under
+    the <application>doc-base</application> <organization>Debian</organization> package,
+    or manpages.
+    </para>
+
+    <para>As of this date, there is no automatic way to generate manpages and HTML 
+    documentation with a debian package. For now, <filename>*.odoc</filename> files
+    will be stored in <filename>/usr/share/ocamldoc-base</filename>. A tools, to
+    auto-generate manpages and HTML documentation is under construction.
     </para>
    </section>
diff --git a/ocaml_packaging_policy.xml b/ocaml_packaging_policy.xml
index 7d3eeb08..140134ab 100644
--- a/ocaml_packaging_policy.xml
+++ b/ocaml_packaging_policy.xml
@@ -5,6 +5,8 @@
  <!ENTITY ocaml-compat  "1">
  <!ENTITY ocaml-pkg      "<application>ocaml-&ocaml-version;-&ocaml-compat;</application>">
  <!ENTITY ocaml-base-pkg "<application>ocaml-base-&ocaml-version;-&ocaml-compat;</application>">
+ <!ENTITY ocaml-name     "<application>OCaml</application>">
+ <!ENTITY ocaml-force    "The OCaml Task Force">
  <!ENTITY authors             SYSTEM "authors.xml">
  <!ENTITY legal               SYSTEM "legal.xml">
  <!ENTITY chapter-ocaml       SYSTEM "chapter-ocaml.xml">
@@ -16,7 +18,7 @@
 ]>
 <article>
  <articleinfo>
-  <title>Debian Ocaml Policy</title>
+  <title>Debian Ocaml Packaging Policy</title>
   <subtitle>For Objective Caml version &ocaml-version;</subtitle>
   <releaseinfo>Revision 0.1</releaseinfo>
   &authors;