mdadm --help should include --detail

[Mike Pelley]

Binary package hint: mdadm

"mdadm --detail /dev/md0" (or "mdadm -D /dev/md0") is the standard way to interactively check the status of a RAID array, so far as I understand. I believe this is a fairly popular option for mdadm, but it doesn't not appear when I type "mdadm --help" for some reason (using Karmic).

I propose that "mdadm --detail device" appear as an option when a user runs "mdadm --help", perhaps between "--build" and "--manage".

[ceg (ceg)]

"mdadm --detail" isn't a "major mode", I guess that's why it is not listed. Have you looked at "mdadm --misc --help"?

[Mike Pelley (mikepelley)]

Yes, it does show under --misc --help (which I overlooked), but my thought was that the most commonly used options should show up under --help. Here's what I was thinking - please feel free to close if you disagree ;o)

For someone who doesn't set up a lot of machines, the mdadm help and man page would be reviewed more thoroughly when creating a RAID array. Once created, however, they might not have occasion to run mdadm other than to check the status, and that might occur infrequently enough that they need to look it up. From that point of view, it might be nice to have --detail a bit more accessible, i.e. on the initial --help page.

Looking at it again, I have an alternate suggestion. It might be better to show the output from "mdadm --help-options" as the default output of "mdadm --help", and move the default output to "mdadm --help-modes" or similar. I think that would better serve folks who are looking for "quick" help via --help, and still provide what's needed to those who are doing something more involved.

Or not - just a thought ;o)

[ceg (ceg)]

OK, as there is no "close", I guess you could mark it "invalid" or pursue it upstream, just as you like.

[Mike Pelley (mikepelley)]

Just for my own information - why did you consider this invalid? Do you disagree? Thanks!

[ceg (ceg)]

Actually I agree the help could be improved, i.e. it could first clearly mention that it is only showing "major modes", or just append the help-options page. I am just a user like you, and the thing is mdadm could be considered unmaintained in ubuntu, just check the bugs and the version. So I'd suggest you contact the linux-raid list with text patches if you'd want to see changes. I really dislike that "invalid" state, too. But there seem to be nothing like "close" for housekeeping. We can add this to launchpad project "mdadm" but that is currently only a place to gather upstream bugs withing launchpad without really getting the info upstream (devs don's seem to use any bug tracker).

[Mike Pelley (mikepelley)]

Ok - thanks! I'll keep your comments in mind when filing in the future.

[ceg (ceg)]

Because it could be misunderstood, by "devs" in my last comment I meant the upstream developders of mdadm (they seem to just use a mailinglist and not an explicit bug tracker).

Well, thank you for filing and caring about mdadm!