From bac409670860b9607ba8e16cb0bd87e4423033b9 Mon Sep 17 00:00:00 2001
From: Bill Currie <bill@taniwha.org>
Date: Wed, 11 Apr 2007 10:48:04 +0000
Subject: [PATCH] some doc improvements as pointed out by Hikaru and add
 --relocatable to the long options

---
 tools/qfcc/doc/man/qfcc.1   | 23 +++++++++++++----------
 tools/qfcc/source/options.c | 35 ++++++++++++++++++-----------------
 2 files changed, 31 insertions(+), 27 deletions(-)

diff --git a/tools/qfcc/doc/man/qfcc.1 b/tools/qfcc/doc/man/qfcc.1
index 6d5d8c8eb..a6242f1c2 100644
--- a/tools/qfcc/doc/man/qfcc.1
+++ b/tools/qfcc/doc/man/qfcc.1
@@ -81,12 +81,13 @@ Process FILE as if \fB#include "FILE"\fP appeared as the first line of the
 primary source file. See the \fBcpp\fP man page (\fB\-include\fP) for details.
 .TP
 .B \-L DIR
-Add DIR to the search path used for -l.
+Add DIR to the search path used for finding libraries specified with \fB-l\fP.
 .TP
 .B \-l LIB
 Add libLIB.a to the list of libraries to be used for resolving undefined
-symbols. \fBqfcc\fP's libraries are really \fBpak\fP files of \fBqfcc\fP
-object files built using the \fBpak\fP utility.
+symbols. \fBqfcc\fP expects libraries to be \fBpak\fP files of \fBqfcc\fP
+object files built using the \fBpak\fP utility. (\fBFIXME\fP: add sections
+on object files and library files)
 .TP
 .B \-M, \-MD, \-MMD
 Generate dependency info. Dependent on \fBcpp\fP version, so check \fBcpp\fP's
@@ -102,16 +103,17 @@ Specify output file name.
 File to use instead of \fBprogs.src\fP
 .TP
 .B \-p, \-\-strip\-path NUM
-Strip NUM leading path elements from file names. eg. -p 3 will strip the
-\../../.. from ../../../src/foo.r when embedding the source file name in the
-output code.
+Strip NUM leading path elements from file names. eg. -p 3 will strip
+the ../../../ from ../../../src/foo.r when embedding the source file name in
+the output code.
 .TP
 .B \-q, \-\-quiet
 Inhibit some of \fBqfcc\fP's normal output.
 .TP
-.B \-r
+.B \-r, \-\-relocatable
 Incremental linking. Generate a larger object file from other object files
-and libraries.
+and libraries. (\fBFIXME\fP: add section describing the linker and its
+operation)
 .TP
 .B \-S, \-\-save\-temps
 Do not delete temporary files.
@@ -122,7 +124,8 @@ look for \fBprogs.src\fP in DIR instead of the current directory.
 .B \-\-traditional
 Use traditional QuakeC syntax, semantics and \*(lqbugs\*(rq. Also implies the
 \fBv6only\fP, \fBno-short-circuit\fP and \fBno-local-merging\fP code
-generation options. This is the default when using \fBprogs.src\fP.
+generation options (see \fBCODE GENERATION OPTIONS\fP). This is the default
+when using \fBprogs.src\fP.
 .TP
 .B \-U, \-\-undefine SYMBOL
 Undefine a preprocessor symbol, if the preprocessor is in use.
@@ -139,7 +142,7 @@ Set warning options. See \fBWARNING OPTIONS\fP for details.
 .B \-z
 Compress object files when writing them. This is especially useful when
 creating libraries, especially if using the object oriented features, but can
-be quite slow.
+be quite slow. This has no effect when writing \fBprogs.dat\fP.
 .SH "CODE GENERATION OPTIONS"
 Code generation options are processed in the order of their appearance on the
 command line. Unsupported options are ignored. The following options are
diff --git a/tools/qfcc/source/options.c b/tools/qfcc/source/options.c
index 333d37c17..872e219c3 100644
--- a/tools/qfcc/source/options.c
+++ b/tools/qfcc/source/options.c
@@ -59,25 +59,26 @@ static int num_files;
 static int files_size;
 
 static struct option const long_options[] = {
-	{"output-file", required_argument, 0, 'o'},
-	{"source", required_argument, 0, 's'},
-	{"progs-src", required_argument, 0, 'P'},
-	{"save-temps", no_argument, 0, 'S'},
-	{"quiet", no_argument, 0, 'q'},
-	{"verbose", no_argument, 0, 'v'},
-	{"code", required_argument, 0, 'C'},
-	{"warn", required_argument, 0, 'W'},
-	{"help", no_argument, 0, 'h'},
-	{"version", no_argument, 0, 'V'},
-	{"files", no_argument, 0, 'F'},
-	{"traditional", no_argument, 0, 257},
 	{"advanced", no_argument, 0, 258},
-	{"strip-path", required_argument, 0, 'p'},
-	{"define", required_argument, 0, 'D'},
-	{"include", required_argument, 0, 259},
-	{"undefine", required_argument, 0, 'U'},
+	{"code", required_argument, 0, 'C'},
 	{"cpp", required_argument, 0, 256},
+	{"define", required_argument, 0, 'D'},
+	{"files", no_argument, 0, 'F'},
+	{"help", no_argument, 0, 'h'},
+	{"include", required_argument, 0, 259},
 	{"notice", required_argument, 0, 'N'},
+	{"output-file", required_argument, 0, 'o'},
+	{"progs-src", required_argument, 0, 'P'},
+	{"quiet", no_argument, 0, 'q'},
+	{"relocatable", no_argument, 0, 'r'},
+	{"save-temps", no_argument, 0, 'S'},
+	{"source", required_argument, 0, 's'},
+	{"strip-path", required_argument, 0, 'p'},
+	{"traditional", no_argument, 0, 257},
+	{"undefine", required_argument, 0, 'U'},
+	{"verbose", no_argument, 0, 'v'},
+	{"version", no_argument, 0, 'V'},
+	{"warn", required_argument, 0, 'W'},
 	{NULL, 0, NULL, 0}
 };
 
@@ -140,7 +141,7 @@ usage (int status)
 "    -p, --strip-path NUM      Strip NUM leading path elements from file\n"
 "                              names\n"
 "    -q, --quiet               Inhibit usual output\n"
-"    -r                        Incremental linking\n"
+"    -r, --relocatable         Incremental linking\n"
 "    -S, --save-temps          Do not delete temporary files\n"
 "    -s, --source DIR          Look for progs.src in DIR instead of \".\"\n"
 "        --traditional         Traditional QuakeC mode: implies v6only\n"