From 3dea4388fda0c73e51f84509740dbb6c0ea54fdf Mon Sep 17 00:00:00 2001 From: Thiago Santos Date: Wed, 14 Aug 2013 18:04:23 -0300 Subject: [PATCH] tools: improve documentation --- validate/gst/validate/gst-validate-file-check.c | 6 +++++- validate/gst/validate/gst-validate-transcoding.c | 8 +++++++- validate/gst/validate/gst-validate.c | 5 ++++- 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/validate/gst/validate/gst-validate-file-check.c b/validate/gst/validate/gst-validate-file-check.c index 8aaf686db8..f477ea3c9b 100644 --- a/validate/gst/validate/gst-validate-file-check.c +++ b/validate/gst/validate/gst-validate-file-check.c @@ -188,7 +188,11 @@ main (int argc, gchar ** argv) {NULL} }; - ctx = g_option_context_new ("- runs Validate transcoding test."); + g_set_prgname ("gst-validate-file-check-" GST_API_VERSION); + ctx = g_option_context_new ("[URI]"); + g_option_context_set_summary (ctx, "Does conformance checks on files. " + "Use the options to enable the tests to be made and pass the expected" + " results"); g_option_context_add_main_entries (ctx, options, NULL); if (!g_option_context_parse (ctx, &argc, &argv, &err)) { diff --git a/validate/gst/validate/gst-validate-transcoding.c b/validate/gst/validate/gst-validate-transcoding.c index 60cb42a8cd..7a0ca5b6c3 100644 --- a/validate/gst/validate/gst-validate-transcoding.c +++ b/validate/gst/validate/gst-validate-transcoding.c @@ -271,7 +271,13 @@ main (int argc, gchar ** argv) {NULL} }; - ctx = g_option_context_new ("- runs Validate transcoding test."); + g_set_prgname ("gst-validate-transcoding-" GST_API_VERSION); + ctx = g_option_context_new ("[input-file] [output-file]"); + g_option_context_set_summary (ctx, "Transcodes input-file to output-file, " + "using the given encoding profile. The pipeline will be monitored for " + "possible issues detection using the gst-validate lib." + "\nCan also perform file conformance" + "tests after transcoding to make sure the result is correct"); g_option_context_add_main_entries (ctx, options, NULL); if (!g_option_context_parse (ctx, &argc, &argv, &err)) { diff --git a/validate/gst/validate/gst-validate.c b/validate/gst/validate/gst-validate.c index 6aee502561..b59aeb47da 100644 --- a/validate/gst/validate/gst-validate.c +++ b/validate/gst/validate/gst-validate.c @@ -60,8 +60,11 @@ main (int argc, gchar ** argv) GstValidateMonitor *monitor; GstBus *bus; - ctx = g_option_context_new ("- runs Validate tests for a pipeline."); + g_set_prgname ("gst-validate-" GST_API_VERSION); + ctx = g_option_context_new ("PIPELINE-DESCRIPTION"); g_option_context_add_main_entries (ctx, options, NULL); + g_option_context_set_summary (ctx, "Runs a gst launch pipeline, adding " + "monitors to it to identify issues in the used elements"); if (argc == 1) { g_print ("%s", g_option_context_get_help (ctx, FALSE, NULL));