validate: Update documentation

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-devtools/-/merge_requests/200>

docs/gst-validate-test-file.md

@@ -24,8 +24,6 @@ do:
 set-globals, media_dir=$(test_dir)/../../media
 ```
 
-The `meta` format:
-
 ## Tool arguments
 
 In the case of [`gst-validate`](gst-validate.md) it **has to** contain an
@@ -91,7 +89,7 @@ array as strings/within quotes.
 * `issue-url`: (string): The url of the issue in the bug tracker if the issue is
                a bug.
 
-# Variables
+### Variables
 
 The same way
 
@@ -117,4 +115,4 @@ Validate testfile will define some variables to make those files relocable:
 * `$(audiosink)`: The GStreamer audiosink to use if the test can work with
                   different sinks for the audio. It allows the tool to use
                   fakesinks when the user doesn't want to have audio feedback
-                  for example.
+                  for example.

docs/plugins/validateflow.md

@@ -117,7 +117,7 @@ event caps: video/x-h264, stream-format=(string)avc, alignment=(string)au, level
 
 ## Configuration
 
-In order to use the plugin a validate configuration file must be provided,
+In order to use the plugin a validate configuration must be provided,
 containing a line starting by `validateflow` followed by a number of settings.
 Every `validateflow` line creates a `ValidateFlowOverride`, which listens to a
 given pad. A test may have several `validateflow` lines, therefore having

validate/gst/validate/gst-validate-report.c

@@ -957,6 +957,19 @@ print_action_parameter_prototype (GString * string,
     g_string_append (string, "]");
 }
 
+static int
+sort_parameters (const GstValidateActionParameter * param1,
+    const GstValidateActionParameter * param2)
+{
+  if (param1->mandatory && !param2->mandatory)
+    return -1;
+
+  if (!param1->mandatory && param2->mandatory)
+    return 1;
+
+  return g_strcmp0 (param1->name, param2->name);
+}
+
 void
 gst_validate_printf_valist (gpointer source, const gchar * format, va_list args)
 {
@@ -975,6 +988,7 @@ gst_validate_printf_valist (gpointer source, const gchar * format, va_list args)
 
     } else if (*(GType *) source == GST_TYPE_VALIDATE_ACTION_TYPE) {
       gint i;
+      gint n_params;
       gboolean has_parameters = FALSE;
       gboolean is_first = TRUE;
 
@@ -1009,14 +1023,17 @@ gst_validate_printf_valist (gpointer source, const gchar * format, va_list args)
       g_string_append_printf (string, "\n``` validate-scenario\n%s,",
           type->name);
 
-      if (!IS_CONFIG_ACTION_TYPE (type->flags)) {
+      for (n_params = 0; type->parameters[n_params].name != NULL; n_params++);
-        print_action_parameter_prototype (string, &playback_time_param,
+      qsort (type->parameters, n_params, sizeof (GstValidateActionParameter),
+          (GCompareFunc) sort_parameters);
+      for (i = 0; type->parameters[i].name; i++) {
+        print_action_parameter_prototype (string, &type->parameters[i],
             is_first);
         is_first = FALSE;
       }
 
-      for (i = 0; type->parameters[i].name; i++) {
+      if (!IS_CONFIG_ACTION_TYPE (type->flags)) {
-        print_action_parameter_prototype (string, &type->parameters[i],
+        print_action_parameter_prototype (string, &playback_time_param,
             is_first);
         is_first = FALSE;
       }
@@ -1036,19 +1053,19 @@ gst_validate_printf_valist (gpointer source, const gchar * format, va_list args)
       if (type->parameters || !IS_CONFIG_ACTION_TYPE (type->flags))
         g_string_append_printf (string, "\n\n### Parameters");
 
-      if (!IS_CONFIG_ACTION_TYPE (type->flags)) {
-        print_action_parameter (string, type, &playback_time_param);
-        print_action_parameter (string, type, &on_message_param);
-      }
-
       if (type->parameters) {
         has_parameters = TRUE;
         for (i = 0; type->parameters[i].name; i++) {
           print_action_parameter (string, type, &type->parameters[i]);
         }
-
       }
 
+      if (!IS_CONFIG_ACTION_TYPE (type->flags)) {
+        print_action_parameter (string, type, &playback_time_param);
+        print_action_parameter (string, type, &on_message_param);
+      }
+
+
       if ((type->flags & GST_VALIDATE_ACTION_TYPE_CAN_BE_OPTIONAL)) {
         has_parameters = TRUE;
         g_string_append_printf (string,