manpage: --add-info

[xonotic/gmqcc.git] / doc / gmqcc.1

diff --git a/doc/gmqcc.1 b/doc/gmqcc.1
index 5b54510ffc5a5ca7662c5c1f69362cbc5d0a1ef4..ed88235ebbf77972405a4f4d91a2eb2b57fa218b 100644 (file)
--- a/doc/gmqcc.1
+++ b/doc/gmqcc.1
@@ -59,7 +59,14 @@ some others. Warnings and errors will of course still be displayed.
 Enable or disable a warning.
 .TP
 .B -Wall
-Enable all warnings. Overrides preceding -W parameters.
+Enable almost all warnings. Overrides preceding -W parameters.
+.sp
+The following warnings will \fBnot\fR be anbled:
+.in +4
+.nf
+-Wuninitialized-global
+.fi
+.in
 .TP
 .BR -Werror ", " -Wno-error
 Controls whether or not all warnings should be treated as errors.
@@ -101,8 +108,20 @@ them.
 .sp
 .BR -std=gmqcc " includes:"
 .in +4
+.nf
 -fadjust-vector-fields
+-fcorrect-logic
+-ftrue-empty-strings
+-floop-labels
+-finitialized-nonconstants
+-ftranslatable-strings
+-f\fIno-\fRfalse-empty-strings
+-Winvalid-parameter-count
+-Wmissing-returnvalues
+-fcorrect-ternary (cannot be turned off)
+.fi
 .in
+.sp
 .BR -std=qcc " includes:"
 .in +4
 .nf
@@ -110,6 +129,7 @@ them.
 -f\fIno-\fRadjust-vector-fields
 .fi
 .in
+.sp
 .BR -std=fteqcc " includes:"
 .in +4
 .nf
@@ -122,6 +142,15 @@ them.
 .fi
 .in
 .TP
+.B "--add-info"
+Adds compiler information to the generated binary file. Currently
+this includes the following globals:
+.RS
+.IP "reserved:version"
+String containing the compiler version as printed by the --version
+parameter.
+.RE
+.TP
 .B "-dump"
 DEBUG OPTION. Print the code's intermediate representation before the
 optimization and finalization passes to stdout before generating the
@@ -165,9 +194,8 @@ optionally enable a warning.
 Functions which aren't of type \fIvoid\fR will warn if it possible to
 reach the end without returning an actual value.
 .TP
-.B -Wtoo-few-parameters
-Warn about a function call with fewer parameters than the function
-expects.
+.B -Winvalid-parameter-count
+Warn about a function call with an invalid number of parameters.
 .TP
 .B -Wlocal-shadows
 Warn when a locally declared variable shadows variable.
@@ -278,6 +306,16 @@ marked \'const\'.
 .TP
 .B -Wdifferent-attributes
 Similar to the above but for attributes like "[[noreturn]]".
+.TP
+.B -Wdeprecated
+Warn when a function is marked with the attribute
+"[[deprecated]]". This flag enables a warning on calls to functions
+marked as such.
+.TP
+.B -Wparenthesis
+Warn about possible mistakes caused by missing or wrong parenthesis,
+like an assignment in an 'if' condition when there's no additional set
+of parens around the assignment.
 .SH COMPILE FLAGS
 .TP
 .B -fdarkplaces-string-table-bug
@@ -310,10 +348,12 @@ __COUNTER__
 __COUNTER_LAST__
 __RANDOM__
 __RANDOM_LAST__
+__DATE__
+__TIME__
 .fi
 .in
-Note that fteqcc also defines __FUNC__, __TIME__, __DATE__ and
-__NULL__, which are not yet implemented.
+Note that fteqcc also defines __NULL__ which is not implemented yet.
+(See -funtyped-nil about gmqcc's alternative to __NULL__).
 .TP
 .B -frelaxed-switch
 Allow switch cases to use non constant variables.
@@ -416,6 +456,19 @@ Adds a global named 'nil' which is of no type and can be assigned to
 anything. No typechecking will be performed on assignments. Assigning
 to it is forbidden, using it in any other kind of expression is also
 not allowed.
+.sp
+Note that this is different from fteqcc's __NULL__: In fteqcc,
+__NULL__ maps to the integer written as '0i'. It's can be assigned to
+function pointers and integers, but it'll error about invalid
+instructions when assigning it to floats without enabling the FTE
+instruction set. There's also a bug which allows it to be assigned to
+vectors, for which the source will be the global at offset 0, meaning
+the vector's y and z components will contain the OFS_RETURN x and y
+components.
+.sp
+In that gmqcc the nil global is an actual global filled with zeroes,
+and can be assigned to anything including fields, vectors or function
+pointers, and they end up becoming zeroed.
 .TP
 .B -fpermissive
 Various effects, usually to weaken some conditions.
@@ -423,6 +476,7 @@ Various effects, usually to weaken some conditions.
 .IP "with -funtyped-nil"
 Allow local variables named 'nil'. (This will not allow declaring a
 global of that name.)
+.RE
 .SH OPTIMIZATIONS
 .TP
 .B -Opeephole