man page for veritysetup does not contain helpful information

[GoogleCodeExporter]

What steps will reproduce the problem?

1. man veritysetup

What is the expected output? What do you see instead?

I expect a useful explanation of what veritysetup does, how to use it, and 
examples.

If, for example, I wish to protect my linux /boot partition - what do I type?  
The "<hash_device>" is not explained.  --hash-offset is not explained, nor is 
how to calculate such a thing.

We need to know what file systems this works with, where the hashes get stored, 
and how to prepare any hash storage area (or better still - don't make us know 
any of that - make the code figure it out auto-magically).

What version of the product are you using? On what operating system?

veritysetup 1.6.2
RHEL7

Please provide any additional information below.

Original issue reported on code.google.com by publis...@vradd.com on 17 Mar 2014 at 5:35

[GoogleCodeExporter]

Yes, veritysetup man page need some extensions. It is mainly used in Chrome OS, 
and using it is quite specific (it was expected you know inner workings of 
dm-verity kernel module, you need secure storage for root hash etc.)

There are some quick examples in Release notes, but it is not definitely enough
http://code.google.com/p/cryptsetup/wiki/Cryptsetup150
and
http://code.google.com/p/cryptsetup/wiki/DMVerity

I will try to fix this but it is not on the top of the TODO list...

So, if your environment is RHEL7, I would suggest to report it to RH bugzilla 
as well, if they have resources to fix it sooner, I will gladly merge the 
documentation patch.

Original comment by gmazyl...@gmail.com on 17 Mar 2014 at 8:07

• Changed state: Accepted

[GoogleCodeExporter]

Hi - thanks for the rapid reply! (and resources)

I spent all night experimenting, and I think I've got my head around a bunch of 
things.  I'll work more on it today, and if I actually figure it out, would you 
like me to propose some updated documentation for you to use ?

Good idea about RHEL7!

Original comment by publis...@vradd.com on 17 Mar 2014 at 11:19

[GoogleCodeExporter]

Every improvement in documentation is of course welcome, just send it to the 
list or place it here. Thanks.

Original comment by gmazyl...@gmail.com on 27 Mar 2014 at 6:01