Bug 113695

Summary: [handbook] [patch] handbook suggests different lockfile than gbde(8) manpage
Product: Documentation Reporter: bill fumerola <billf>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
gbde.patch none

Description bill fumerola freebsd_committer freebsd_triage 2007-06-14 23:50:04 UTC 
the 'disks-encrypting' section suggests creating a gbde partition
lock as /etc/gbde/ad4s1c, the gbde manpage suggests /etc/gbde/ad4s1c.lock,
and /etc/rc.d/gbde looks for /etc/gbde/PARTITION.lock

following the handbook's advice, one will not be able to use the
rc.conf/rc.d system to mount a gbde file system.

additionally, the handbook suggests the 'c' partition (the magic whole disk),
while the manpage suggests using a 'real' partition. the author of this
PR found that using the 'c' partition didn't work

Fix: 

(*) change the handbook to use the 'a' partition in its example (as it will
exist after following the instructions on adding a new drive (section 18.3)

(*) change the handbook to instruct users to create the lockfile with the
.lock suffix
How-To-Repeat: 
follow the GBDE instructions in the handbook, section 18.16
Comment 1 Marc Silver 2008-01-10 12:22:19 UTC 
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
Comment 2 dfilter service freebsd_committer freebsd_triage 2008-01-21 21:08:13 UTC 
trhodes     2008-01-21 21:08:05 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/handbook/disks chapter.sgml 
  Log:
  Discuss the gbde lockfile
  
  PR:             113695
  Submitted by:   Marc Silver <marcs@draenor.org>
  
  Revision  Changes    Path
  1.280     +10 -5     doc/en_US.ISO8859-1/books/handbook/disks/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2008-01-21 21:08:23 UTC 
State Changed
From-To: open->closed

Slightly different patch applied as the submitted one seemed broken.  Thanks 
for the submission!
Comment 4 Tom Rhodes freebsd_committer freebsd_triage 2008-01-21 21:08:23 UTC 
Responsible Changed
From-To: freebsd-doc->trhodes

Over to me in case of follow up.