microsoft / diskspd

DISKSPD is a storage load generator / performance test tool from the Windows/Windows Server and Cloud Server Infrastructure Engineering teams
MIT License
1.15k stars 214 forks source link

Where are the Error Codes and Mitigations #84

Open RandyDotCom opened 5 years ago

RandyDotCom commented 5 years ago

Can you provide a TroubleShootingGuide.md for this repo?

RandyDotCom commented 5 years ago

At least add https://docs.microsoft.com/en-us/windows/desktop/Debug/system-error-codes to the readme

dl2n commented 5 years ago

Links disconnected from where an error pops out aren't incredibly useful in my experience, certainly shouldn't be handling the 99% cases. This is a perfect example. The answer for your original question was a relatively simple search away (that you shouldn't really have had to make), and I'd argue thats more accessible than trawling a readme.

I took a quick look through the code and I'm inclined that there should be a distinguished PrintErrorWithCode() that takes error code along with the rest of the printf varargs, and does the right job of formatting it out with the text for the win32 error codes. The bulk of the current PrintError fall into that category (or should … some seem to be missing code output, where they really should have).