Bug 68595

Summary: [PATCH] add FAQ entry for lock order reversals
Product: Documentation Reporter: Jon Noack <noackj>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
lor-faq.diff none

Description Jon Noack 2004-07-02 09:40:13 UTC
	Add a FAQ entry for lock order reversals.  It basically just
	quotes a mailing list response by Robert Watson, but there is
	also a note pointing to the lock order reversal status page
	maintained by Bjoern Zeeb:
	http://sources.zabbadoz.net/freebsd/lor.html

	See recent comments in the freebsd-current archive:
	http://docs.freebsd.org/cgi/mid.cgi?20040701083434.GA83951
	http://docs.freebsd.org/cgi/mid.cgi?20040701103535.GA84499
	http://docs.freebsd.org/cgi/mid.cgi?40E3EBD2.2020106

Fix: See patch below.
How-To-Repeat: 	N/A
Comment 1 Hiten Pandya freebsd_committer freebsd_triage 2004-07-07 00:40:55 UTC
Dear Jonathan,

This text actually belongs in the glossary part of the Handbook.

People generally tend to print out the Handbook so by putting it
there, it results into better documentation.

Cheers.

Hiten Pandya
hmp at freebsd.org
Comment 2 Jon Noack 2004-07-08 07:45:26 UTC
I can't seem to find the glossary part of the handbook (there doesn't app=
ear
to be a glossary at http://www.freebsd.org/handbook/ and grepping for
glossary in the doc source didn't turn up much).  Can you point me to whe=
re
it is defined?

Jon


Jonathan Noack
Technology Coordinator
Concordia Lutheran High School (http://www.concordiacrusaders.org)
700 East Main Street
Tomball, TX 77375-6721
281.351.2547 x229 (work)
713.480.7163 (cell)

"Do not worry about your problems with computers, I assure you mine are f=
ar
greater." -- Jonathan Noack
Comment 3 Simon L. B. Nielsen freebsd_committer freebsd_triage 2004-07-08 09:18:12 UTC
On 2004.07.08 06:50:24 +0000, Jonathan Noack wrote:

> I can't seem to find the glossary part of the handbook (there doesn't
> appear to be a glossary at http://www.freebsd.org/handbook/ and
> grepping for glossary in the doc source didn't turn up much).  Can you
> point me to where it is defined?


It is not build by default (yet) since there hasn't been that much
content in it (though that should probably be reconsidered soon).
Anyway, it's located in:

doc/en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml

-- 
Simon L. Nielsen
FreeBSD Documentation Team
Comment 4 Hiten Pandya freebsd_committer freebsd_triage 2004-07-08 12:15:49 UTC
I do apologise.  The glossary is actually part of the Architecture
Handbook.

In that case, it might be just OK to add it to the FAQ right now,
and once a Glossary chapter is written for the Handbook it can be
included in there.

Hiten Pandya
hmp at freebsd.org

On Thu, 8 Jul 2004, Jonathan Noack wrote:

 :I can't seem to find the glossary part of the handbook (there doesn't appear
 :to be a glossary at http://www.freebsd.org/handbook/ and grepping for
 :glossary in the doc source didn't turn up much).  Can you point me to where
 :it is defined?
 :
 :Jon
 :
 :
 :Jonathan Noack
 :Technology Coordinator
 :Concordia Lutheran High School (http://www.concordiacrusaders.org)
 :700 East Main Street
 :Tomball, TX 77375-6721
 :281.351.2547 x229 (work)
 :713.480.7163 (cell)
 :
 :"Do not worry about your problems with computers, I assure you mine are far
 :greater." -- Jonathan Noack
 :
 :
 :
Comment 5 Murray Stokely freebsd_committer freebsd_triage 2004-08-02 06:26:03 UTC
State Changed
From-To: open->closed

The submitter did not send in a glossary entry.  It's true that we may 
want to add LOR to a glossary at some point, but as proved by the 
mailing list thread from which this submission was taken, this is in 
fact a frequently asked question.  This is very appropriate for the 
troubleshooting section of the FAQ as is. 

Thanks for the submission!  It will appear on the website within 24 
hours.