Reporte de errores

En todo proyecto de software existen errores. Es un hecho. Sin embargo, éstos ser corregidos. Y cuanto mejor sea el reporte de un error mayores serán las posibilidades de que el equipo de desarrollo lo pueda replicar, investigar y finalmente corregir.

Todos los reportes de error deben ser registrados en el sistema oficial de seguimiento de errores (bug tracker). También se registrarán allí las sugerencias de mejoras y nuevas características, usando la etiqueta de severidad (severity): Wishlist (lista de deseos).

Primero lo primero

Sin embargo, antes de salir corriendo a hacer esto, por favor revisar los siguientes pasos:

Paso 1: Actualizar el programa a su última versión

Actualizar el programa a su última versión oficialmente lanzada. No se responderán reportes de errores referentes a versiones antiguas del programa (a menos que aún puedan reproducirse en la versión más reciente).

Paso 2: Buscar en la documentación oficial de Kdenlive

RTFM - Read The Fine Manual (o Lee el maldito manual) es una sigla habitualmente usada para burlarse y aleccionar de los usuarios que formulan preguntas que bien podrían ser respondidas mediante la lectura del propio manual del programa. En los tiempos de los tutoriales de YouTube esto podría no ser ya tan relevante, sin embargo se recomienda consultar la documentación oficial de Kdenlive. La misma contiene una función de búsqueda y contiene una cantidad significativa de valiosa información y consejos de uso.

Paso 3: Buscar en los foros

Kdenlive cuenta con una amplia comunidad que se encuentra activa en foros y salas de chat. Consultar en el foro oficial (official forum on Discuss) para ver si algún otro usuario se ha encontrado con el mismo problema. Muchas veces existe alguna corrección o alternativa al mismo. Otros canales que pueden ser consultados son

Paso 4: Revisar dentro de los incidentes ya abiertos

Buscar en el sistema de seguimiento de errores (Search the bug tracker). Quizás el problema que se está experimentando ya ha sido reportado o hasta se encuentra en vías de solución. El estado del error es una buen indicador para saber lo que está sucediendo actualmente con él:

  • REPORTED (Reportado) es un error que ha sido reportado, pero con el cual nada ha sucedido hasta el momento. Es posible que exista una discusión al respecto, por lo que sería bueno comprobar si eso aplica al caso puntual que se deseaba reportar.

  • NEEDSINFO (Se necesita información) es un error reportado, para el cual se necesita más información de los usuarios. Esto significa que un miembro del equipo de desarrollo del programa lo ha revisado pero que juzgó que con la información disponible reportada no alcanza para determinar su naturaleza, identificarlo adecuadamente o decidir sobre una posible vía de solución.

  • CONFIRMED (Confirmado) significa que el error pudo ser reproducido (tanto por otros usuarios, como por el equipo de desarrollo).

  • ASSIGNED (Asignado) significa que un desarrollador se está encargando del problema.

  • RESOLVED (Resuelto) significa que el error fue corregido en la versión de desarrollo del programa.

Paso 5: Reportar el problema

En caso de que se produzca un cierre imprevisto del programa al iniciarlo o al intentar reproducir un archivo de video, seguir los siguientes pasos:

  • En caso de haber compilado Kdenlive y/o MLT por uno mismo, asegurarse de haber seguido todos los pasos descriptos en las instrucciones.

  • Comprobar que no existan varias versiones de MLT instaladas en el sistema

  • Intentar reproducir el archivo de video con el reproductor de FFmpeg. Desde una terminal, ejecutar: ffplay myvideo.mpg

  • Intentar reproducir el archivo de video con el reproductor de MLT. Desde una terminal, ejecutar: melt myvideo.mpg

Incluir el resultado de esto en el reporte del error, en forma de archivo adjunto.

Para realizar un buen reporte de error, incluir la siguiente información:

  • Las versiones en uso de Kdenlive y MLT. Será posible copiar esa información usando la opción de Kdenlive: Ayuda > Acerca de.

  • El sistema operativo en uso (Windows, distribución de Linux o macOS, incluyendo su versión correspondiente)

  • El método de instalación de Kdenlive, por ejemplo: Instalador o versión autónoma de Windows o flatpak/snap/ppa o appimage de Linux

  • Pasos detallados para reproducir el error. Tanto las capturas de pantalla como las grabaciones de pantalla serán de mucha ayuda a la hora de poder replicar el problema.

  • Cualquier mensaje de error o archivo de registro de error que pueda ser proporcionado. Por favor no copiar y pegar el contenido de registros de error en el texto del propio reporte, sino como un archivo de texto adjunto.

  • En caso de que el error cause el cierre del programa, proporcionar un «backtrace».

Cómo obtener información relevante (backtrace) acerca de un cierre inesperado:

Un «backtrace» contiene información valiosa para el equipo de desarrollo. Será necesaria una pequeña configuración del sistema operativo, así como un mínimo de destreza en el manejo de la Línea de comandos, para obtenerla, por lo cual es posible que no sea una tarea apta para todo el mundo.

Linux appimage:

Instalar los siguientes paquetes: gdb, kdenlive-dbg y libmlt-dbg (los nombres de los paquetes podrían ser ligeramente distintos, dependiendo de la distribución usada)

Cuando Kdenlive se cierre, en caso de que el administrador de cierres de KDE aparezca, será posible copiar los datos que éste proporciona. En caso contrario, ejecutar Kdenlive desde una terminal, de la siguiente forma:

