Bug 188582

Summary:	fstab man page has incorrect option "keylength" listed for .eli devices
Product:	Documentation	Reporter:	Michael Hall <mhallpub>
Component:	Books & Articles	Assignee:	Christian Brueffer <brueffer>
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description Michael Hall 2014-04-14 03:10:00 UTC

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.

Fix: 

Update the documentation to spell the key length option as "keylen".

Comment 1 dfilter service freebsd_committer

2014-04-14 07:59:53 UTC

Author: brueffer
Date: Mon Apr 14 06:59:49 2014
New Revision: 264453
URL: http://svnweb.freebsd.org/changeset/base/264453

Log:
  Correct geli parameter.
  
  PR:		188582
  Submitted by:	Michael Hall
  MFC after:	3 days

Modified:
  head/share/man/man5/fstab.5

Modified: head/share/man/man5/fstab.5
==============================================================================
--- head/share/man/man5/fstab.5	Mon Apr 14 06:34:08 2014	(r264452)
+++ head/share/man/man5/fstab.5	Mon Apr 14 06:59:49 2014	(r264453)
@@ -28,7 +28,7 @@
 .\"     @(#)fstab.5	8.1 (Berkeley) 6/5/93
 .\" $FreeBSD$
 .\"
-.Dd September 10, 2013
+.Dd April 14, 2014
 .Dt FSTAB 5
 .Os
 .Sh NAME
@@ -241,7 +241,7 @@ devices will cause automatic creation of
 The
 .Dq ealgo ,
 .Dq aalgo ,
-.Dq keylength ,
+.Dq keylen ,
 and
 .Dq sectorsize
 options may be passed to control those
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 2 Christian Brueffer freebsd_committer

2014-04-14 08:00:03 UTC

State Changed
From-To: open->patched

Fixed in HEAD, thanks!

Comment 3 Christian Brueffer freebsd_committer

2014-04-14 08:00:03 UTC

Responsible Changed
From-To: freebsd-doc->brueffer

Merge reminder.

Comment 4 dfilter service freebsd_committer

2014-04-17 11:43:42 UTC

Author: brueffer
Date: Thu Apr 17 10:43:38 2014
New Revision: 264589
URL: http://svnweb.freebsd.org/changeset/base/264589

Log:
  MFC: r264453
  
  Correct geli parameter.
  
  PR:		188582
  Submitted by:	Michael Hall

Modified:
  stable/10/share/man/man5/fstab.5
Directory Properties:
  stable/10/   (props changed)

Modified: stable/10/share/man/man5/fstab.5
==============================================================================
--- stable/10/share/man/man5/fstab.5	Thu Apr 17 10:41:26 2014	(r264588)
+++ stable/10/share/man/man5/fstab.5	Thu Apr 17 10:43:38 2014	(r264589)
@@ -32,7 +32,7 @@
 .\"     @(#)fstab.5	8.1 (Berkeley) 6/5/93
 .\" $FreeBSD$
 .\"
-.Dd September 10, 2013
+.Dd April 14, 2014
 .Dt FSTAB 5
 .Os
 .Sh NAME
@@ -245,7 +245,7 @@ devices will cause automatic creation of
 The
 .Dq ealgo ,
 .Dq aalgo ,
-.Dq keylength ,
+.Dq keylen ,
 and
 .Dq sectorsize
 options may be passed to control those
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 5 Christian Brueffer freebsd_committer

2014-04-17 11:48:26 UTC

State Changed
From-To: patched->closed

Merge to stable branch done.