Bug 171529

Summary:	Serial chapter introduction mentions obsolete sio(4) interface
Product:	Documentation	Reporter:	Enji Cooper <ngie>
Component:	Books & Articles	Assignee:	Isabell Long <issyl0>
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description Enji Cooper freebsd_committer

2012-09-11 00:30:02 UTC

The link to the following page in the handbook mentions sio(4) instead of uart(4): http://www.freebsd.org/doc/en/books/handbook/serial.html#SERIAL-CABLES-PORTS . The documentation needs to be updated for FreeBSD 8.x+ as sio(4) is defunct in 8.x+:

wf048# dmesg | grep ^sio
wf048# dmesg | grep ^uart
uart0: <16550 or compatible> port 0x3f8-0x3ff irq 4 flags 0x10 on acpi0
uart0: console (115200,n,8,1)
uart1: <16550 or compatible> port 0x2f8-0x2ff irq 3 flags 0x10 on acpi0
uart2: <16550 or compatible> port 0x3e8-0x3ef irq 5 flags 0x10 on acpi0

Comment 1 Glen Barber freebsd_committer

2012-09-11 02:13:40 UTC

Class Changed
From-To: sw-bug->doc-bug

Docs PR.

Comment 2 Glen Barber freebsd_committer

2012-09-11 02:13:40 UTC

Responsible Changed
From-To: freebsd-bugs->freebsd-docs

Docs PR.

Comment 3 Glen Barber freebsd_committer

2012-09-11 02:14:37 UTC

Responsible Changed
From-To: freebsd-docs->freebsd-doc

Fix assignment...

Comment 4 dfilter service freebsd_committer

2012-09-14 22:55:45 UTC

Author: issyl0
Date: Fri Sep 14 21:55:29 2012
New Revision: 39550
URL: http://svn.freebsd.org/changeset/doc/39550

Log:
  - Update a section of the serial communications Handbook chapter to refer
    to uart(4) in FreeBSD 8.X as opposed to the obsolete sio(4).  Keep the
    references to sio(4) but specify that they are for 7.X and older
    releases.  [1]
  - Fix some capitalisation convention errors also in the Handbook.
  
  PR:		docs/171529 [1]
  Approved by:	gjb, gabor (mentors)

Modified:
  head/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.sgml
  head/en_US.ISO8859-1/books/handbook/install/chapter.sgml
  head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml

Modified: head/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.sgml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.sgml	Fri Sep 14 21:37:14 2012	(r39549)
+++ head/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.sgml	Fri Sep 14 21:55:29 2012	(r39550)
@@ -37,7 +37,7 @@
     </authorgroup>
   </chapterinfo>
 
-  <title>Installing &os;&nbsp;9.<replaceable>x</replaceable> and
+  <title>Installing &os;&nbsp;9.<replaceable>X</replaceable> and
     Later</title>
 
   <sect1 id="bsdinstall-synopsis">

Modified: head/en_US.ISO8859-1/books/handbook/install/chapter.sgml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/install/chapter.sgml	Fri Sep 14 21:37:14 2012	(r39549)
+++ head/en_US.ISO8859-1/books/handbook/install/chapter.sgml	Fri Sep 14 21:55:29 2012	(r39550)
@@ -27,7 +27,7 @@
     <!-- January 2000 -->
   </chapterinfo>
 
-  <title>Installing &os;&nbsp;8.<replaceable>x</replaceable> and Earlier</title>
+  <title>Installing &os;&nbsp;8.<replaceable>X</replaceable> and Earlier</title>
 
   <sect1 id="install-synopsis">
     <title>Synopsis</title>

Modified: head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml	Fri Sep 14 21:37:14 2012	(r39549)
+++ head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml	Fri Sep 14 21:55:29 2012	(r39550)
@@ -547,16 +547,20 @@
 	for messages while the kernel is booting, or use the
 	<command>/sbin/dmesg</command> command to replay the kernel's boot
 	messages.  In particular, look for messages that start with the
-	characters <literal>sio</literal>.</para>
+	characters <literal>uart</literal> if you use &os;&nbsp;8.0 or
+	higher, or <literal>sio</literal> for &os;&nbsp;7.2 or older.</para>
 
       <tip><para>To view just the messages that have the word
-	<literal>sio</literal>, use the command:</para>
+	<literal>uart</literal> or <literal>sio</literal> depending on the
+	installed version of &os;, use the commands:</para>
 
-      <screen>&prompt.root; <userinput>/sbin/dmesg | grep 'sio'</userinput></screen>
+      <screen>&prompt.root; <userinput>/sbin/dmesg | grep 'uart'</userinput>
+&prompt.root; <userinput>/sbin/dmesg | grep 'sio'</userinput></screen>
       </tip>
 
-      <para>For example, on a system with four serial ports, these are the
-	serial-port specific kernel boot messages:</para>
+      <para>For example, on a &os;&nbsp;7.<replaceable>X</replaceable>
+	system with four serial ports, these are the serial-port specific
+	kernel boot messages:</para>
 
       <screen>sio0 at 0x3f8-0x3ff irq 4 on isa
 sio0: type 16550A
_______________________________________________
svn-doc-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-doc-all
To unsubscribe, send any mail to "svn-doc-all-unsubscribe@freebsd.org"

Comment 5 Isabell Long freebsd_committer

2012-09-14 22:58:23 UTC

Responsible Changed
From-To: freebsd-doc->issyl0

Mine, now I've submitted a patch.

Comment 6 Isabell Long freebsd_committer

2012-09-14 23:05:00 UTC

State Changed
From-To: open->closed

This has been fixed now in the way that you suggested.  Thanks for the 
report!