Escribir gdb kdenlive

Después de que gdb lea los símbolos de depuración, escribir run

Linux Flatpak:

Primero asegurarse de que los símbolos de depuración de Flatpak se encuentren instalados, introduciendo flatpak install org.kde.kdenlive.Debug en una línea de comandos.

Ahora, será posible ejecutar el Flatpak desde una línea de comandos, de la siguiente forma:

  • Abrir una terminal dentro de la sandbox del Flatpack de Kdenlive: flatpak run --command=sh --devel org.kde.kdenlive

  • Introducir gdb /app/bin/kdenlive

  • Después de que gdb lea los símbolos de depuración, escribir run

Para más detalles sobre la depuración con Flatpak, ver aquí: https://docs.flatpak.org/en/latest/debugging.html

Windows:

Compilar Kdenlive localmente con KDE Craft, tal como se describe aquí:

  • Introducir cd C:/CraftRoot/mingw64/bin en una línea de comandos

  • Ejecutar gdb, introduciendo: gdb

  • Ejecutar Kdenlive -> obtener su número de PID

  • attach 3288 (reemplazar 3288 por el número de PID)

  • Esperar por el símbolo del sistema de (gdb)

  • Introducir: c

Una vez se hayan seguido las instrucciones específicas de cada plataforma (arriba), ejecutar Kdenlive, hacer que se dispare el error. Cuando Kdenlive se cierre, ir a la ventana de terminal e introducir:

thread apply all bt full

Luego, pulsar Intro hasta que se vean los datos completos. Copiar el registro a un archivo y adjuntarlo al reporte del error.

Creación de un reporte de error

Ahora que se dispone que toda la información relevante, será tiempo de confeccionar un reporte de error en el sistema de seguimiento de errores de KDE, Bugzilla.

Abrir un navegador e introducir la dirección del sistema de seguimiento de errores (bugs.kde.org) en el campo de URI.

kde_bugtracking_system.webp

Pantalla de bienvenida del sistema de seguimiento de errores de KDE

Es posible que sea necesario ingresar previamente al sistema con un usuario y contraseña o crear una nueva cuenta de usuario. Se deberán seguir las instrucciones que aparezcan en pantalla al respecto.

Hacer clic en File a Bug.

kde_bug_classification.webp

Selección de categorías en el sistema de seguimiento de errores de KDE

Hacer clic en Application para obtener una lista de todas las aplicaciones de KDE que utilizan el sistema Bugzilla para el seguimiento de sus errores.

kde_bug_application.webp

Selección de una aplicación en el sistema de seguimiento de errores de KDE

La lista estará orgeneda de forma alfabética. Desplazarse hacia abajo, hasta donde se encuentre Kdenlive en el listado, o usar Ctrl+F para abrir un campo de búsqueda e introducir el nombre kdenlive. Esto último debería funcionar en la mayoría de los navegadores, aunque podría ser diferente en otros.

Bugzilla abrirá la pantalla para crear un nuevo reporte de error. Algunos campos serán obligatorios (los indicados por el símbolo * en color rojo) y otros se encontrarán rellenados con datos recogidos del sistema en uso.

kde_bug_enter.webp

Introducción de los detalles del error en el sistema de seguimiento de errores de KDE

1:

El reporte de error será rellenado a nombre de la dirección de correo electrónico del usuario con el que se ingresó al sistema

2:

Seleccionar el componente de la aplicación que mejor se ajuste al tipo de problema encontrado

3:

Seleccionar la versión de Kdenlive en uso

4:

Especificar la severidad del problema. En caso de que lo deseado sea proponer una nueva característica o función para el programa, seleccionar la categoría de Severidad: wishlist.

5:

Seleccionar la plataforma que se está usando. Esto ayudará para tratar de identificar y reproducir el problema.

6:

Seleccionar el sistema operativo que se está usando

7:

Introducir un resumen descriptivo breve del error o problema que se está reportando

8:

Aquí es donde se deberá describir el problema con más detalle. El texto entre *** se muestra sólo con un propósito informativo, intentando prevenir reportes de error innecesarios. En caso de desear continuar con la creación de un reporte de error, seleccionar dicho texto y borrarlo. A continuación, comenzar a introducir la descripción del problema.

Se ruega incluir la mayor cantidad de detalles posibles al describir lo que se estaba haciendo al producirse el error o el funcionamiento inapropiado de Kdenlive.

Existen algunas secciones ya escritas, tales como Step to Reproduce (Pasos para reproducir el error), Observed Results (Resultado observado) y Expected Results (Resultado esperado), que servirán como guía para completar lo que se espera de un reporte de error. Se usan simplemente para ayudar a estructurar el reporte, para que sea más sencilla su comprensión y posterior reproducción por parte del equipo de desarrollo.

En la sección Software/OS Version se podrá pegar los datos relevantes obtenidos mediante la opción Ayuda ‣ Acerca de Kdenlive ‣ Componentes ‣ Copiar al portapapeles.

kde_bug_kdenlive_components

Copiar información desde Kdenlive

9:

Será posible agregar archivos adjuntos como capturas o grabaciones de pantalla o archivos de texto con información de depuración o detalles de la salida de consola del programa.

10:

Hacer clic en Submit Bug para enviar el reporte de error