package rocq-runtime

  1. Overview
  2. Docs

Module UserWarnSource

This is about warnings triggered from user .v code ("warn" attibute). See cWarnings.mli for the generic warning interface.

Sourcetype warn = private {
  1. note : string;
  2. cats : string;
}

note and comma separated list of categories

Sourcetype t = {
  1. depr : Deprecation.t option;
  2. warn : warn list;
}
Sourcetype 'a with_qf = {
  1. depr_qf : 'a Deprecation.with_qf option;
  2. warn_qf : warn list;
}
Sourceval drop_qf : 'a with_qf -> t
Sourceval with_empty_qf : t -> 'a with_qf
Sourceval map_qf : ('a -> 'b) -> 'a with_qf -> 'b with_qf
Sourceval is_empty : t -> bool
Sourceval is_empty_qf : _ with_qf -> bool
Sourceval empty : t
Sourceval make_warn : note:string -> ?cats:string -> unit -> warn
Sourceval create_warning : ?default:CWarnings.status -> warning_name_if_no_cats:string -> unit -> ?loc:Loc.t -> warn -> unit
Sourceval create_depr_and_user_warnings : ?default:CWarnings.status -> object_name:string -> warning_name_base:string -> ('a -> Pp.t) -> unit -> ?loc:Loc.t -> 'a -> t -> unit
Sourceval create_depr_and_user_warnings_qf : ?default:CWarnings.status -> object_name:string -> warning_name_base:string -> pp_qf:('qf -> Pp.t) -> ('a -> Pp.t) -> unit -> ?loc:Loc.t -> 'a -> 'qf with_qf -> unit