Повідомлення про помилки

Існує три види помилок:

  • неправильна або несподівана поведінка, яка не викликає помилок

  • м’які помилки

  • серйозні помилки (збої)

Некоректна поведінка

У цьому випадку, будь ласка, повідомте про проблему на нашому трекері проблем з достатньою інформацією, щоб допомогти нам відтворити проблему.

Ви повинні включити такі відомості:

  • скріншот/скрінкаст, що показує проблему

  • опис проблеми

  • кроки для відтворення проблеми

  • Інформація про версію ОС і Zrythm

  • останні 100 рядків файлу журналу

У наступних підрозділах пояснюється, як надати цю інформацію.

Отримання скріншота/скрінкасту

Ви можете натиснути PrintScreen на клавіатурі, щоб отримати знімок екрана.

Щоб отримати скрінкаст, ви можете використовувати програмне забезпечення для запису екрана, наприклад OBS, або Control-Shift-Alt-R у GNOME.

Опис проблеми

Ви повинні надати якомога більше деталей, щоб допомогти нам зрозуміти та відтворити проблему, інакше ми нічого не зможемо з нею вдіяти. Ось приклад хорошого опису помилки:

Нерівні та неправильно вирівняні піктограми майстра часової бази та транспортного клієнта

Як видно на наступному знімку екрана, дві піктограми, здавалося б, неправильно вирівняні, переміщені одна в одну, а також дуже піксельні.

Кроки для відтворення

Укажіть точні кроки для відтворення проблеми, починаючи з порожнього проекту (якщо можливо). Ми виконаємо ці точні кроки, щоб відтворити помилку, щоб ми могли її виправити. Якщо ми не можемо відтворити проблему, її дуже важко знайти чи виправити.

Ось приклад корисних кроків для відтворення:

  1. Створіть порожній проект

  2. Додайте трек MIDI

  3. Створіть область, починаючи з такту 1 і закінчуючи тактою 5

  4. Додайте примітку в область, починаючи з такту 2 і закінчуючи тактом 4

  5. Розділіть ноту на такті 3

  6. Видалити 2-у ноту

  7. Зритм завмирає

інформація про версію ОС і Zrythm

Ви можете скопіювати версію Zrythm із діалогового вікна «Про програму» або (бажано) використати параметр --version під час запуску Zrythm у терміналі.

../_images/terminal-version-info.png

Ви можете отримати інформацію про ОС у діалоговому вікні Про (клацніть Усунення несправностей, а потім Інформація про налагодження)

../_images/debugging-info.png

Журнал

Файл журналу можна знайти у розташуванні, вказаному тут. Будь ласка, надайте принаймні останні 100 рядків. Вас можуть попросити надати повний файл журналу (спочатку стисніть його).

Як повідомити про проблему на GitLab

Примітка

Ви повинні спочатку зареєструвати обліковий запис у нас (якщо у вас його ще немає). Вам буде запропоновано ввійти (або створити обліковий запис), коли ви спробуєте створити проблему.

Спочатку перейдіть до нашого відстеження проблем. Ви побачите наступну сторінку.

../_images/gitlab-issues.png

Список проблем Zrythm

Натисніть Новий випуск. Ви побачите наступну сторінку, де ви зможете вказати деталі проблеми, з якою ви зіткнулися. Натисніть Виберіть шаблон… під Опис і виберіть те, що найкраще описує вашу проблему (наприклад, помилку).

../_images/gitlab-new-issue-selecting-template.png

Вибір шаблону випуску

Потім введіть необхідні дані, щоб допомогти нам зрозуміти, відтворити та вирішити проблему.

../_images/gitlab-filling-in-new-issue.png

Заповнення реквізитів за шаблоном

Коли ви закінчите, натисніть кнопку Створити проблему, щоб надіслати проблему нам.

../_images/gitlab-clicking-create-issue.png

Подання проблеми

Існуючі проблеми

Будь ласка, не забудьте спершу пошукати в нашому інструменті відстеження проблем будь-які подібні проблеми, перш ніж створювати новий (наявність кількох запитів про ту саму проблему витрачає наш час).

