diff options
author | David Robillard <d@drobilla.net> | 2020-12-01 13:13:59 +0100 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2020-12-01 13:16:35 +0100 |
commit | 51f729b55621979af7291cb791cda70e8accefbe (patch) | |
tree | 4697b1ecad24238902f09a3108a15c13ee7aace4 | |
parent | 9ff0cbc41d84bd278b690c35ba0877a33c27437b (diff) | |
download | lilv-51f729b55621979af7291cb791cda70e8accefbe.tar.gz lilv-51f729b55621979af7291cb791cda70e8accefbe.tar.bz2 lilv-51f729b55621979af7291cb791cda70e8accefbe.zip |
Fix wording of scratch_dir documentation
-rw-r--r-- | lilv/lilv.h | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/lilv/lilv.h b/lilv/lilv.h index 0b4c454..83b28e2 100644 --- a/lilv/lilv.h +++ b/lilv/lilv.h @@ -1345,11 +1345,12 @@ typedef const void* (*LilvGetPortValueFunc)(const char* port_symbol, If supported (via state:makePath passed to LV2_Descriptor::instantiate()), `scratch_dir` should be the directory where any files created by the plugin - (not during save time, e.g. during instantiation) are stored. These files - will be copied to preserve their state at this time.plugin-created files are - stored. Lilv will assume any files within this directory (recursively) are - created by the plugin and all other files are immutable. Note that this - function does not save the state, use lilv_state_save() for that. + (for example during instantiation or while running) are stored. Any files + here that are referred to in the state will be copied to preserve their + contents at the time of the save. Lilv will assume any files within this + directory (recursively) are created by the plugin and that all other files + are immutable. Note that this function does not completely save the state, + use lilv_state_save() for that. See <a href="http://lv2plug.in/ns/ext/state/state.h">state.h</a> from the LV2 State extension for details on the `flags` and `features` parameters. |