man: document `--colors-are-symbols` in nitc
authorJean Privat <jean@pryen.org>
Sat, 10 Jan 2015 19:53:46 +0000 (14:53 -0500)
committerJean Privat <jean@pryen.org>
Tue, 13 Jan 2015 01:27:50 +0000 (20:27 -0500)
Signed-off-by: Jean Privat <jean@pryen.org>

fixod

share/man/nitc.md

index 9c1d562..f98d50d 100644 (file)
@@ -329,6 +329,18 @@ Usually you do not need them since they make the generated code slower.
 `--colo-dead-methods`
 :   Force colorization of dead methods.
 
+`--colors-are-symbols`
+:   Store colors as symbols instead of static data.
+
+    By default, the various identifiers used to implement OO-mechanisms are stored as genuine constant static variables.
+
+    This option uses linker symbols to encode these identifiers.
+    This makes the compiled program faster since less indirections are required to get the values.
+    It also produces executables that are a little bit smaller since static memory does not have to store the colors.
+
+    Warning: the usage of linker symbols is not portable on all toolchains (eg. Mac OS X).
+    Also, this option does nothing on some platforms (like android).
+
 `--no-gcc-directive`
 :   Disable advanced gcc directives for optimization.