tools: improve documentation

This commit is contained in:
Thiago Santos 2013-08-14 18:04:23 -03:00
parent 52002376ea
commit 3dea4388fd
3 changed files with 16 additions and 3 deletions

View file

@ -188,7 +188,11 @@ main (int argc, gchar ** argv)
{NULL} {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); g_option_context_add_main_entries (ctx, options, NULL);
if (!g_option_context_parse (ctx, &argc, &argv, &err)) { if (!g_option_context_parse (ctx, &argc, &argv, &err)) {

View file

@ -271,7 +271,13 @@ main (int argc, gchar ** argv)
{NULL} {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); g_option_context_add_main_entries (ctx, options, NULL);
if (!g_option_context_parse (ctx, &argc, &argv, &err)) { if (!g_option_context_parse (ctx, &argc, &argv, &err)) {

View file

@ -60,8 +60,11 @@ main (int argc, gchar ** argv)
GstValidateMonitor *monitor; GstValidateMonitor *monitor;
GstBus *bus; 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_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) { if (argc == 1) {
g_print ("%s", g_option_context_get_help (ctx, FALSE, NULL)); g_print ("%s", g_option_context_get_help (ctx, FALSE, NULL));