Bug 203345

Summary: Grammatical Error in Developer's handbook (Kernel debugging)
Product: Documentation Reporter: munshs
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Some People CC: bcr
Priority: --- Keywords: patch
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
SVN difference file none

Description munshs 2015-09-25 17:49:36 UTC 
Created attachment 161396 [details]
SVN difference file

This section discusses the efforts made in correcting a minor grammatical error in the FreeBSD Developer's Handbook. This error was located on the "Kernel Debugging", Chapter 10, Section 1.

https://www.freebsd.org/doc/en/books/developers-handbook/kerneldebug.html

"Several types of kernel crash dumps are available: full memory dumps, which hold the complete contents of physical memory, minidumps, which hold only memory pages in use by the kernel (FreeBSD 6.2 and higher), and textdumps, which hold captured scripted or interactive debugger output (FreeBSD 7.1 and higher)."

After the colon, the sentence should have read "full memory dumps, which hold the complete contents of physical memory; minidumps, which hold ...; and textdumps, which hold captured ..."

While there were several little comma based errors in the handbook, this one was particularly confusing because it was fusing two list items together.
Comment 1 commit-hook freebsd_committer freebsd_triage 2016-04-24 09:07:39 UTC 
A commit references this bug:

Author: bcr
Date: Sun Apr 24 09:07:06 UTC 2016
New revision: 48725
URL: https://svnweb.freebsd.org/changeset/doc/48725

Log:
  Replace some colons in a long sentence with
  semi-colons to make a list which contains
  regular commas more readable.

  PR:		203345
  Submitted by:	munshs@rpi.edu
  Sponsored by:	Essen Hackathon 2016

Changes:
  head/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.xml
Comment 2 Benedict Reuschling freebsd_committer freebsd_triage 2016-04-24 09:10:01 UTC 
Patch committed. Thanks for sending it. PR closed!