[docs][exported_values] add issue LexiFi#55 to limitations

Author: fantazio

check/classic/classic.ref

@@ -25,6 +25,10 @@
 ./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:3: goodbye
 ./examples/docs/exported_values/hello_world/hello_world_with_intf.mli:4: world
 
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:20: copy: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:25: id: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:40: new_method: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:41: public_method_label: Should not be detected
 ./examples/docs/exported_values/limitations/sigincl/sigincl_lib.mli:10: I.x: Should not be detected
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:3: internally_used
@@ -619,7 +623,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 532
+Total: 536
 Success: 531
-Failed: 1
-Ratio: 99.8120300752%
+Failed: 5
+Ratio: 99.0671641791%

check/internal/internal.ref

@@ -15,6 +15,10 @@
 
 ./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused
 
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:20: copy: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:25: id: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:40: new_method: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:41: public_method_label: Should not be detected
 ./examples/docs/exported_values/limitations/sigincl/sigincl_lib.mli:10: I.x: Should not be detected
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused
@@ -574,7 +578,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 490
+Total: 494
 Success: 489
-Failed: 1
-Ratio: 99.7959183673%
+Failed: 5
+Ratio: 98.987854251%

check/threshold-1/threshold-1.ref

@@ -15,6 +15,10 @@
 
 ./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused
 
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:20: copy: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:25: id: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:40: new_method: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:41: public_method_label: Should not be detected
 ./examples/docs/exported_values/limitations/sigincl/sigincl_lib.mli:10: I.x: Should not be detected
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused
@@ -951,7 +955,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 821
+Total: 825
 Success: 820
-Failed: 1
-Ratio: 99.8781973203%
+Failed: 5
+Ratio: 99.3939393939%

check/threshold-3-0.5/threshold-3-0.5.ref

@@ -15,6 +15,10 @@
 
 ./examples/docs/exported_values/code_constructs/module/module_lib.mli:6: M.unused
 
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:20: copy: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:25: id: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:40: new_method: Should not be detected
+./examples/docs/exported_values/limitations/incl_same_name/oo.mli:41: public_method_label: Should not be detected
 ./examples/docs/exported_values/limitations/sigincl/sigincl_lib.mli:10: I.x: Should not be detected
 ./examples/using_dune/preprocessed_lib/preprocessed.mli:1: unused
 ./examples/using_dune/preprocessed_lib/preprocessed_no_intf.ml:2: unused
@@ -1340,7 +1344,7 @@ Nothing else to report in this section
 --------------------------------------------------------------------------------
 
 
-Total: 1133
+Total: 1137
 Success: 1132
-Failed: 1
-Ratio: 99.9117387467%
+Failed: 5
+Ratio: 99.5602462621%

docs/exported_values/EXPORTED_VALUES.md

@@ -11,6 +11,7 @@
 + [Limitations](#limitations)
     + [Module type](#module-type)
     + [Include module type with substitution](#include-module-type-with-substitution)
+    + [Including a module with same name](#including-a-module-with-the-same-name)
 
 # Exported Values
 
@@ -318,3 +319,72 @@ make: Leaving directory '/tmp/docs/exported_values/limitations/sigincl'
 
 The analyzer reports `I.x` at the line where `T` is included although it is
 actually declared in `T`.
+
+## Including a module with the same name
+
+Related issue :
+[issue #55](https://github.com/LexiFi/dead_code_analyzer/issues/55).
+
+According to the semantics described in the
+[Include](./code_constructs/INCLUDE.md) example, values re-exported via included
+should not be reported. However, it may happen that values re-exported by
+including a compilation unit out of the current codebase are reported when the
+re-exporting compilation unit has the same name as the one included.
+
+### Example
+
+The reference files for this example are in the
+[incl\_same\_name](../examples/docs/exported_values/limitations/incl_same_name)
+directory.
+
+The reference takes place in `/tmp/docs/exported_values/limitations`, which
+is a copy of the [limitations](../examples/docs/exported_values/limitations)
+directory. Reported locations may differ depending on the location of the source
+files.
+
+The compilation command is :
+```
+make -C incl_same_name build
+```
+
+The analysis command is :
+```
+make -C incl_same_name analyze
+```
+
+The compile + analyze command is :
+```
+make -C incl_same_name
+```
+
+Code:
+```OCaml
+(* oo.ml *)
+include Stdlib.Oo
+```
+
+Compile and analyze:
+```
+$ make -C incl_same_name
+make: Entering directory '/tmp/docs/exported_values/limitations/incl_same_name'
+ocamlopt -bin-annot oo.ml
+dead_code_analyzer --nothing -E all .
+Scanning files...
+ [DONE]
+
+.> UNUSED EXPORTED VALUES:
+=========================
+/tmp/docs/exported_values/limitations/incl_same_name/oo.mli:20: copy
+/tmp/docs/exported_values/limitations/incl_same_name/oo.mli:25: id
+/tmp/docs/exported_values/limitations/incl_same_name/oo.mli:40: new_method
+/tmp/docs/exported_values/limitations/incl_same_name/oo.mli:41: public_method_label
+
+Nothing else to report in this section
+--------------------------------------------------------------------------------
+
+
+make: Leaving directory '/tmp/docs/exported_values/limitations/incl_same_name'
+```
+
+The analyzer reports values in `oo.mli` although they are included from
+`Stdlib.Oo`.

examples/docs/exported_values/limitations/Makefile

@@ -4,8 +4,9 @@ all: build
 
 build:
 	make -C sigincl build
+	make -C incl_same_name build
 
 clean:
 	rm -f *~ *.cm* *.o *.obj
 	make -C sigincl clean
-
+	make -C incl_same_name clean

examples/docs/exported_values/limitations/incl_same_name/Makefile

@@ -0,0 +1,12 @@
+SRC:=oo.ml
+
+all: build analyze
+
+build:
+	ocamlopt -bin-annot ${SRC}
+
+analyze:
+	dead_code_analyzer --nothing -E all .
+
+clean:
+	rm -f *.cm* *.o a.out

examples/docs/exported_values/limitations/incl_same_name/oo.ml

@@ -0,0 +1,2 @@
+(* oo.ml *)
+include Stdlib.Oo