Натисніть Новий випуск. Ви побачите наступну сторінку, де ви зможете вказати деталі проблеми, з якою ви зіткнулися. Натисніть Виберіть шаблон… під опис і виберіть те, що найкраще описує вашу проблему (наприклад, помилку).

Якщо ви не впевнені, що ваша проблема є дублікатом, все одно надішліть її.

Порада

Зазвичай ми працюємо над проблемами, які вважаємо першочерговими, але якщо ви хочете швидко вирішити проблему й готові платити, зв’яжіться з нами зі своєю пропозицією.

М’які помилки

У цьому випадку Zrythm відобразить діалогове вікно звіту про помилку. Дотримуйтесь інструкцій у цьому діалоговому вікні, щоб повідомити про проблему.

Збої

Якщо Zrythm стався збій, діалогове вікно звіту про помилку може не відображатися або файл журналу може містити недостатньо інформації, щоб допомогти нам вирішити проблему. У цьому випадку виконайте наведені нижче дії, щоб створити дамп ядра або зворотне трасування.

Створення дампів ядра на GNU/Linux

Вам потрібно буде ввести деякі команди в термінал. Також переконайтеся, що у вашому дистрибутиві встановлено systemd-coredump або еквівалентний пакет.

Примітка

Наступні кроки стосуються користувачів systemd (переважна більшість користувачів GNU/Linux). Користувачі, які не користуються systemd, зазвичай можуть отримати основний файл у поточному каталозі після виконання перших 2 команд нижче та запуску Zrythm до збою.

Спочатку увімкніть дамп ядра:

ulimit -c unlimited

Скажіть Linux додати PID (ідентифікатор процесу) до дампа ядра:

sudo sysctl -w kernel.core_uses_pid=1

Запустіть Zrythm і зробіть його збій. Проміжний файл дампа ядра тепер має бути згенерований у /var/lib/systemd/coredump. Використовуйте coredumpctl, щоб перевірити:

coredumpctl list -1

Ви повинні побачити щось на зразок наступного:

TIME                          PID  UID  GID SIG    COREFILE EXE
Thu 2023-08-24 05:48:14 CDT 23179 1000 1000 SIGILL present  /opt/zrythm-1.0.0.beta.4.12.1/bin/zrythm

Зауважте, що під COREFILE вказано present, отже, основний файл існує.

Тепер ми нарешті можемо експортувати файл дампа ядра у вибране нами місце (у цьому випадку в мій каталог Downloads), передавши PID до coredumpctl:

coredumpctl dump 23179 --output=/home/alex/Downloads/core.23179

Важливо

Змініть шлях до файлу, наданий --output, на потрібне місце.

Будь ласка, надішліть нам файл дампа ядра (у наведеному вище прикладі його можна знайти за адресою /home/alex/Downloads/core.23179).

Отримання Backtrace у Windows

Відкрийте програму «Командний рядок» як адміністратор, знайшовши «cmd» у меню «Пуск», потім клацнувши програму правою кнопкою миші та вибравши «Запустити від імені адміністратора». Потім введіть наступне та натисніть enter/return:

"C:\Program Files\Zrythm\bin\drmingw.exe" -i"
../_images/drmingw-install.png

Це встановить DrMingw як налагоджувач за замовчуванням (ви можете видалити його пізніше).

../_images/drmingw-install-confirmation.png

Потім запустіть C:Program FilesZrythmbinzrythm_debug_gdb.exe і зробіть його збій. Коли Zrythm аварійно завершує роботу, на екрані з’являється вікно Dr. Mingw з деталями помилки.

../_images/drmingw-trace.png

Натисніть «Файл» -> «Зберегти як…» і збережіть де-небудь файл помилки. Будь ласка, надішліть нам цей файл помилки.

../_images/drmingw-saveas.png

Коли ви закінчите, якщо хочете, ви можете видалити Dr. Mingw за допомогою такої команди:

"C:\Program Files\Zrythm\bin\drmingw.exe" -u"
../_images/drmingw-uninstall.png

З’явиться діалогове вікно підтвердження:

../_images/drmingw-uninstall-confirmation.png