[ECOS] [PATCH] io.sgml \n\r <=> \r\n

[ECOS] [PATCH] io.sgml \n\r <=> \r\n

[Billy]

In the TTY docs, the CRLFs are always expressed as '\n\r'...
(See http://sources.redhat.com/ecos/docs-latest/ref/io-tty-driver.html)
I had to check that the tty code actually does the right thing.
Here's a correction to the docs..


Index: ecos/packages/io/common/current/doc/io.sgml
===================================================================
RCS file: /cvs/ecos/packages/io/common/current/doc/io.sgml,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 io.sgml
--- ecos/packages/io/common/current/doc/io.sgml	17 Apr 2003 21:49:02 -0000	1.1.1.1
+++ ecos/packages/io/common/current/doc/io.sgml	4 Nov 2003 22:18:53 -0000
@@ -839,12 +839,12 @@
 <literal>CYG_TTY_OUT_FLAGS_xxx</literal> values below. </PARA>
 
 <PROGRAMLISTING>
-#define CYG_TTY_OUT_FLAGS_CRLF 0x0001 // Map '\n' =&gt; '\n\r' on output
+#define CYG_TTY_OUT_FLAGS_CRLF 0x0001 // Map '\n' =&gt; '\r\n' on output
 </PROGRAMLISTING>
 
 <PARA>If this bit is set in <structfield>tty_out_flags</structfield>,
 any occurrence of the character &quot;\n&quot; will
-be replaced by the sequence &quot;\n\r&quot; before
+be replaced by the sequence &quot;\r\n&quot; before
 being sent to the device.</PARA>
 
 <PARA>The field <structfield><!-- <index></index> -->tty_in_flags</structfield>
@@ -861,12 +861,12 @@
 most keyboards) will be mapped to &quot;\n&quot;.</PARA>
 
 <PROGRAMLISTING>
-#define CYG_TTY_IN_FLAGS_CRLF 0x0002 // Map '\n\r' =&gt; '\n' on input
+#define CYG_TTY_IN_FLAGS_CRLF 0x0002 // Map '\r\n' =&gt; '\n' on input
 </PROGRAMLISTING>
 
 <PARA>
 If this bit is set in <structfield>tty_in_flags</structfield>, the
-character sequence &quot;\n\r&quot; (often sent by DOS/Windows
+character sequence &quot;\r\n&quot; (often sent by DOS/Windows
 based terminals) will be mapped to &quot;\n&quot;. </PARA>
 
 <PROGRAMLISTING>
@@ -916,7 +916,7 @@
 
 <PARA>This function is used to send data to the device. In the default
 case, the end-of-line character "\n" is replaced by the
-sequence "\n\r". </PARA>
+sequence "\r\n". </PARA>
 
 <PROGRAMLISTING>
 cyg_io_get_config(handle, key, buf, len)

-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss

Re: [ECOS] [PATCH] io.sgml \n\r <=> \r\n

[Andrew Lunn]

On Tue, Nov 04, 2003 at 05:20:30PM -0500, Billy wrote:
> In the TTY docs, the CRLFs are always expressed as '\n\r'...
> (See http://sources.redhat.com/ecos/docs-latest/ref/io-tty-driver.html)
> I had to check that the tty code actually does the right thing.
> Here's a correction to the docs..

Thanks. Please could you include a ChangeLog entry next time. I made
one up for you this time. See bellow.

    Andrew



Index: io/common//current/ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/packages/io/common/current/ChangeLog,v
retrieving revision 1.18
diff -u -r1.18 ChangeLog
--- io/common//current/ChangeLog        25 Mar 2003 02:46:53 -0000      1.18
+++ io/common//current/ChangeLog        6 Nov 2003 11:15:07 -0000
@@ -1,3 +1,8 @@
+2003-11-06   Billy <billy@babababa.net>
+
+       * doc/io.sgml: In the TTY section swap "\n\r" to "\r\n" to match
+       reality.
+
 2003-03-25  Jonathan Larmour  <jifl@eCosCentric.com>
 
        * include/config_keys.h: Define CYG_IO_SET_CONFIG_SERIAL_OUTPUT_FLUSH

-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss