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. También se registrarán allí las sugerencias de mejoras y nuevas características, usando la etiqueta de severidad (severity): Wishlist (lista de deseos). 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 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. 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:

  1. En caso de haber compilado Kdenlive y/o MLT por uno mismo, asegurarse de haber seguido todos los pasos descriptos en las instrucciones.
  2. Comprobar que no existan varias versiones de MLT instaladas en el sistema
  3. Intentar reproducir el archivo de video con el reproductor de FFmpeg. Desde una terminal, ejecutar: ffplay myvideo.mpg
  4. 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 útil sobre la detención del programa (backtrace)

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.

Appimage de Linux

Instalar los siguientes paquetes: gdb, kdenlive-dbg, 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:

  1. Escribir gdb kdenlive
  2. Después de que gdb lea los símbolos de depuración, escribir run

Flatpak de Linux

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:

  1. Abrir una terminal dentro de la sandbox del Flatpack de Kdenlive: flatpak run --command=sh --devel org.kde.kdenlive
  2. Introducir gdb /app/bin/kdenlive
  3. 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

  1. Compilar Kdenlive localmente con KDE Craft, tal como se describe aquí.
  2. Introducir cd C:/CraftRoot/mingw64/bin en una línea de comandos.
  3. Ejecutar gdb, introduciendo: gdb
  4. Ejecutar Kdenlive -> obtener su número de PID
  5. attach 3288 (reemplazar 3288 por el número de PID)
  6. Esperar por el símbolo del sistema de (gdb)
  7. 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.