Bug 187321

Summary: [handbook] [patch] Clarification needed on using geli rc.d script
Product: Documentation Reporter: Jack-Benny Persson <jack-benny>
Component: Books & ArticlesAssignee: Warren Block <wblock>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff
none
docs.disks_geli_fix.patch
none
docs.disks_geli_fix_v2.patch none

Description Jack-Benny Persson 2014-03-06 17:30:01 UTC
When automatically attaching a provider during boot, the provider will detach itself again if it's not mounted with an entry in /etc/fstab during boot. This could need some clarification in chapter 18.14.2.1.

Fix: See attached patch.

Patch attached with submission follows:
Comment 1 Allan Jude 2014-03-19 21:24:22 UTC
Minor edits to the patch

- added double spaces after periods
- removed whitespace at ends of lines
- reflowed paragraphs for 70 columns
- removed the duplicated reference to /etc/fstab
- added a warning about the fact that the password prompt can be hidden
by device attachments
- Other minor grammar edits

-- 
Allan Jude
Comment 2 Allan Jude 2014-03-19 22:00:53 UTC
Fix a typo that caused a build error


-- 
Allan Jude
Comment 3 dfilter service freebsd_committer freebsd_triage 2014-04-11 17:07:37 UTC
Author: wblock
Date: Fri Apr 11 16:07:32 2014
New Revision: 44533
URL: http://svnweb.freebsd.org/changeset/doc/44533

Log:
  Clarify usage of GELI rc.d script.
  
  PR:		docs/187321
  Reviewed by:	Allan Jude and mat@ on IRC

Modified:
  head/en_US.ISO8859-1/books/handbook/disks/chapter.xml

Modified: head/en_US.ISO8859-1/books/handbook/disks/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/disks/chapter.xml	Fri Apr 11 15:50:19 2014	(r44532)
+++ head/en_US.ISO8859-1/books/handbook/disks/chapter.xml	Fri Apr 11 16:07:32 2014	(r44533)
@@ -3126,8 +3126,8 @@ Filesystem     Size   Used  Avail Capaci
 geli_da2_flags="-p -k /root/da2.key"</programlisting>
 
 	<para>This configures <filename>/dev/da2</filename> as a
-	  <command>geli</command> provider of which the master key
-	  file is located in <filename>/root/da2.key</filename>.
+	  <command>geli</command> provider with a master key
+	  file of <filename>/root/da2.key</filename>.
 	  <command>geli</command> will not use a passphrase when
 	  attaching to the provider if
 	  <option>-P</option> was given during the
@@ -3135,6 +3135,26 @@ geli_da2_flags="-p -k /root/da2.key"</pr
 	  the <command>geli</command> provider from the kernel before
 	  the system shuts down.</para>
 
+	<note>
+	  <para>During the startup process, scripts prompt for the
+	    passphrase before attaching the <acronym>GELI</acronym>
+	    provider.  Other kernel messages might be shown before and
+	    after the password prompt.  If the boot process seems to
+	    stall, look carefully for the password prompt among the
+	    other messages.</para>
+
+	  <para>When the correct password is given, the provider is
+	    attached.  A consumer, like a file system, is then mounted
+	    on the provider, typically by an entry in
+	    <filename>/etc/fstab</filename> (see
+	    &man.fstab.5;).</para>
+
+	  <para>Later in the startup process, &os; configures
+	    <acronym>GELI</acronym> providers to automatically detach.
+	    <acronym>GELI</acronym> providers without any consumers
+	    will detach at that time.</para>
+	</note>
+
 	<para>More information about configuring
 	  <filename>rc.d</filename> is provided in the
 	  <link linkend="configtuning-rcd">rc.d</link> section of the
_______________________________________________
svn-doc-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-doc-all
To unsubscribe, send any mail to "svn-doc-all-unsubscribe@freebsd.org"
Comment 4 Warren Block freebsd_committer freebsd_triage 2014-04-11 17:11:12 UTC
State Changed
From-To: open->closed
Comment 5 Warren Block freebsd_committer freebsd_triage 2014-04-11 17:11:12 UTC
Responsible Changed
From-To: freebsd-doc->wblock

Reorganized version of patch committed.  Thanks!