package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Generic representation
Formatting
Package files

package b0

b0
- B0_build
- B0_cli
  - Arg
- B0_cmdlet
  - Env
  - Map
  - Set
- B0_def
  - Make
    
    Map
    
    Set
    
    V
  - S
    
    Map
    
    Set
  - Scope
  - VALUE
- B0_dir
- B0_driver
  - Cli
  - Compile
  - Conf
  - Env
  - Exit
- B0_file
- B0_meta
  - Key
- B0_pack
  - Map
  - Set
- B0_unit
  - Action
  - Map
  - Set
b0.b0
- B0_b0
  - Cli
  - Def
- B0_cmd_build
- B0_cmd_cmd
- B0_cmd_cmdlet
- B0_cmd_delete
- B0_cmd_file
- B0_cmd_list
- B0_cmd_log
- B0_cmd_pack
- B0_cmd_root
- B0_cmd_scope
- B0_cmd_unit
- B0_main
b0.b00
- B00
  - Env
  - Memo
  - 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_cli
  - Arg
  - B00_std
  - Exit
  - File_cache
  - Memo
    
    Log
  - Op
- B00_cmark
- B00_editor
  - Env
- B00_fexts
- B00_findex
- B00_github
  - Auth
  - Issue
  - Pages
  - Release
  - Repo
- B00_htmlg
  - At
  - El
- B00_http
  - Http
  - Httpr
  - Uri
- B00_jsoo
- B00_lines
- B00_ocaml
  - Archive
  - Cobj
    
    Map
    
    Set
  - Compile
  - Conf
  - Lib
    
    Name
    
    Map
    
    Set
    
    Resolver
  - Link
  - Mod
    
    Name
    
    Ref
    
    Map
    
    Set
    
    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_rsync
- B00_serialk_json
  - Json
  - Jsong
  - Jsonq
- B00_serialk_sexp
  - Sexp
  - Sexpg
  - Sexpq
- B00_serialk_text
  - Tdec
  - Tloc
- B00_trace
  - Compilation_database
  - Trace_event
- B00_vcs
  - Git
  - Hg
- B00_www_browser
  - Env
b0.b00.std
- B00_std
  - Bincode
  - Char
    
    Ascii
  - Cmd
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Fut
    
    Syntax
  - Hash
    
    Murmur3_128
    
    T
    
    Xxh_64
  - List
  - Log
  - Os
    
    Cmd
    
    Cpu
    
    Dir
    
    Env
    
    Exit
    
    Fd
    
    File
    
    Path
  - Result
    
    Syntax
  - Rqueue
  - String
    
    Ascii
    
    Map
    
    Set
  - Tid
  - Time
    
    Span
  - Tty
b0.kit
- B0_jsoo
- B0_kit
  - V000
- B0_ocaml
  - Meta
- B0_ocaml_eco
- B0_opam
  - Cmdlet
  - File
  - Meta
- B0_release
  - Cmdlet
  - Meta
- B0_srcs

Legend:
Library
Module
Module type
Parameter
Class
Class type

opam file generation.

Generic representation

type value = [

| `Raw of string
(*
A raw, unescaped value
*)
| `B of bool
(*
A boolean.
*)
| `S of string
(*
A string.
*)
| `L of bool * value list
(*
A list of values, the boolean indicates whether line-by-line rendering should be forced.
*)

]

The type for opam values.

type field = string * value

The type for opam fields. The field name and its value.

type section = string * string option * t

The type for opam sections. The section name, the optional string and the contents of the section.

and comment = string

The type for comments.

and item = [

| `Comment of comment
| `Field of field
| `Section of section

]

The type for items.

and t = item list

The type for generic opam file contents.

val v2 : item

v2 is opam-version: "2.0".

Formatting

val pp : t B00_std.Fmt.t

pp formats file contents.

val to_string : t -> string

to_string formats file contents to a string.

Package files

val pkg_of_meta : with_name:bool -> B0_meta.t -> t

pkg_of_meta ~with_name m is an opam package file from m. Here's an account of how opam fields are populated by metadata keys.

"authors:", B0_meta.authors.
"build:", B0_opam.Meta.build.
"bug-report:", B0_meta.issues.
"conflicts:", B0_opam.Meta.conflicts.
"description:", B0_meta.description.
"depends:", B0_opam.Meta.depends.
"depopts:", B0_opam.Meta.depopts.
"dev-repo:", B0_meta.repo.
"doc:", B0_meta.online_doc.
"homepage:", B0_meta.homepage.
"install:", B0_opam.Meta.install.
"license:", B0_meta.licenses.
"maintainer:", B0_meta.maintainers.
"name:", B0_opam.Meta.name iff with_name is true.
"synopsis:", B0_meta.synopsis.
"tags:", B0_meta.description_tags.

Finally the contents of B0_opam.Meta.file_addendum is appended after the definition of these fields.

See Meta.pkg_of_pack for deriving metadata from build packs.