package opam-format

  1. Overview
  2. Docs
Format library for opam 2.0

Install 

dune-project
 Dependency

opam.ocaml.org Readme Edit opam file Versions (33)

Authors

  1. V
    Vincent Bernardoff <vb@luminar.eu.org>
  2. R
    Raja Boujbel <raja.boujbel@ocamlpro.com>
  3. R
    Roberto Di Cosmo <roberto@dicosmo.org>
  4. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  5. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  6. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  7. A
    Anil Madhavapeddy <anil@recoil.org>
  8. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  9. R
    Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  10. F
    Frederic Tuong <tuong@users.gforge.inria.fr>

Maintainers

  1. O
    opam-devel@lists.ocaml.org

Sources

2.0.1.tar.gz
md5=1e55c234fa09e678e8115a31f3ec2a05
sha512=d71c362d70a6b6cb9fe54cc43bfbea8079cca05d4721a7dda951196f543a1ff5af81399a246e0cd68bc590c7bdca388d96c7127217ed637261957047ce725516

doc/opam-format/OpamFile/Dot_config/index.html

Module OpamFile.Dot_configSource

.config files

include IO_FILE
Sourcetype t

File contents

Sourceval empty : t

Empty file

Sourceval write : t typed_file -> t -> unit

Write some contents to a file

Sourceval read : t typed_file -> t

Read file contents. Raise an error if the file does not exist.

Sourceval read_opt : t typed_file -> t option

Returns None on non-existing file

Sourceval safe_read : t typed_file -> t

Read file contents. Return empty if the file does not exist.

Sourceval read_from_channel : ?filename:t typed_file -> in_channel -> t
Sourceval read_from_string : ?filename:t typed_file -> string -> t
Sourceval write_to_channel : ?filename:t typed_file -> out_channel -> t -> unit
Sourceval write_to_string : ?filename:t typed_file -> t -> string

Create a new .config file (containing only variables)

Sourceval file_depends : t -> (OpamTypes.filename * OpamHash.t) list

Dependency towards file-system paths and their hashes

Sourceval with_file_depends : (OpamTypes.filename * OpamHash.t) list -> t -> t

Sets all bindings in the file

Top-level variables

Sourceval variables : t -> OpamTypes.variable list

The list of top-level variables

Lists all the variable bindings in the file

Sets the given variable, overriding any previous definition. With None, unsets the variable