package ninja_utils

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

What is Ninja?
Ninja expressions
Ninja rules
Ninja builds

ninja_utils
- README
- Library ninja_utils
  - Ninja_utils
    
    Var
    
    Expr
    
    Binding
    
    Rule
    
    Build
    
    Default
- Sources
  - ninja_utils
    
    ninja_utils.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Ninja_utils`Source

This library contains the implementations of utility functions used to generate Ninja build files in OCaml with almost no dependencies -- it only depends on Re. It's currently developed to be used by Clerk, the Catala build system. Therefore, the library supports only very basic features required by Clerk.

What is Ninja?

Ninja is a low-level build system. It's designed to have its input files (build.ninja) generated by a higher-level build system, and to run builds as fast as possible by supporting native cross-platform (Windows and Unix) parallel builds.

See the manual for more details.

Ninja expressions

Sourcemodule Var : sig ... end

Ninja variable names, distinguishing binding name ("x") from references in expressions ("$x")

Sourcemodule Expr : sig ... end

Helper module to build ninja expressions.

Sourcemodule Binding : sig ... end

Ninja rules

Sourcemodule Rule : sig ... end

Helper module to build ninja rules.

Ninja builds

Sourcemodule Build : sig ... end

Helper module to build ninja build statements.

Sourcemodule Default : sig ... end

Sourcetype def =

| Comment of string
| Binding of Binding.t
| Rule of Rule.t
| Build of Build.t
| Default of Default.t

Sourceval comment : string -> def

Sourceval binding : Var.t -> Expr.t -> def

Source

val rule : 
  ?vars:Binding.t list ->
  string ->
  command:Expr.t ->
  description:Expr.t ->
  def

Source

val build : 
  ?inputs:Expr.t ->
  ?implicit_in:Expr.t ->
  outputs:Expr.t ->
  ?implicit_out:Expr.t ->
  ?vars:(Var.t * Expr.t) list ->
  string ->
  def

Sourceval default : Expr.t -> def

Sourceval format_def : Format.formatter -> def -> unit

Sourcetype ninja = def Seq.t

Sourceval format : Format.formatter -> ninja -> unit