¿Cuál es la forma preferida de estructurar y construir proyectos OCaml?

Question

No está claro para los recién llegados al ecosistema cuál es la forma canónica preferida para estructurar y administrar proyectos OCaml de tamaño pequeño a mediano. Entiendo los conceptos básicos de ocamlc, & c .-- reflejan los compiladores convencionales UNIX C lo suficiente como para parecer sencillo. Pero, por encima del nivel de compilación única de archivos individuales, no está claro cuál es la mejor manera de administrar la compilación de manera simple y limpia. El problema no es buscar herramientas potenciales, sino ver una o varias formas correctas (suficientes), según lo validado por la experiencia de la comunidad, para estructurar y construir proyectos estándares de OCaml.

Mi caso de uso de modelo es un proyecto modesto pero no trivial, de OCaml puro u OCaml más una dependencia de C. Tal proyecto:

1. contiene una serie de archivos de origen
2. enlaces a una serie de bibliotecas estándar
3. enlaces a bibliotecas de uno o más de 3 ª parte
4. incluye opcionalmente una biblioteca C y la envoltura OCaml como subproyecto (aunque esto también podría ser administrado por separado y se incluye como una biblioteca tercera parte, como en (3))

Varias herramientas alternativas destacan:

• Los Makefiles personalizados parecen ser el estándar común en la mayoría de los paquetes OCaml de código abierto, pero parecen frustrantemente prolijo y complejo, incluso más que para los modestos proyectos C/C++. Peor aún, muchas incluso aparentemente simples bibliotecas OCaml capa autoconf/automake en la parte superior para una complejidad aún mayor.
• ocamlbuild parece ofrecer un mecanismo moderno y simplificado para automatizar construcciones con configuración mínima, pero no está bien documentado para los recién llegados, ni representados por ejemplos en los materiales introductorios en el ecosistema OCaml, ni visiblemente utilizado por cualquiera de los varios publicados Proyectos OCaml que busqué en busca de inspiración.
• OASIS parece ser una capa de convención y código de biblioteca encima de otros sistemas de compilación para admitir la construcción de un administrador de paquetes y una biblioteca, como Cabal.

(También he visto OMake, lo que parece ser un autodenominado "make++", que también incluye un conjunto de reglas estándar para lenguajes comunes, incluyendo OCaml, y ocaml-make de soltera OCamlMakefile, proporcionando una plantilla de reglas estándar para GNU make.)

¿Alguna de estas es una forma preferida y moderna de administrar las compilaciones de OCaml?

¿Cómo se estructuran mejor los archivos de proyecto?

¿Cómo se incluyen y administran las dependencias de bibliotecas de terceros? ¿Se prefiere instalarlos a nivel del sistema o existe una forma estándar y directa de administrarlos localmente en un proyecto? Preferiría mucho un modelo en el que los proyectos permanezcan tan autónomos como sea posible.

Answer 1

Tiene una lista completa de las opciones disponibles, pero esta pregunta no tendrá una respuesta clara. Mi recomendación personal es también usar ocamlbuild. El archivo myocamlbuild.ml proporcionado here es un buen comienzo. Le permitirá compilar fácilmente proyectos que dependen de varias bibliotecas. No creo que maneje el caso del enlace a bibliotecas C, pero hay ejemplos adicionales en el wiki que pueden ser útiles.

Algunas personas se oponen a ocamlbuild porque es otra herramienta de compilación, lo que complica los trabajos de los gestores de paquetes. Sin embargo, su facilidad de uso y el hecho de que esté incluido en la distribución oficial lo están haciendo cada vez más utilizado.

También puede saltar todo esto y utilizar directamente oasis. Es muy nuevo y aún no se ha anunciado su lanzamiento estable, pero es muy útil. Generará el myocamlbuild.ml automáticamente para usted. Este es probablemente el camino a seguir en un futuro muy cercano, si no es que ya lo es. Además, al usar oasis, tendrá inmediatamente el beneficio de oasis-db, un sistema CPAN similar para OCaml que está en desarrollo.

En cuanto a la gestión de bibliotecas, la respuesta es ocamlfind. Si tiene instaladas varias instancias de OCaml, llamar a la copia correspondiente de ocamlfind hará automáticamente que todas las referencias a bibliotecas sean las correspondientes a esa instancia en particular, suponiendo que usa ocamlfind sistemáticamente para todas las bibliotecas. Actualmente uso godi para instalar OCaml y bibliotecas. Utiliza ocamlfind y no tengo problemas para tener instaladas varias instancias de OCaml.

Answer 2

Personalmente daría +1 por ocamlbuild. Sus reglas predeterminadas son lo suficientemente buenas como para compilar proyectos pequeños a medianos con un solo comando y configuraciones de mínimas a mínimas. También impone algunas convenciones muy razonables (no combina fuentes con resultados de compilación). Y para proyectos más grandes, puede personalizarse según sus deseos, con reglas adicionales & complementos.En la empresa donde trabajo lo estamos usando para un large project (+ Ocaml algunos C + + algo de pre-procesamiento ...) y funciona como un encanto (y nos da mucho menos dolores de cabeza que lo haría Makefile).

En cuanto a los manuales, creo que la guía del usuario (disponible en el author's webpage,) debería ser suficiente para comenzar. Las cosas más originales pueden requerir un poco más de excavación.

Answer 3

+1 para OMAKE.

Hemos renovado nuestra infraestructura de construcción hace unos años y eligió OMAKE por las siguientes razones:

• nuestros productos se componen de una mezcla de C, C++, C++ administrada, Ruby y OCaml.
• nos dirigimos tanto a Linux como a Windows.
• interactuamos con bases de datos en tiempo de compilación.
• para algunas producciones tuvimos que usar OCaml 3.10.
• nuestro sistema de construcción original utilizado autoconf/automake.
• requerimos compilaciones fuera de origen *.

Para ser sincero, no sé si podríamos haberlo hecho con ocamlbuild, no lo he probado. La herramienta está en uso con certeza ya que hay algo de actividad a su alrededor en el rastreador de errores de OCaml. Si opta por ocamlbuild, asegúrese de tener una versión actualizada de OCaml.

* OMake admite construcciones fuera de la fuente de una manera poco obvia. También tiene algunos problemas cuando las fuentes son de solo lectura. Tuvimos que parchar y reconstruir nuestra versión para Windows de OMake.

Answer 4

buena pregunta.Yo tendería a decir:

1) ocamlbuild Es probable que sea la forma estándar de compilación, porque es eficiente, rápida y la herramienta predeterminada dada por la distribución oficial. El hecho de que esté en la distribución oficial es un buen punto, porque es más probable que permanezca con el tiempo. Además, tiene habilitado ocamlfind, por lo que puede administrar paquetes instalados con ocamlfind, otro estándar para instalar paquetes (ocamlfind es un poco como pkg-config para C)

2) Pero no será suficiente para su proyecto. La integración con C es básica con ocamlbuild. Así que aquí quizás te recomiende que uses oasis para finalmente responder a tu pregunta. También probé OMake, pero no me gustó.

3) Sin embargo, sus scripts de compilación probablemente no funcionarán si no desea que otras personas puedan descargar y construir su proyecto en su propia máquina. Además, oasis no maneja pkg-config. Por esas razones, tendería a aconsejarle que use ocaml-autoconf (macros ocaml para autotools). Porque las autotools son el estándar para administrar bibliotecas C y es muy conocido por los mantenedores de paquetes. También puede manejar compilación cruzada ...

=> ocaml-autoconf con ocamlbuild