From 153d7a2ffa67ff5dd85b754f65e7cb842143094c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Sun, 21 Feb 2021 20:27:29 +0100 Subject: [PATCH] doc: yambar-modules: script: stress the importance of an empty line after a transaction Closes #34 --- doc/yambar-modules.5.scd | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/yambar-modules.5.scd b/doc/yambar-modules.5.scd index 14aed8f..aae3268 100644 --- a/doc/yambar-modules.5.scd +++ b/doc/yambar-modules.5.scd @@ -738,8 +738,11 @@ terminated. Or, the script can continue executing and update yambar with new tag sets, either periodically, or when there is new data to feed to yambar. -Tag sets, or _transactions_, are separated by an empty line. Each -_tag_ is a single line on the format: +Tag sets, or _transactions_, are separated by an empty line +(e.g. *echo ""*). The empty line is required to commit (update) the +tag even for only one transaction. + +Each _tag_ is a single line on the format: ``` name|type|value @@ -754,14 +757,16 @@ Example: ``` var1|string|hello var2|int|13 - + var1|string|world var2|int|37 + ``` The example above consists of two transactions. Each transaction has two tags: one string tag and one integer tag. The second transaction -replaces the tags from the first transaction. +replaces the tags from the first transaction. Note that **both** +transactions need to be terminated with an empty line. Supported _types_ are: