Module Topkg_care.Opam.Descr

module Descr: sig .. end
descr files.


Descr file


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 of_readme : ?flavour:Topkg_care.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 Topkg_care.Text.flavour_of_fpath and Topkg_care.Opam.Descr.of_readme.