Bug 1512155

I noticed when submitting the description above that "vdoHashZonesThreads" in the last sentence of the man-page text should be "vdoHashZoneThreads" instead (no "s" after "zones"). So, just in case you do use that part of the text...

Hello Ken,

Thanks for reporting this. I'm setting this bug as a blocker for our main VDO docs bug.

Marek

I've added the option and references to it to match the current vdo man page.

See the built preview:
https://access.qa.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/storage_administration_guide/vdo-ig-commands#vdo_opt_vdoHashZoneThreads

The man page describes the option in a slightly different way than what you suggest, so could you please check if it's correct?

Also, the typos are now fixed.

It looks like you've changed the numbers, and I don't think they're correct. The minimum is 0 (with the constraint about other parameters also being zero or nonzero), and the default is 1.

I actually copied the description from the current vdo(8) man page, which says:

> --vdoHashZoneThreads=thread count
> 
> Specifies the number of threads across which to subdivide  parts
> of  the VDO processing based on the hash value computed from the
> block data. The value must be at least 1 and less than or  equal
> to  100.  vdoHashZonesThreads,  vdoLogicalThreads  and vdoPhysi‐
> calThreads must be either all zero or all non-zero. The  default
> is 2.

I'm happy with changing the values in the documentation, but I just wanted to point out that the man page is probably wrong in that case.

Ah, I see. It looks like the values for vdoHashZoneThreads were erroneously copied from vdoCpuThreads when a rewrite of the man page was done recently. The values there are wrong. (And inconsistent: It says vdoHashZoneThreads can be 0 if two other parameters are 0, but also says it must be at least 1.)

The program requires 0-100 and defaults to 1. The help message output by the program appears to have the correct values.

I've just opened bug 1547786 for the man page issue.

I've updated the description of the vdoHashZoneThreads option in the documentation to what you suggested in comment#0. See the built preview:
https://access.qa.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/storage_administration_guide/vdo-ig-commands#vdo_opt_vdoHashZoneThreads

Thanks for opening the man page bug. If there's anything more to do, please let me know.

The new text looks correct, thanks.

Minor nit-picking: It says "vdoHashZoneThreads, vdoLogicalThreads and vdoPhysicalThreads must...", whereas the other two say, "The vdoHashZoneThreads, vdoLogicalThreads, and vdoPhysicalThreads options must be either all zero or all non‐zero."

I'm not sure the latter is the best wording, either; strictly speaking, I'd say "the vdoHashZoneThreads option" refers to the argument "--vdoHashZoneThreads=3" or whatever, not just the number, so the "option" isn't a numeric value. Perhaps the option is *given* or *set to* a numeric value, or we could refer to the vdoHashZoneThreads *value*. But now I'm really getting picky. :-)

Ken,
your nitpicking is right: the descriptions were inconsistent and it's questionable whether those values can be called "options". I'm removing "options" so that the documentation is identical to what the man page says.

As a side note, the VDO documentation is now published on the Customer Portal. See here for the section that includes the description of "--vdoHashZoneThreads":
https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/storage_administration_guide/vdo-ig-commands#vdo_opt_vdoHashZoneThreads

I'm closing this bug as CURRENTRELEASE.

Thanks for your help!