Still writing

Sylvain LE GALL

diff --git a/chapter-liblocal.xml b/chapter-liblocal.xml
index ddad9a85e1769488ccc82bb600e94de9fb94f391..0fe2b9b5ecfff3027e105740b06625bab9cb134c 100644 (file)
--- a/chapter-liblocal.xml
+++ b/chapter-liblocal.xml
@@ -1,3 +1,31 @@
-   <section id="liblocal-camlp4">
-    <title>Camlp4 files</title>
-   </section>
+    <para>
+    Installation and use of locally installed &ocaml-name; is out of the 
+    scope of this document. However, in order to have it work with a standard
+    &ocaml-name; &debian-name; install, you should follow some guideline.
+    </para>
+
+    <section id="liblocal-path">     
+    <para>You user this path to install local library and executable :
+    <variablelist>
+     <varlistentry>
+      <term>bytecoded executable</term>
+      <listitem>/usr/local/bin</listitem>
+      <listitem>/usr/local/sbin</listitem>
+     </varlistentry>
+     <varlistentry>
+      <term>bytecoded library ( <filename>*.cma</filename> )</term>
+      <listitem>/usr/local/lib/ocaml/&ocaml-version;/
+      <listitem>native executable</listitem>
+      <listitem>native library ( <filename>*.cmxa</filename> )</listitem>
+      <listitem>shared library ( for C-binding ) ( <filename>dll*.so</filename> )</listitem>
+      <listitem>static library ( for C-binding ) ( <filename>lib*.a</filename> )</listitem>
+      <listitem>bytecoded object ( <filename>*.cmo</filename> )</listitem>
+      <listitem>native object ( <filename>*.cmx</filename> )</listitem>
+      <listitem>configuration file for handling library ( <filename>META</filename> )</listitem>
+      <listitem>&ocamldoc; generated documentation ( <filename>*.odoc</filename> )</listitem>
+      <listitem>&camlp4; related files ( <filename>*.cm[ao]</filename> )</listitem>
+     </simplelist>
+    </para>
+
+
+    </section>

diff --git a/chapter-ocaml.xml b/chapter-ocaml.xml
index ad57135adfbe8cd0bdcf861dd2d5ae3ce37544c2..2afcfc8f68af1e7853e259a98072cb8dec15aee1 100644 (file)
--- a/chapter-ocaml.xml
+++ b/chapter-ocaml.xml
@@ -46,6 +46,7 @@
       <listitem>native object ( <filename>*.cmx</filename> )</listitem>
       <listitem>configuration file for handling library ( <filename>META</filename> )</listitem>
       <listitem>&ocamldoc; generated documentation ( <filename>*.odoc</filename> )</listitem>
+      <listitem>&camlp4; related files ( <filename>*.cm[ao]</filename> )</listitem>
      </simplelist>
     </para>
    
@@ -270,8 +271,36 @@
    author to have a well commented source.
    </para>
    </subsection>
-   
 
+   <subsection id="camlp4-path">
+   <para>
+   Actually, &camlp4; extensions are stored in 
+   <filename>/usr/lib/ocaml/&ocaml-version;/camlp4/</filename>. In order to do something
+   cleaner, &ocaml-force; propose to put this files in their own directory, even in their
+   own package. It is not mandatory, but it could ease a lot, the user of camlp4, by avoiding
+   name clash.
+   </para>
+
+   <para>
+   You just have to consider &camlp4; file just as standard library, except that you
+   prefix them with <varname>-syntax</varname>. <example>For example : the syntax 
+   extension coming with <application>libokey-ocaml-dev</application> should be stored
+   in <filename>/usr/lib/ocaml/&ocaml-version;/okey-syntax/</filename>, the package
+   containing it should be called <application>libokey-syntax-ocaml-dev</application>.
+   </example>
+   </para>
+
+   <para>
+   It is recommended to use <filename>META</filename> to specify how to handle this
+   extension.
+   </para>
+
+   <para>
+   All definition is taken from previous text considering syntax extension as a standalone
+   library.
+   </para>
+
+   </subsection>
    </section>