--- Begin Message ---
- To: Debian Bug Tracking System <submit@bugs.debian.org>
- Subject: patch to add usage information to mesa-utils
- From: david@fries.net
- Date: Mon, 02 Oct 2006 21:23:43 -0500
- Message-id: <20061003022343.19359.688.reportbug@SubSpace.fries.net>
Package: mesa-utils
Version: 6.3.2-2.1
Severity: normal
Tags: patch
Usage information for a program is nice. Only documenting it in the
source isn't. Here is a patch to add usage information to the
mesa-utils programs.
diff -r -up xdemos_orig/glthreads.c xdemos/glthreads.c
--- xdemos_orig/glthreads.c 2006-10-02 21:03:50.000000000 -0500
+++ xdemos/glthreads.c 2006-10-02 19:21:18.000000000 -0500
@@ -322,7 +322,13 @@ clean_up(void)
}
}
-
+void usage(const char *prog)
+{
+ printf("%s: test of GL thread safety (any key = exit)\n", prog);
+ printf("Usage:\n");
+ printf(" %s [-display dpyName] [-n numthreads]\n", prog);
+ exit(1);
+}
int
main(int argc, char *argv[])
@@ -334,9 +340,7 @@ main(int argc, char *argv[])
Status threadStat;
if (argc == 1) {
- printf("threadgl: test of GL thread safety (any key = exit)\n");
- printf("Usage:\n");
- printf(" threadgl [-display dpyName] [-n numthreads]\n");
+ usage(argv[0]);
}
else {
int i;
@@ -353,6 +357,9 @@ main(int argc, char *argv[])
numThreads = MAX_WINTHREADS;
i++;
}
+ else {
+ usage(argv[0]);
+ }
}
}
diff -r -up xdemos_orig/glxcontexts.c xdemos/glxcontexts.c
--- xdemos_orig/glxcontexts.c 2006-10-02 21:03:50.000000000 -0500
+++ xdemos/glxcontexts.c 2006-10-02 19:31:10.000000000 -0500
@@ -557,7 +557,13 @@ event_loop(Display *dpy)
}
}
-
+void usage(const char *prog)
+{
+ printf("%s: non-GLUT GLX Gears\n", prog);
+ printf("Usage:\n");
+ printf(" %s [-display dpyName] [-info] [-stereo] [-fullscreen]\n", prog);
+ exit(1);
+}
int
main(int argc, char *argv[])
@@ -581,8 +587,10 @@ main(int argc, char *argv[])
else if (strcmp(argv[i], "-fullscreen") == 0) {
fullscreen = GL_TRUE;
}
- else
- printf("Warrning: unknown parameter: %s\n", argv[i]);
+ else {
+ printf("Warrning: unknown parameter: %s\n", argv[i]);
+ usage(argv[0]);
+ }
}
dpy = XOpenDisplay(dpyName);
diff -r -up xdemos_orig/glxdemo.c xdemos/glxdemo.c
--- xdemos_orig/glxdemo.c 2006-10-02 21:03:50.000000000 -0500
+++ xdemos/glxdemo.c 2006-10-02 19:32:49.000000000 -0500
@@ -107,11 +107,20 @@ static void event_loop( Display *dpy )
}
+void usage(const char *prog)
+{
+ printf("%s: Draw a rectangle, (no arguments)\n", prog);
+ printf("Usage:\n");
+ printf(" %s\n", prog);
+ exit(1);
+}
int main( int argc, char *argv[] )
{
Display *dpy;
Window win;
+ if(argc!=1)
+ usage(argv[0]);
dpy = XOpenDisplay(NULL);
diff -r -up xdemos_orig/glxgears.c xdemos/glxgears.c
--- xdemos_orig/glxgears.c 2006-10-02 21:03:50.000000000 -0500
+++ xdemos/glxgears.c 2006-10-02 19:35:28.000000000 -0500
@@ -542,6 +542,14 @@ event_loop(Display *dpy, Window win)
}
}
+void usage(const char *prog)
+{
+ printf("%s: GLX Gears\n", prog);
+ printf("Usage:\n");
+ printf(" %s [-display dpyName] [-info] [-stereo] [-fullscreen] "
+ "[-iacknowledgethatthistoolisnotabenchmark] [-printfps]\n", prog);
+ exit(1);
+}
int
main(int argc, char *argv[])
@@ -571,8 +579,10 @@ main(int argc, char *argv[])
(strcmp(argv[i], "-printfps") == 0)) {
printfps = GL_TRUE;
}
- else
- printf("Warrning: unknown parameter: %s\n", argv[i]);
+ else {
+ printf("Warrning: unknown parameter: %s\n", argv[i]);
+ usage(argv[0]);
+ }
}
dpy = XOpenDisplay(dpyName);
diff -r -up xdemos_orig/glxgears2.c xdemos/glxgears2.c
--- xdemos_orig/glxgears2.c 2006-10-02 21:03:50.000000000 -0500
+++ xdemos/glxgears2.c 2006-10-02 19:36:16.000000000 -0500
@@ -473,6 +473,14 @@ event_loop(Display *dpy, Window win)
}
+void usage(const char *prog)
+{
+ printf("%s: GLX Gears\n", prog);
+ printf("Usage:\n");
+ printf(" %s [-display dpyName] [-info]\n", prog);
+ exit(1);
+}
+
int
main(int argc, char *argv[])
{
@@ -491,6 +499,9 @@ main(int argc, char *argv[])
else if (strcmp(argv[i], "-info") == 0) {
printInfo = GL_TRUE;
}
+ else {
+ usage(argv[0]);
+ }
}
dpy = XOpenDisplay(dpyName);
diff -r -up xdemos_orig/glxgears_fbconfig.c xdemos/glxgears_fbconfig.c
--- xdemos_orig/glxgears_fbconfig.c 2006-10-02 21:03:50.000000000 -0500
+++ xdemos/glxgears_fbconfig.c 2006-10-02 20:24:20.000000000 -0500
@@ -553,6 +553,14 @@ event_loop(Display *dpy, Window win)
}
+void usage(const char *prog)
+{
+ printf("%s: GLX fbconfig version Gears\n", prog);
+ printf("Usage:\n");
+ printf(" %s [-display dpyName] [-info]\n", prog);
+ exit(1);
+}
+
int
main(int argc, char *argv[])
{
@@ -571,6 +579,9 @@ main(int argc, char *argv[])
else if (strcmp(argv[i], "-info") == 0) {
printInfo = GL_TRUE;
}
+ else {
+ usage(argv[0]);
+ }
}
dpy = XOpenDisplay(dpyName);
diff -r -up xdemos_orig/glxswapcontrol.c xdemos/glxswapcontrol.c
--- xdemos_orig/glxswapcontrol.c 2006-10-02 21:03:50.000000000 -0500
+++ xdemos/glxswapcontrol.c 2006-10-02 20:28:19.000000000 -0500
@@ -695,6 +695,19 @@ is_extension_supported( const char * ext
}
+void usage(const char *prog)
+{
+ printf("Usage:\n");
+ printf(" %s [options]\n", prog);
+ printf("Options:\n");
+ printf(" -help Print this information\n");
+ printf(" -display displayName Specify X display\n");
+ printf(" -info Display GL information\n");
+ printf(" -swap N Swap no more than once per N vertical refreshes\n");
+ printf(" -forcegetrate Try to use glXGetMscRateOML function\n");
+ exit(1);
+}
+
int
main(int argc, char *argv[])
{
@@ -734,16 +747,8 @@ main(int argc, char *argv[])
else if (strcmp(argv[i], "-ztrick") == 0) {
use_ztrick = GL_TRUE;
}
- else if (strcmp(argv[i], "-help") == 0) {
- printf("Usage:\n");
- printf(" gears [options]\n");
- printf("Options:\n");
- printf(" -help Print this information\n");
- printf(" -display displayName Specify X display\n");
- printf(" -info Display GL information\n");
- printf(" -swap N Swap no more than once per N vertical refreshes\n");
- printf(" -forcegetrate Try to use glXGetMscRateOML function\n");
- return 0;
+ else {
+ usage(argv[0]);
}
}
diff -r -up xdemos_orig/manywin.c xdemos/manywin.c
--- xdemos_orig/manywin.c 2006-10-02 21:03:50.000000000 -0500
+++ xdemos/manywin.c 2006-10-02 20:29:35.000000000 -0500
@@ -342,13 +342,8 @@ PrintInfo(const struct head *h)
}
-int
-main(int argc, char *argv[])
+void usage(const char *prog)
{
- char *dpyName = NULL;
- int i;
-
- if (argc == 1) {
printf("manywin: open N simultaneous glx windows\n");
printf("Usage:\n");
printf(" manywin [-s] numWindows\n");
@@ -356,7 +351,17 @@ main(int argc, char *argv[])
printf(" -s = swap immediately after drawing (see src code)\n");
printf("Example:\n");
printf(" manywin 10\n");
- return 0;
+ exit(1);
+}
+
+int
+main(int argc, char *argv[])
+{
+ char *dpyName = NULL;
+ int i;
+
+ if (argc == 1) {
+ usage(argv[0]);
}
else {
int n = 3;
-- System Information:
Debian Release: testing/unstable
APT prefers testing
APT policy: (500, 'testing')
Architecture: i386 (i686)
Shell: /bin/sh linked to /bin/bash
Kernel: Linux 2.6.14-rc3
Locale: LANG=C, LC_CTYPE=C (charmap=ANSI_X3.4-1968)
Versions of packages mesa-utils depends on:
ii freeglut3 2.4.0-5 OpenGL Utility Toolkit
ii libc6 2.3.6-15 GNU C Library: Shared libraries
ii libgl1-mesa-glx [libgl1] 6.4.2-1 A free implementation of the OpenG
ii libglu1-mesa [libglu1] 6.4.2-1 The OpenGL utility library (GLU)
ii libx11-6 2:1.0.0-7 X11 client-side library
mesa-utils recommends no packages.
-- no debconf information
--- End Message ---