docs/188582: fstab man page has incorrect option "keylength" listed for .eli devices
Michael Hall
mhallpub at mailc.net
Mon Apr 14 02:10:01 UTC 2014
>Number: 188582
>Category: docs
>Synopsis: fstab man page has incorrect option "keylength" listed for .eli devices
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Mon Apr 14 02:10:00 UTC 2014
>Closed-Date:
>Last-Modified:
>Originator: Michael Hall
>Release: 10.0
>Organization:
>Environment:
FreeBSD Test 10.0-RELEASE FreeBSD 10.0-RELEASE #0 r260789: Thu Jan 16 22:34:59 UTC 2014 root at snap.freebsd.org:/usr/obj/usr/src/sys/GENERIC amd64
>Description:
When configuring an encrypted swap partition, I found an error in the fstab man page documentation. Search for "eli" in the man page. It will go to the section where "fs_type" is being described. In the middle of that paragraph, it says:
"Swap entries on .eli devices will cause automatic creation of encrypted devices. The ``ealgo'', ``aalgo'', ``keylength'', and ``sectorsize'' options may be passed to control those geli(8) parameters."
The ``keylength'' paramater is an invalid option which did work when I used it in the fstab file. I found the SVN commit (r252310) where the key length parameter was documented. It should be ``keylen''. Using this spelling of the parameter, I was able to successfully set the key length for the encrypted swap partition.
>How-To-Repeat:
>Fix:
Update the documentation to spell the key length option as "keylen".
>Release-Note:
>Audit-Trail:
>Unformatted:
More information about the freebsd-doc
mailing list