Skip to content

Commit 7ce077d

Browse files
authored
Mention VRT case in README (#16)
1 parent 4f1b513 commit 7ce077d

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,13 @@ There is also an entry called `package_version_dict`, which contains a dictionar
4646

4747
If the environment variable `HISTORY_ENVVARS_TO_AUTOINCLUDE` is set, it will be taken to be a space-separated list of other environment variable names. For each of these names, if it is set, then that name/value pair will also be automatically included in the metadata dictionary.
4848

49+
## VRT Files
50+
A GDAL VRT file is handled as a somewhat special case. The component files of the VRT are treated as
51+
parents of the VRT (and there can be no other parents), and the history of those files is read
52+
directly from them, rather than being copied into the VRT. This is handled transparently, so
53+
that when history is read from the VRT, it appears to have all come from there. This allows the
54+
history of the components to be as dynamic as the data itself.
55+
4956
## Viewer
5057
A simple viewer called ``historyview`` is provided, to display the processing history to the console. Since the whole lineage can be quite large and complex, no attempt is made to display the whole thing at once. Rather, the metadata dictionary or the list of parents can be displayed, for either the main file itself, or for a nominated ancestor file within the lineage.
5158

0 commit comments

Comments
 (0)