Change flag name and update documentation

voodoos · voodoos · commit 59edafdf2482 · 2021-11-02T15:39:23.000+01:00
diff --git a/driver/main_args.ml b/driver/main_args.ml
@@ -36,12 +36,12 @@ let mk_annot f =
   "-annot", Arg.Unit f, " (deprecated) Save information in <filename>.annot"
 ;;
 
-let mk_binannot f =
-  "-bin-annot", Arg.Unit f, " Save typedtree in <filename>.cmt"
+let mk_annot_shapes f =
+  "-annot-shapes", Arg.Unit f, " Save shapes in <filename>.cms"
 ;;
 
-let mk_shapes f =
-  "-shapes", Arg.Unit f, " Save shapes in <filename>.cms"
+let mk_binannot f =
+  "-bin-annot", Arg.Unit f, " Save typedtree in <filename>.cmt"
 ;;
 
 let mk_c f =
@@ -965,6 +965,7 @@ end
 module type Compiler_options = sig
   val _a : unit -> unit
   val _annot : unit -> unit
+  val _annot_shapes : unit -> unit
   val _binannot : unit -> unit
   val _c : unit -> unit
   val _cc : string -> unit
@@ -999,7 +1000,6 @@ module type Compiler_options = sig
   val _with_runtime : unit -> unit
   val _without_runtime : unit -> unit
   val _safe_string : unit -> unit
-  val _shapes : unit -> unit
   val _short_paths : unit -> unit
   val _thread : unit -> unit
   val _v : unit -> unit
@@ -1160,8 +1160,8 @@ struct
     mk_alert F._alert;
     mk_absname F._absname;
     mk_annot F._annot;
+    mk_annot_shapes F._annot_shapes;
     mk_binannot F._binannot;
-    mk_shapes F._shapes;
     mk_c F._c;
     mk_cc F._cc;
     mk_cclib F._cclib;
@@ -1342,8 +1342,8 @@ struct
     mk_afl_instrument F._afl_instrument;
     mk_afl_inst_ratio F._afl_inst_ratio;
     mk_annot F._annot;
+    mk_annot_shapes F._annot_shapes;
     mk_binannot F._binannot;
-    mk_shapes F._shapes;
     mk_inline_branch_factor F._inline_branch_factor;
     mk_c F._c;
     mk_cc F._cc;
@@ -1852,6 +1852,7 @@ module Default = struct
   module Compiler = struct
     let _a = set make_archive
     let _annot = set annotations
+    let _annot_shapes = set shapes
     let _args = Arg.read_arg
     let _args0 = Arg.read_arg0
     let _binannot = set binary_annotations
@@ -1883,7 +1884,6 @@ module Default = struct
     let _plugin _p = plugin := true
     let _pp s = preprocessor := (Some s)
     let _runtime_variant s = runtime_variant := s
-    let _shapes = set shapes
     let _stop_after pass =
       let module P = Compiler_pass in
         match P.of_string pass with
diff --git a/driver/main_args.mli b/driver/main_args.mli
@@ -74,6 +74,7 @@ end
 module type Compiler_options = sig
   val _a : unit -> unit
   val _annot : unit -> unit
+  val _annot_shapes : unit -> unit
   val _binannot : unit -> unit
   val _c : unit -> unit
   val _cc : string -> unit
@@ -108,7 +109,6 @@ module type Compiler_options = sig
   val _with_runtime : unit -> unit
   val _without_runtime : unit -> unit
   val _safe_string : unit -> unit
-  val _shapes : unit -> unit
   val _short_paths : unit -> unit
   val _thread : unit -> unit
   val _v : unit -> unit
diff --git a/man/ocamlc.m b/man/ocamlc.m
@@ -208,6 +208,20 @@ Build a library (.cma file) with the object files (.cmo files) given
 .BR \-bin-annot
 instead.
 .TP
+.B \-annot\-shapes
+Dump information about the definitions of the current compilation unit in binary
+format. This information is represented as shapes, an abstraction of modules.
+The information for file
+.IR src .ml
+is put into file
+.IR src .cms.
+The files
+produced by
+.B \-annot\-shapes
+are more lightweight than the ones produced by
+.B \-bin\-annot
+but contain enough information for most external tooling needs.
+.TP
 .B \-bin\-annot
 Dump detailed information about the compilation (types, bindings,
 tail-calls, etc) in binary format. The information for file
diff --git a/man/ocamlopt.m b/man/ocamlopt.m
@@ -171,6 +171,20 @@ Build a library (.cmxa/.a file) with the object files (.cmx/.o
 .BR \-bin-annot
 instead.
 .TP
+.B \-annot\-shapes
+Dump information about the definitions of the current compilation unit in binary
+format. This information is represented as shapes, an abstraction of modules.
+The information for file
+.IR src .ml
+is put into file
+.IR src .cms.
+The files
+produced by
+.B \-annot\-shapes
+are more lightweight than the ones produced by
+.B \-bin\-annot
+but contain enough information for most external tooling needs.
+.TP
 .B \-bin\-annot
 Dump detailed information about the compilation (types, bindings,
 tail-calls, etc) in binary format. The information for file
diff --git a/manual/src/cmds/unified-options.etex b/manual/src/cmds/unified-options.etex
@@ -64,6 +64,15 @@ Force error messages to show absolute paths for file names.
 Deprecated since OCaml 4.11. Please use "-bin-annot" instead.
 }%notop
 
+\notop{\item["-annot-shapes"]
+Dump information about the definitions of the current compilation unit in binary
+format. This information is represented as shapes, an abstraction of modules.
+The information for file \var{src}".ml" (resp. \var{src}".mli") is put into file
+\var{src}".cms" (resp. \var{src}".cmsi"). The "*.cms" and "*.cmsi" files
+produced by "-annot-shape" are more lightweight than the cmt produced by
+"-bin-annot" but contain enough information for most external tooling needs.
+}%notop
+
 \item["-args" \var{filename}]
 Read additional newline-terminated command line arguments from \var{filename}.
 \top{It is not possible to pass a \var{scriptfile} via file to the toplevel.
diff --git a/stdlib/Makefile b/stdlib/Makefile
@@ -22,7 +22,7 @@ TARGET_BINDIR ?= $(BINDIR)
 COMPILER=$(ROOTDIR)/ocamlc$(EXE)
 CAMLC=$(OCAMLRUN) $(COMPILER)
 COMPFLAGS=-strict-sequence -absname -w +a-4-9-41-42-44-45-48-70 \
-          -g -warn-error +A -bin-annot -shapes -nostdlib -principal \
+          -g -warn-error +A -bin-annot -annot-shapes -nostdlib -principal \
           -safe-string -strict-formats
 ifeq "$(FLAMBDA)" "true"
 OPTCOMPFLAGS += -O3
diff --git a/utils/clflags.ml b/utils/clflags.ml
@@ -68,7 +68,7 @@ and all_ppx = ref ([] : string list)        (* -ppx *)
 let absname = ref false                 (* -absname *)
 let annotations = ref false             (* -annot *)
 let binary_annotations = ref false      (* -bin-annot *)
-let shapes = ref false                  (* -shapes *)
+let shapes = ref false                  (* -annot-shapes *)
 and use_threads = ref false             (* -thread *)
 and noassert = ref false                (* -noassert *)
 and verbose = ref false                 (* -verbose *)
