Bug 69225

Summary: PATCH-Serial comms chapter has wrong acronym for Transmit Data
Product: Documentation Reporter: Warren Block <wblock>
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
file.diff none

Description Warren Block 2004-07-18 05:50:25 UTC 
Serial comms chapter acronym for serial transmit data line is wrong, fix for tenses.

Fix: Apply this patch:
How-To-Repeat: Search for <acronym>SD in the serial comms chapter.
Comment 1 Giorgos Keramidas 2004-07-18 12:53:35 UTC 
On 2004-07-17 22:40, Warren Block <wblock@wonkity.com> wrote:
> --- /usr/doc/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml	Sat Jul 17 06:22:19 2004
> +++ chapter.sgml	Sat Jul 17 22:37:04 2004
> @@ -978,11 +978,11 @@
>
>  	<itemizedlist>
>  	  <listitem>
> -	    <para>Transmitted Data (<acronym>SD</acronym>)</para>
> +	    <para>Transmit Data (<acronym>TD</acronym>)</para>
>  	  </listitem>

Actually, the LED that shows transmit line activity in my modem is
labelled "SD".  Perhaps, we should change the description text to "Sent
Data" instead?

- Giorgos
Comment 2 Marc Fonvieille freebsd_committer freebsd_triage 2004-07-18 13:54:39 UTC 
On Sun, Jul 18, 2004 at 12:00:52PM +0000, Giorgos Keramidas wrote:
>  On 2004-07-17 22:40, Warren Block <wblock@wonkity.com> wrote:
>  > --- /usr/doc/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml	Sat Jul 17 06:22:19 2004
>  > +++ chapter.sgml	Sat Jul 17 22:37:04 2004
>  > @@ -978,11 +978,11 @@
>  >
>  >  	<itemizedlist>
>  >  	  <listitem>
>  > -	    <para>Transmitted Data (<acronym>SD</acronym>)</para>
>  > +	    <para>Transmit Data (<acronym>TD</acronym>)</para>
>  >  	  </listitem>
>  
>  Actually, the LED that shows transmit line activity in my modem is
>  labelled "SD".  Perhaps, we should change the description text to "Sent
>  Data" instead?
>

SD is on the modem, the text is talking about a RS232 cable: "A standard
RS-232C serial cable should suffice as long as all of the normal signals
are wired:"

I'd change SD for TD which is the correct term in our case (or TxD, but
in this case RD must be changed for RxD).  TD is the data transmitted by
the DTE (our computer) to the DCE (modem), RD is data to DTE from DCE.
These descriptions come from a time where half duplex was common.
s/Transmitted/Transmit/ etc. is not mandatory, in fact both versions are
used.  So I'd keep the description but I'd s/SD/TD which is correct.

Marc
Comment 3 Giorgos Keramidas freebsd_committer freebsd_triage 2004-07-18 14:04:53 UTC 
On 2004-07-18 14:54, Marc Fonvieille <blackend@FreeBSD.org> wrote:
> [snip]
> So I'd keep the description but I'd s/SD/TD which is correct.

Cool!  Thanks for the explanation too, I didn't read the original text
very carefully and this was much needed.

Go for it :)
Comment 4 Marc Fonvieille freebsd_committer freebsd_triage 2004-07-19 14:30:04 UTC 
State Changed
From-To: open->closed

I s/SD/TD and s/TxD/TD s/RxD/RD for consistency. 
I kept the line description with the "ed" since it's the one used in the 
UTI V24 recommendation.  Thanks.
Comment 5 Marc Fonvieille freebsd_committer freebsd_triage 2004-07-19 14:38:05 UTC 
On Mon, Jul 19, 2004 at 01:32:32PM +0000, Marc Fonvieille wrote:
> Synopsis: PATCH-Serial comms chapter has wrong acronym for Transmit Data
> 
> State-Changed-From-To: open->closed
> State-Changed-By: blackend
> State-Changed-When: Mon Jul 19 13:30:04 GMT 2004
> State-Changed-Why: 
> I s/SD/TD and s/TxD/TD s/RxD/RD for consistency.
> I kept the line description with the "ed" since it's the one used in the
> UTI V24 recommendation.  Thanks.
>

grr I meant ITU (International Telecommunication Union).