fixed a bug which allowed some statements to end in tokens other than semicolons...

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

diff --git a/doc/gmqcc.1 b/doc/gmqcc.1
index 5b54510ffc5a5ca7662c5c1f69362cbc5d0a1ef4..940afd0fa04919ccd81054ec782ee0d7ae66d5c1 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
@@ -165,9 +185,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 +297,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 +339,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 +447,14 @@ 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 that gmqcc
+generates an actual empty global, rather than using the global at
+offset 0 because it would overlap with the global RETURN variable when
+dealing with vectors, which starts at offset 1. Setting a vector to
+__NULL__ in fteqcc causes only the vector's x component to be 0.
+However, its y and z components will contain the previous x and y
+components of the global OFS_RETURN.
 .TP
 .B -fpermissive
 Various effects, usually to weaken some conditions.