about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@80x24.org>2015-01-25 10:51:50 +0000
committerEric Wong <e@80x24.org>2015-01-25 10:59:51 +0000
commitead7725fa693c7dd832b22f77b32847c81a70d72 (patch)
tree44a662deec10ae6af49ea0b44ebf2d2f8793c562 /Documentation
parentef6dc55d9c40aaac9d1fbe5438dbaedc2ddad5e0 (diff)
While the Ruby Hash class is ordered in 1.9+, the YAML
specifications do not specify hashes as ordered by default.
Thus we must explicitly declare ordering via !omap for
interopability with non-Ruby tools.

This makes the YAML output of dtas-sourcedit and dtas-sinkedit
slightly more verbose

Users of dtas-splitfx are also encouraged to declare !omap
when creating their YAML files for interoperability.

Ordering env is important because any implementation of
built-in variable expansion is dependent on it.
Diffstat (limited to 'Documentation')
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/dtas-splitfx.txt b/Documentation/dtas-splitfx.txt
index 3c421a4..8e37523 100644
--- a/Documentation/dtas-splitfx.txt
+++ b/Documentation/dtas-splitfx.txt
@@ -38,8 +38,8 @@ to use ecasound(1), too.
 * infile - string, the pathname of the original audio file
-* env - hash of environment variables to set for all commands
-    env:
+* env - ordered hash of environment variables to set for all commands
+    env: !omap
       FX: vol +3dB stats
 * comments - hash of common tags for all audio (e.g. ARTIST, ALBUM, YEAR)