docs/113695: handbook suggests different lockfile than gbde(8) manpage

[Marc Silver]

The following reply was made to PR docs/113695; it has been noted by GNATS.

From: Marc Silver <marcs at draenor.org>
To: bug-followup at FreeBSD.org, billf at mu.org
Cc:  
Subject: Re: docs/113695: handbook suggests different lockfile than gbde(8) manpage
Date: Thu, 10 Jan 2008 14:22:19 +0200

 --V88s5gaDVPzZ0KCq
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: inline
 
 Hi there,
 
 I double checked this and /etc/rc.d/gbde does indeed look for a file
 that ends in ".lock".  Furthermore, the rc.d script explicitly looks in
 /etc for a lockfile unless gbde_lockdir is explicitly set in
 /etc/rc.conf.
 
 Included is a patch that corrects the article as well as adding notes
 regarding the fact that GBDE lock files must end in .lock and adding
 mention of the gbde_lockdir override.  
 
 With regards to the 'c' partition vs. the 'real' partition, I was able
 to set this up with the 'c' partition without any error, but since the
 guide states that the disk output should be used as a guideline I don't
 think this is too much of a trainsmash.
 
 Cheers,
 Marc
 
 --V88s5gaDVPzZ0KCq
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: attachment; filename="gbde.patch"
 
 --- chapter.sgml.orig	2008-01-10 13:59:53.000000000 +0200
 +++ chapter.sgml	2008-01-10 14:06:04.000000000 +0200
 @@ -3566,7 +3566,7 @@
  	    initialized before it can be used. This initialization needs to
  	    be performed only once:</para>
  
 -	  <screen>&prompt.root; <userinput>gbde init /dev/ad4s1c -i -L /etc/gbde/ad4s1c</userinput></screen>
 +	  <screen>&prompt.root; <userinput>gbde init /dev/ad4s1c -i -L /etc/gbde/ad4s1c.lock</userinput></screen>
  
  	  <para>&man.gbde.8; will open your editor, permitting you to set
  	    various configuration options in a template. For use with UFS1
 @@ -3598,7 +3598,14 @@
  	  <para>The <command>gbde init</command> command creates a lock
  	    file for your <application>gbde</application> partition that in
  	    this example is stored as
 -	    <filename>/etc/gbde/ad4s1c</filename>.</para>
 +	    <filename>/etc/gbde/ad4s1c.lock</filename>.</para>
 +
 +	  <note>
 +	    <para><application>gbde</application> lock files must end in
 +	    <emphasis>.lock</emphasis> in order to be correctly detected
 +	    by the <application>gbde</application> <filename>rc.d</filename> 
 +	    script.</para>
 +	  </note>
  
  	  <caution>
  	    <para><application>gbde</application> lock files
 @@ -3616,7 +3623,7 @@
  	<step>
  	  <title>Attach the Encrypted Partition to the Kernel</title>
  
 -	  <screen>&prompt.root; <userinput>gbde attach /dev/ad4s1c -l /etc/gbde/ad4s1c</userinput></screen>
 +	  <screen>&prompt.root; <userinput>gbde attach /dev/ad4s1c -l /etc/gbde/ad4s1c.lock</userinput></screen>
  
  	  <para> You will be asked to provide the passphrase that you
  	    selected during the initialization of the encrypted partition.
 @@ -3693,7 +3700,7 @@
  	<step>
  	  <title>Attach the gbde Partition to the Kernel</title>
  
 -	  <screen>&prompt.root; <userinput>gbde attach /dev/ad4s1c -l /etc/gbde/ad4s1c</userinput></screen>
 +	  <screen>&prompt.root; <userinput>gbde attach /dev/ad4s1c -l /etc/gbde/ad4s1c.lock</userinput></screen>
  
  	  <para>You will be asked to provide the passphrase that you
  	    selected during initialization of the encrypted
 @@ -3734,7 +3741,8 @@
  	  &man.rc.conf.5;, for example:</para>
  
  	<programlisting>gbde_autoattach_all="YES"
 -gbde_devices="ad4s1c"</programlisting>
 +gbde_devices="ad4s1c"
 +gbde_lockdir="/etc/gbde"</programlisting>
  
  	<para>This will require that the <application>gbde</application>
  	  passphrase be entered at boot time.  After typing the correct
 
 --V88s5gaDVPzZ0KCq--