package topkg-care

You can search for identifiers within the package.

in-package search v0.2.0

The transitory OCaml software packager

Install

sha512=4b632b60137852bb72ff9c8cdc2e16ac5ece6473569e50963fef9c1e800a0933a516bea1107b04011645afa4a1e78893c82dbce0aa8de2970d4d6c6d0dd2fe02

descr files.

type t = string * string

The type for opam descr files, the package synopsis and the description.

val of_string : string -> (t, Bos_setup.R.msg) Bos_setup.result

of_string s is a description from the string s.

val to_string : t -> string

to_string d is d as a string.

val to_opam_fields : t -> string

to_opam_fields d is d as synopsis and description opam v2 fields.

val of_readme : 
  ?flavour:Text.flavour ->
  string ->
  (t, Bos_setup.R.msg) Bos_setup.result

of_readme r extracts an opam description file from a readme r with a certain structure.

val of_readme_file : Fpath.t -> (t, Bos_setup.R.msg) Bos_setup.result

of_readme_file f extracts an opam description file from a readme file f using Text.flavour_of_fpath and of_readme.

On This Page