[waffle] [PATCH 1/4] wflinfo: Clean usage text

Jordan Justen jordan.l.justen at intel.com
Mon Jan 20 14:27:51 PST 2014


From: Jordan Justen <jljusten at gmail.com>

Cleaning up and re-organizing to allow short version
parameters to be added.

Signed-off-by: Jordan Justen <jljusten at gmail.com>
---
 src/utils/wflinfo.c | 37 ++++++++++++++++++++++---------------
 1 file changed, 22 insertions(+), 15 deletions(-)

diff --git a/src/utils/wflinfo.c b/src/utils/wflinfo.c
index 1257666..a030520 100644
--- a/src/utils/wflinfo.c
+++ b/src/utils/wflinfo.c
@@ -54,24 +54,26 @@ removeXcodeArgs(int *argc, char **argv);
 #include "waffle.h"
 
 static const char *usage_message =
-    "usage:\n"
-    "    wflinfo --platform=android|cgl|gbm|glx|wayland|x11_egl\n"
-    "             --api=gl|gles1|gles2|gles3\n"
-    "             [--version=MAJOR.MINOR]\n"
-    "             [--profile=core|compat|none]\n"
-    "             [--forward-compatible]\n"
-    "             [--debug-context]\n"
-    "             [--verbose]\n"
+    "Usage:\n"
+    "    wflinfo <Required Parameters> [Options]\n"
     "\n"
-    "examples:\n"
-    "    wflinfo --platform=glx --api=gl\n"
-    "    wflinfo --platform=x11_egl --api=gl --version=3.2 --profile=core\n"
-    "    wflinfo --platform=wayland --api=gles3\n"
-    "\n"
-    "description:\n"
+    "Description:\n"
     "    Create an OpenGL or OpenGL ES context and print information about it.\n"
     "\n"
-    "options:\n"
+    "Required Parameters:\n"
+    "    --platform\n"
+    "        One of: android, cgl, gbm, glx, wayland or x11_egl\n"
+    "\n"
+    "    --api\n"
+    "        One of: gl, gles1, gles2 or gles3\n"
+    "\n"
+    "Options:\n"
+    "    --version\n"
+    "        For example --api=gl --version=3.2 would request OpenGL 3.2.\n"
+    "\n"
+    "    --profile\n"
+    "        One of: core, compat or none\n"
+    "\n"
     "    --verbose\n"
     "        Print more information.\n"
     "\n"
@@ -80,6 +82,11 @@ static const char *usage_message =
     "\n"
     "    --debug-context\n"
     "        Create a debug context.\n"
+    "\n"
+    "Examples:\n"
+    "    wflinfo --platform=glx --api=gl\n"
+    "    wflinfo --platform=x11_egl --api=gl --version=3.2 --profile=core\n"
+    "    wflinfo --platform=wayland --api=gles3\n"
     ;
 
 enum {
-- 
1.8.5.3



More information about the waffle mailing list