Skip to content

Commit

Permalink
Update the developper manual to describe a bit more .comp files
Browse files Browse the repository at this point in the history
Fix #681
  • Loading branch information
samoht committed Jul 16, 2013
1 parent 965fb99 commit e7725fb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
Binary file modified doc/dev-manual/dev-manual.pdf
Binary file not shown.
22 changes: 21 additions & 1 deletion doc/dev-manual/dev-manual.tex
Expand Up @@ -14,7 +14,7 @@

\title{
OPAM: a Package Management Systems for OCaml\\
Developer Manual (version 1.0)\\ ~\ \\
Developer Manual (version 1.1)\\ ~\ \\
~\ \\}
\author{Thomas GAZAGNAIRE\\
\url{thomas.gazagnaire@ocamlpro.com}\\
Expand Down Expand Up @@ -990,9 +990,13 @@ \subsubsection{Compiler Description Files}
?requires: [ STRING+ ]
?pp: [ <ppflag>+ ]
?preinstalled: BOOL
?env: [ <env>+ ]
<ppflag> := CAMLP4 { STRING+ }
| STRING+
<env> := IDENT <eq> STRING
<eq> := '=' | '+=' | '=+' | ':=' | '=:'
\end{Verbatim}
}
\begin{itemize}
Expand Down Expand Up @@ -1044,6 +1048,20 @@ \subsubsection{Compiler Description Files}

\item {\tt preinstall} is {\tt true} when the version of the compiler available
in the path is the same as {\tt name}.

\item {\tt env} is the list of environment variables to set in the
given compiler switch:
\begin{itemize}
\item {\tt VAR = "value"} set the variable to the given value;
\item {\tt VAR += "value"} prepend the given value to the variable;
\item {\tt VAR =+ "value"} append the given value to the variable;
\item {\tt VAR := "value"} prepend the given value to the variable,
separated by a colon. If the variable was empty, add the
colon anyway.
\item {\tt VAR =: "value"} append the given value to the variable,
separated by a colon. If the variable was empty, add the colon
anyway.
\end{itemize}
\end{itemize}

For instance the file, {\tt 3.12.1+memprof.comp} describes OCaml,
Expand All @@ -1055,6 +1073,7 @@ \subsubsection{Compiler Description Files}
src: "http://caml.inria.fr/pub/distrib/ocaml-3.12/ocaml-3.12.1.tar.gz"
make: [ "world" "world.opt" ]
patches: [ "http://bozman.cagdas.free.fr/documents/ocamlmemprof-3.12.0.patch" ]
env: [ CAML_LD_LIBRARY_PATH = "%{lib}%/stublibs" ]
\end{verbatim}

And the file {\tt trunk-g-notk-byte.comp} describes OCaml from SVN
Expand All @@ -1069,6 +1088,7 @@ \subsubsection{Compiler Description Files}
make: [ "world" ]
bytecomp: [ "-g" ]
bytelink: [ "-g" ]
env: [ CAML_LD_LIBRARY_PATH = "%{lib}%/stublibs" ]
\end{verbatim}

\subsection{Commands}
Expand Down

0 comments on commit e7725fb

Please sign in to comment.