man-pages/man3/Warnings.3o.html
2021-03-31 01:06:50 +01:00

535 lines
6.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of Warnings</TITLE>
</HEAD><BODY>
<H1>Warnings</H1>
Section: OCaml library (3o)<BR>Updated: 2020-01-30<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
Warnings - Warning definitions
<A NAME="lbAC">&nbsp;</A>
<H2>Module</H2>
Module Warnings
<A NAME="lbAD">&nbsp;</A>
<H2>Documentation</H2>
<P>
Module
<B>Warnings</B>
<BR>&nbsp;:&nbsp;
<B>sig end</B>
<P>
<P>
Warning definitions
<P>
Warning: this module is unstable and part of
<B>Compiler_libs</B>
.
<P>
<P>
<P>
<P>
<P>
<I>type loc </I>
= {
<BR>&nbsp;loc_start&nbsp;:&nbsp;
<B>Lexing.position</B>
;
<BR>&nbsp;loc_end&nbsp;:&nbsp;
<B>Lexing.position</B>
;
<BR>&nbsp;loc_ghost&nbsp;:&nbsp;
<B>bool</B>
;
<BR>&nbsp;}
<P>
<P>
<P>
<P>
<I>type t </I>
=
<BR>&nbsp;|&nbsp;Comment_start
<BR>&nbsp;|&nbsp;Comment_not_end
<BR>&nbsp;|&nbsp;Fragile_match
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Partial_application
<BR>&nbsp;|&nbsp;Labels_omitted
<B>of </B>
<B>string list</B>
<BR>&nbsp;|&nbsp;Method_override
<B>of </B>
<B>string list</B>
<BR>&nbsp;|&nbsp;Partial_match
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Non_closed_record_pattern
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Statement_type
<BR>&nbsp;|&nbsp;Unused_match
<BR>&nbsp;|&nbsp;Unused_pat
<BR>&nbsp;|&nbsp;Instance_variable_override
<B>of </B>
<B>string list</B>
<BR>&nbsp;|&nbsp;Illegal_backslash
<BR>&nbsp;|&nbsp;Implicit_public_methods
<B>of </B>
<B>string list</B>
<BR>&nbsp;|&nbsp;Unerasable_optional_argument
<BR>&nbsp;|&nbsp;Undeclared_virtual_method
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Not_principal
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Without_principality
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unused_argument
<BR>&nbsp;|&nbsp;Nonreturning_statement
<BR>&nbsp;|&nbsp;Preprocessor
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Useless_record_with
<BR>&nbsp;|&nbsp;Bad_module_name
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;All_clauses_guarded
<BR>&nbsp;|&nbsp;Unused_var
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unused_var_strict
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Wildcard_arg_to_constant_constr
<BR>&nbsp;|&nbsp;Eol_in_string
<BR>&nbsp;|&nbsp;Duplicate_definitions
<B>of </B>
<B>string * string * string * string</B>
<BR>&nbsp;|&nbsp;Multiple_definition
<B>of </B>
<B>string * string * string</B>
<BR>&nbsp;|&nbsp;Unused_value_declaration
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unused_open
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unused_type_declaration
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unused_for_index
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unused_ancestor
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unused_constructor
<B>of </B>
<B>string * bool * bool</B>
<BR>&nbsp;|&nbsp;Unused_extension
<B>of </B>
<B>string * bool * bool * bool</B>
<BR>&nbsp;|&nbsp;Unused_rec_flag
<BR>&nbsp;|&nbsp;Name_out_of_scope
<B>of </B>
<B>string * string list * bool</B>
<BR>&nbsp;|&nbsp;Ambiguous_name
<B>of </B>
<B>string list * string list * bool * string</B>
<BR>&nbsp;|&nbsp;Disambiguated_name
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Nonoptional_label
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Open_shadow_identifier
<B>of </B>
<B>string * string</B>
<BR>&nbsp;|&nbsp;Open_shadow_label_constructor
<B>of </B>
<B>string * string</B>
<BR>&nbsp;|&nbsp;Bad_env_variable
<B>of </B>
<B>string * string</B>
<BR>&nbsp;|&nbsp;Attribute_payload
<B>of </B>
<B>string * string</B>
<BR>&nbsp;|&nbsp;Eliminated_optional_arguments
<B>of </B>
<B>string list</B>
<BR>&nbsp;|&nbsp;No_cmi_file
<B>of </B>
<B>string * string option</B>
<BR>&nbsp;|&nbsp;Bad_docstring
<B>of </B>
<B>bool</B>
<BR>&nbsp;|&nbsp;Expect_tailcall
<BR>&nbsp;|&nbsp;Fragile_literal_pattern
<BR>&nbsp;|&nbsp;Misplaced_attribute
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Duplicated_attribute
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Inlining_impossible
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unreachable_case
<BR>&nbsp;|&nbsp;Ambiguous_pattern
<B>of </B>
<B>string list</B>
<BR>&nbsp;|&nbsp;No_cmx_file
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Assignment_to_non_mutable_value
<BR>&nbsp;|&nbsp;Unused_module
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unboxable_type_in_prim_decl
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Constraint_on_gadt
<BR>&nbsp;|&nbsp;Erroneous_printed_signature
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unsafe_without_parsing
<BR>&nbsp;|&nbsp;Redefining_unit
<B>of </B>
<B>string</B>
<BR>&nbsp;|&nbsp;Unused_open_bang
<B>of </B>
<B>string</B>
<BR>&nbsp;
<P>
<P>
<P>
<I>type alert </I>
= {
<BR>&nbsp;kind&nbsp;:&nbsp;
<B>string</B>
;
<BR>&nbsp;message&nbsp;:&nbsp;
<B>string</B>
;
<BR>&nbsp;def&nbsp;:&nbsp;
<B>loc</B>
;
<BR>&nbsp;use&nbsp;:&nbsp;
<B>loc</B>
;
<BR>&nbsp;}
<P>
<P>
<P>
<P>
<P>
<I>val parse_options </I>
:
<B>bool -&gt; string -&gt; unit</B>
<P>
<P>
<P>
<P>
<I>val parse_alert_option </I>
:
<B>string -&gt; unit</B>
<P>
Disable/enable alerts based on the parameter to the -alert
command-line option. Raises
<B>Arg.Bad</B>
if the string is not a
valid specification.
<P>
<P>
<P>
<I>val without_warnings </I>
:
<B>(unit -&gt; 'a) -&gt; 'a</B>
<P>
Run the thunk with all warnings and alerts disabled.
<P>
<P>
<P>
<I>val is_active </I>
:
<B>t -&gt; bool</B>
<P>
<P>
<P>
<P>
<I>val is_error </I>
:
<B>t -&gt; bool</B>
<P>
<P>
<P>
<P>
<I>val defaults_w </I>
:
<B>string</B>
<P>
<P>
<P>
<P>
<I>val defaults_warn_error </I>
:
<B>string</B>
<P>
<P>
<P>
<I>type reporting_information </I>
= {
<BR>&nbsp;id&nbsp;:&nbsp;
<B>string</B>
;
<BR>&nbsp;message&nbsp;:&nbsp;
<B>string</B>
;
<BR>&nbsp;is_error&nbsp;:&nbsp;
<B>bool</B>
;
<BR>&nbsp;sub_locs&nbsp;:&nbsp;
<B>(loc * string) list</B>
;
<BR>&nbsp;}
<P>
<P>
<P>
<P>
<P>
<I>val report </I>
:
<B>t -&gt; [ `Active of reporting_information | `Inactive ]</B>
<P>
<P>
<P>
<P>
<I>val report_alert </I>
:
<B>alert -&gt; [ `Active of reporting_information | `Inactive ]</B>
<P>
<P>
<P>
<P>
<I>exception Errors </I>
<P>
<P>
<P>
<P>
<P>
<I>val check_fatal </I>
:
<B>unit -&gt; unit</B>
<P>
<P>
<P>
<P>
<I>val reset_fatal </I>
:
<B>unit -&gt; unit</B>
<P>
<P>
<P>
<P>
<I>val help_warnings </I>
:
<B>unit -&gt; unit</B>
<P>
<P>
<P>
<I>type state </I>
<P>
<P>
<P>
<P>
<P>
<I>val backup </I>
:
<B>unit -&gt; state</B>
<P>
<P>
<P>
<P>
<I>val restore </I>
:
<B>state -&gt; unit</B>
<P>
<P>
<P>
<P>
<I>val mk_lazy </I>
:
<B>(unit -&gt; 'a) -&gt; 'a Lazy.t</B>
<P>
Like
<B>Lazy.of_fun</B>
, but the function is applied with
the warning/alert settings at the time
<B>mk_lazy</B>
is called.
<P>
<P>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">Module</A><DD>
<DT id="3"><A HREF="#lbAD">Documentation</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:59 GMT, March 31, 2021
</BODY>
</HTML>