Add guides on how to manually collect bug report system information #58

Merged
Alaska merged 39 commits from Alaska/blender-developer-docs:manual-system-information into main 2024-08-07 14:17:21 +02:00
4 changed files with 138 additions and 0 deletions
Showing only changes of commit 9e2e1494a4 - Show all commits

View File

@ -0,0 +1,15 @@
# Manually Collecting System Information
When reporting a bug you will be asked to provide some system information
and your Blender version number. This information can be automatically
collected and filled out by selecteing `Help > Report a bug` from the
top of Blender. Or selecting `Report a bug` on the add-on you want
to report a bug on.
However, sometimes Blender won't open, so you can't use these features.
In which case you will need to collect the information manually.
To do that, check the guide for your operating system below.
- [Windows](windows_information.md)
- [macOS](macos_information.md)
- [Linux](linux_information.md)

View File

@ -0,0 +1,14 @@
# Linux System Information
## Operating System
TODO: `uname -r` in terminal?
## Graphics Card
TODO: Investigate how to get this info
## Blender Version
TODO: Investigate how to get version info, and see if there's anything
special for Snap.

View File

@ -0,0 +1,44 @@
# macOS System Information
## Operating System
Select from the top bar of macOS `Apple Icon > About This Mac`. Here you will find
your macOS version beside the field `macOS`.
Share the information on the report form like this: `macOS 14.4.1`
![](../../../images/macOS_get_os_version.jpg)
## Graphics Card
Open Launchpad from the dock and search for `System Information` and open the app
that appears. You will be find your graphics card information in the section
`Hardware > Graphics/Display`. The information we're interested in is the
`Chipset Model` and the `Metal Support`.
Combine these two details together and share them in your bug report form
like this: `Apple M1 Pro - Metal 3`
![](../../../images/macOS_get_gpu_info.jpg)
## Blender Version
Follow one of the guides below to obtain your Blender version number then
share it on your bug reporting form like this: `Blender 4.1.1`
### Downloaded from Blender Website
Navigate to where Blender is installed and right click on it and select `Get Info`.
You will find the Blender version number in the field `General > Version`.
![](../../../images/macOS_get_blender_version.jpg)
### Downloaded from Steam
If you installed Blender through Steam, then open Steam, right click
on Blender and select the option `Manage > Browse local files`.
A file browser will appear showing where Blender is installed.
Right click on Blender and select `Get Info`. You will find the
Blender version number in the field `General > Version`.
TODO: ADD IMAGE FOR STEAM

View File

@ -0,0 +1,65 @@
# Windows System Information
## Operating System
To collect operating system information, open the Windows settings app,
and navigate to the `System > About` page. Here you will find the operating
system information you need. They are:
- System Type (E.g. x64 or ARM64)
- Windows Editon (E.g. Windows 10, Windows 11)
- OS Build
Combine these details together and share them in the bug report form like this:
`Windows 11 22631.3447 x64 processor`
TODO: ADD IMAGE
## Graphics Card
To collect information about your graphics card, right click a empty spot on
your task bar and select `Task Manager`. In the window that appears,
expand it to show more details, and go to the `Performance` tab.
In the performance tab you should find one or more `GPUs` in the collum on
the left. Click on them, and you will find the graphics card name
in the top right and the driver version in the bottom right.
Combine these details together and share them in your bug report form like this:
`NVIDIA GeForce RTX 4090 - Driver 31.0.15.5186`
TODO: ADD IMAGE
## Blender Version
Follow one of the guides below to obtain your Blender version number then
share it on your bug reporting form like this: `Blender 4.1.1`
mod_moder marked this conversation as resolved

Just to make sure, does this approach might work in case if blender doesn't run?
Mainly, if there is issue with GPU context or windows drivers.

Just to make sure, does this approach might work in case if blender doesn't run? Mainly, if there is issue with GPU context or windows drivers.
Review

Version is handled as early as possible, without creating any GPU context.

Version is handled as early as possible, without creating any GPU context.
### Downloaded from Blender Website
Navigate to where Blender is installed, right click on the file `blender.exe`
and select the `Properties` option. In the new window that appears, select
the `Details` tab and you will find the Blender version in the field
called `File Version`.
TODO: ADD IMAGE
### Downloaded from Steam
If you installed Blender through Steam, then open Steam, right click
on Blender and select the option `Manage > Browse local files`.
A file browser will appear showing where Blender is installed.
Right click on the file `blender.exe` and select the `Properties` option.
In the new window that appears, select the `Details` tab and you will find
the Blender version in the field called `File Version`.
TODO: ADD IMAGE
### Downloaded from Microsoft Store
If you installed Blender through the Microsoft store, then click on the Windows
icon on the task bar and find Blender in your apps list. Once you've found it,
right click on Blender and select `More > App Settings`. The settings app will
open and you will find the Blender version in the field `Specifications` with
the name `Version`.
TODO: ADD IMAGE