diff --git a/docs/data/Filemapping.md b/docs/data/Filemapping.md index e9473f248..3ff7de505 100644 --- a/docs/data/Filemapping.md +++ b/docs/data/Filemapping.md @@ -5,4 +5,20 @@ parent: Data nav_order: 4 --- -TODO \ No newline at end of file +# Filemapping + +Creating the instrumented version of the program will create a file named `FileMapping.txt` in the current working directory. +Each line in this file corresponds to an individual file encountered during the static analysis. +The format used to report the assigned file ids is as follows: + +``` + + +... +``` + +## Usage +In general, the `FileMapping.txt` can be used to map `file-ids`, e.g. used in the representation of identified `CUs`, to the file path of the corresponding file. + +## Utilities +For a simplified use from python modules, utilities for loading a filemapping can be imported from `discopop_library/PathManagement`.