https://git.ruby-lang.org/ruby.git/commit/?id=0d13f5aa73

From 0d13f5aa736ed2c30113df9f72d4044f2a091ef5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=8D=9C=E9=83=A8=E6=98=8C=E5=B9=B3?=
 <shyouhei@r...>
Date: Thu, 21 Jan 2021 10:16:50 +0900
Subject: include/ruby/internal/dosish.h: add doxygen

Must not be a bad idea to improve documents. [ci skip]
---
 include/ruby/internal/dosish.h | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/include/ruby/internal/dosish.h b/include/ruby/internal/dosish.h
index c0453c2..7d354dd 100644
--- a/include/ruby/internal/dosish.h
+++ b/include/ruby/internal/dosish.h
@@ -38,20 +38,46 @@ https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/dosish.h#L38
 #include "ruby/win32.h"
 #endif
 
+/** The delimiter of `PATH` environment variable. */
 #if defined(DOSISH)
 #define PATH_SEP ";"
 #else
 #define PATH_SEP ":"
 #endif
 
+/** Identical to #PATH_SEP, except it is of type `char`. */
 #define PATH_SEP_CHAR PATH_SEP[0]
 
+/**
+ * @private
+ *
+ * @deprecated  This macro once was a thing in the old days, but makes no sense
+ *              any  longer today.   Exists  here  for backwards  compatibility
+ *              only.  You can safely forget about it.
+ *
+ * @internal
+ *
+ * For  historical interests:  there was  an operating  system called  Human68k
+ * which used an environment variable called `"path"` for this purpose.
+ */
 #define PATH_ENV "PATH"
 
 #if defined(DOSISH)
 #define ENV_IGNORECASE
 #endif
 
+/**
+ * Stone age  assumption was that  an operating  system supports only  one file
+ * system at a  moment.  This macro was  to detect if such (one  and only) file
+ * system  has case  sensitivity.   This  assumption is  largely  not true  any
+ * longer; most operating systems can mount  many kinds of file systems side by
+ * side.  Also there are file systems that  do or do not ignore cases depending
+ * on configuration (e.g.  EXT4's `casefold` feature).
+ *
+ * This  macro is  still  used  internally (for  instance  Ruby level  constant
+ * `File::FNM_SYSCASE` depends on it), but it is basically a wrong idea for you
+ * to use it today.  Please just find another way.
+ */
 #ifndef CASEFOLD_FILESYSTEM
 # if defined DOSISH
 #   define CASEFOLD_FILESYSTEM 1
-- 
cgit v1.1


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/