package topkg-care

  1. Overview
  2. Docs
On This Page
  1. Descr file
The transitory OCaml software packager

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC License Edit opam file Versions (2)

Authors

  1. T
    The topkg programmers

Maintainers

  1. Daniel Bünzli

Sources

topkg-1.1.0.tbz
sha512=34d22ae5b6bd166dd4a601a7d12d89c336684b3c56d7c7f481b40837eab263616cc3a6e6f63602f3d4a7d53c911967bf261de6c1ac205341b98a9838e5ea7aeb

doc/topkg_care/Topkg_care/Opam/Descr/index.html

Module Opam.Descr

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 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.