Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Supported Hardware page could be clearer #69

Closed
Chealer opened this issue Nov 19, 2024 · 4 comments
Closed

Supported Hardware page could be clearer #69

Chealer opened this issue Nov 19, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Chealer
Copy link

Chealer commented Nov 19, 2024

The Supported Hardware page is very helpful, but I suspect it can be confusing for people with limited experience.

It currently reads:

GSmartControl supports ATA drives (both PATA and SATA), NVMe drives, various USB to ATA bridges, and drives behind some RAID controllers.

See Smartmontools USB Device Support page for an (incomplete) list of supported USB to ATA bridges.

GSmartControl supports the following RAID controllers:

[...]

Note: Smartmontools supports even more RAID Controllers. The drives behind such controllers can be manually entered in GSmartControl using Add Device… functionality or --add-device command-line option.

I do not know smartmontools well and am far from being sure of what it supports, but if my understanding is correct, I would suggested rephrasing to something like:

GSmartControl supports ATA drives (both PATA and SATA) and NVMe drives when they are directly attached. For drives behind bridges or RAID controllers, see the following section.

USB and RAID
See smartmontools USB Device Support page for an (incomplete) list of supported USB to ATA bridges.

GSmartControl supports the following RAID controllers:

[...]

Note: Smartmontools supports even more RAID Controllers. The drives behind such controllers can be manually entered in GSmartControl using Add Device… functionality or --add-device command-line option.

@Chealer Chealer added the enhancement New feature or request label Nov 19, 2024
@ashaduri
Copy link
Owner

I updated the Supported Hardware page for clarity.

Please note that some USB to NVMe bridges are supported as well.

@ashaduri ashaduri added the documentation Improvements or additions to documentation label Nov 19, 2024
@Chealer
Copy link
Author

Chealer commented Nov 19, 2024

Thanks @ashaduri
I wrote this ticket thinking that my own knowledge about hardware has vastly diminished in the last 15 years, and I imagine the text could be intimidating for new generations.

Perhaps it clarifies to specify that SCSI drives are not supported. Also, the new text lists ATA drives, but not which. Perhaps the first 2 items in the list can be numbered and #1 relabelled to "All ATA drives―either serial (SATA) or parallel (PATA)―which support SMART", if that is accurate. Then the third element can read "#1 and #2 behind some USB bridges […]".

@ashaduri
Copy link
Owner

I added a note about SCSI / SAS support.

I left the rest as is. The page already lists SATA and PATA drives. As for the SMART support, any non-buggy hdd/ssd has SMART support, unless it's connected via USB, and USB bridges are listed separately.
I also do not want to use the term "directly attached" - it is very vague and may be even more confusing.

@Chealer
Copy link
Author

Chealer commented Nov 21, 2024

Thanks @ashaduri
Yes, the page already lists SATA and PATA drives, but not which. English can be very vague. For example, I can say that my flashlight contains batteries, but it does not mean that it contains all the batteries in the world. In its current state, the page effectively only claims that some ATA drives are supported.

I agree that "directly attached" is vague. However, I think not indicating that attachment matters is misleading.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants