# HG changeset patch # User Adam Chlipala # Date 1401024116 14400 # Node ID 3ed2ee0815d27ae9551aedc25ba79a625b684214 # Parent 4a93f379c45221a48f0c9bbd080d079e23596936 Warn about MLton memory usage diff -r 4a93f379c452 -r 3ed2ee0815d2 doc/manual.tex --- a/doc/manual.tex Sun May 18 19:09:09 2014 -0400 +++ b/doc/manual.tex Sun May 25 09:21:56 2014 -0400 @@ -62,6 +62,8 @@ apt-get install mlton libssl-dev \end{verbatim} +Note that, like the Ur/Web compiler, MLton is a whole-program optimizing compiler, so it frequently requires much more memory than old-fashioned compilers do. Expect building Ur/Web with MLton to require not much less than a gigabyte of RAM. If a \texttt{mlton} invocation ends suspiciously, the most likely explanation is that it has exhausted available memory. + To build programs that access SQL databases, you also need one of these client libraries for supported backends. \begin{verbatim} apt-get install libpq-dev libmysqlclient-dev libsqlite3-dev @@ -72,7 +74,7 @@ apt-get install smlnj libsmlnj-smlnj ml-yacc ml-lpt \end{verbatim} -To begin an interactive session with the Ur compiler modules, run \texttt{make smlnj}, and then, from within an \texttt{sml} session, run \texttt{CM.make "src/urweb.cm";}. The \texttt{Compiler} module is the main entry point. +To begin an interactive session with the Ur compiler modules, run \texttt{make smlnj}, and then, from within an \texttt{sml} session, run \texttt{CM.make "src/urweb.cm";}. The \texttt{Compiler} module is the main entry point, and you can find its signature in \texttt{src/compiler.sig}. To run an SQL-backed application with a backend besides SQLite, you will probably want to install one of these servers.