summaryrefslogtreecommitdiffstats
path: root/debian/uncrustify-trinity/uncrustify-trinity-0.73.0/documentation/control_the_spaces.txt
diff options
context:
space:
mode:
Diffstat (limited to 'debian/uncrustify-trinity/uncrustify-trinity-0.73.0/documentation/control_the_spaces.txt')
-rw-r--r--debian/uncrustify-trinity/uncrustify-trinity-0.73.0/documentation/control_the_spaces.txt22
1 files changed, 22 insertions, 0 deletions
diff --git a/debian/uncrustify-trinity/uncrustify-trinity-0.73.0/documentation/control_the_spaces.txt b/debian/uncrustify-trinity/uncrustify-trinity-0.73.0/documentation/control_the_spaces.txt
new file mode 100644
index 00000000..8ea2ac52
--- /dev/null
+++ b/debian/uncrustify-trinity/uncrustify-trinity-0.73.0/documentation/control_the_spaces.txt
@@ -0,0 +1,22 @@
+2021-01-23
+
+Guy Maurel
+
+The do_space function within the file space.cpp controls the space between every two tokens.
+
+There are three categories of actions.
+The first one is the most important.
+Options control what is to do with the interval between the two token:
+ * "Ignore" means do not change it.
+ * "Add" in the context of spaces means make sure there is at least 1.
+ * "Add" elsewhere means make sure one is present.
+ * "Remove" mean remove the space/brace/newline/etc.
+ * "Force" in the context of spaces means ensure that there is exactly 1.
+ * "Force" in other contexts means the same as "add".
+For example the option "sp_before_assign":
+Add or remove space before assignment operator '=', '+=', etc.
+in such a statement:
+ a =5;
+
+The second categorie is used for all positions where no option is coded.
+The third categorie is a debug for the developer, who still have something to do.