Updates requested in the review: Typos, and export_cache issue.

Author: marek-trtik

src/analyses/README.md

@@ -151,16 +151,16 @@ as std::map, an ordering is defined.
 #### Class `sparse_bitvector_analysist`
 
 An instance of this class provides an assignment of unique numeric `ID` to each
-inserted `reaching_definitionst` instance. Internally, the class holds two data
+inserted `reaching_definitiont` instance. Internally, the class holds two data
 members:
 
 - `value_map` is an unordered map from names of program variables to a set
   of pairs (`reaching_definitiont`, `ID`). Formally, the map is defined as
-  `value_map: var_names -> (reaching_definitionst -> ID)`.
+  `value_map: var_names -> (reaching_definitiont -> ID)`.
 - `values` is a map from an `ID` to the corresponding `reaching_definitiont`
   instance inside the map `value_map`. Namely, the map is implemented as an 
   `std::vector` of iterators to elements of the map `value_map`. An index to
-  `values` vector is the `ID` of the related `reaching_definitionst` instance.
+  `values` vector is the `ID` of the related `reaching_definitiont` instance.
 
 #### Class `rd_range_domaint`
 
@@ -188,14 +188,16 @@ information is held in these data members:
   The map is not empty only if `has_value` is `UNKNOWN`. Variables in the map
   are all those which are live at the associated instruction.
 - `export_cache` is a helper data structure. It consists of data already
-  stored in `values` and `bv_container`. The purpose of this structure is to
-  provide a speed-up for certain operations (discussed below). It is basically
-  (an ordered) map from (a subset of) variables in `values` to iterators to
-  GOTO instructions where the variables are defined. Moreover, each such
-  iterator is also associated with a range of bits defining the value of that
-  variable at that GOTO instruction. Both the iterators and the corresponding
-  bit ranges are simply taken from `reaching_definitiont` instances obtained
-  for `ID`s in `values[var_name]`.
+  stored in `values` and `bv_container`. It is basically (an ordered) map from
+  (a subset of) variables in `values` to iterators to GOTO instructions where
+  the variables are defined. Moreover, each such iterator is also associated
+  with a range of bits defining the value of that variable at that GOTO
+  instruction. Both the iterators and the corresponding bit ranges are simply
+  taken from `reaching_definitiont` instances obtained for `ID`s in
+  `values[var_name]`. This data structure is actually used only in the `output`
+  method; other methods only remove outdated data from it. Since the cache
+  does not contribute to the computation, it should be either moved to the
+  `output` method or removed entirely.
 
 ##### Method `merge`
 
@@ -208,9 +210,6 @@ of `ID`s is the set union of `a.values[v]` and `b.values[v]`.
 NOTE: The operation actually does not produce a new `join` element. The element
 `a` is modified to become the `join` element. 
 
-NOTE: When union of `a.values[v]` and `b.values[v]` is computed, then `v` must
-be removed from the cache `export_cache`.
-
 ##### Method `transform`
 
 Computes an instance obtained from a source instance `a` by transformation over
@@ -222,8 +221,7 @@ instruction. The dedicated methods are described below.
 ##### Method `transform_dead`
 
 Computes an instance obtained from a source instance `a` by transformation over
-`DEAD v` GOTO instruction. The operation simply removes `v` from `a.values` (an
-from the `export_cache`).
+`DEAD v` GOTO instruction. The operation simply removes `v` from `a.values`.
 
 ##### Method `transform_start_thread`
 
@@ -258,6 +256,9 @@ in `values[v]` and stores them into `export_cache[v]`. Namely, for each
 `reaching_definitiont` instance `rd` obtained from `bv_container` it associates
 `rd.definition_at` with the bit-range `(rd.bit_begin, rd.bit_end)`.
 
+This function is only used to fill in the cache `export_cache` for the `output`
+method.
+
 ### Class `reaching_definitions_analysist`
 
 \subsection analyses-reaching-definitions Reaching definitions (reaching_definitions_analysist)