Merge branch 'fix-true-documentation' into 'master'

change HELP.md to tell the user about the correct encoding of True.

See merge request mlubbers/ssm!3

HELP.md

@@ -519,7 +519,7 @@ M_post[SP_post] = M_pre[SP_pre - 1] ^ M_pre[SP_pre]
 
 #### Description
 
-Test for equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with beq.
+Test for equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with beq.
 
 #### Pre and postconditions
 
@@ -532,7 +532,7 @@ M_post[SP_post] = M_pre[SP_pre - 1] == M_pre[SP_pre]
 
 #### Description
 
-Test for not equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with bne.
+Test for not equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with bne.
 
 #### Pre and postconditions
 
@@ -545,7 +545,7 @@ M_post[SP_post] = M_pre[SP_pre - 1] != M_pre[SP_pre]
 
 #### Description
 
-Test for less then. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with blt.
+Test for less then. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with blt.
 
 #### Pre and postconditions
 
@@ -558,7 +558,7 @@ M_post[SP_post] = M_pre[SP_pre - 1] < M_pre[SP_pre]
 
 #### Description
 
-Test for less or equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with ble.
+Test for less or equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with ble.
 
 #### Pre and postconditions
 
@@ -571,7 +571,7 @@ M_post[SP_post] = M_pre[SP_pre - 1] <= M_pre[SP_pre]
 
 #### Description
 
-Test for greater then. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with bgt.
+Test for greater then. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with bgt.
 
 #### Pre and postconditions
 
@@ -584,7 +584,7 @@ M_post[SP_post] = M_pre[SP_pre - 1] > M_pre[SP_pre]
 
 #### Description
 
-Test for greater or equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with bge.
+Test for greater or equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with bge.
 
 #### Pre and postconditions
 

src/Help/ssminstrhelp.prop

@@ -124,27 +124,27 @@ xor_descr=Exclusive Or. Replaces 2 top stack values with the bitwise exclusive o
 xor_prepost=SP_post = SP_pre - 1, M_post[SP_post] = M_pre[SP_pre - 1] ^ M_pre[SP_pre]
 xor_example=ldc 0xFF00 ; variant of ldc 0x0FF0, ldc 0xF0F0, xor
 
-eq_descr=Test for equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with beq.
+eq_descr=Test for equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (all 1 bit pattern 0xFFFFFFFF) Used in combination with brf. This is a variant of cmp combined with beq.
 eq_prepost=SP_post = SP_pre - 1, M_post[SP_post] = M_pre[SP_pre - 1] == M_pre[SP_pre]
 eq_example=ldc 2, ldc 3, eq, brf FalseAction
 
-ne_descr=Test for not equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with bne.
+ne_descr=Test for not equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (all 1 bit pattern 0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with bne.
 ne_prepost=SP_post = SP_pre - 1, M_post[SP_post] = M_pre[SP_pre - 1] != M_pre[SP_pre]
 ne_example=ldc 2, ldc 3, ne, brf FalseAction
 
-lt_descr=Test for less then. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with blt.
+lt_descr=Test for less then. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (all 1 bit pattern 0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with blt.
 lt_prepost=SP_post = SP_pre - 1, M_post[SP_post] = M_pre[SP_pre - 1] < M_pre[SP_pre]
 lt_example=ldc 2, ldc 3, lt, brf FalseAction
 
-le_descr=Test for less or equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with ble.
+le_descr=Test for less or equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (all 1 bit pattern 0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with ble.
 le_prepost=SP_post = SP_pre - 1, M_post[SP_post] = M_pre[SP_pre - 1] <= M_pre[SP_pre]
 le_example=ldc 2, ldc 3, lr, brf FalseAction
 
-gt_descr=Test for greater then. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with bgt.
+gt_descr=Test for greater then. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (all 1 bit pattern 0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with bgt.
 gt_prepost=SP_post = SP_pre - 1, M_post[SP_post] = M_pre[SP_pre - 1] > M_pre[SP_pre]
 gt_example=ldc 2, ldc 3, gt, brf FalseAction
 
-ge_descr=Test for greater or equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as 1. Used in combination with brf. This is a variant of cmp combined with bge.
+ge_descr=Test for greater or equal. Replaces 2 top stack values with boolean result of the test. False is encoded as 0, True as -1 (all 1 bit pattern 0xFFFFFFFF). Used in combination with brf. This is a variant of cmp combined with bge.
 ge_prepost=SP_post = SP_pre - 1, M_post[SP_post] = M_pre[SP_pre - 1] >= M_pre[SP_pre]
 ge_example=ldc 2, ldc 3, ge, brf FalseAction