Bug 157901

Summary: [PATCH] grammar and wording fixes to snd_hda.4
Product: Documentation Reporter: Niclas Zeising <niclas.zeising>
Component: Books & ArticlesAssignee: Benedict Reuschling <bcr>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
snd_hda.4.diff none

Description Niclas Zeising 2011-06-15 15:20:08 UTC 
	The wording in the BUGS section of snd_hda(4) is a little wierd and not always gramatically correct.

Fix: Attached patch tries to improve the wording and grammar.
Comment 1 Benedict Reuschling freebsd_committer freebsd_triage 2011-06-15 17:51:26 UTC 
Responsible Changed
From-To: freebsd-doc->bcr

Take this PR.
Comment 2 dfilter service freebsd_committer freebsd_triage 2011-06-16 20:57:25 UTC 
Author: bcr (doc committer)
Date: Thu Jun 16 19:57:07 2011
New Revision: 223160
URL: http://svn.freebsd.org/changeset/base/223160

Log:
  Fix some wording and grammar in the BUGS section.
  
  PR:             docs/157901
  Submitted by:   Niclas Zeising (niclas dot zeising at gmail dot com)
  Reviewed by:    mav
  MFC after:      3 days

Modified:
  head/share/man/man4/snd_hda.4

Modified: head/share/man/man4/snd_hda.4
==============================================================================
--- head/share/man/man4/snd_hda.4	Thu Jun 16 19:47:56 2011	(r223159)
+++ head/share/man/man4/snd_hda.4	Thu Jun 16 19:57:07 2011	(r223160)
@@ -668,16 +668,20 @@ and
 A few Hardware/OEM vendors tend to screw up BIOS settings, thus
 rendering the
 .Nm
-driver useless, which usually results in a state where the
+driver useless.
+This usually results in a state where the
 .Nm
-driver seems to attach and work, but without any sound. Some of
-that cases can be solved by tuning loader.conf variables. But before
-trying to fix problem that way, make sure that problem is really exists
-and the PCM audio device you are using really corresponds to expected
+driver seems to attach and work, but no sound is played.
+Some cases can be solved by tuning
+.Pa loader.conf
+variables.
+Before trying to fix problem that way, make sure that there really is a problem
+and that the PCM audio device in use really corresponds to the expected
 audio connector.
 .Pp
-Some vendors use non-standardized General Purpose I/O (GPIO) pins of codec
-to control external amplifiers. In some cases setting proper combination of
-GPIO bits may be needed to make sound work on specific device.
+Some vendors use non-standardized General Purpose I/O (GPIO) pins of the codec
+to control external amplifiers.
+In some cases setting a combination of GPIO bits may be needed to make
+sound work on a specific device.
 .Pp
 HDMI and DisplayPort audio may also require support from video driver.
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 3 Benedict Reuschling freebsd_committer freebsd_triage 2011-06-16 21:05:27 UTC 
State Changed
From-To: open->patched

Set to state patched until the MFC is through.
Comment 4 dfilter service freebsd_committer freebsd_triage 2011-06-19 12:01:53 UTC 
Author: bcr (doc committer)
Date: Sun Jun 19 11:01:38 2011
New Revision: 223290
URL: http://svn.freebsd.org/changeset/base/223290

Log:
  MFC r223160:
  
  Fix some wording and grammar in the BUGS section.
  
  PR:             docs/157901
  Submitted by:   Niclas Zeising (niclas dot zeising at gmail dot com)
  Reviewed by:    mav

Modified:
  stable/8/share/man/man4/snd_hda.4
Directory Properties:
  stable/8/share/man/man4/   (props changed)

Modified: stable/8/share/man/man4/snd_hda.4
==============================================================================
--- stable/8/share/man/man4/snd_hda.4	Sun Jun 19 08:53:16 2011	(r223289)
+++ stable/8/share/man/man4/snd_hda.4	Sun Jun 19 11:01:38 2011	(r223290)
@@ -669,16 +669,20 @@ and
 A few Hardware/OEM vendors tend to screw up BIOS settings, thus
 rendering the
 .Nm
-driver useless, which usually results in a state where the
+driver useless.
+This usually results in a state where the
 .Nm
-driver seems to attach and work, but without any sound. Some of
-that cases can be solved by tuning loader.conf variables. But before
-trying to fix problem that way, make sure that problem is really exists
-and the PCM audio device you are using really corresponds to expected
+driver seems to attach and work, but no sound is played.
+Some cases can be solved by tuning
+.Pa loader.conf
+variables.
+Before trying to fix problem that way, make sure that there really is a problem
+and that the PCM audio device in use really corresponds to the expected
 audio connector.
 .Pp
-Some vendors use non-standardized General Purpose I/O (GPIO) pins of codec
-to control external amplifiers. In some cases setting proper combination of
-GPIO bits may be needed to make sound work on specific device.
+Some vendors use non-standardized General Purpose I/O (GPIO) pins of the codec
+to control external amplifiers.
+In some cases setting a combination of GPIO bits may be needed to make
+sound work on a specific device.
 .Pp
 HDMI and DisplayPort audio may also require support from video driver.
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 5 dfilter service freebsd_committer freebsd_triage 2011-06-19 12:14:12 UTC 
Author: bcr (doc committer)
Date: Sun Jun 19 11:14:02 2011
New Revision: 223291
URL: http://svn.freebsd.org/changeset/base/223291

Log:
  MFC r223160:
  
  Fix some wording and grammar in the BUGS section.
  
  PR:             docs/157901
  Submitted by:   Niclas Zeising (niclas dot zeising at gmail dot com)
  Reviewed by:    mav

Modified:
  stable/7/share/man/man4/snd_hda.4
Directory Properties:
  stable/7/share/man/man4/   (props changed)

Modified: stable/7/share/man/man4/snd_hda.4
==============================================================================
--- stable/7/share/man/man4/snd_hda.4	Sun Jun 19 11:01:38 2011	(r223290)
+++ stable/7/share/man/man4/snd_hda.4	Sun Jun 19 11:14:02 2011	(r223291)
@@ -626,17 +626,21 @@ and
 A few Hardware/OEM vendors tend to screw up BIOS settings, thus
 rendering the
 .Nm
-driver useless, which usually results in a state where the
+driver useless.
+This usually results in a state where the
 .Nm
-driver seems to attach and work, but without any sound. Some of
-that cases can be solved by tuning loader.conf variables. But before
-trying to fix problem that way, make sure that problem is really exists
-and the PCM audio device you are using really corresponds to expected
+driver seems to attach and work, but no sound is played.
+Some cases can be solved by tuning
+.Pa loader.conf
+variables.
+Before trying to fix problem that way, make sure that there really is a problem
+and that the PCM audio device in use really corresponds to the expected
 audio connector.
 .Pp
-Some vendors use non-standardized General Purpose I/O (GPIO) pins of codec
-to control external amplifiers. In some cases setting proper combination of
-GPIO bits may be needed to make sound work on specific device.
+Some vendors use non-standardized General Purpose I/O (GPIO) pins of the codec
+to control external amplifiers.
+In some cases setting a combination of GPIO bits may be needed to make
+sound work on a specific device.
 .Pp
 HDMI and DisplayPort audio may also require support from video driver.
 .Pp
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 6 Benedict Reuschling freebsd_committer freebsd_triage 2011-06-19 12:20:20 UTC 
State Changed
From-To: patched->closed

MFC is done. Thanks for filing the PR and sending the patch. PR closed!