Module Topkg_vcs

VCS repositories.

See Topkg.Vcs for documentation.

VCS

type kind = [
| `Git
| `Hg
]
val pp_kind : Stdlib.Format.formatter -> kind -> unit
type commit_ish = string
type t
val kind : t -> kind
val dir : t -> Topkg_fpath.t
val find : ?dir:Topkg_fpath.t -> unit -> t option Topkg_result.result
val get : ?dir:Topkg_fpath.t -> unit -> t Topkg_result.result
val cmd : t -> Topkg_cmd.t
val pp : Stdlib.Format.formatter -> t -> unit
val is_dirty : t -> bool Topkg_result.result
val not_dirty : t -> unit Topkg_result.result
val file_is_dirty : t -> Topkg_fpath.t -> bool Topkg_result.result
val head : ?dirty:bool -> t -> string Topkg_result.result
val commit_id : ?dirty:bool -> ?commit_ish:string -> t -> string Topkg_result.result
val commit_ptime_s : ?commit_ish:commit_ish -> t -> int Topkg_result.result
val describe : ?dirty:bool -> ?commit_ish:string -> t -> string Topkg_result.result
val tags : t -> string list Topkg_result.result
val changes : ?until:string -> t -> after:string -> (string * string) list Topkg_result.result
val tracked_files : ?tree_ish:string -> t -> Topkg_fpath.t list Topkg_result.result
val clone : t -> dir:Topkg_fpath.t -> unit Topkg_result.result
val checkout : ?branch:string -> t -> commit_ish:string -> unit Topkg_result.result
val commit_files : ?msg:string -> t -> Topkg_fpath.t list -> unit Topkg_result.result
val delete_tag : t -> string -> unit Topkg_result.result
val tag : ?force:bool -> ?sign:bool -> ?msg:string -> ?commit_ish:string -> t -> string -> unit Topkg_result.result