[pkg-cryptsetup-devel] Bug#585664: cryptsetup: miscellaneous documentation issues

[Christoph Anton Mitterer]

Package: cryptsetup
Version: 2:1.1.2-1
Severity: normal


Hi Jonas.

I might have again spotted several issues in the documentation which could
be improved:

In /etc/default/cryptdisks:
1) CRYPTDISKS_ENABLE
Clarify all allowed values, defaults if unset and most important
what this exactly does (I guess it simply disables the initscript) and
whether it only affects cryptdisks or also cryptdisks-early.


2) CRYPTDISKS_MOUNT
How this exactly works,... are these simply mountpoints from fstab
and all options/etc. are taken from there?
Again, the missing default if the variable isn't set at all

btw: Do you plan to deprecate this on the long term run? I guess passdev is
a more appropriate way for doing this.


3) CRYPTDISKS_CHECK/CRYPTDISKS_PRECHECK
I guess this needs to be clarified in the following way:
The crypttab manpage already tells defaults. Are these the defaults set in that file?
Or what exactly? This should be documented more exactly in both manpage/and
/etc/default/cryptdisks.

I'd have expected CRYPTDISKS_PRECHECK to be set to "un_blkid"?!

And in the /etc/default/cryptdisks it should also be documented that PRECHECK is
only used for non-LUKS.


If you want assistance, I could write a better documented /etc/default/cryptdisks,
perhaps with assistance from you by answering questions :)


btw: The manpage notes for both checks that the program is searched in
/lib/cryptsetup/checks/:
1) Is it still ok to specify an absolute path to some other location?
2) User's are not meant to put anything in /lib/ (by FHS).
So not sure how interesting this info on the search path is.
On could add functionallity that also some .../local/lib/cryptsetup/checks/
path is searched, but there is no one that corresponds to /lib just one for /usr/lib,
and then we should also add the same thing for keyscripts (searching them in a "local"-
path).
These are of course not the most important features, but I guess it woul make
everything more perfect/conformant.



Cheers,
Chris.