summaryrefslogtreecommitdiff
path: root/io.c
diff options
context:
space:
mode:
authorAlan Wu <XrXr@users.noreply.github.com>2022-08-03 10:48:43 -0400
committerAlan Wu <XrXr@users.noreply.github.com>2022-08-05 14:34:08 -0400
commitca8daf70fa7045aa1e505514497d1ac4720a6b16 (patch)
tree4f0699398170e420dd1eaccd1ba28cdefbb677e7 /io.c
parentf1057393da7a98e447ee7679db69aeec8f4d1650 (diff)
downloadruby-ca8daf70fa7045aa1e505514497d1ac4720a6b16.tar.gz
[DOC] Mention Windows text mode EOF marker interpretation
I don't think this is super well known so it's worth mentioning as it can be a pitfall. See: https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/fopen-wfopen?view=msvc-170 Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
Diffstat (limited to 'io.c')
-rw-r--r--io.c6
1 files changed, 4 insertions, 2 deletions
diff --git a/io.c b/io.c
index c91899a6fe..f2c64989df 100644
--- a/io.c
+++ b/io.c
@@ -14504,9 +14504,11 @@ set_LAST_READ_LINE(VALUE val, ID _x, VALUE *_y)
* Either of the following may be suffixed to any of the string read/write modes above:
*
* - <tt>'t'</tt>: Text data; sets the default external encoding to +Encoding::UTF_8+;
- * on Windows, enables conversion between EOL and CRLF.
+ * on Windows, enables conversion between EOL and CRLF and enables interpreting +0x1A+
+ * as an end-of-file marker.
* - <tt>'b'</tt>: Binary data; sets the default external encoding to +Encoding::ASCII_8BIT+;
- * on Windows, suppresses conversion between EOL and CRLF.
+ * on Windows, suppresses conversion between EOL and CRLF and disables interpreting +0x1A+
+ * as an end-of-file marker.
*
* If neither is given, the stream defaults to text data.
*