blender/blender-developer-docs
7
8
Fork 38
Code Issues 3 Pull Requests 5 Activity

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
Conversation 15 Commits 39 Files Changed 27 +364 -2
Alaska commented 2024-05-09 03:13:31 +02:00
Member
Copy Link

Add pages with guides on how to manually collect system information
for the bug report form in case Blender isn't opening.

Add pages with guides on how to manually collect system information for the bug report form in case Blender isn't opening.
❤️ 1
Alaska added 1 commit 2024-05-09 03:13:33 +02:00 
Setup some pages for guides on how to manually collect infomration

Some images are missing, and Linux stuff is missing. But this is just to get general feedback
Alaska added 1 commit 2024-05-09 03:15:14 +02:00
Alaska commented 2024-05-09 03:19:53 +02:00
Author
Member
Copy Link

This is WIP because I haven't done any work on the Linux side of things, and I haven't uploaded all the images yet.

I am uploading it here to get some general feedback. CC @brecht @Sergey and @lichtwerk ?

This is part of the Blender bug reporting template redesign. One of the things I wanted to add is a guide on how to manually collect system information in case Blender isn't opening. And this pull request is just that.

Even if the bug reporting template redesign doesn't go through, then this guide can still be helpful.

This is WIP because I haven't done any work on the Linux side of things, and I haven't uploaded all the images yet. I am uploading it here to get some general feedback. CC @brecht @Sergey and @lichtwerk ? --- This is part of the Blender bug reporting template redesign. One of the things I wanted to add is a guide on how to manually collect system information in case Blender isn't opening. And this pull request is just that. Even if the bug reporting template redesign doesn't go through, then this guide can still be helpful.
Alaska reviewed 2024-05-09 03:21:52 +02:00
docs/handbook/bug_reports/making_good_bug_reports/macos_information.md Outdated
@ -0,0 +14,4 @@
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`.
Alaska commented 2024-05-09 03:21:52 +02:00
Author
Member
Copy Link

Is it called Chipset model when using a AMD GPU on macOS?

Is it called `Chipset model` when using a AMD GPU on macOS?
Alaska marked this conversation as resolved
Alaska added 1 commit 2024-05-09 03:23:47 +02:00
Brecht Van Lommel commented 2024-05-10 14:42:58 +02:00
Owner
Copy Link

It looks like useful information to have in the docs. I think review of this can be left to the triaging team, doesn't need me.

It looks like useful information to have in the docs. I think review of this can be left to the triaging team, doesn't need me.
Alaska added 7 commits 2024-05-11 06:51:59 +02:00
Alaska commented 2024-05-11 07:07:57 +02:00
Author
Member
Copy Link

For anyone that wants a preview of what the page will look like (including images), then you can access it here: https://projects.blender.org/Alaska/blender-developer-docs/src/branch/manual-system-information/docs/handbook/bug_reports/making_good_bug_reports/collect_system_information.md

Otherwise you can checkout this pull request and build the website yourself.

For anyone that wants a preview of what the page will look like (including images), then you can access it here: https://projects.blender.org/Alaska/blender-developer-docs/src/branch/manual-system-information/docs/handbook/bug_reports/making_good_bug_reports/collect_system_information.md Otherwise you can checkout this pull request and build the website yourself.
Stephen Boddy commented 2024-05-11 18:13:44 +02:00
First-time contributor
Copy Link

Per Linux, glxinfo -B only reports "information about the OpenGL and GLX implementations running on a given X display." In my case with a laptop with Intel/NVIDIA (Optimus/Prime), it only reports the Intel bit. You might find there is no single common command to conveniently collect everything all at once. One helpful command for systems with NVIDIA is nvidia-smi. This will report driver and CUDA versions, plus the model, memory etc. of each connected NVIDIA GPU. There are option flags to get more detailed information too.

Per Linux, `glxinfo -B` only reports _"information about the OpenGL and GLX implementations **running on a given X display**."_ In my case with a laptop with Intel/NVIDIA (Optimus/Prime), it only reports the Intel bit. You might find there is no single common command to conveniently collect everything all at once. One helpful command for systems with NVIDIA is `nvidia-smi`. This will report driver and CUDA versions, plus the model, memory etc. of each connected NVIDIA GPU. There are option flags to get more detailed information too.
Alaska commented 2024-05-12 02:56:56 +02:00
Author
Member
Copy Link

@Stephen-Boddy I'd prefer to keep collecting GPU information to a single command for all GPU vendors, but if there's no easy way to do it, then I can add guides for each GPU vendor.

We do run into some issues if we write a guide for each vendor. Specifically with some vendors having multiple drivers (E.g. Nouveau and NVIDIA proprietary), and with a lot of small GPU vendors (Mostly found on ARM SBCs, but if Blender gets Linux on ARM support, then there is a possibility of getting bug reports from these systems)

@Stephen-Boddy I'd prefer to keep collecting GPU information to a single command for all GPU vendors, but if there's no easy way to do it, then I can add guides for each GPU vendor. We do run into some issues if we write a guide for each vendor. Specifically with some vendors having multiple drivers (E.g. Nouveau and NVIDIA proprietary), and with a lot of small GPU vendors (Mostly found on ARM SBCs, but if Blender gets Linux on ARM support, then there is a possibility of getting bug reports from these systems)
Philipp Oeser commented 2024-05-13 09:42:12 +02:00
Member
Copy Link

Thank you very much!
Very useful to have, if we can get the TODOs out of the way this is +1 from me

Thank you very much! Very useful to have, if we can get the TODOs out of the way this is +1 from me
Philipp Oeser reviewed 2024-05-13 10:23:57 +02:00
docs/handbook/bug_reports/making_good_bug_reports/linux_information.md Outdated
@ -0,0 +35,4 @@
## Graphics Card
TODO: Pick an option: `lspci -k | grep -EA3 'VGA|3D|Display'` or `glxinfo -B`
Philipp Oeser commented 2024-05-13 10:22:59 +02:00
Member
Copy Link

Maybe just mention both? (pointing out the advantage of glxinfo if available)

Maybe just mention both? (pointing out the advantage of `glxinfo` if available)
Alaska marked this conversation as resolved
docs/handbook/bug_reports/making_good_bug_reports/linux_information.md Outdated
@ -0,0 +39,4 @@
or something else?
`lspci` should be accessible on every Linux system, but the driver version is not
printed. `glxinfo` may need to be installed on some distros (Including Ubuntu),
but it prints GPU and driver version. `glxinfo` is usally proviede as part
Philipp Oeser commented 2024-05-13 10:23:20 +02:00
Member
Copy Link

proviede > provided

proviede > provided
Alaska marked this conversation as resolved
Alaska added 4 commits 2024-05-13 10:59:52 +02:00
Julian Eisel commented 2024-05-14 12:33:42 +02:00
Member
Copy Link

The images here are quite specific to these documents, I think it's better to have an images subfolder in handbook/bug_reports/making_good_bug_reports for these. Then they are closer to the pages they are used on, which IMO is preferable. I rather avoid a big images folder that is hard to work with.

The images here are quite specific to these documents, I think it's better to have an `images` subfolder in `handbook/bug_reports/making_good_bug_reports` for these. Then they are closer to the pages they are used on, which IMO is preferable. I rather avoid a big images folder that is hard to work with.
👍 1
Alaska added 5 commits 2024-05-14 14:12:12 +02:00
Alaska commented 2024-05-14 14:17:02 +02:00
Author
Member
Copy Link

Remaining TODOs:

  • Figure out if AMD and Intel GPUs names are under Chipset model in macOS System Information app. (I need someone with a AMD/Intel mac to test this)
  • Add a link to this guide inside the /docs/handbook/bug_reports/making_good_bug_reports/index.md page. (It may just be tiredness, but I couldn't identify a nice place to put it. I'll look at it tomorrow, but feedback is welcome from anyone)
  • General review
Remaining TODOs: - [x] Figure out if AMD and Intel GPUs names are [under `Chipset model` in macOS System Information app](https://projects.blender.org/blender/blender-developer-docs/pulls/58/files#issuecomment-1184977). (I need someone with a AMD/Intel mac to test this) - [x] Add a link to this guide inside the `/docs/handbook/bug_reports/making_good_bug_reports/index.md` page. (It may just be tiredness, but I couldn't identify a nice place to put it. I'll look at it tomorrow, but feedback is welcome from anyone) - General review
Alaska added 5 commits 2024-05-15 05:46:26 +02:00
Sergey Sharybin commented 2024-05-15 15:58:28 +02:00
Owner
Copy Link

@Alaska The instruction for macOS seems to be correct on an Intel MacPro with AMD GPU: Screenshot 2024-05-15 at 15.55.53.png

@Alaska The instruction for macOS seems to be correct on an Intel MacPro with AMD GPU: ![Screenshot 2024-05-15 at 15.55.53.png](/attachments/1a2c85ca-484b-4248-9ed3-142ac1900a81)
Screenshot 2024-05-15 at 15.55.53.png
196 KiB
👍 1
Alaska changed title from WIP: Add guides on how to manually collect bug report system information to Add guides on how to manually collect bug report system information 2024-05-16 03:18:56 +02:00
Alaska added 1 commit 2024-05-16 03:19:04 +02:00
Alaska requested review from Philipp Oeser 2024-05-16 03:19:15 +02:00
Alaska commented 2024-05-16 03:29:31 +02:00
Author
Member
Copy Link

There are a few things that could be improved upon. Let me know if you have any opinions on these:

  • GPU information on Linux collected through lspci is very limited.
    • We could just not include the recommendation to use lspci and encourage everyone to use glxinfo (and vulkaninfo once Blender switches to Vulkan)?
  • Blender version info is quite limited.
    • Running blender --version from the command line offers us some more info we can use if we want. But I'm concerned about using this in more places. Primarily Windows and macOS due to "average user" on those platforms being less familiar with command prompt/terminal applications.
There are a few things that could be improved upon. Let me know if you have any opinions on these: - GPU information on Linux collected through `lspci` is very limited. - We could just not include the recommendation to use lspci and encourage everyone to use `glxinfo` (and `vulkaninfo` once Blender switches to Vulkan)? - Blender version info is quite limited. - Running `blender --version` from the command line offers us some more info we can use if we want. But I'm concerned about using this in more places. Primarily Windows and macOS due to "average user" on those platforms being less familiar with command prompt/terminal applications.
Philipp Oeser commented 2024-05-16 11:30:17 +02:00
Member
Copy Link

There are a few things that could be improved upon. Let me know if you have any opinions on these:

  • GPU information on Linux collected through lspci is very limited.
    • We could just not include the recommendation to use lspci and encourage everyone to use glxinfo (and vulkaninfo once Blender switches to Vulkan)?

I think the current wording is fine (mentioning both glxinfo & lspci)

  • Blender version info is quite limited.
    • Running blender --version from the command line offers us some more info we can use if we want. But I'm concerned about using this in more places. Primarily Windows and macOS due to "average user" on those platforms being less familiar with command prompt/terminal applications.

My vote would be to include the commandline for Windows and macOS as well. We could cross-link to the manual?

Speaking of the manual, I think it might be worth cross-linking to https://docs.blender.org/manual/en/4.2/troubleshooting/startup.html ? (this is not mandatory to land this PR though, just saying...)

> There are a few things that could be improved upon. Let me know if you have any opinions on these: > > - GPU information on Linux collected through `lspci` is very limited. > - We could just not include the recommendation to use lspci and encourage everyone to use `glxinfo` (and `vulkaninfo` once Blender switches to Vulkan)? I think the current wording is fine (mentioning both `glxinfo` & `lspci`) > - Blender version info is quite limited. > - Running `blender --version` from the command line offers us some more info we can use if we want. But I'm concerned about using this in more places. Primarily Windows and macOS due to "average user" on those platforms being less familiar with command prompt/terminal applications. My vote would be to include the commandline for Windows and macOS as well. We could cross-link to [the manual](https://docs.blender.org/manual/en/4.2/advanced/command_line/launch/index.html#command-line-launch-index)? Speaking of the manual, I think it might be worth cross-linking to https://docs.blender.org/manual/en/4.2/troubleshooting/startup.html ? (this is not mandatory to land this PR though, just saying...)
Alaska commented 2024-05-16 14:00:25 +02:00
Author
Member
Copy Link

My vote would be to include the commandline for Windows and macOS as well.

Would you like us to list both the simple and commandline way of collecting information on Windows and macOS? Or list just the commandline way?

> My vote would be to include the commandline for Windows and macOS as well. Would you like us to list both the simple and commandline way of collecting information on Windows and macOS? Or list **just** the commandline way?
Philipp Oeser commented 2024-05-16 14:58:48 +02:00
Member
Copy Link

My vote would be to include the commandline for Windows and macOS as well.

Would you like us to list both the simple and commandline way of collecting information on Windows and macOS? Or list just the commandline way?

both is better I think

> > My vote would be to include the commandline for Windows and macOS as well. > > Would you like us to list both the simple and commandline way of collecting information on Windows and macOS? Or list **just** the commandline way? both is better I think
Alaska added 4 commits 2024-05-17 10:00:19 +02:00
Alaska commented 2024-05-17 10:03:16 +02:00
Author
Member
Copy Link

I've added some extra details for gathering information from the command line on the different platforms. Some notes:

  1. The branch details (E.g. Main branch of Blender) are are only available in Blender 4.2+. So that's why the 4.2 notes are there.
  2. I feel like the notes on using the command line on macOS are a bit messy/unclear, especially the Steam instructions. How do you feel about it?
I've added some extra details for gathering information from the command line on the different platforms. Some notes: 1. The branch details (E.g. Main branch of Blender) are are only available in [Blender 4.2+](https://projects.blender.org/blender/blender/commit/9320ee2a36b57cc4c941365568c9fc569f6c893f). So that's why the 4.2 notes are there. 2. I feel like the notes on using the command line on macOS are a bit messy/unclear, especially the Steam instructions. How do you feel about it?
Iliya Katushenock reviewed 2024-05-17 11:03:46 +02:00
docs/handbook/bug_reports/making_good_bug_reports/windows_information.md
@ -0,0 +33,4 @@
#### Command line
Open up a command prompt or terminal and run the command
`/path/to/blender.exe --version`. You will find the Blender version,
Iliya Katushenock commented 2024-05-17 11:03:46 +02:00
Member
Copy Link

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.
Sergey Sharybin commented 2024-05-17 11:43:16 +02:00
Owner
Copy Link

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

Version is handled as early as possible, without creating any GPU context.
👍 1
mod_moder marked this conversation as resolved
Alaska added 1 commit 2024-05-17 12:50:39 +02:00
Alaska added 2 commits 2024-05-17 16:47:39 +02:00
Alaska added 1 commit 2024-08-07 11:17:07 +02:00 
This is no longer in 4.2.
Alaska added 1 commit 2024-08-07 11:22:46 +02:00 
Adjustments are to make it clearer, or just to fit a different format.
Alaska added 1 commit 2024-08-07 11:36:38 +02:00 
Mostly small changes, but there is a larger change in the "Steam Command line" section
Alaska added 1 commit 2024-08-07 11:39:21 +02:00 
Just a small change to align with every other page
Alaska added 2 commits 2024-08-07 11:58:59 +02:00
Alaska changed title from Add guides on how to manually collect bug report system information to WIP: Add guides on how to manually collect bug report system information 2024-08-07 12:02:47 +02:00
Alaska commented 2024-08-07 12:03:10 +02:00
Author
Member
Copy Link

Set to WIP temporarily because I requested Philipp to review this, but made a mistake. I'm fixing it now.

Fixed

~~Set to WIP temporarily because I requested Philipp to review this, but made a mistake. I'm fixing it now.~~ Fixed
Alaska changed title from WIP: Add guides on how to manually collect bug report system information to Add guides on how to manually collect bug report system information 2024-08-07 12:07:44 +02:00
Alaska added 1 commit 2024-08-07 12:07:55 +02:00
Philipp Oeser approved these changes 2024-08-07 13:30:29 +02:00
Philipp Oeser left a comment
Member
Copy Link

Lgtm, lets finally do this :)

Lgtm, lets finally do this :)
🎉 1
Alaska merged commit 6be9da6503 into main 2024-08-07 14:17:21 +02:00
Alaska deleted branch manual-system-information 2024-08-07 14:17:22 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Philipp Oeser
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
7 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender-developer-docs#58
No description provided.
Delete Branch "Alaska/blender-developer-docs:manual-system-information"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?