package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Compile
Convenience

package b0

b0.b0
- B0_build
  - Unit
- B0_def
  - Make
    
    Map
    
    Set
    
    V
  - S
    
    Map
    
    Set
  - Scope
  - VALUE
- B0_meta
  - Key
- B0_pack
  - Map
  - Set
- B0_unit
  - Map
  - Set
b0.b00
- B00
  - Env
  - Memo
    
    Fut
  - Store
  - Tool
- B000
  - Exec
  - File_cache
  - Guard
  - Op
    
    Copy
    
    Delete
    
    Map
    
    Mkdir
    
    Notify
    
    Read
    
    Set
    
    Spawn
    
    Wait_files
    
    Write
  - Reviver
  - Trash
- B000_conv
  - Op
b0.b00.kit
- B00_base64
- B00_cmark
- B00_editor
  - Env
- B00_fexts
- B00_findex
- B00_github
  - Issue
  - Pages
  - Release
  - Repo
- B00_htmlg
  - At
  - El
- B00_http
  - Http
  - Httpr
  - Uri
- B00_lines
- B00_ocaml
  - Cobj
    
    Map
    
    Set
  - Compile
  - Conf
  - Lib
  - Lib_name
    
    Map
    
    Set
  - Lib_resolver
  - Link
    
    Deps
  - Mod_name
  - Mod_ref
    
    Map
    
    Set
  - Mod_src
    
    Deps
  - Ocamlpath
  - Tool
- B00_odoc
  - Compile
    
    Dep
    
    Writes
  - Html
    
    Dep
    
    Writes
  - Html_fragment
  - Support_files
    
    Writes
  - Theme
- B00_os
- B00_pager
  - Env
- B00_pdf_viewer
  - Env
- B00_serialk_json
  - Json
  - Jsong
  - Jsonq
- B00_serialk_sexp
  - Sexp
  - Sexpg
  - Sexpq
- B00_serialk_text
  - Tdec
  - Tloc
- B00_std_ui
- B00_trace
  - Compilation_database
  - Trace_event
- B00_ui
  - Cli
  - File_cache
  - Memo
    
    Log
  - Op
- B00_vcs
  - Git
- B00_www_browser
  - Env
b0.b00.std
- B00_std
  - Bincode
  - Char
    
    Ascii
  - Cmd
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Hash
    
    Murmur3_128
    
    T
    
    Xxh_64
  - List
  - Log
  - Option
  - Os
    
    Cmd
    
    Cpu
    
    Dir
    
    Env
    
    Fd
    
    File
    
    Path
    
    Sig_exit
  - Result
  - Rqueue
  - String
    
    Ascii
    
    Map
    
    Set
  - Tid
  - Time
    
    Span
  - Tty
b0.driver
- B0_driver
  - Cli
  - Compile
  - Conf
  - Env
  - Exit
    
    Info
- B0_file
b0.driver.b0
- B0_b0
  - Cli
  - Def
- B0_cmd_build
- B0_cmd_delete
- B0_cmd_file
- B0_cmd_log
- B0_cmd_pack
- B0_cmd_unit
- B0_main
b0.kit
- B0_kit
  - V000
- B0_ocaml
  - Meta
  - Unit
- B0_srcs

Legend:
Library
Module
Module type
Parameter
Class
Class type

Compiling .cmi, .cmti, .cmt and .mld files to .odoc files.

Compile

module Dep : sig ... end

Compilation dependencies, for compiling .cmi, .cmti or .cmt files to .odoc files.

module Writes : sig ... end

Compilation writes, files written by compiling a .cmi, .cmti, .cmt or .mld file to an .odoc file.

val cmd : 
  ?resolve_forward_deps:bool ->
  ?hidden:bool ->
  B00.Memo.t ->
  odoc_deps:B00_std.Fpath.t list ->
  writes:B00_std.Fpath.t list ->
  pkg:string ->
  B00_std.Fpath.t ->
  o:B00_std.Fpath.t ->
  unit

cmd m ~resolve_forward_deps ~hidden ~odoc_deps ~writes ~pkg cobj o compiles the compilation object cobj part of package pkg to destination odoc file o.

odoc_deps are the odoc files the compilation of cobj reads. They can be obtained by resolving the result of Dep on cobj.
writes specifies the writes of the command they can be obtained via Writes.
resolve_forward_deps and hidden are the corresponding odoc options. See odoc compile --help.

Convenience

val to_odoc : 
  B00.Memo.t ->
  ?hidden:bool ->
  pkg:string ->
  odoc_deps:B00_std.Fpath.t list ->
  B00_std.Fpath.t ->
  o:B00_std.Fpath.t ->
  unit

to_odoc m ~hidden ~pkg ~odoc_deps obj ~o compiles obj (which can be any of a .cmi, .cmt, .cmti or .mld file) to an odoc file o assuming it depends on odoc_deps and is part of package pkg.